diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man3/OSSL_DECODER_CTX.3')
| -rw-r--r-- | secure/lib/libcrypto/man/man3/OSSL_DECODER_CTX.3 | 32 |
1 files changed, 21 insertions, 11 deletions
diff --git a/secure/lib/libcrypto/man/man3/OSSL_DECODER_CTX.3 b/secure/lib/libcrypto/man/man3/OSSL_DECODER_CTX.3 index 616aca3869d1..2abe63e31819 100644 --- a/secure/lib/libcrypto/man/man3/OSSL_DECODER_CTX.3 +++ b/secure/lib/libcrypto/man/man3/OSSL_DECODER_CTX.3 @@ -1,5 +1,5 @@ .\" -*- mode: troff; coding: utf-8 -*- -.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) +.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== @@ -52,10 +52,13 @@ . \} .\} .rr rF +.\" +.\" Required to disable full justification in groff 1.23.0. +.if n .ds AD l .\" ======================================================================== .\" .IX Title "OSSL_DECODER_CTX 3ossl" -.TH OSSL_DECODER_CTX 3ossl 2025-09-30 3.5.4 OpenSSL +.TH OSSL_DECODER_CTX 3ossl 2026-04-07 3.5.6 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -157,7 +160,7 @@ added those that take the specified input type, and functions like the decoder implementations that take that input type. For example, if the input type is set to \f(CW\*(C`DER\*(C'\fR, a PEM to DER decoder will be ignored. .PP -The input type can also be NULL, which means that the caller doesn't know +The input type can also be NULL, which means that the caller doesn\*(Aqt know what type of input they have. In this case, \fBOSSL_DECODER_from_bio()\fR will simply try with one decoder implementation after the other, and thereby discover what kind of input the caller gave it. @@ -181,7 +184,7 @@ parameter descriptors. \&\fBOSSL_DECODER_CTX_set_params()\fR attempts to set parameters specified with an \&\fBOSSL_PARAM\fR\|(3) array \fIparams\fR. These parameters are passed to all decoders that have been added to the \fIctx\fR so far. Parameters that an -implementation doesn't recognise should be ignored by it. +implementation doesn\*(Aqt recognise should be ignored by it. .PP \&\fBOSSL_DECODER_CTX_free()\fR frees the given context \fIctx\fR. If the argument is NULL, nothing is done. @@ -199,7 +202,7 @@ above. .PP \&\fBOSSL_DECODER_CTX_set_input_structure()\fR sets the name of the structure that the input is expected to have. This may be used to determines what decoder -implementations may be used. NULL is a valid input structure, when it's not +implementations may be used. NULL is a valid input structure, when it\*(Aqs not relevant, or when the decoder implementations are expected to figure it out. .PP \&\fBOSSL_DECODER_CTX_get_num_decoders()\fR gets the number of decoders currently @@ -208,7 +211,7 @@ added to the context \fIctx\fR. \&\fBOSSL_DECODER_CTX_set_construct()\fR sets the constructor \fIconstruct\fR. .PP \&\fBOSSL_DECODER_CTX_set_construct_data()\fR sets the constructor data that is -passed to the constructor every time it's called. +passed to the constructor every time it\*(Aqs called. .PP \&\fBOSSL_DECODER_CTX_set_cleanup()\fR sets the constructor data \fIcleanup\fR function. This is called by \fBOSSL_DECODER_CTX_free\fR\|(3). @@ -224,6 +227,13 @@ decode instance \fIdecoder_inst\fR that the constructor got and an object \&\fIreference\fR, unpacks the object which it refers to, and exports it by creating an \fBOSSL_PARAM\fR\|(3) array that it then passes to \fIexport_cb\fR, along with \fIexport_arg\fR. +.PP +Note that functions \fBOSSL_DECODER_CTX_set_selection()\fR, +\&\fBOSSL_DECODER_CTX_set_output_type()\fR, \fBOSSL_DECODER_CTX_set_output_structure()\fR, +\&\fBOSSL_DECODER_CTX_add_encoder()\fR, \fBOSSL_DECODER_CTX_add_extra()\fR, +\&\fBOSSL_DECODER_CTX_set_construct()\fR, \fBOSSL_DECODER_CTX_set_construct_data()\fR, and +\&\fBOSSL_DECODER_CTX_set_cleanup()\fR shouldn\*(Aqt be used after the context is finalised, +in particular after calling the function \fBOSSL_DECODER_CTX_new_for_pkey()\fR. .SS Constructor .IX Subsection "Constructor" A \fBOSSL_DECODER_CONSTRUCT\fR gets the following arguments: @@ -233,8 +243,8 @@ The \fBOSSL_DECODER_INSTANCE\fR for the decoder from which the constructor gets its data. .IP \fIobject\fR 4 .IX Item "object" -A provider-native object abstraction produced by the decoder. Further -information on the provider-native object abstraction can be found in +A provider\-native object abstraction produced by the decoder. Further +information on the provider\-native object abstraction can be found in \&\fBprovider\-object\fR\|(7). .IP \fIconstruct_data\fR 4 .IX Item "construct_data" @@ -249,10 +259,10 @@ These utility functions may be used by a constructor: implementation from a decoder instance \fIdecoder_inst\fR. .PP \&\fBOSSL_DECODER_INSTANCE_get_decoder_ctx()\fR can be used to get the decoder -implementation's provider context from a decoder instance \fIdecoder_inst\fR. +implementation\*(Aqs provider context from a decoder instance \fIdecoder_inst\fR. .PP \&\fBOSSL_DECODER_INSTANCE_get_input_type()\fR can be used to get the decoder -implementation's input type from a decoder instance \fIdecoder_inst\fR. +implementation\*(Aqs input type from a decoder instance \fIdecoder_inst\fR. .PP \&\fBOSSL_DECODER_INSTANCE_get_input_structure()\fR can be used to get the input structure for the decoder implementation from a decoder instance @@ -261,7 +271,7 @@ This may be NULL. .SH "RETURN VALUES" .IX Header "RETURN VALUES" \&\fBOSSL_DECODER_CTX_new()\fR returns a pointer to a \fBOSSL_DECODER_CTX\fR, or NULL -if the context structure couldn't be allocated. +if the context structure couldn\*(Aqt be allocated. .PP \&\fBOSSL_DECODER_settable_ctx_params()\fR returns an \fBOSSL_PARAM\fR\|(3) array, or NULL if none is available. |