Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)

Standard preamble:
========================================================================
..
..
.. 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 -- \(*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\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, 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.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF
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 . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . 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 . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . 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 .\} ========================================================================

Title "OSSL_DECODER_FROM_BIO 3"
OSSL_DECODER_FROM_BIO 3 "2023-08-01" "3.0.10" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
"NAME"
OSSL_DECODER_from_data, OSSL_DECODER_from_bio, OSSL_DECODER_from_fp \- Routines to perform a decoding
"SYNOPSIS"
Header "SYNOPSIS" .Vb 1 #include <openssl/decoder.h> \& int OSSL_DECODER_from_bio(OSSL_DECODER_CTX *ctx, BIO *in); int OSSL_DECODER_from_fp(OSSL_DECODER_CTX *ctx, FILE *fp); int OSSL_DECODER_from_data(OSSL_DECODER_CTX *ctx, const unsigned char **pdata, size_t *pdata_len); .Ve

Feature availability macros:

"OSSL_DECODER_from_fp() is only available when \s-1OPENSSL_NO_STDIO\s0 is undefined." 4
Item "OSSL_DECODER_from_fp() is only available when OPENSSL_NO_STDIO is undefined."
"DESCRIPTION"
Header "DESCRIPTION" \fBOSSL_DECODER_from_data() runs the decoding process for the context ctx, with input coming from *pdata, *pdata_len bytes long. Both *pdata and *pdata_len must be non-NULL. When OSSL_DECODER_from_data() returns, \fI*pdata is updated to point at the location after what has been decoded, and *pdata_len to have the number of remaining bytes.

\fBOSSL_DECODER_from_bio() runs the decoding process for the context ctx, with the input coming from the \s-1BIO\s0 in. Should it make a difference, it's recommended to have the \s-1BIO\s0 set in binary mode rather than text mode.

\fBOSSL_DECODER_from_fp() does the same thing as OSSL_DECODER_from_bio(), except that the input is coming from the \s-1FILE\s0 fp.

"RETURN VALUES"
Header "RETURN VALUES" \fBOSSL_DECODER_from_bio(), OSSL_DECODER_from_data() and OSSL_DECODER_from_fp() return 1 on success, or 0 on failure.
"EXAMPLES"
Header "EXAMPLES" To decode an \s-1RSA\s0 key encoded with \s-1PEM\s0 from a bio:

.Vb 6 OSSL_DECODER_CTX *dctx; EVP_PKEY *pkey = NULL; const char *format = "PEM"; /* NULL for any format */ const char *structure = NULL; /* any structure */ const char *keytype = "RSA"; /* NULL for any key */ const unsigned char *pass = "my password"; \& dctx = OSSL_DECODER_CTX_new_for_pkey(&pkey, format, structure, keytype, OSSL_KEYMGMT_SELECT_KEYPAIR, NULL, NULL); if (dctx == NULL) { /* error: no suitable potential decoders found */ } if (pass != NULL) OSSL_DECODER_CTX_set_passphrase(dctx, pass, strlen(pass)); if (OSSL_DECODER_from_bio(dctx, bio)) { /* pkey is created with the decoded data from the bio */ } else { /* decoding failure */ } OSSL_DECODER_CTX_free(dctx); .Ve

To decode an \s-1EC\s0 key encoded with \s-1DER\s0 from a buffer:

.Vb 8 OSSL_DECODER_CTX *dctx; EVP_PKEY *pkey = NULL; const char *format = "DER"; /* NULL for any format */ const char *structure = NULL; /* any structure */ const char *keytype = "EC"; /* NULL for any key */ const unsigned char *pass = NULL const unsigned char *data = buffer; size_t datalen = sizeof(buffer); \& dctx = OSSL_DECODER_CTX_new_for_pkey(&pkey, format, structure, keytype, OSSL_KEYMGMT_SELECT_KEYPAIR | OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS, NULL, NULL); if (dctx == NULL) { /* error: no suitable potential decoders found */ } if (pass != NULL) OSSL_DECODER_CTX_set_passphrase(dctx, pass, strlen(pass)); if (OSSL_DECODER_from_data(dctx, &data, &datalen)) { /* pkey is created with the decoded data from the buffer */ } else { /* decoding failure */ } OSSL_DECODER_CTX_free(dctx); .Ve

"SEE ALSO"
Header "SEE ALSO" \fBprovider\|(7), \s-1OSSL_DECODER_CTX\s0\|(3)
"HISTORY"
Header "HISTORY" The functions described here were added in OpenSSL 3.0.
"COPYRIGHT"
Header "COPYRIGHT" Copyright 2020-2023 The OpenSSL Project Authors. All Rights Reserved.

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>.