summaryrefslogtreecommitdiffstats
path: root/doc/man7/provider.pod
diff options
context:
space:
mode:
authorRichard Levitte <levitte@openssl.org>2019-11-18 01:29:06 +0100
committerRichard Levitte <levitte@openssl.org>2019-11-29 20:54:48 +0100
commit0d003c52d3dcf4b076bb01a6767cdd5ace2d79f6 (patch)
treec04a81334735f506d3c94a3591e224683feb78ad /doc/man7/provider.pod
parent36fa4d8a0df9dc168047fadd0365966c7116b31d (diff)
SERIALIZER: New API for serialization of objects through providers
Serialization is needed to be able to take a provider object (such as the provider side key data) and output it in PEM form, DER form, text form (for display), and possibly other future forms (XML? JSON? JWK?) The idea is that a serializer should be able to handle objects it has intimate knowledge of, as well as object data in OSSL_PARAM form. The latter will allow libcrypto to serialize some object with a different provider than the one holding the data, if exporting of that data is allowed and there is a serializer that can handle it. We will provide serializers for the types of objects we know about, which should be useful together with any other provider that provides implementations of the same type of object. Serializers are selected by method name and a couple of additional properties: - format used to tell what format the output should be in. Possibilities could include "format=text", "format=pem", "format=der", "format=pem-pkcs1" (traditional), "format=der-pkcs1" (traditional) - type used to tell exactly what type of data should be output, for example "type=public" (the public part of a key), "type=private" (the private part of a key), "type=domainparams" (domain parameters). This also adds a passphrase callback function type, OSSL_PASSPHRASE_CALLBACK, which is a bit like OSSL_CALLBACK, but it takes a few extra arguments to place the result in. Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/10394)
Diffstat (limited to 'doc/man7/provider.pod')
-rw-r--r--doc/man7/provider.pod8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/man7/provider.pod b/doc/man7/provider.pod
index c3405b6f22..b6c5e49f50 100644
--- a/doc/man7/provider.pod
+++ b/doc/man7/provider.pod
@@ -147,6 +147,14 @@ The number for this operation is B<OSSL_OP_KEYEXCH>.
The functions the provider can offer are described in
L<provider-keyexch(7)>
+=item Serialization
+
+In the OpenSSL libraries, the corresponding method object is
+B<OSSL_SERIALIZER>.
+The number for this operation is B<OSSL_OP_SERIALIZER>.
+The functions the provider can offer are described in
+L<provider-serializer(7)>
+
=back
=head2 Fetching algorithms