diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man7/provider-decoder.7')
| -rw-r--r-- | secure/lib/libcrypto/man/man7/provider-decoder.7 | 43 |
1 files changed, 23 insertions, 20 deletions
diff --git a/secure/lib/libcrypto/man/man7/provider-decoder.7 b/secure/lib/libcrypto/man/man7/provider-decoder.7 index b388f23a52e3..adea234d34d0 100644 --- a/secure/lib/libcrypto/man/man7/provider-decoder.7 +++ b/secure/lib/libcrypto/man/man7/provider-decoder.7 @@ -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 "PROVIDER-DECODER 7ossl" -.TH PROVIDER-DECODER 7ossl 2025-09-30 3.5.4 OpenSSL +.TH PROVIDER-DECODER 7ossl 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 @@ -104,30 +107,30 @@ provider\-decoder \- The OSSL_DECODER library <\-> provider functions not limited to deserialization as individual decoders can also do decoding into intermediate data formats.\fR .PP -The DECODER operation is a generic method to create a provider-native +The DECODER operation is a generic method to create a provider\-native object reference or intermediate decoded data from an encoded form read from the given \fBOSSL_CORE_BIO\fR. If the caller wants to decode data from memory, it should provide a \fBBIO_s_mem\fR\|(3) \fBBIO\fR. The decoded data or object reference is passed along with eventual metadata to the \fImetadata_cb\fR as \fBOSSL_PARAM\fR\|(3) parameters. .PP -The decoder doesn't need to know more about the \fBOSSL_CORE_BIO\fR +The decoder doesn\*(Aqt need to know more about the \fBOSSL_CORE_BIO\fR pointer than being able to pass it to the appropriate BIO upcalls (see "Core functions" in \fBprovider\-base\fR\|(7)). .PP The DECODER implementation may be part of a chain, where data is passed from one to the next. For example, there may be an implementation to decode an object from PEM to DER, and another one -that decodes DER to a provider-native object. +that decodes DER to a provider\-native object. .PP The last decoding step in the decoding chain is usually supposed to create -a provider-native object referenced by an object reference. To import +a provider\-native object referenced by an object reference. To import that object into a different provider the \fBOSSL_FUNC_decoder_export_object()\fR can be called as the final step of the decoding process. .PP All "functions" mentioned here are passed as function pointers between \&\fIlibcrypto\fR and the provider in \fBOSSL_DISPATCH\fR\|(3) arrays via -\&\fBOSSL_ALGORITHM\fR\|(3) arrays that are returned by the provider's +\&\fBOSSL_ALGORITHM\fR\|(3) arrays that are returned by the provider\*(Aqs \&\fBprovider_query_operation()\fR function (see "Provider Functions" in \fBprovider\-base\fR\|(7)). .PP @@ -206,9 +209,9 @@ expected to have. .Sp This property is \fIoptional\fR. .Sp -Structures currently recognised by built-in decoders: +Structures currently recognised by built\-in decoders: .RS 4 -.IP """type-specific""" 4 +.IP """type\-specific""" 4 .IX Item """type-specific""" Type specific structure. .IP """pkcs8""" 4 @@ -222,15 +225,15 @@ Encoding of public keys according to the Subject Public Key Info of RFC 5280. .RE .PP The possible values of both these properties is open ended. A provider may -very well specify input types and structures that libcrypto doesn't know +very well specify input types and structures that libcrypto doesn\*(Aqt know anything about. .SS "Subset selections" .IX Subsection "Subset selections" Sometimes, an object has more than one subset of data that is interesting to -treat separately or together. It's possible to specify what subsets are to +treat separately or together. It\*(Aqs possible to specify what subsets are to be decoded, with a set of bits \fIselection\fR that are passed in an \fBint\fR. .PP -This set of bits depend entirely on what kind of provider-side object is +This set of bits depend entirely on what kind of provider\-side object is to be decoded. For example, those bits are assumed to be the same as those used with \fBprovider\-keymgmt\fR\|(7) (see "Key Objects" in \fBprovider\-keymgmt\fR\|(7)) when the object is an asymmetric keypair \- e.g., \fBOSSL_KEYMGMT_SELECT_PRIVATE_KEY\fR @@ -259,7 +262,7 @@ See \fBOSSL_PARAM\fR\|(3) for further details on the parameters structure used b \&\fBOSSL_FUNC_decoder_set_ctx_params()\fR and \fBOSSL_FUNC_decoder_settable_ctx_params()\fR. .SS "Export function" .IX Subsection "Export function" -When a provider-native object is created by a decoder it would be unsuitable +When a provider\-native object is created by a decoder it would be unsuitable for direct use with a foreign provider. The export function allows for exporting the object into that foreign provider if the foreign provider supports the type of the object and provides an import function. @@ -279,21 +282,21 @@ The decoding functions also take an \fBOSSL_PASSPHRASE_CALLBACK\fR\|(3) function pointer along with a pointer to application data \fIcbarg\fR, which should be used when a pass phrase prompt is needed. .PP -It's important to understand that the return value from this function is +It\*(Aqs important to understand that the return value from this function is interpreted as follows: .IP "True (1)" 4 .IX Item "True (1)" This means "carry on the decoding process", and is meaningful even though -this function couldn't decode the input into anything, because there may be +this function couldn\*(Aqt decode the input into anything, because there may be another decoder implementation that can decode it into something. .Sp -The \fIdata_cb\fR callback should never be called when this function can't +The \fIdata_cb\fR callback should never be called when this function can\*(Aqt decode the input into anything. .IP "False (0)" 4 .IX Item "False (0)" This means "stop the decoding process", and is meaningful when the input could be decoded into some sort of object that this function understands, -but further treatment of that object results into errors that won't be +but further treatment of that object results into errors that won\*(Aqt be possible for some other decoder implementation to get a different result. .PP The conditions to stop the decoding process are at the discretion of the @@ -301,14 +304,14 @@ implementation. .SS "Decoder operation parameters" .IX Subsection "Decoder operation parameters" There are currently no operation parameters currently recognised by the -built-in decoders. +built\-in decoders. .PP -Parameters currently recognised by the built-in pass phrase callback: +Parameters currently recognised by the built\-in pass phrase callback: .IP """info"" (\fBOSSL_PASSPHRASE_PARAM_INFO\fR) <UTF8 string>" 4 .IX Item """info"" (OSSL_PASSPHRASE_PARAM_INFO) <UTF8 string>" A string of information that will become part of the pass phrase prompt. This could be used to give the user information on what kind -of object it's being prompted for. +of object it\*(Aqs being prompted for. .SH "RETURN VALUES" .IX Header "RETURN VALUES" \&\fBOSSL_FUNC_decoder_newctx()\fR returns a pointer to a context, or NULL on |