249 lines
8.6 KiB
Groff
Executable File
249 lines
8.6 KiB
Groff
Executable File
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
|
|
.\"
|
|
.\" Standard preamble:
|
|
.\" ========================================================================
|
|
.de Sp \" Vertical space (when we can't use .PP)
|
|
.if t .sp .5v
|
|
.if n .sp
|
|
..
|
|
.de Vb \" Begin verbatim text
|
|
.ft CW
|
|
.nf
|
|
.ne \\$1
|
|
..
|
|
.de Ve \" End verbatim text
|
|
.ft R
|
|
.fi
|
|
..
|
|
.\" Set up some character translations and predefined strings. \*(-- will
|
|
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
|
|
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
|
|
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
|
|
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
|
|
.\" nothing in troff, for use with C<>.
|
|
.tr \(*W-
|
|
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
|
.ie n \{\
|
|
. ds -- \(*W-
|
|
. ds PI pi
|
|
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
|
|
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
|
|
. ds L" ""
|
|
. ds R" ""
|
|
. ds C` ""
|
|
. ds C' ""
|
|
'br\}
|
|
.el\{\
|
|
. ds -- \|\(em\|
|
|
. ds PI \(*p
|
|
. ds L" ``
|
|
. ds R" ''
|
|
'br\}
|
|
.\"
|
|
.\" Escape single quotes in literal strings from groff's Unicode transform.
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\"
|
|
.\" If the F register is turned on, we'll generate index entries on stderr for
|
|
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
|
|
.\" entries marked with X<> in POD. Of course, you'll have to process the
|
|
.\" output yourself in some meaningful fashion.
|
|
.ie \nF \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. nr % 0
|
|
. rr F
|
|
.\}
|
|
.el \{\
|
|
. de IX
|
|
..
|
|
.\}
|
|
.\"
|
|
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
|
.\" Fear. Run. Save yourself. No user-serviceable parts.
|
|
. \" fudge factors for nroff and troff
|
|
.if n \{\
|
|
. ds #H 0
|
|
. ds #V .8m
|
|
. ds #F .3m
|
|
. ds #[ \f1
|
|
. ds #] \fP
|
|
.\}
|
|
.if t \{\
|
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
|
. ds #V .6m
|
|
. ds #F 0
|
|
. ds #[ \&
|
|
. ds #] \&
|
|
.\}
|
|
. \" simple accents for nroff and troff
|
|
.if n \{\
|
|
. ds ' \&
|
|
. ds ` \&
|
|
. ds ^ \&
|
|
. ds , \&
|
|
. ds ~ ~
|
|
. ds /
|
|
.\}
|
|
.if t \{\
|
|
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
|
|
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
|
|
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
|
|
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
|
|
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
|
|
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
|
|
.\}
|
|
. \" troff and (daisy-wheel) nroff accents
|
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
|
.ds ae a\h'-(\w'a'u*4/10)'e
|
|
.ds Ae A\h'-(\w'A'u*4/10)'E
|
|
. \" corrections for vroff
|
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
|
. \" for low resolution devices (crt and lpr)
|
|
.if \n(.H>23 .if \n(.V>19 \
|
|
\{\
|
|
. ds : e
|
|
. ds 8 ss
|
|
. ds o a
|
|
. ds d- d\h'-1'\(ga
|
|
. ds D- D\h'-1'\(hy
|
|
. ds th \o'bp'
|
|
. ds Th \o'LP'
|
|
. ds ae ae
|
|
. ds Ae AE
|
|
.\}
|
|
.rm #[ #] #H #V #F C
|
|
.\" ========================================================================
|
|
.\"
|
|
.IX Title "OSSL_SERIALIZER 3"
|
|
.TH OSSL_SERIALIZER 3 "2020-03-02" "3.0.0-dev" "OpenSSL"
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
|
.\" way too many mistakes in technical documents.
|
|
.if n .ad l
|
|
.nh
|
|
.SH "NAME"
|
|
OSSL_SERIALIZER,
|
|
OSSL_SERIALIZER_fetch,
|
|
OSSL_SERIALIZER_up_ref,
|
|
OSSL_SERIALIZER_free,
|
|
OSSL_SERIALIZER_provider,
|
|
OSSL_SERIALIZER_properties,
|
|
OSSL_SERIALIZER_is_a,
|
|
OSSL_SERIALIZER_number,
|
|
OSSL_SERIALIZER_do_all_provided,
|
|
OSSL_SERIALIZER_names_do_all
|
|
\&\- Serializer method routines
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.Vb 1
|
|
\& #include <openssl/serializer.h>
|
|
\&
|
|
\& typedef struct ossl_serializer_st OSSL_SERIALIZER;
|
|
\&
|
|
\& OSSL_SERIALIZER *OSSL_SERIALIZER_fetch(OPENSSL_CTX *ctx, const char *name,
|
|
\& const char *properties);
|
|
\& int OSSL_SERIALIZER_up_ref(OSSL_SERIALIZER *serializer);
|
|
\& void OSSL_SERIALIZER_free(OSSL_SERIALIZER *serializer);
|
|
\& const OSSL_PROVIDER *OSSL_SERIALIZER_provider(const OSSL_SERIALIZER
|
|
\& *serializer);
|
|
\& const char *OSSL_SERIALIZER_properties(const OSSL_SERIALIZER *ser);
|
|
\& int OSSL_SERIALIZER_is_a(const OSSL_SERIALIZER *serializer,
|
|
\& const char *name);
|
|
\& int OSSL_SERIALIZER_number(const OSSL_SERIALIZER *serializer);
|
|
\& void OSSL_SERIALIZER_do_all_provided(OPENSSL_CTX *libctx,
|
|
\& void (*fn)(OSSL_SERIALIZER *serializer,
|
|
\& void *arg),
|
|
\& void *arg);
|
|
\& void OSSL_SERIALIZER_names_do_all(const OSSL_SERIALIZER *serializer,
|
|
\& void (*fn)(const char *name, void *data),
|
|
\& void *data);
|
|
.Ve
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
\&\fB\s-1OSSL_SERIALIZER\s0\fR is a method for serializers, which know how to
|
|
serialize an object of some kind to a serialized form, such as \s-1PEM\s0,
|
|
\&\s-1DER\s0, or even human readable text.
|
|
.PP
|
|
\&\fIOSSL_SERIALIZER_fetch()\fR looks for an algorithm within the provider that
|
|
has been loaded into the \fB\s-1OPENSSL_CTX\s0\fR given by \fIctx\fR, having the
|
|
name given by \fIname\fR and the properties given by \fIproperties\fR.
|
|
The \fIname\fR determines what type of object the fetched serializer
|
|
method is expected to be able to serialize, and the properties are
|
|
used to determine the expected output type.
|
|
For known properties and the values they may have, please have a look
|
|
in \*(L"Names and properties\*(R" in \fIprovider\-serializer\fR\|(7).
|
|
.PP
|
|
\&\fIOSSL_SERIALIZER_up_ref()\fR increments the reference count for the given
|
|
\&\fIserializer\fR.
|
|
.PP
|
|
\&\fIOSSL_SERIALIZER_free()\fR decrements the reference count for the given
|
|
\&\fIserializer\fR, and when the count reaches zero, frees it.
|
|
.PP
|
|
\&\fIOSSL_SERIALIZER_provider()\fR returns the provider of the given
|
|
\&\fIserializer\fR.
|
|
.PP
|
|
\&\fIOSSL_SERIALIZER_provider()\fR returns the property definition associated
|
|
with the given \fIserializer\fR.
|
|
.PP
|
|
\&\fIOSSL_SERIALIZER_is_a()\fR checks if \fIserializer\fR is an implementation of an
|
|
algorithm that's identifiable with \fIname\fR.
|
|
.PP
|
|
\&\fIOSSL_SERIALIZER_number()\fR returns the internal dynamic number assigned to
|
|
the given \fIserializer\fR.
|
|
.PP
|
|
\&\fIOSSL_SERIALIZER_names_do_all()\fR traverses all names for the given
|
|
\&\fIserializer\fR, and calls \fIfn\fR with each name and \fIdata\fR.
|
|
.PP
|
|
\&\fIOSSL_SERIALIZER_do_all_provided()\fR traverses all serializer
|
|
implementations by all activated providers in the library context
|
|
\&\fIlibctx\fR, and for each of the implementations, calls \fIfn\fR with the
|
|
implementation method and \fIdata\fR as arguments.
|
|
.SH "NOTES"
|
|
.IX Header "NOTES"
|
|
\&\fIOSSL_SERIALIZER_fetch()\fR may be called implicitly by other fetching
|
|
functions, using the same library context and properties.
|
|
Any other \s-1API\s0 that uses keys will typically do this.
|
|
.SH "RETURN VALUES"
|
|
.IX Header "RETURN VALUES"
|
|
\&\fIOSSL_SERIALIZER_fetch()\fR returns a pointer to the key management
|
|
implementation represented by an \s-1OSSL_SERIALIZER\s0 object, or \s-1NULL\s0 on
|
|
error.
|
|
.PP
|
|
\&\fIOSSL_SERIALIZER_up_ref()\fR returns 1 on success, or 0 on error.
|
|
.PP
|
|
\&\fIOSSL_SERIALIZER_free()\fR doesn't return any value.
|
|
.PP
|
|
\&\fIOSSL_SERIALIZER_provider()\fR returns a pointer to a provider object, or
|
|
\&\s-1NULL\s0 on error.
|
|
.PP
|
|
\&\fIOSSL_SERIALIZER_properties()\fR returns a pointer to a property
|
|
definition string, or \s-1NULL\s0 on error.
|
|
.PP
|
|
\&\fIOSSL_SERIALIZER_is_a()\fR returns 1 of \fIserializer\fR was identifiable,
|
|
otherwise 0.
|
|
.PP
|
|
\&\fIOSSL_SERIALIZER_number()\fR returns an integer.
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fIprovider\fR\|(7), \s-1\fIOSSL_SERIALIZER_CTX\s0\fR\|(3), \fIOSSL_SERIALIZER_to_bio\fR\|(3),
|
|
\&\fIOSSL_SERIALIZER_CTX_new_by_EVP_PKEY\fR\|(3), \s-1\fIOPENSSL_CTX\s0\fR\|(3)
|
|
.SH "HISTORY"
|
|
.IX Header "HISTORY"
|
|
The functions described here were added in OpenSSL 3.0.
|
|
.SH "COPYRIGHT"
|
|
.IX Header "COPYRIGHT"
|
|
Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
|
|
.PP
|
|
Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
|
|
this file except in compliance with the License. You can obtain a copy
|
|
in the file \s-1LICENSE\s0 in the source distribution or at
|
|
<https://www.openssl.org/source/license.html>.
|