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

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 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_CTX 3ossl" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
OSSL_ENCODER_CTX, OSSL_ENCODER_CTX_new, OSSL_ENCODER_settable_ctx_params, OSSL_ENCODER_CTX_set_params, OSSL_ENCODER_CTX_free, OSSL_ENCODER_CTX_set_selection, OSSL_ENCODER_CTX_set_output_type, OSSL_ENCODER_CTX_set_output_structure, OSSL_ENCODER_CTX_add_encoder, OSSL_ENCODER_CTX_add_extra, OSSL_ENCODER_CTX_get_num_encoders, OSSL_ENCODER_INSTANCE, OSSL_ENCODER_INSTANCE_get_encoder, OSSL_ENCODER_INSTANCE_get_encoder_ctx, OSSL_ENCODER_INSTANCE_get_output_type, OSSL_ENCODER_INSTANCE_get_output_structure, OSSL_ENCODER_CONSTRUCT, OSSL_ENCODER_CLEANUP, OSSL_ENCODER_CTX_set_construct, OSSL_ENCODER_CTX_set_construct_data, OSSL_ENCODER_CTX_set_cleanup \- Encoder context routines Header "SYNOPSIS" .Vb 1 #include <openssl/encoder.h> \& typedef struct ossl_encoder_ctx_st OSSL_ENCODER_CTX; \& OSSL_ENCODER_CTX *OSSL_ENCODER_CTX_new(); const OSSL_PARAM *OSSL_ENCODER_settable_ctx_params(OSSL_ENCODER *encoder); int OSSL_ENCODER_CTX_set_params(OSSL_ENCODER_CTX *ctx, const OSSL_PARAM params[]); void OSSL_ENCODER_CTX_free(OSSL_ENCODER_CTX *ctx); \& int OSSL_ENCODER_CTX_set_selection(OSSL_ENCODER_CTX *ctx, int selection); int OSSL_ENCODER_CTX_set_output_type(OSSL_ENCODER_CTX *ctx, const char *output_type); int OSSL_ENCODER_CTX_set_output_structure(OSSL_ENCODER_CTX *ctx, const char *output_structure); \& int OSSL_ENCODER_CTX_add_encoder(OSSL_ENCODER_CTX *ctx, OSSL_ENCODER *encoder); int OSSL_ENCODER_CTX_add_extra(OSSL_ENCODER_CTX *ctx, OSSL_LIB_CTX *libctx, const char *propq); int OSSL_ENCODER_CTX_get_num_encoders(OSSL_ENCODER_CTX *ctx); \& typedef struct ossl_encoder_instance_st OSSL_ENCODER_INSTANCE; OSSL_ENCODER * OSSL_ENCODER_INSTANCE_get_encoder(OSSL_ENCODER_INSTANCE *encoder_inst); void * OSSL_ENCODER_INSTANCE_get_encoder_ctx(OSSL_ENCODER_INSTANCE *encoder_inst); const char * OSSL_ENCODER_INSTANCE_get_output_type(OSSL_ENCODER_INSTANCE *encoder_inst); const char * OSSL_ENCODER_INSTANCE_get_output_structure(OSSL_ENCODER_INSTANCE *encoder_inst); \& typedef const void *OSSL_ENCODER_CONSTRUCT(OSSL_ENCODER_INSTANCE *encoder_inst, void *construct_data); typedef void OSSL_ENCODER_CLEANUP(void *construct_data); \& int OSSL_ENCODER_CTX_set_construct(OSSL_ENCODER_CTX *ctx, OSSL_ENCODER_CONSTRUCT *construct); int OSSL_ENCODER_CTX_set_construct_data(OSSL_ENCODER_CTX *ctx, void *construct_data); int OSSL_ENCODER_CTX_set_cleanup(OSSL_ENCODER_CTX *ctx, OSSL_ENCODER_CLEANUP *cleanup); .Ve Header "DESCRIPTION" Encoding an input object to the desired encoding may be done with a chain of encoder implementations, which means that the output from one encoder may be the input for the next in the chain. The \s-1OSSL_ENCODER_CTX\s0 holds all the data about these encoders. This allows having generic format encoders such as \s-1DER\s0 to \s-1PEM,\s0 as well as more specialized encoders like \s-1RSA\s0 to \s-1DER.\s0

The final output type must be given, and a chain of encoders must end with an implementation that produces that output type.

At the beginning of the encoding process, a constructor provided by the caller is called to ensure that there is an appropriate provider-side object to start with. The constructor is set with OSSL_ENCODER_CTX_set_construct().

\fB\s-1OSSL_ENCODER_INSTANCE\s0 is an opaque structure that contains data about the encoder that is going to be used, and that may be useful for the constructor. There are some functions to extract data from this type, described in \*(L"Constructor\*(R" below.

Subsection "Functions" \fBOSSL_ENCODER_CTX_new() creates a \s-1OSSL_ENCODER_CTX\s0.

\fBOSSL_ENCODER_settable_ctx_params() returns an \s-1OSSL_PARAM\s0\|(3) array of parameter descriptors.

\fBOSSL_ENCODER_CTX_set_params() attempts to set parameters specified with an \s-1OSSL_PARAM\s0\|(3) array params. Parameters that the implementation doesn't recognise should be ignored.

\fBOSSL_ENCODER_CTX_free() frees the given context ctx.

\fBOSSL_ENCODER_CTX_add_encoder() populates the \s-1OSSL_ENCODER_CTX\s0 \fIctx with a encoder, to be used to encode an input object.

\fBOSSL_ENCODER_CTX_add_extra() finds encoders that further encodes output from already added encoders, and adds them as well. This is used to build encoder chains.

\fBOSSL_ENCODER_CTX_set_output_type() sets the ending output type. This must be specified, and determines if a complete encoder chain is available.

\fBOSSL_ENCODER_CTX_set_output_structure() sets the desired output structure. This may be used to determines what encoder implementations may be used. Depending on the type of object being encoded, the output structure may not be relevant.

\fBOSSL_ENCODER_CTX_get_num_encoders() gets the number of encoders currently added to the context ctx.

\fBOSSL_ENCODER_CTX_set_construct() sets the constructor construct.

\fBOSSL_ENCODER_CTX_set_construct_data() sets the constructor data that is passed to the constructor every time it's called.

\fBOSSL_ENCODER_CTX_set_cleanup() sets the constructor data cleanup function. This is called by OSSL_ENCODER_CTX_free\|(3).

Subsection "Constructor" A \s-1OSSL_ENCODER_CONSTRUCT\s0 gets the following arguments: Item "encoder_inst" The \s-1OSSL_ENCODER_INSTANCE\s0 for the encoder from which the constructor gets its data. Item "construct_data" The pointer that was set with OSSL_ENCODE_CTX_set_construct_data().

The constructor is expected to return a valid (non-NULL) pointer to a provider-native object that can be used as first input of an encoding chain, or \s-1NULL\s0 to indicate that an error has occurred.

These utility functions may be used by a constructor:

\fBOSSL_ENCODER_INSTANCE_get_encoder() can be used to get the encoder implementation of the encoder instance encoder_inst.

\fBOSSL_ENCODER_INSTANCE_get_encoder_ctx() can be used to get the encoder implementation's provider context of the encoder instance encoder_inst.

\fBOSSL_ENCODER_INSTANCE_get_output_type() can be used to get the output type for the encoder implementation of the encoder instance encoder_inst. This will never be \s-1NULL.\s0

\fBOSSL_ENCODER_INSTANCE_get_output_structure() can be used to get the output structure for the encoder implementation of the encoder instance \fIencoder_inst. This may be \s-1NULL.\s0

Header "RETURN VALUES" \fBOSSL_ENCODER_CTX_new() returns a pointer to a \s-1OSSL_ENCODER_CTX\s0, or \s-1NULL\s0 if the context structure couldn't be allocated.

\fBOSSL_ENCODER_settable_ctx_params() returns an \s-1OSSL_PARAM\s0\|(3) array, or \s-1NULL\s0 if none is available.

\fBOSSL_ENCODER_CTX_set_params() returns 1 if all recognised parameters were valid, or 0 if one of them was invalid or caused some other failure in the implementation.

\fBOSSL_ENCODER_CTX_add_encoder(), OSSL_ENCODER_CTX_add_extra(), \fBOSSL_ENCODER_CTX_set_construct(), OSSL_ENCODER_CTX_set_construct_data() and \fBOSSL_ENCODER_CTX_set_cleanup() return 1 on success, or 0 on failure.

\fBOSSL_ENCODER_CTX_get_num_encoders() returns the current number of encoders. It returns 0 if ctx is \s-1NULL.\s0

\fBOSSL_ENCODER_INSTANCE_get_encoder() returns an \s-1OSSL_ENCODER\s0 pointer on success, or \s-1NULL\s0 on failure.

\fBOSSL_ENCODER_INSTANCE_get_encoder_ctx() returns a provider context pointer on success, or \s-1NULL\s0 on failure.

\fBOSSL_ENCODER_INSTANCE_get_output_type() returns a string with the name of the input type, if relevant. \s-1NULL\s0 is a valid returned value.

\fBOSSL_ENCODER_INSTANCE_get_output_type() returns a string with the name of the output type.

\fBOSSL_ENCODER_INSTANCE_get_output_structure() returns a string with the name of the output structure.

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