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_ENCODER_TO_BIO 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
OSSL_ENCODER_to_data, OSSL_ENCODER_to_bio, OSSL_ENCODER_to_fp \- Routines to perform an encoding Header "SYNOPSIS" .Vb 1 #include <openssl/encoder.h> \& int OSSL_ENCODER_to_data(OSSL_ENCODER_CTX *ctx, unsigned char **pdata, size_t *pdata_len); int OSSL_ENCODER_to_bio(OSSL_ENCODER_CTX *ctx, BIO *out); int OSSL_ENCODER_to_fp(OSSL_ENCODER_CTX *ctx, FILE *fp); .Ve

Feature availability macros:

Item "OSSL_ENCODER_to_fp() is only available when OPENSSL_NO_STDIO is undefined." Header "DESCRIPTION" \fBOSSL_ENCODER_to_data() runs the encoding process for the context ctx, with the output going to the *pdata and *pdata_len. If *pdata is \s-1NULL\s0 when OSSL_ENCODER_to_data() is called, a buffer will be allocated using OPENSSL_zalloc\|(3), and *pdata will be set to point at the start of that buffer, and *pdata_len will be assigned its length when \fBOSSL_ENCODER_to_data() returns. If *pdata is non-NULL when OSSL_ENCODER_to_data() is called, *pdata_len is assumed to have its size. In this case, *pdata will be set to point after the encoded bytes, and *pdata_len will be assigned the number of remaining bytes.

\fBOSSL_ENCODER_to_bio() runs the encoding process for the context ctx, with the output going to the \s-1BIO\s0 out.

\fBOSSL_ENCODER_to_fp() does the same thing as OSSL_ENCODER_to_bio(), except that the output is going to the \s-1FILE\s0 fp.

For OSSL_ENCODER_to_bio() and OSSL_ENCODER_to_fp(), the application is required to set up the \s-1BIO\s0 or \s-1FILE\s0 properly, for example to have it in text or binary mode as is appropriate for the encoder output type.

Header "RETURN VALUES" \fBOSSL_ENCODER_to_bio(), OSSL_ENCODER_to_fp() and OSSL_ENCODER_to_data() return 1 on success, or 0 on failure. Header "EXAMPLES" To encode a pkey as PKCS#8 with \s-1PEM\s0 format into a bio:

.Vb 4 OSSL_ENCODER_CTX *ectx; const char *format = "PEM"; const char *structure = "PrivateKeyInfo"; /* PKCS#8 structure */ const unsigned char *pass = "my password"; \& ectx = OSSL_ENCODER_CTX_new_for_pkey(pkey, OSSL_KEYMGMT_SELECT_KEYPAIR | OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS, format, structure, NULL); if (ectx == NULL) { /* error: no suitable potential encoders found */ } if (pass != NULL) OSSL_ENCODER_CTX_set_passphrase(ectx, pass, strlen(pass)); if (OSSL_ENCODER_to_bio(ectx, bio)) { /* pkey was successfully encoded into the bio */ } else { /* encoding failure */ } OSSL_ENCODER_CTX_free(ectx); .Ve

To encode a pkey as PKCS#8 with \s-1DER\s0 format encrypted with \s-1AES-256-CBC\s0 into a buffer:

.Vb 6 OSSL_ENCODER_CTX *ectx; const char *format = "DER"; const char *structure = "PrivateKeyInfo"; /* PKCS#8 structure */ const unsigned char *pass = "my password"; unsigned char *data = NULL; size_t datalen; \& ectx = OSSL_ENCODER_CTX_new_for_pkey(pkey, OSSL_KEYMGMT_SELECT_KEYPAIR | OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS, format, structure, NULL); if (ectx == NULL) { /* error: no suitable potential encoders found */ } if (pass != NULL) { OSSL_ENCODER_CTX_set_passphrase(ectx, pass, strlen(pass)); OSSL_ENCODER_CTX_set_cipher(ctx, "AES-256-CBC", NULL); } if (OSSL_ENCODER_to_data(ectx, &data, &datalen)) { /* * pkey was successfully encoded into a newly allocated * data buffer */ } else { /* encoding failure */ } OSSL_ENCODER_CTX_free(ectx); .Ve

Header "SEE ALSO" \fBprovider\|(7), \s-1OSSL_ENCODER_CTX\s0\|(3) Header "HISTORY" The functions described here were added in OpenSSL 3.0. Header "COPYRIGHT" Copyright 2019-2021 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>.