.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) .\" .\" 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" '' . ds C` . ds C' '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 >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'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" 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_ENCODER_TO_BIO 3ossl" .TH OSSL_ENCODER_TO_BIO 3ossl "2023-09-19" "3.0.11" "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_ENCODER_to_data, OSSL_ENCODER_to_bio, OSSL_ENCODER_to_fp \&\- Routines to perform an encoding .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& #include \& \& 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 .PP Feature availability macros: .IP "\fBOSSL_ENCODER_to_fp()\fR is only available when \fB\s-1OPENSSL_NO_STDIO\s0\fR is undefined." 4 .IX Item "OSSL_ENCODER_to_fp() is only available when OPENSSL_NO_STDIO is undefined." .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fBOSSL_ENCODER_to_data()\fR runs the encoding process for the context \fIctx\fR, with the output going to the \fI*pdata\fR and \fI*pdata_len\fR. If \fI*pdata\fR is \s-1NULL\s0 when \fBOSSL_ENCODER_to_data()\fR is called, a buffer will be allocated using \fBOPENSSL_zalloc\fR\|(3), and \fI*pdata\fR will be set to point at the start of that buffer, and \fI*pdata_len\fR will be assigned its length when \&\fBOSSL_ENCODER_to_data()\fR returns. If \fI*pdata\fR is non-NULL when \fBOSSL_ENCODER_to_data()\fR is called, \fI*pdata_len\fR is assumed to have its size. In this case, \fI*pdata\fR will be set to point after the encoded bytes, and \fI*pdata_len\fR will be assigned the number of remaining bytes. .PP \&\fBOSSL_ENCODER_to_bio()\fR runs the encoding process for the context \fIctx\fR, with the output going to the \fB\s-1BIO\s0\fR \fIout\fR. .PP \&\fBOSSL_ENCODER_to_fp()\fR does the same thing as \fBOSSL_ENCODER_to_bio()\fR, except that the output is going to the \fB\s-1FILE\s0\fR \fIfp\fR. .PP For \fBOSSL_ENCODER_to_bio()\fR and \fBOSSL_ENCODER_to_fp()\fR, the application is required to set up the \fB\s-1BIO\s0\fR or \fB\s-1FILE\s0\fR properly, for example to have it in text or binary mode as is appropriate for the encoder output type. .SH "RETURN VALUES" .IX Header "RETURN VALUES" \&\fBOSSL_ENCODER_to_bio()\fR, \fBOSSL_ENCODER_to_fp()\fR and \fBOSSL_ENCODER_to_data()\fR return 1 on success, or 0 on failure. .SH "EXAMPLES" .IX Header "EXAMPLES" To encode a pkey as PKCS#8 with \s-1PEM\s0 format into a bio: .PP .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 .PP To encode a pkey as PKCS#8 with \s-1DER\s0 format encrypted with \&\s-1AES\-256\-CBC\s0 into a buffer: .PP .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 .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBprovider\fR\|(7), \s-1\fBOSSL_ENCODER_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\-2021 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 .