346 lines
15 KiB
Groff
Executable File
346 lines
15 KiB
Groff
Executable File
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
|
|
.\"
|
|
.\" 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" ''
|
|
'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.
|
|
.ie \nF \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. nr % 0
|
|
. rr F
|
|
.\}
|
|
.el \{\
|
|
. de IX
|
|
..
|
|
.\}
|
|
.\"
|
|
.\" 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 "EVP_CIPHER_METH_NEW 3"
|
|
.TH EVP_CIPHER_METH_NEW 3 "2020-03-02" "3.0.0-dev" "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"
|
|
EVP_CIPHER_meth_new, EVP_CIPHER_meth_dup, EVP_CIPHER_meth_free,
|
|
EVP_CIPHER_meth_set_iv_length, EVP_CIPHER_meth_set_flags,
|
|
EVP_CIPHER_meth_set_impl_ctx_size, EVP_CIPHER_meth_set_init,
|
|
EVP_CIPHER_meth_set_do_cipher, EVP_CIPHER_meth_set_cleanup,
|
|
EVP_CIPHER_meth_set_set_asn1_params, EVP_CIPHER_meth_set_get_asn1_params,
|
|
EVP_CIPHER_meth_set_ctrl, EVP_CIPHER_meth_get_init,
|
|
EVP_CIPHER_meth_get_do_cipher, EVP_CIPHER_meth_get_cleanup,
|
|
EVP_CIPHER_meth_get_set_asn1_params, EVP_CIPHER_meth_get_get_asn1_params,
|
|
EVP_CIPHER_meth_get_ctrl
|
|
\&\- Routines to build up EVP_CIPHER methods
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.Vb 1
|
|
\& #include <openssl/evp.h>
|
|
\&
|
|
\& EVP_CIPHER *EVP_CIPHER_meth_new(int cipher_type, int block_size, int key_len);
|
|
\& EVP_CIPHER *EVP_CIPHER_meth_dup(const EVP_CIPHER *cipher);
|
|
\& void EVP_CIPHER_meth_free(EVP_CIPHER *cipher);
|
|
\&
|
|
\& int EVP_CIPHER_meth_set_iv_length(EVP_CIPHER *cipher, int iv_len);
|
|
\& int EVP_CIPHER_meth_set_flags(EVP_CIPHER *cipher, unsigned long flags);
|
|
\& int EVP_CIPHER_meth_set_impl_ctx_size(EVP_CIPHER *cipher, int ctx_size);
|
|
\& int EVP_CIPHER_meth_set_init(EVP_CIPHER *cipher,
|
|
\& int (*init)(EVP_CIPHER_CTX *ctx,
|
|
\& const unsigned char *key,
|
|
\& const unsigned char *iv,
|
|
\& int enc));
|
|
\& int EVP_CIPHER_meth_set_do_cipher(EVP_CIPHER *cipher,
|
|
\& int (*do_cipher)(EVP_CIPHER_CTX *ctx,
|
|
\& unsigned char *out,
|
|
\& const unsigned char *in,
|
|
\& size_t inl));
|
|
\& int EVP_CIPHER_meth_set_cleanup(EVP_CIPHER *cipher,
|
|
\& int (*cleanup)(EVP_CIPHER_CTX *));
|
|
\& int EVP_CIPHER_meth_set_set_asn1_params(EVP_CIPHER *cipher,
|
|
\& int (*set_asn1_parameters)(EVP_CIPHER_CTX *,
|
|
\& ASN1_TYPE *));
|
|
\& int EVP_CIPHER_meth_set_get_asn1_params(EVP_CIPHER *cipher,
|
|
\& int (*get_asn1_parameters)(EVP_CIPHER_CTX *,
|
|
\& ASN1_TYPE *));
|
|
\& int EVP_CIPHER_meth_set_ctrl(EVP_CIPHER *cipher,
|
|
\& int (*ctrl)(EVP_CIPHER_CTX *, int type,
|
|
\& int arg, void *ptr));
|
|
\&
|
|
\& int (*EVP_CIPHER_meth_get_init(const EVP_CIPHER *cipher))(EVP_CIPHER_CTX *ctx,
|
|
\& const unsigned char *key,
|
|
\& const unsigned char *iv,
|
|
\& int enc);
|
|
\& int (*EVP_CIPHER_meth_get_do_cipher(const EVP_CIPHER *cipher))(EVP_CIPHER_CTX *ctx,
|
|
\& unsigned char *out,
|
|
\& const unsigned char *in,
|
|
\& size_t inl);
|
|
\& int (*EVP_CIPHER_meth_get_cleanup(const EVP_CIPHER *cipher))(EVP_CIPHER_CTX *);
|
|
\& int (*EVP_CIPHER_meth_get_set_asn1_params(const EVP_CIPHER *cipher))(EVP_CIPHER_CTX *,
|
|
\& ASN1_TYPE *);
|
|
\& int (*EVP_CIPHER_meth_get_get_asn1_params(const EVP_CIPHER *cipher))(EVP_CIPHER_CTX *,
|
|
\& ASN1_TYPE *);
|
|
\& int (*EVP_CIPHER_meth_get_ctrl(const EVP_CIPHER *cipher))(EVP_CIPHER_CTX *,
|
|
\& int type, int arg,
|
|
\& void *ptr);
|
|
.Ve
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
The \fB\s-1EVP_CIPHER\s0\fR type is a structure for symmetric cipher method
|
|
implementation.
|
|
.PP
|
|
\&\fIEVP_CIPHER_meth_new()\fR creates a new \fB\s-1EVP_CIPHER\s0\fR structure.
|
|
.PP
|
|
\&\fIEVP_CIPHER_meth_dup()\fR creates a copy of \fBcipher\fR.
|
|
.PP
|
|
\&\fIEVP_CIPHER_meth_free()\fR destroys a \fB\s-1EVP_CIPHER\s0\fR structure.
|
|
.PP
|
|
\&\fIEVP_CIPHER_meth_set_iv_length()\fR sets the length of the \s-1IV\s0.
|
|
This is only needed when the implemented cipher mode requires it.
|
|
.PP
|
|
\&\fIEVP_CIPHER_meth_set_flags()\fR sets the flags to describe optional
|
|
behaviours in the particular \fBcipher\fR.
|
|
With the exception of cipher modes, of which only one may be present,
|
|
several flags can be or'd together.
|
|
The available flags are:
|
|
.IP "\s-1EVP_CIPH_STREAM_CIPHER\s0, \s-1EVP_CIPH_ECB_MODE\s0 \s-1EVP_CIPH_CBC_MODE\s0, \s-1EVP_CIPH_CFB_MODE\s0, \s-1EVP_CIPH_OFB_MODE\s0, \s-1EVP_CIPH_CTR_MODE\s0, \s-1EVP_CIPH_GCM_MODE\s0, \s-1EVP_CIPH_CCM_MODE\s0, \s-1EVP_CIPH_XTS_MODE\s0, \s-1EVP_CIPH_WRAP_MODE\s0, \s-1EVP_CIPH_OCB_MODE\s0, \s-1EVP_CIPH_SIV_MODE\s0" 4
|
|
.IX Item "EVP_CIPH_STREAM_CIPHER, EVP_CIPH_ECB_MODE EVP_CIPH_CBC_MODE, EVP_CIPH_CFB_MODE, EVP_CIPH_OFB_MODE, EVP_CIPH_CTR_MODE, EVP_CIPH_GCM_MODE, EVP_CIPH_CCM_MODE, EVP_CIPH_XTS_MODE, EVP_CIPH_WRAP_MODE, EVP_CIPH_OCB_MODE, EVP_CIPH_SIV_MODE"
|
|
The cipher mode.
|
|
.IP "\s-1EVP_CIPH_VARIABLE_LENGTH\s0" 4
|
|
.IX Item "EVP_CIPH_VARIABLE_LENGTH"
|
|
This cipher is of variable length.
|
|
.IP "\s-1EVP_CIPH_CUSTOM_IV\s0" 4
|
|
.IX Item "EVP_CIPH_CUSTOM_IV"
|
|
Storing and initialising the \s-1IV\s0 is left entirely to the
|
|
implementation.
|
|
.IP "\s-1EVP_CIPH_ALWAYS_CALL_INIT\s0" 4
|
|
.IX Item "EVP_CIPH_ALWAYS_CALL_INIT"
|
|
Set this if the implementation's \fIinit()\fR function should be called even
|
|
if \fBkey\fR is \fB\s-1NULL\s0\fR.
|
|
.IP "\s-1EVP_CIPH_CTRL_INIT\s0" 4
|
|
.IX Item "EVP_CIPH_CTRL_INIT"
|
|
Set this to have the implementation's \fIctrl()\fR function called with
|
|
command code \fB\s-1EVP_CTRL_INIT\s0\fR early in its setup.
|
|
.IP "\s-1EVP_CIPH_CUSTOM_KEY_LENGTH\s0" 4
|
|
.IX Item "EVP_CIPH_CUSTOM_KEY_LENGTH"
|
|
Checking and setting the key length after creating the \fB\s-1EVP_CIPHER\s0\fR
|
|
is left to the implementation.
|
|
Whenever someone uses \fIEVP_CIPHER_CTX_set_key_length()\fR on a
|
|
\&\fB\s-1EVP_CIPHER\s0\fR with this flag set, the implementation's \fIctrl()\fR function
|
|
will be called with the control code \fB\s-1EVP_CTRL_SET_KEY_LENGTH\s0\fR and
|
|
the key length in \fBarg\fR.
|
|
.IP "\s-1EVP_CIPH_NO_PADDING\s0" 4
|
|
.IX Item "EVP_CIPH_NO_PADDING"
|
|
Don't use standard block padding.
|
|
.IP "\s-1EVP_CIPH_RAND_KEY\s0" 4
|
|
.IX Item "EVP_CIPH_RAND_KEY"
|
|
Making a key with random content is left to the implementation.
|
|
This is done by calling the implementation's \fIctrl()\fR function with the
|
|
control code \fB\s-1EVP_CTRL_RAND_KEY\s0\fR and the pointer to the key memory
|
|
storage in \fBptr\fR.
|
|
.IP "\s-1EVP_CIPH_CUSTOM_COPY\s0" 4
|
|
.IX Item "EVP_CIPH_CUSTOM_COPY"
|
|
Set this to have the implementation's \fIctrl()\fR function called with
|
|
command code \fB\s-1EVP_CTRL_COPY\s0\fR at the end of \fIEVP_CIPHER_CTX_copy()\fR.
|
|
The intended use is for further things to deal with after the
|
|
implementation specific data block has been copied.
|
|
The destination \fB\s-1EVP_CIPHER_CTX\s0\fR is passed to the control with the
|
|
\&\fBptr\fR parameter.
|
|
The implementation specific data block is reached with
|
|
\&\fIEVP_CIPHER_CTX_get_cipher_data()\fR.
|
|
.IP "\s-1EVP_CIPH_FLAG_DEFAULT_ASN1\s0" 4
|
|
.IX Item "EVP_CIPH_FLAG_DEFAULT_ASN1"
|
|
Use the default \s-1EVP\s0 routines to pass \s-1IV\s0 to and from \s-1ASN\s0.1.
|
|
.IP "\s-1EVP_CIPH_FLAG_LENGTH_BITS\s0" 4
|
|
.IX Item "EVP_CIPH_FLAG_LENGTH_BITS"
|
|
Signals that the length of the input buffer for encryption /
|
|
decryption is to be understood as the number of bits instead of
|
|
bytes for this implementation.
|
|
This is only useful for \s-1CFB1\s0 ciphers.
|
|
.IP "\s-1EVP_CIPH_FLAG_CUSTOM_CIPHER\s0" 4
|
|
.IX Item "EVP_CIPH_FLAG_CUSTOM_CIPHER"
|
|
This indicates that the implementation takes care of everything,
|
|
including padding, buffering and finalization.
|
|
The \s-1EVP\s0 routines will simply give them control and do nothing more.
|
|
.IP "\s-1EVP_CIPH_FLAG_AEAD_CIPHER\s0" 4
|
|
.IX Item "EVP_CIPH_FLAG_AEAD_CIPHER"
|
|
This indicates that this is an \s-1AEAD\s0 cipher implementation.
|
|
.IP "\s-1EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK\s0" 4
|
|
.IX Item "EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK"
|
|
Allow interleaving of crypto blocks, a particular optimization only applicable
|
|
to certain \s-1TLS\s0 ciphers.
|
|
.PP
|
|
\&\fIEVP_CIPHER_meth_set_impl_ctx_size()\fR sets the size of the \s-1EVP_CIPHER\s0's
|
|
implementation context so that it can be automatically allocated.
|
|
.PP
|
|
\&\fIEVP_CIPHER_meth_set_init()\fR sets the cipher init function for
|
|
\&\fBcipher\fR.
|
|
The cipher init function is called by \fIEVP_CipherInit()\fR,
|
|
\&\fIEVP_CipherInit_ex()\fR, \fIEVP_EncryptInit()\fR, \fIEVP_EncryptInit_ex()\fR,
|
|
\&\fIEVP_DecryptInit()\fR, \fIEVP_DecryptInit_ex()\fR.
|
|
.PP
|
|
\&\fIEVP_CIPHER_meth_set_do_cipher()\fR sets the cipher function for
|
|
\&\fBcipher\fR.
|
|
The cipher function is called by \fIEVP_CipherUpdate()\fR,
|
|
\&\fIEVP_EncryptUpdate()\fR, \fIEVP_DecryptUpdate()\fR, \fIEVP_CipherFinal()\fR,
|
|
\&\fIEVP_EncryptFinal()\fR, \fIEVP_EncryptFinal_ex()\fR, \fIEVP_DecryptFinal()\fR and
|
|
\&\fIEVP_DecryptFinal_ex()\fR.
|
|
.PP
|
|
\&\fIEVP_CIPHER_meth_set_cleanup()\fR sets the function for \fBcipher\fR to do
|
|
extra cleanup before the method's private data structure is cleaned
|
|
out and freed.
|
|
Note that the cleanup function is passed a \fB\s-1EVP_CIPHER_CTX\s0 *\fR, the
|
|
private data structure is then available with
|
|
\&\fIEVP_CIPHER_CTX_get_cipher_data()\fR.
|
|
This cleanup function is called by \fIEVP_CIPHER_CTX_reset()\fR and
|
|
\&\fIEVP_CIPHER_CTX_free()\fR.
|
|
.PP
|
|
\&\fIEVP_CIPHER_meth_set_set_asn1_params()\fR sets the function for \fBcipher\fR
|
|
to set the AlgorithmIdentifier \*(L"parameter\*(R" based on the passed cipher.
|
|
This function is called by \fIEVP_CIPHER_param_to_asn1()\fR.
|
|
\&\fIEVP_CIPHER_meth_set_get_asn1_params()\fR sets the function for \fBcipher\fR
|
|
that sets the cipher parameters based on an \s-1ASN\s0.1 AlgorithmIdentifier
|
|
\&\*(L"parameter\*(R".
|
|
Both these functions are needed when there is a need for custom data
|
|
(more or other than the cipher \s-1IV\s0).
|
|
They are called by \fIEVP_CIPHER_param_to_asn1()\fR and
|
|
\&\fIEVP_CIPHER_asn1_to_param()\fR respectively if defined.
|
|
.PP
|
|
\&\fIEVP_CIPHER_meth_set_ctrl()\fR sets the control function for \fBcipher\fR.
|
|
.PP
|
|
\&\fIEVP_CIPHER_meth_get_init()\fR, \fIEVP_CIPHER_meth_get_do_cipher()\fR,
|
|
\&\fIEVP_CIPHER_meth_get_cleanup()\fR, \fIEVP_CIPHER_meth_get_set_asn1_params()\fR,
|
|
\&\fIEVP_CIPHER_meth_get_get_asn1_params()\fR and \fIEVP_CIPHER_meth_get_ctrl()\fR
|
|
are all used to retrieve the method data given with the
|
|
EVP_CIPHER_meth_set_*() functions above.
|
|
.SH "RETURN VALUES"
|
|
.IX Header "RETURN VALUES"
|
|
\&\fIEVP_CIPHER_meth_new()\fR and \fIEVP_CIPHER_meth_dup()\fR return a pointer to a
|
|
newly created \fB\s-1EVP_CIPHER\s0\fR, or \s-1NULL\s0 on failure.
|
|
All EVP_CIPHER_meth_set_*() functions return 1.
|
|
All EVP_CIPHER_meth_get_*() functions return pointers to their
|
|
respective \fBcipher\fR function.
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fIEVP_EncryptInit\fR\|(3)
|
|
.SH "HISTORY"
|
|
.IX Header "HISTORY"
|
|
The functions described here were added in OpenSSL 1.1.0.
|
|
The \fB\s-1EVP_CIPHER\s0\fR structure created with these functions became reference
|
|
counted in OpenSSL 3.0.
|
|
.SH "COPYRIGHT"
|
|
.IX Header "COPYRIGHT"
|
|
Copyright 2016\-2018 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>.
|