345 lines
13 KiB
Plaintext
345 lines
13 KiB
Plaintext
.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
|
|
.\"
|
|
.\" 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 turned on, 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
|
|
.\"
|
|
.\" 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
|
|
.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_CTX 3ossl"
|
|
.TH OSSL_ENCODER_CTX 3ossl "2024-01-30" "3.2.1" "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_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
|
|
.SH "SYNOPSIS"
|
|
.IX 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
|
|
.SH "DESCRIPTION"
|
|
.IX 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 \fB\s-1OSSL_ENCODER_CTX\s0\fR 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
|
|
.PP
|
|
The final output type must be given, and a chain of encoders must end with
|
|
an implementation that produces that output type.
|
|
.PP
|
|
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 \fIOSSL_ENCODER_CTX_set_construct()\fR.
|
|
.PP
|
|
\&\fB\s-1OSSL_ENCODER_INSTANCE\s0\fR 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.
|
|
.SS "Functions"
|
|
.IX Subsection "Functions"
|
|
\&\fIOSSL_ENCODER_CTX_new()\fR creates a \fB\s-1OSSL_ENCODER_CTX\s0\fR.
|
|
.PP
|
|
\&\fIOSSL_ENCODER_settable_ctx_params()\fR returns an \s-1\fIOSSL_PARAM\s0\fR\|(3)
|
|
array of parameter descriptors.
|
|
.PP
|
|
\&\fIOSSL_ENCODER_CTX_set_params()\fR attempts to set parameters specified
|
|
with an \s-1\fIOSSL_PARAM\s0\fR\|(3) array \fIparams\fR. Parameters that the
|
|
implementation doesn't recognise should be ignored.
|
|
.PP
|
|
\&\fIOSSL_ENCODER_CTX_free()\fR frees the given context \fIctx\fR.
|
|
.PP
|
|
\&\fIOSSL_ENCODER_CTX_add_encoder()\fR populates the \fB\s-1OSSL_ENCODER_CTX\s0\fR
|
|
\&\fIctx\fR with a encoder, to be used to encode an input object.
|
|
.PP
|
|
\&\fIOSSL_ENCODER_CTX_add_extra()\fR finds encoders that further encodes output
|
|
from already added encoders, and adds them as well. This is used to build
|
|
encoder chains.
|
|
.PP
|
|
\&\fIOSSL_ENCODER_CTX_set_output_type()\fR sets the ending output type. This must
|
|
be specified, and determines if a complete encoder chain is available.
|
|
.PP
|
|
\&\fIOSSL_ENCODER_CTX_set_output_structure()\fR 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.
|
|
.PP
|
|
\&\fIOSSL_ENCODER_CTX_get_num_encoders()\fR gets the number of encoders currently
|
|
added to the context \fIctx\fR.
|
|
.PP
|
|
\&\fIOSSL_ENCODER_CTX_set_construct()\fR sets the constructor \fIconstruct\fR.
|
|
.PP
|
|
\&\fIOSSL_ENCODER_CTX_set_construct_data()\fR sets the constructor data that is
|
|
passed to the constructor every time it's called.
|
|
.PP
|
|
\&\fIOSSL_ENCODER_CTX_set_cleanup()\fR sets the constructor data \fIcleanup\fR
|
|
function. This is called by \fIOSSL_ENCODER_CTX_free\fR\|(3).
|
|
.SS "Constructor"
|
|
.IX Subsection "Constructor"
|
|
A \fB\s-1OSSL_ENCODER_CONSTRUCT\s0\fR gets the following arguments:
|
|
.IP "\fIencoder_inst\fR" 4
|
|
.IX Item "encoder_inst"
|
|
The \fB\s-1OSSL_ENCODER_INSTANCE\s0\fR for the encoder from which the constructor gets
|
|
its data.
|
|
.IP "\fIconstruct_data\fR" 4
|
|
.IX Item "construct_data"
|
|
The pointer that was set with \fIOSSL_ENCODE_CTX_set_construct_data()\fR.
|
|
.PP
|
|
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.
|
|
.PP
|
|
These utility functions may be used by a constructor:
|
|
.PP
|
|
\&\fIOSSL_ENCODER_INSTANCE_get_encoder()\fR can be used to get the encoder
|
|
implementation of the encoder instance \fIencoder_inst\fR.
|
|
.PP
|
|
\&\fIOSSL_ENCODER_INSTANCE_get_encoder_ctx()\fR can be used to get the encoder
|
|
implementation's provider context of the encoder instance \fIencoder_inst\fR.
|
|
.PP
|
|
\&\fIOSSL_ENCODER_INSTANCE_get_output_type()\fR can be used to get the output type
|
|
for the encoder implementation of the encoder instance \fIencoder_inst\fR.
|
|
This will never be \s-1NULL.\s0
|
|
.PP
|
|
\&\fIOSSL_ENCODER_INSTANCE_get_output_structure()\fR can be used to get the output
|
|
structure for the encoder implementation of the encoder instance
|
|
\&\fIencoder_inst\fR.
|
|
This may be \s-1NULL.\s0
|
|
.SH "RETURN VALUES"
|
|
.IX Header "RETURN VALUES"
|
|
\&\fIOSSL_ENCODER_CTX_new()\fR returns a pointer to a \fB\s-1OSSL_ENCODER_CTX\s0\fR, or \s-1NULL\s0
|
|
if the context structure couldn't be allocated.
|
|
.PP
|
|
\&\fIOSSL_ENCODER_settable_ctx_params()\fR returns an \s-1\fIOSSL_PARAM\s0\fR\|(3) array, or
|
|
\&\s-1NULL\s0 if none is available.
|
|
.PP
|
|
\&\fIOSSL_ENCODER_CTX_set_params()\fR returns 1 if all recognised parameters were
|
|
valid, or 0 if one of them was invalid or caused some other failure in the
|
|
implementation.
|
|
.PP
|
|
\&\fIOSSL_ENCODER_CTX_add_encoder()\fR, \fIOSSL_ENCODER_CTX_add_extra()\fR,
|
|
\&\fIOSSL_ENCODER_CTX_set_construct()\fR, \fIOSSL_ENCODER_CTX_set_construct_data()\fR and
|
|
\&\fIOSSL_ENCODER_CTX_set_cleanup()\fR return 1 on success, or 0 on failure.
|
|
.PP
|
|
\&\fIOSSL_ENCODER_CTX_get_num_encoders()\fR returns the current number of encoders.
|
|
It returns 0 if \fIctx\fR is \s-1NULL.\s0
|
|
.PP
|
|
\&\fIOSSL_ENCODER_INSTANCE_get_encoder()\fR returns an \fB\s-1OSSL_ENCODER\s0\fR pointer on
|
|
success, or \s-1NULL\s0 on failure.
|
|
.PP
|
|
\&\fIOSSL_ENCODER_INSTANCE_get_encoder_ctx()\fR returns a provider context pointer on
|
|
success, or \s-1NULL\s0 on failure.
|
|
.PP
|
|
\&\fIOSSL_ENCODER_INSTANCE_get_output_type()\fR returns a string with the name of the
|
|
input type, if relevant. \s-1NULL\s0 is a valid returned value.
|
|
.PP
|
|
\&\fIOSSL_ENCODER_INSTANCE_get_output_type()\fR returns a string with the name of the
|
|
output type.
|
|
.PP
|
|
\&\fIOSSL_ENCODER_INSTANCE_get_output_structure()\fR returns a string with the name
|
|
of the output structure.
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fIprovider\fR\|(7), \s-1\fIOSSL_ENCODER\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\-2022 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
|
|
<https://www.openssl.org/source/license.html>.
|