diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man3/EVP_EncryptInit.3')
| -rw-r--r-- | secure/lib/libcrypto/man/man3/EVP_EncryptInit.3 | 1410 |
1 files changed, 753 insertions, 657 deletions
diff --git a/secure/lib/libcrypto/man/man3/EVP_EncryptInit.3 b/secure/lib/libcrypto/man/man3/EVP_EncryptInit.3 index 773d049ab9b0..d5c2ae603553 100644 --- a/secure/lib/libcrypto/man/man3/EVP_EncryptInit.3 +++ b/secure/lib/libcrypto/man/man3/EVP_EncryptInit.3 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .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' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .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\} @@ -68,81 +52,23 @@ . \} .\} .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 "EVP_ENCRYPTINIT 3ossl" -.TH EVP_ENCRYPTINIT 3ossl "2023-09-19" "3.0.11" "OpenSSL" +.TH EVP_ENCRYPTINIT 3ossl 2025-07-01 3.5.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" +.SH NAME EVP_CIPHER_fetch, EVP_CIPHER_up_ref, EVP_CIPHER_free, EVP_CIPHER_CTX_new, EVP_CIPHER_CTX_reset, EVP_CIPHER_CTX_free, +EVP_CIPHER_CTX_dup, +EVP_CIPHER_CTX_copy, EVP_EncryptInit_ex, EVP_EncryptInit_ex2, EVP_EncryptUpdate, @@ -153,6 +79,7 @@ EVP_DecryptUpdate, EVP_DecryptFinal_ex, EVP_CipherInit_ex, EVP_CipherInit_ex2, +EVP_CipherInit_SKEY, EVP_CipherUpdate, EVP_CipherFinal_ex, EVP_CIPHER_CTX_set_key_length, @@ -164,6 +91,11 @@ EVP_DecryptFinal, EVP_CipherInit, EVP_CipherFinal, EVP_Cipher, +EVP_CIPHER_can_pipeline, +EVP_CipherPipelineEncryptInit, +EVP_CipherPipelineDecryptInit, +EVP_CipherPipelineUpdate, +EVP_CipherPipelineFinal, EVP_get_cipherbyname, EVP_get_cipherbynid, EVP_get_cipherbyobj, @@ -230,7 +162,7 @@ EVP_CIPHER_CTX_num, EVP_CIPHER_CTX_type, EVP_CIPHER_CTX_mode \&\- EVP cipher routines -.SH "SYNOPSIS" +.SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& #include <openssl/evp.h> @@ -242,6 +174,8 @@ EVP_CIPHER_CTX_mode \& EVP_CIPHER_CTX *EVP_CIPHER_CTX_new(void); \& int EVP_CIPHER_CTX_reset(EVP_CIPHER_CTX *ctx); \& void EVP_CIPHER_CTX_free(EVP_CIPHER_CTX *ctx); +\& EVP_CIPHER_CTX *EVP_CIPHER_CTX_dup(const EVP_CIPHER_CTX *in); +\& int EVP_CIPHER_CTX_copy(EVP_CIPHER_CTX *out, const EVP_CIPHER_CTX *in); \& \& int EVP_EncryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *type, \& ENGINE *impl, const unsigned char *key, const unsigned char *iv); @@ -266,6 +200,9 @@ EVP_CIPHER_CTX_mode \& int EVP_CipherInit_ex2(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *type, \& const unsigned char *key, const unsigned char *iv, \& int enc, const OSSL_PARAM params[]); +\& int EVP_CipherInit_SKEY(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher, +\& EVP_SKEY *skey, const unsigned char *iv, size_t iv_len, +\& int enc, const OSSL_PARAM params[]); \& int EVP_CipherUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, \& int *outl, const unsigned char *in, int inl); \& int EVP_CipherFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *outm, int *outl); @@ -285,6 +222,25 @@ EVP_CIPHER_CTX_mode \& int EVP_Cipher(EVP_CIPHER_CTX *ctx, unsigned char *out, \& const unsigned char *in, unsigned int inl); \& +\& int EVP_CIPHER_can_pipeline(const EVP_CIPHER *cipher, int enc); +\& int EVP_CipherPipelineEncryptInit(EVP_CIPHER_CTX *ctx, +\& const EVP_CIPHER *cipher, +\& const unsigned char *key, size_t keylen, +\& size_t numpipes, +\& const unsigned char **iv, size_t ivlen); +\& int EVP_CipherPipelineDecryptInit(EVP_CIPHER_CTX *ctx, +\& const EVP_CIPHER *cipher, +\& const unsigned char *key, size_t keylen, +\& size_t numpipes, +\& const unsigned char **iv, size_t ivlen); +\& int EVP_CipherPipelineUpdate(EVP_CIPHER_CTX *ctx, +\& unsigned char **out, size_t *outl, +\& const size_t *outsize, +\& const unsigned char **in, const size_t *inl); +\& int EVP_CipherPipelineFinal(EVP_CIPHER_CTX *ctx, +\& unsigned char **outm, size_t *outl, +\& const size_t *outsize); +\& \& int EVP_CIPHER_CTX_set_padding(EVP_CIPHER_CTX *x, int padding); \& int EVP_CIPHER_CTX_set_key_length(EVP_CIPHER_CTX *x, int keylen); \& int EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX *ctx, int cmd, int p1, void *p2); @@ -364,7 +320,7 @@ EVP_CIPHER_CTX_mode .Ve .PP The following function has been deprecated since OpenSSL 3.0, and can be -hidden entirely by defining \fB\s-1OPENSSL_API_COMPAT\s0\fR with a suitable version value, +hidden entirely by defining \fBOPENSSL_API_COMPAT\fR with a suitable version value, see \fBopenssl_user_macros\fR\|(7): .PP .Vb 1 @@ -372,44 +328,53 @@ see \fBopenssl_user_macros\fR\|(7): .Ve .PP The following function has been deprecated since OpenSSL 1.1.0, and can be -hidden entirely by defining \fB\s-1OPENSSL_API_COMPAT\s0\fR with a suitable version value, +hidden entirely by defining \fBOPENSSL_API_COMPAT\fR with a suitable version value, see \fBopenssl_user_macros\fR\|(7): .PP .Vb 1 \& int EVP_CIPHER_CTX_flags(const EVP_CIPHER_CTX *ctx); .Ve -.SH "DESCRIPTION" +.SH DESCRIPTION .IX Header "DESCRIPTION" -The \s-1EVP\s0 cipher routines are a high-level interface to certain +The EVP cipher routines are a high-level interface to certain symmetric ciphers. .PP -The \fB\s-1EVP_CIPHER\s0\fR type is a structure for cipher method implementation. -.IP "\fBEVP_CIPHER_fetch()\fR" 4 +The \fBEVP_CIPHER\fR type is a structure for cipher method implementation. +.IP \fBEVP_CIPHER_fetch()\fR 4 .IX Item "EVP_CIPHER_fetch()" Fetches the cipher implementation for the given \fIalgorithm\fR from any provider offering it, within the criteria given by the \fIproperties\fR. -See \*(L"\s-1ALGORITHM FETCHING\*(R"\s0 in \fBcrypto\fR\|(7) for further information. +See "ALGORITHM FETCHING" in \fBcrypto\fR\|(7) for further information. .Sp The returned value must eventually be freed with \fBEVP_CIPHER_free()\fR. .Sp -Fetched \fB\s-1EVP_CIPHER\s0\fR structures are reference counted. -.IP "\fBEVP_CIPHER_up_ref()\fR" 4 +Fetched \fBEVP_CIPHER\fR structures are reference counted. +.IP \fBEVP_CIPHER_up_ref()\fR 4 .IX Item "EVP_CIPHER_up_ref()" -Increments the reference count for an \fB\s-1EVP_CIPHER\s0\fR structure. -.IP "\fBEVP_CIPHER_free()\fR" 4 +Increments the reference count for an \fBEVP_CIPHER\fR structure. +.IP \fBEVP_CIPHER_free()\fR 4 .IX Item "EVP_CIPHER_free()" -Decrements the reference count for the fetched \fB\s-1EVP_CIPHER\s0\fR structure. +Decrements the reference count for the fetched \fBEVP_CIPHER\fR structure. If the reference count drops to 0 then the structure is freed. -.IP "\fBEVP_CIPHER_CTX_new()\fR" 4 +If the argument is NULL, nothing is done. +.IP \fBEVP_CIPHER_CTX_new()\fR 4 .IX Item "EVP_CIPHER_CTX_new()" Allocates and returns a cipher context. -.IP "\fBEVP_CIPHER_CTX_free()\fR" 4 +.IP \fBEVP_CIPHER_CTX_free()\fR 4 .IX Item "EVP_CIPHER_CTX_free()" Clears all information from a cipher context and frees any allocated memory -associated with it, including \fIctx\fR itself. This function should be called after -all operations using a cipher are complete so sensitive information does not -remain in memory. -.IP "\fBEVP_CIPHER_CTX_ctrl()\fR" 4 +associated with it, including \fIctx\fR itself. This function should be called +after all operations using a cipher are complete so sensitive information does +not remain in memory. If the argument is NULL, nothing is done. +.IP \fBEVP_CIPHER_CTX_dup()\fR 4 +.IX Item "EVP_CIPHER_CTX_dup()" +Can be used to duplicate the cipher state from \fIin\fR. This is useful +to avoid multiple \fBEVP_CIPHER_fetch()\fR calls or if large amounts of data are to be +fed which only differ in the last few bytes. +.IP \fBEVP_CIPHER_CTX_copy()\fR 4 +.IX Item "EVP_CIPHER_CTX_copy()" +Can be used to copy the cipher state from \fIin\fR to \fIout\fR. +.IP \fBEVP_CIPHER_CTX_ctrl()\fR 4 .IX Item "EVP_CIPHER_CTX_ctrl()" \&\fIThis is a legacy method.\fR \fBEVP_CIPHER_CTX_set_params()\fR and \&\fBEVP_CIPHER_CTX_get_params()\fR is the mechanism that should be used to set and get @@ -420,66 +385,75 @@ is indicated in \fIcmd\fR and any additional arguments in \fIp1\fR and \fIp2\fR. \&\fBEVP_CIPHER_CTX_ctrl()\fR must be called after \fBEVP_CipherInit_ex2()\fR. Other restrictions may apply depending on the control type and cipher implementation. .Sp -If this function happens to be used with a fetched \fB\s-1EVP_CIPHER\s0\fR, it will -translate the controls that are known to OpenSSL into \s-1\fBOSSL_PARAM\s0\fR\|(3) +If this function happens to be used with a fetched \fBEVP_CIPHER\fR, it will +translate the controls that are known to OpenSSL into \fBOSSL_PARAM\fR\|(3) parameters with keys defined by OpenSSL and call \fBEVP_CIPHER_CTX_get_params()\fR or \&\fBEVP_CIPHER_CTX_set_params()\fR as is appropriate for each control command. .Sp -See \*(L"\s-1CONTROLS\*(R"\s0 below for more information, including what translations are +See "CONTROLS" below for more information, including what translations are being done. -.IP "\fBEVP_CIPHER_get_params()\fR" 4 +.IP \fBEVP_CIPHER_get_params()\fR 4 .IX Item "EVP_CIPHER_get_params()" -Retrieves the requested list of algorithm \fIparams\fR from a \s-1CIPHER\s0 \fIcipher\fR. -See \*(L"\s-1PARAMETERS\*(R"\s0 below for more information. -.IP "\fBEVP_CIPHER_CTX_get_params()\fR" 4 +Retrieves the requested list of algorithm \fIparams\fR from a CIPHER \fIcipher\fR. +See "PARAMETERS" below for more information. +.IP \fBEVP_CIPHER_CTX_get_params()\fR 4 .IX Item "EVP_CIPHER_CTX_get_params()" -Retrieves the requested list of \fIparams\fR from \s-1CIPHER\s0 context \fIctx\fR. -See \*(L"\s-1PARAMETERS\*(R"\s0 below for more information. -.IP "\fBEVP_CIPHER_CTX_set_params()\fR" 4 +Retrieves the requested list of \fIparams\fR from CIPHER context \fIctx\fR. +See "PARAMETERS" below for more information. +.IP \fBEVP_CIPHER_CTX_set_params()\fR 4 .IX Item "EVP_CIPHER_CTX_set_params()" -Sets the list of \fIparams\fR into a \s-1CIPHER\s0 context \fIctx\fR. -See \*(L"\s-1PARAMETERS\*(R"\s0 below for more information. -.IP "\fBEVP_CIPHER_gettable_params()\fR" 4 +Sets the list of \fIparams\fR into a CIPHER context \fIctx\fR. +See "PARAMETERS" below for more information. +.IP \fBEVP_CIPHER_gettable_params()\fR 4 .IX Item "EVP_CIPHER_gettable_params()" -Get a constant \s-1\fBOSSL_PARAM\s0\fR\|(3) array that describes the retrievable parameters +Get a constant \fBOSSL_PARAM\fR\|(3) array that describes the retrievable parameters that can be used with \fBEVP_CIPHER_get_params()\fR. .IP "\fBEVP_CIPHER_gettable_ctx_params()\fR and \fBEVP_CIPHER_CTX_gettable_params()\fR" 4 .IX Item "EVP_CIPHER_gettable_ctx_params() and EVP_CIPHER_CTX_gettable_params()" -Get a constant \s-1\fBOSSL_PARAM\s0\fR\|(3) array that describes the retrievable parameters +Get a constant \fBOSSL_PARAM\fR\|(3) array that describes the retrievable parameters that can be used with \fBEVP_CIPHER_CTX_get_params()\fR. \&\fBEVP_CIPHER_gettable_ctx_params()\fR returns the parameters that can be retrieved from the algorithm, whereas \fBEVP_CIPHER_CTX_gettable_params()\fR returns the parameters that can be retrieved in the context's current state. .IP "\fBEVP_CIPHER_settable_ctx_params()\fR and \fBEVP_CIPHER_CTX_settable_params()\fR" 4 .IX Item "EVP_CIPHER_settable_ctx_params() and EVP_CIPHER_CTX_settable_params()" -Get a constant \s-1\fBOSSL_PARAM\s0\fR\|(3) array that describes the settable parameters +Get a constant \fBOSSL_PARAM\fR\|(3) array that describes the settable parameters that can be used with \fBEVP_CIPHER_CTX_set_params()\fR. \&\fBEVP_CIPHER_settable_ctx_params()\fR returns the parameters that can be set from the algorithm, whereas \fBEVP_CIPHER_CTX_settable_params()\fR returns the parameters that can be set in the context's current state. -.IP "\fBEVP_EncryptInit_ex2()\fR" 4 +.IP \fBEVP_EncryptInit_ex2()\fR 4 .IX Item "EVP_EncryptInit_ex2()" -Sets up cipher context \fIctx\fR for encryption with cipher \fItype\fR. \fItype\fR is -typically supplied by calling \fBEVP_CIPHER_fetch()\fR. \fItype\fR may also be set +Sets up cipher context \fIctx\fR for encryption with cipher \fItype\fR. \fIctx\fR \fBMUST NOT\fR be NULL. +\&\fItype\fR is typically supplied by calling \fBEVP_CIPHER_fetch()\fR. \fItype\fR may also be set using legacy functions such as \fBEVP_aes_256_cbc()\fR, but this is not recommended -for new applications. \fIkey\fR is the symmetric key to use and \fIiv\fR is the \s-1IV\s0 to -use (if necessary), the actual number of bytes used for the key and \s-1IV\s0 depends +for new applications. \fIkey\fR is the symmetric key to use and \fIiv\fR is the IV to +use (if necessary), the actual number of bytes used for the key and IV depends on the cipher. The parameters \fIparams\fR will be set on the context after -initialisation. It is possible to set all parameters to \s-1NULL\s0 except \fItype\fR in +initialisation. It is possible to set all parameters to NULL except \fItype\fR in an initial call and supply the remaining parameters in subsequent calls, all of -which have \fItype\fR set to \s-1NULL.\s0 This is done when the default cipher parameters +which have \fItype\fR set to NULL. This is done when the default cipher parameters are not appropriate. -For \fB\s-1EVP_CIPH_GCM_MODE\s0\fR the \s-1IV\s0 will be generated internally if it is not +For \fBEVP_CIPH_GCM_MODE\fR the IV will be generated internally if it is not specified. -.IP "\fBEVP_EncryptInit_ex()\fR" 4 +.IP \fBEVP_EncryptInit_ex()\fR 4 .IX Item "EVP_EncryptInit_ex()" -This legacy function is similar to \fBEVP_EncryptInit_ex2()\fR when \fIimpl\fR is \s-1NULL.\s0 +This legacy function is similar to \fBEVP_EncryptInit_ex2()\fR when \fIimpl\fR is NULL. The implementation of the \fItype\fR from the \fIimpl\fR engine will be used if it exists. -.IP "\fBEVP_EncryptUpdate()\fR" 4 +.IP \fBEVP_EncryptUpdate()\fR 4 .IX Item "EVP_EncryptUpdate()" Encrypts \fIinl\fR bytes from the buffer \fIin\fR and writes the encrypted version to -\&\fIout\fR. This function can be called multiple times to encrypt successive blocks +\&\fIout\fR. The pointers \fIout\fR and \fIin\fR may point to the same location, in which +case the encryption will be done in-place. However, in-place encryption is +guaranteed to work only if the encryption context (\fIctx\fR) has processed data in +multiples of the block size. If the context contains an incomplete data block +from previous operations, in-place encryption will fail. \fIctx\fR \fBMUST NOT\fR be NULL. +.Sp +If \fIout\fR and \fIin\fR point to different locations, the two buffers must be +disjoint, otherwise the operation might fail or the outcome might be undefined. +.Sp +This function can be called multiple times to encrypt successive blocks of data. The amount of data written depends on the block alignment of the encrypted data. For most ciphers and modes, the amount of data written can be anything @@ -488,15 +462,14 @@ For wrap cipher modes, the amount of data written can be anything from zero bytes to (inl + cipher_block_size) bytes. For stream ciphers, the amount of data written can be anything from zero bytes to inl bytes. -Thus, \fIout\fR should contain sufficient room for the operation being performed. -The actual number of bytes written is placed in \fIoutl\fR. It also -checks if \fIin\fR and \fIout\fR are partially overlapping, and if they are -0 is returned to indicate failure. +Thus, the buffer pointed to by \fIout\fR must contain sufficient room for the +operation being performed. +The actual number of bytes written is placed in \fIoutl\fR. .Sp If padding is enabled (the default) then \fBEVP_EncryptFinal_ex()\fR encrypts -the \*(L"final\*(R" data, that is any data that remains in a partial block. -It uses standard block padding (aka \s-1PKCS\s0 padding) as described in -the \s-1NOTES\s0 section, below. The encrypted +the "final" data, that is any data that remains in a partial block. +It uses standard block padding (aka PKCS padding) as described in +the NOTES section, below. The encrypted final data is written to \fIout\fR which should have sufficient space for one cipher block. The number of bytes written is placed in \fIoutl\fR. After this function is called the encryption operation is finished and no further @@ -510,17 +483,18 @@ that is if the total data length is not a multiple of the block size. These functions are the corresponding decryption operations. \&\fBEVP_DecryptFinal()\fR will return an error code if padding is enabled and the final block is not correctly formatted. The parameters and restrictions are -identical to the encryption operations except that if padding is enabled the -decrypted data buffer \fIout\fR passed to \fBEVP_DecryptUpdate()\fR should have -sufficient room for (\fIinl\fR + cipher_block_size) bytes unless the cipher block -size is 1 in which case \fIinl\fR bytes is sufficient. +identical to the encryption operations. \fIctx\fR \fBMUST NOT\fR be NULL. .IP "\fBEVP_CipherInit_ex2()\fR, \fBEVP_CipherInit_ex()\fR, \fBEVP_CipherUpdate()\fR and \fBEVP_CipherFinal_ex()\fR" 4 .IX Item "EVP_CipherInit_ex2(), EVP_CipherInit_ex(), EVP_CipherUpdate() and EVP_CipherFinal_ex()" These functions can be used for decryption or encryption. The operation performed depends on the value of the \fIenc\fR parameter. It should be set to 1 for encryption, 0 for decryption and \-1 to leave the value unchanged (the actual value of 'enc' being supplied in a previous call). -.IP "\fBEVP_CIPHER_CTX_reset()\fR" 4 +.IP \fBEVP_CipherInit_SKEY()\fR 4 +.IX Item "EVP_CipherInit_SKEY()" +This function is similar to \fBEVP_CipherInit_ex2()\fR but accepts a +symmetric key object of type \fIEVP_SKEY\fR as a key. +.IP \fBEVP_CIPHER_CTX_reset()\fR 4 .IX Item "EVP_CIPHER_CTX_reset()" Clears all information from a cipher context and free up any allocated memory associated with it, except the \fIctx\fR itself. This function should be called @@ -537,33 +511,76 @@ Identical to \fBEVP_EncryptFinal_ex()\fR, \fBEVP_DecryptFinal_ex()\fR and \&\fBEVP_CipherFinal_ex()\fR. In previous releases they also cleaned up the \fIctx\fR, but this is no longer done and \fBEVP_CIPHER_CTX_cleanup()\fR must be called to free any context resources. -.IP "\fBEVP_Cipher()\fR" 4 +.IP \fBEVP_Cipher()\fR 4 .IX Item "EVP_Cipher()" Encrypts or decrypts a maximum \fIinl\fR amount of bytes from \fIin\fR and leaves the result in \fIout\fR. .Sp For legacy ciphers \- If the cipher doesn't have the flag -\&\fB\s-1EVP_CIPH_FLAG_CUSTOM_CIPHER\s0\fR set, then \fIinl\fR must be a multiple of +\&\fBEVP_CIPH_FLAG_CUSTOM_CIPHER\fR set, then \fIinl\fR must be a multiple of \&\fBEVP_CIPHER_get_block_size()\fR. If it isn't, the result is undefined. If the cipher has that flag set, then \fIinl\fR can be any size. .Sp -Due to the constraints of the \s-1API\s0 contract of this function it shouldn't be used +Due to the constraints of the API contract of this function it shouldn't be used in applications, please consider using \fBEVP_CipherUpdate()\fR and \&\fBEVP_CipherFinal_ex()\fR instead. +.IP \fBEVP_CIPHER_can_pipeline()\fR 4 +.IX Item "EVP_CIPHER_can_pipeline()" +This function checks if a \fBEVP_CIPHER\fR fetched using \fBEVP_CIPHER_fetch()\fR supports +cipher pipelining. If the cipher supports pipelining, it returns 1, otherwise 0. +This function will return 0 for non-fetched ciphers such as \fBEVP_aes_128_gcm()\fR. +There are currently no built-in ciphers that support pipelining. +.Sp +Cipher pipelining support allows an application to submit multiple chunks of +data in one set of \fBEVP_CipherUpdate()\fR/EVP_CipherFinal calls, thereby allowing +the provided implementation to take advantage of parallel computing. This is +beneficial for hardware accelerators as pipeline amortizes the latency over +multiple chunks. +.Sp +For non-fetched ciphers, \fBEVP_CipherPipelineEncryptInit()\fR or +\&\fBEVP_CipherPipelineDecryptInit()\fR may be directly called, which will perform a +fetch and return an error if a pipeline supported implementation is not found. +.IP "\fBEVP_CipherPipelineEncryptInit()\fR, \fBEVP_CipherPipelineDecryptInit()\fR, \fBEVP_CipherPipelineUpdate()\fR and \fBEVP_CipherPipelineFinal()\fR" 4 +.IX Item "EVP_CipherPipelineEncryptInit(), EVP_CipherPipelineDecryptInit(), EVP_CipherPipelineUpdate() and EVP_CipherPipelineFinal()" +These functions can be used to perform multiple encryption or decryption +operations in parallel. \fBEVP_CIPHER_can_pipeline()\fR may be called to check if the +cipher supports pipelining. These functions are analogous to +\&\fBEVP_EncryptInit_ex2()\fR, \fBEVP_DecryptInit_ex2()\fR, \fBEVP_CipherUpdate()\fR and +\&\fBEVP_CipherFinal()\fR but take an array of pointers for iv, input and output buffers. +.Sp +The \fIkey\fR, of length \fIkeylen\fR, is the symmetric key to use. The \fInumpipes\fR +parameter specifies the number of parallel operations to perform. The +\&\fInumpipes\fR cannot exceed \fBEVP_MAX_PIPES\fR. The \fIiv\fR parameter is an array of +buffer pointers, containing IVs. The array size must be equal to \fInumpipes\fR. +The size of each IV buffer must be equal to \fIivlen\fR. When IV is not provided, +\&\fIiv\fR must be NULL, rather than an array of NULL pointers. The \fIin\fR +parameters takes an array of buffer pointers, each pointing to a buffer +containing the input data. The buffers can be of different sizes. The \fIinl\fR +parameter is an array of size_t, each specifying the size of the corresponding +input buffer. The \fIout\fR and \fIoutm\fR parameters are arrays of buffer pointers, +each pointing to a buffer where the output data will be written. The \fIoutsize\fR +parameter is an array of size_t, each specifying the size of the corresponding +output buffer. The \fIoutl\fR parameter is an array of size_t which will be updated +with the size of the output data written to the corresponding output buffer. +For size requirement of the output buffers, see the description of \fBEVP_CipherUpdate()\fR. +.Sp +The \fBEVP_CipherPipelineUpdate()\fR function can be called multiple times to encrypt +successive blocks of data. For AAD data, the \fIout\fR, and \fIoutsize\fR parameter +should be NULL, rather than an array of NULL pointers. .IP "\fBEVP_get_cipherbyname()\fR, \fBEVP_get_cipherbynid()\fR and \fBEVP_get_cipherbyobj()\fR" 4 .IX Item "EVP_get_cipherbyname(), EVP_get_cipherbynid() and EVP_get_cipherbyobj()" -Returns an \fB\s-1EVP_CIPHER\s0\fR structure when passed a cipher name, a cipher \fB\s-1NID\s0\fR or -an \fB\s-1ASN1_OBJECT\s0\fR structure respectively. +Returns an \fBEVP_CIPHER\fR structure when passed a cipher name, a cipher \fBNID\fR or +an \fBASN1_OBJECT\fR structure respectively. .Sp -\&\fBEVP_get_cipherbyname()\fR will return \s-1NULL\s0 for algorithms such as \*(L"\s-1AES\-128\-SIV\*(R", -\&\*(L"AES\-128\-CBC\-CTS\*(R"\s0 and \*(L"\s-1CAMELLIA\-128\-CBC\-CTS\*(R"\s0 which were previously only +\&\fBEVP_get_cipherbyname()\fR will return NULL for algorithms such as "AES\-128\-SIV", +"AES\-128\-CBC\-CTS" and "CAMELLIA\-128\-CBC\-CTS" which were previously only accessible via low level interfaces. .Sp The \fBEVP_get_cipherbyname()\fR function is present for backwards compatibility with OpenSSL prior to version 3 and is different to the \fBEVP_CIPHER_fetch()\fR function -since it does not attempt to \*(L"fetch\*(R" an implementation of the cipher. +since it does not attempt to "fetch" an implementation of the cipher. Additionally, it only knows about ciphers that are built-in to OpenSSL and have -an associated \s-1NID.\s0 Similarly \fBEVP_get_cipherbynid()\fR and \fBEVP_get_cipherbyobj()\fR +an associated NID. Similarly \fBEVP_get_cipherbynid()\fR and \fBEVP_get_cipherbyobj()\fR also return objects without an associated implementation. .Sp When the cipher objects returned by these functions are used (such as in a call @@ -572,637 +589,686 @@ fetched from the loaded providers. This fetch could fail if no suitable implementation is available. Use \fBEVP_CIPHER_fetch()\fR instead to explicitly fetch the algorithm and an associated implementation from a provider. .Sp -See \*(L"\s-1ALGORITHM FETCHING\*(R"\s0 in \fBcrypto\fR\|(7) for more information about fetching. +See "ALGORITHM FETCHING" in \fBcrypto\fR\|(7) for more information about fetching. .Sp The cipher objects returned from these functions do not need to be freed with \&\fBEVP_CIPHER_free()\fR. .IP "\fBEVP_CIPHER_get_nid()\fR and \fBEVP_CIPHER_CTX_get_nid()\fR" 4 .IX Item "EVP_CIPHER_get_nid() and EVP_CIPHER_CTX_get_nid()" -Return the \s-1NID\s0 of a cipher when passed an \fB\s-1EVP_CIPHER\s0\fR or \fB\s-1EVP_CIPHER_CTX\s0\fR -structure. The actual \s-1NID\s0 value is an internal value which may not have a -corresponding \s-1OBJECT IDENTIFIER.\s0 +Return the NID of a cipher when passed an \fBEVP_CIPHER\fR or \fBEVP_CIPHER_CTX\fR +structure. The actual NID value is an internal value which may not have a +corresponding OBJECT IDENTIFIER. NID_undef is returned in the event that the +nid is unknown or if the cipher has not been properly initialized via a call to +\&\fBEVP_CipherInit\fR. .IP "\fBEVP_CIPHER_CTX_set_flags()\fR, \fBEVP_CIPHER_CTX_clear_flags()\fR and \fBEVP_CIPHER_CTX_test_flags()\fR" 4 .IX Item "EVP_CIPHER_CTX_set_flags(), EVP_CIPHER_CTX_clear_flags() and EVP_CIPHER_CTX_test_flags()" -Sets, clears and tests \fIctx\fR flags. See \*(L"\s-1FLAGS\*(R"\s0 below for more information. +Sets, clears and tests \fIctx\fR flags. See "FLAGS" below for more information. .Sp For provided ciphers \fBEVP_CIPHER_CTX_set_flags()\fR should be called only after the fetched cipher has been assigned to the \fIctx\fR. It is recommended to use -\&\*(L"\s-1PARAMETERS\*(R"\s0 instead. -.IP "\fBEVP_CIPHER_CTX_set_padding()\fR" 4 +"PARAMETERS" instead. +.IP \fBEVP_CIPHER_CTX_set_padding()\fR 4 .IX Item "EVP_CIPHER_CTX_set_padding()" Enables or disables padding. This function should be called after the context is set up for encryption or decryption with \fBEVP_EncryptInit_ex2()\fR, -\&\fBEVP_DecryptInit_ex2()\fR or \fBEVP_CipherInit_ex2()\fR. By default encryption operations -are padded using standard block padding and the padding is checked and removed -when decrypting. If the \fIpad\fR parameter is zero then no padding is -performed, the total amount of data encrypted or decrypted must then -be a multiple of the block size or an error will occur. +\&\fBEVP_DecryptInit_ex2()\fR, \fBEVP_CipherInit_ex2()\fR, or \fBEVP_CipherInit_SKEY()\fR. By +default encryption operations are padded using standard block padding and the +padding is checked and removed when decrypting. If the \fIpad\fR parameter is zero +then no padding is performed, the total amount of data encrypted or decrypted +must then be a multiple of the block size or an error will occur. \fIx\fR \fBMUST +NOT\fR be NULL. .IP "\fBEVP_CIPHER_get_key_length()\fR and \fBEVP_CIPHER_CTX_get_key_length()\fR" 4 .IX Item "EVP_CIPHER_get_key_length() and EVP_CIPHER_CTX_get_key_length()" -Return the key length of a cipher when passed an \fB\s-1EVP_CIPHER\s0\fR or -\&\fB\s-1EVP_CIPHER_CTX\s0\fR structure. The constant \fB\s-1EVP_MAX_KEY_LENGTH\s0\fR is the maximum +Return the key length of a cipher when passed an \fBEVP_CIPHER\fR or +\&\fBEVP_CIPHER_CTX\fR structure. The constant \fBEVP_MAX_KEY_LENGTH\fR is the maximum key length for all ciphers. Note: although \fBEVP_CIPHER_get_key_length()\fR is fixed for a given cipher, the value of \fBEVP_CIPHER_CTX_get_key_length()\fR may be different for variable key length ciphers. -.IP "\fBEVP_CIPHER_CTX_set_key_length()\fR" 4 +.IP \fBEVP_CIPHER_CTX_set_key_length()\fR 4 .IX Item "EVP_CIPHER_CTX_set_key_length()" Sets the key length of the cipher context. If the cipher is a fixed length cipher then attempting to set the key length to any value other than the fixed value is an error. .IP "\fBEVP_CIPHER_get_iv_length()\fR and \fBEVP_CIPHER_CTX_get_iv_length()\fR" 4 .IX Item "EVP_CIPHER_get_iv_length() and EVP_CIPHER_CTX_get_iv_length()" -Return the \s-1IV\s0 length of a cipher when passed an \fB\s-1EVP_CIPHER\s0\fR or -\&\fB\s-1EVP_CIPHER_CTX\s0\fR. It will return zero if the cipher does not use an \s-1IV.\s0 -The constant \fB\s-1EVP_MAX_IV_LENGTH\s0\fR is the maximum \s-1IV\s0 length for all ciphers. -.IP "\fBEVP_CIPHER_CTX_get_tag_length()\fR" 4 +Return the IV length of a cipher when passed an \fBEVP_CIPHER\fR or +\&\fBEVP_CIPHER_CTX\fR. It will return zero if the cipher does not use an IV, if +the cipher has not yet been initialized within the \fBEVP_CIPHER_CTX\fR, or if the +passed cipher is NULL. The constant \fBEVP_MAX_IV_LENGTH\fR is the maximum IV +length for all ciphers. +.IP \fBEVP_CIPHER_CTX_get_tag_length()\fR 4 .IX Item "EVP_CIPHER_CTX_get_tag_length()" -Returns the tag length of an \s-1AEAD\s0 cipher when passed a \fB\s-1EVP_CIPHER_CTX\s0\fR. It will +Returns the tag length of an AEAD cipher when passed a \fBEVP_CIPHER_CTX\fR. It will return zero if the cipher does not support a tag. It returns a default value if the tag length has not been set. .IP "\fBEVP_CIPHER_get_block_size()\fR and \fBEVP_CIPHER_CTX_get_block_size()\fR" 4 .IX Item "EVP_CIPHER_get_block_size() and EVP_CIPHER_CTX_get_block_size()" -Return the block size of a cipher when passed an \fB\s-1EVP_CIPHER\s0\fR or -\&\fB\s-1EVP_CIPHER_CTX\s0\fR structure. The constant \fB\s-1EVP_MAX_BLOCK_LENGTH\s0\fR is also the +Return the block size of a cipher when passed an \fBEVP_CIPHER\fR or +\&\fBEVP_CIPHER_CTX\fR structure. The constant \fBEVP_MAX_BLOCK_LENGTH\fR is also the maximum block length for all ciphers. +A value of 0 is returned if, with \fBEVP_CIPHER_get_block_size()\fR, the cipher +\&\fIe\fR is NULL, or, with \fBEVP_CIPHER_CTX_get_block_size()\fR, the context +\&\fIctx\fR is NULL or has not been properly initialized with a call to +\&\fBEVP_CipherInit\fR. .IP "\fBEVP_CIPHER_get_type()\fR and \fBEVP_CIPHER_CTX_get_type()\fR" 4 .IX Item "EVP_CIPHER_get_type() and EVP_CIPHER_CTX_get_type()" -Return the type of the passed cipher or context. This \*(L"type\*(R" is the actual \s-1NID\s0 -of the cipher \s-1OBJECT IDENTIFIER\s0 and as such it ignores the cipher parameters -(40 bit \s-1RC2\s0 and 128 bit \s-1RC2\s0 have the same \s-1NID\s0). If the cipher does not have an -object identifier or does not have \s-1ASN1\s0 support this function will return +Return the type of the passed cipher or context. This "type" is the actual NID +of the cipher OBJECT IDENTIFIER and as such it ignores the cipher parameters +(40 bit RC2 and 128 bit RC2 have the same NID). If the cipher does not have an +object identifier or does not have ASN1 support this function will return \&\fBNID_undef\fR. -.IP "\fBEVP_CIPHER_is_a()\fR" 4 +.IP \fBEVP_CIPHER_is_a()\fR 4 .IX Item "EVP_CIPHER_is_a()" Returns 1 if \fIcipher\fR is an implementation of an algorithm that's identifiable with \fIname\fR, otherwise 0. If \fIcipher\fR is a legacy cipher (it's the return value from the likes of \fBEVP_aes128()\fR rather than the result of an \&\fBEVP_CIPHER_fetch()\fR), only cipher names registered with the default library -context (see \s-1\fBOSSL_LIB_CTX\s0\fR\|(3)) will be considered. +context (see \fBOSSL_LIB_CTX\fR\|(3)) will be considered. .IP "\fBEVP_CIPHER_get0_name()\fR and \fBEVP_CIPHER_CTX_get0_name()\fR" 4 .IX Item "EVP_CIPHER_get0_name() and EVP_CIPHER_CTX_get0_name()" Return the name of the passed cipher or context. For fetched ciphers with multiple names, only one of them is returned. See also \fBEVP_CIPHER_names_do_all()\fR. -.IP "\fBEVP_CIPHER_names_do_all()\fR" 4 +\&\fIcipher\fR \fBMUST NOT\fR be NULL. +.IP \fBEVP_CIPHER_names_do_all()\fR 4 .IX Item "EVP_CIPHER_names_do_all()" Traverses all names for the \fIcipher\fR, and calls \fIfn\fR with each name and -\&\fIdata\fR. This is only useful with fetched \fB\s-1EVP_CIPHER\s0\fRs. -.IP "\fBEVP_CIPHER_get0_description()\fR" 4 +\&\fIdata\fR. This is only useful with fetched \fBEVP_CIPHER\fRs. +.IP \fBEVP_CIPHER_get0_description()\fR 4 .IX Item "EVP_CIPHER_get0_description()" Returns a description of the cipher, meant for display and human consumption. The description is at the discretion of the cipher implementation. -.IP "\fBEVP_CIPHER_get0_provider()\fR" 4 +.IP \fBEVP_CIPHER_get0_provider()\fR 4 .IX Item "EVP_CIPHER_get0_provider()" -Returns an \fB\s-1OSSL_PROVIDER\s0\fR pointer to the provider that implements the given -\&\fB\s-1EVP_CIPHER\s0\fR. -.IP "\fBEVP_CIPHER_CTX_get0_cipher()\fR" 4 +Returns an \fBOSSL_PROVIDER\fR pointer to the provider that implements the given +\&\fBEVP_CIPHER\fR. +.IP \fBEVP_CIPHER_CTX_get0_cipher()\fR 4 .IX Item "EVP_CIPHER_CTX_get0_cipher()" -Returns the \fB\s-1EVP_CIPHER\s0\fR structure when passed an \fB\s-1EVP_CIPHER_CTX\s0\fR structure. +Returns the \fBEVP_CIPHER\fR structure when passed an \fBEVP_CIPHER_CTX\fR structure. \&\fBEVP_CIPHER_CTX_get1_cipher()\fR is the same except the ownership is passed to -the caller. +the caller. Both functions return NULL on error. .IP "\fBEVP_CIPHER_get_mode()\fR and \fBEVP_CIPHER_CTX_get_mode()\fR" 4 .IX Item "EVP_CIPHER_get_mode() and EVP_CIPHER_CTX_get_mode()" Return the block cipher mode: -\&\s-1EVP_CIPH_ECB_MODE, EVP_CIPH_CBC_MODE, EVP_CIPH_CFB_MODE, EVP_CIPH_OFB_MODE, +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\s0 or \s-1EVP_CIPH_SIV_MODE.\s0 -If the cipher is a stream cipher then \s-1EVP_CIPH_STREAM_CIPHER\s0 is returned. -.IP "\fBEVP_CIPHER_get_flags()\fR" 4 +EVP_CIPH_WRAP_MODE, EVP_CIPH_OCB_MODE or EVP_CIPH_SIV_MODE. +If the cipher is a stream cipher then EVP_CIPH_STREAM_CIPHER is returned. +.IP \fBEVP_CIPHER_get_flags()\fR 4 .IX Item "EVP_CIPHER_get_flags()" -Returns any flags associated with the cipher. See \*(L"\s-1FLAGS\*(R"\s0 +Returns any flags associated with the cipher. See "FLAGS" for a list of currently defined flags. .IP "\fBEVP_CIPHER_CTX_get_num()\fR and \fBEVP_CIPHER_CTX_set_num()\fR" 4 .IX Item "EVP_CIPHER_CTX_get_num() and EVP_CIPHER_CTX_set_num()" -Gets or sets the cipher specific \*(L"num\*(R" parameter for the associated \fIctx\fR. +Gets or sets the cipher specific "num" parameter for the associated \fIctx\fR. Built-in ciphers typically use this to track how much of the current underlying block -has been \*(L"used\*(R" already. -.IP "\fBEVP_CIPHER_CTX_is_encrypting()\fR" 4 +has been "used" already. +.IP \fBEVP_CIPHER_CTX_is_encrypting()\fR 4 .IX Item "EVP_CIPHER_CTX_is_encrypting()" Reports whether the \fIctx\fR is being used for encryption or decryption. -.IP "\fBEVP_CIPHER_CTX_flags()\fR" 4 +.IP \fBEVP_CIPHER_CTX_flags()\fR 4 .IX Item "EVP_CIPHER_CTX_flags()" A deprecated macro calling \f(CW\*(C`EVP_CIPHER_get_flags(EVP_CIPHER_CTX_get0_cipher(ctx))\*(C'\fR. Do not use. -.IP "\fBEVP_CIPHER_param_to_asn1()\fR" 4 +.IP \fBEVP_CIPHER_param_to_asn1()\fR 4 .IX Item "EVP_CIPHER_param_to_asn1()" -Sets the AlgorithmIdentifier \*(L"parameter\*(R" based on the passed cipher. This will -typically include any parameters and an \s-1IV.\s0 The cipher \s-1IV\s0 (if any) must be set +Sets the AlgorithmIdentifier "parameter" based on the passed cipher. This will +typically include any parameters and an IV. The cipher IV (if any) must be set when this call is made. This call should be made before the cipher is actually -\&\*(L"used\*(R" (before any \fBEVP_EncryptUpdate()\fR, \fBEVP_DecryptUpdate()\fR calls for example). -This function may fail if the cipher does not have any \s-1ASN1\s0 support. -.IP "\fBEVP_CIPHER_asn1_to_param()\fR" 4 +"used" (before any \fBEVP_EncryptUpdate()\fR, \fBEVP_DecryptUpdate()\fR calls for example). +This function may fail if the cipher does not have any ASN1 support, or if an +uninitialized cipher is passed to it. +.IP \fBEVP_CIPHER_asn1_to_param()\fR 4 .IX Item "EVP_CIPHER_asn1_to_param()" -Sets the cipher parameters based on an \s-1ASN1\s0 AlgorithmIdentifier \*(L"parameter\*(R". -The precise effect depends on the cipher. In the case of \fB\s-1RC2\s0\fR, for example, -it will set the \s-1IV\s0 and effective key length. +Sets the cipher parameters based on an ASN1 AlgorithmIdentifier "parameter". +The precise effect depends on the cipher. In the case of \fBRC2\fR, for example, +it will set the IV and effective key length. This function should be called after the base cipher type is set but before -the key is set. For example \fBEVP_CipherInit()\fR will be called with the \s-1IV\s0 and -key set to \s-1NULL,\s0 \fBEVP_CIPHER_asn1_to_param()\fR will be called and finally -\&\fBEVP_CipherInit()\fR again with all parameters except the key set to \s-1NULL.\s0 It is -possible for this function to fail if the cipher does not have any \s-1ASN1\s0 support -or the parameters cannot be set (for example the \s-1RC2\s0 effective key length +the key is set. For example \fBEVP_CipherInit()\fR will be called with the IV and +key set to NULL, \fBEVP_CIPHER_asn1_to_param()\fR will be called and finally +\&\fBEVP_CipherInit()\fR again with all parameters except the key set to NULL. It is +possible for this function to fail if the cipher does not have any ASN1 support +or the parameters cannot be set (for example the RC2 effective key length is not supported. -.IP "\fBEVP_CIPHER_CTX_rand_key()\fR" 4 +.IP \fBEVP_CIPHER_CTX_rand_key()\fR 4 .IX Item "EVP_CIPHER_CTX_rand_key()" Generates a random key of the appropriate length based on the cipher context. -The \fB\s-1EVP_CIPHER\s0\fR can provide its own random key generation routine to support +The \fBEVP_CIPHER\fR can provide its own random key generation routine to support keys of a specific form. \fIkey\fR must point to a buffer at least as big as the value returned by \fBEVP_CIPHER_CTX_get_key_length()\fR. -.IP "\fBEVP_CIPHER_do_all_provided()\fR" 4 +.IP \fBEVP_CIPHER_do_all_provided()\fR 4 .IX Item "EVP_CIPHER_do_all_provided()" Traverses all ciphers implemented by all activated providers in the given library context \fIlibctx\fR, and for each of the implementations, calls the given function \fIfn\fR with the implementation method and the given \fIarg\fR as argument. -.SH "PARAMETERS" +.SH PARAMETERS .IX Header "PARAMETERS" -See \s-1\fBOSSL_PARAM\s0\fR\|(3) for information about passing parameters. -.SS "Gettable \s-1EVP_CIPHER\s0 parameters" +See \fBOSSL_PARAM\fR\|(3) for information about passing parameters. +.SS "Gettable EVP_CIPHER parameters" .IX Subsection "Gettable EVP_CIPHER parameters" When \fBEVP_CIPHER_fetch()\fR is called it internally calls \fBEVP_CIPHER_get_params()\fR and caches the results. .PP -\&\fBEVP_CIPHER_get_params()\fR can be used with the following \s-1\fBOSSL_PARAM\s0\fR\|(3) keys: -.ie n .IP """mode"" (\fB\s-1OSSL_CIPHER_PARAM_MODE\s0\fR) <unsigned integer>" 4 -.el .IP "``mode'' (\fB\s-1OSSL_CIPHER_PARAM_MODE\s0\fR) <unsigned integer>" 4 -.IX Item "mode (OSSL_CIPHER_PARAM_MODE) <unsigned integer>" +\&\fBEVP_CIPHER_get_params()\fR can be used with the following \fBOSSL_PARAM\fR\|(3) keys: +.IP """mode"" (\fBOSSL_CIPHER_PARAM_MODE\fR) <unsigned integer>" 4 +.IX Item """mode"" (OSSL_CIPHER_PARAM_MODE) <unsigned integer>" Gets the mode for the associated cipher algorithm \fIcipher\fR. -See \*(L"\fBEVP_CIPHER_get_mode()\fR and \fBEVP_CIPHER_CTX_get_mode()\fR\*(R" for a list of valid modes. +See "\fBEVP_CIPHER_get_mode()\fR and \fBEVP_CIPHER_CTX_get_mode()\fR" for a list of valid modes. Use \fBEVP_CIPHER_get_mode()\fR to retrieve the cached value. -.ie n .IP """keylen"" (\fB\s-1OSSL_CIPHER_PARAM_KEYLEN\s0\fR) <unsigned integer>" 4 -.el .IP "``keylen'' (\fB\s-1OSSL_CIPHER_PARAM_KEYLEN\s0\fR) <unsigned integer>" 4 -.IX Item "keylen (OSSL_CIPHER_PARAM_KEYLEN) <unsigned integer>" +.IP """keylen"" (\fBOSSL_CIPHER_PARAM_KEYLEN\fR) <unsigned integer>" 4 +.IX Item """keylen"" (OSSL_CIPHER_PARAM_KEYLEN) <unsigned integer>" Gets the key length for the associated cipher algorithm \fIcipher\fR. Use \fBEVP_CIPHER_get_key_length()\fR to retrieve the cached value. -.ie n .IP """ivlen"" (\fB\s-1OSSL_CIPHER_PARAM_IVLEN\s0\fR) <unsigned integer>" 4 -.el .IP "``ivlen'' (\fB\s-1OSSL_CIPHER_PARAM_IVLEN\s0\fR) <unsigned integer>" 4 -.IX Item "ivlen (OSSL_CIPHER_PARAM_IVLEN) <unsigned integer>" -Gets the \s-1IV\s0 length for the associated cipher algorithm \fIcipher\fR. +.IP """ivlen"" (\fBOSSL_CIPHER_PARAM_IVLEN\fR) <unsigned integer>" 4 +.IX Item """ivlen"" (OSSL_CIPHER_PARAM_IVLEN) <unsigned integer>" +Gets the IV length for the associated cipher algorithm \fIcipher\fR. Use \fBEVP_CIPHER_get_iv_length()\fR to retrieve the cached value. -.ie n .IP """blocksize"" (\fB\s-1OSSL_CIPHER_PARAM_BLOCK_SIZE\s0\fR) <unsigned integer>" 4 -.el .IP "``blocksize'' (\fB\s-1OSSL_CIPHER_PARAM_BLOCK_SIZE\s0\fR) <unsigned integer>" 4 -.IX Item "blocksize (OSSL_CIPHER_PARAM_BLOCK_SIZE) <unsigned integer>" +.IP """blocksize"" (\fBOSSL_CIPHER_PARAM_BLOCK_SIZE\fR) <unsigned integer>" 4 +.IX Item """blocksize"" (OSSL_CIPHER_PARAM_BLOCK_SIZE) <unsigned integer>" Gets the block size for the associated cipher algorithm \fIcipher\fR. The block size should be 1 for stream ciphers. Note that the block size for a cipher may be different to the block size for the underlying encryption/decryption primitive. -For example \s-1AES\s0 in \s-1CTR\s0 mode has a block size of 1 (because it operates like a -stream cipher), even though \s-1AES\s0 has a block size of 16. +For example AES in CTR mode has a block size of 1 (because it operates like a +stream cipher), even though AES has a block size of 16. Use \fBEVP_CIPHER_get_block_size()\fR to retrieve the cached value. -.ie n .IP """aead"" (\fB\s-1OSSL_CIPHER_PARAM_AEAD\s0\fR) <integer>" 4 -.el .IP "``aead'' (\fB\s-1OSSL_CIPHER_PARAM_AEAD\s0\fR) <integer>" 4 -.IX Item "aead (OSSL_CIPHER_PARAM_AEAD) <integer>" -Gets 1 if this is an \s-1AEAD\s0 cipher algorithm, otherwise it gets 0. -Use (EVP_CIPHER_get_flags(cipher) & \s-1EVP_CIPH_FLAG_AEAD_CIPHER\s0) to retrieve the +.IP """aead"" (\fBOSSL_CIPHER_PARAM_AEAD\fR) <integer>" 4 +.IX Item """aead"" (OSSL_CIPHER_PARAM_AEAD) <integer>" +Gets 1 if this is an AEAD cipher algorithm, otherwise it gets 0. +Use (EVP_CIPHER_get_flags(cipher) & EVP_CIPH_FLAG_AEAD_CIPHER) to retrieve the cached value. -.ie n .IP """custom-iv"" (\fB\s-1OSSL_CIPHER_PARAM_CUSTOM_IV\s0\fR) <integer>" 4 -.el .IP "``custom-iv'' (\fB\s-1OSSL_CIPHER_PARAM_CUSTOM_IV\s0\fR) <integer>" 4 -.IX Item "custom-iv (OSSL_CIPHER_PARAM_CUSTOM_IV) <integer>" -Gets 1 if the cipher algorithm \fIcipher\fR has a custom \s-1IV,\s0 otherwise it gets 0. -Storing and initializing the \s-1IV\s0 is left entirely to the implementation, if a -custom \s-1IV\s0 is used. -Use (EVP_CIPHER_get_flags(cipher) & \s-1EVP_CIPH_CUSTOM_IV\s0) to retrieve the +.IP """custom-iv"" (\fBOSSL_CIPHER_PARAM_CUSTOM_IV\fR) <integer>" 4 +.IX Item """custom-iv"" (OSSL_CIPHER_PARAM_CUSTOM_IV) <integer>" +Gets 1 if the cipher algorithm \fIcipher\fR has a custom IV, otherwise it gets 0. +Storing and initializing the IV is left entirely to the implementation, if a +custom IV is used. +Use (EVP_CIPHER_get_flags(cipher) & EVP_CIPH_CUSTOM_IV) to retrieve the cached value. -.ie n .IP """cts"" (\fB\s-1OSSL_CIPHER_PARAM_CTS\s0\fR) <integer>" 4 -.el .IP "``cts'' (\fB\s-1OSSL_CIPHER_PARAM_CTS\s0\fR) <integer>" 4 -.IX Item "cts (OSSL_CIPHER_PARAM_CTS) <integer>" +.IP """cts"" (\fBOSSL_CIPHER_PARAM_CTS\fR) <integer>" 4 +.IX Item """cts"" (OSSL_CIPHER_PARAM_CTS) <integer>" Gets 1 if the cipher algorithm \fIcipher\fR uses ciphertext stealing, otherwise it gets 0. This is currently used to indicate that the cipher is a one shot that only allows a single call to \fBEVP_CipherUpdate()\fR. -Use (EVP_CIPHER_get_flags(cipher) & \s-1EVP_CIPH_FLAG_CTS\s0) to retrieve the +Use (EVP_CIPHER_get_flags(cipher) & EVP_CIPH_FLAG_CTS) to retrieve the cached value. -.ie n .IP """tls-multi"" (\fB\s-1OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK\s0\fR) <integer>" 4 -.el .IP "``tls-multi'' (\fB\s-1OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK\s0\fR) <integer>" 4 -.IX Item "tls-multi (OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK) <integer>" +.IP """tls-multi"" (\fBOSSL_CIPHER_PARAM_TLS1_MULTIBLOCK\fR) <integer>" 4 +.IX Item """tls-multi"" (OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK) <integer>" Gets 1 if the cipher algorithm \fIcipher\fR supports interleaving of crypto blocks, otherwise it gets 0. The interleaving is an optimization only applicable to certain -\&\s-1TLS\s0 ciphers. -Use (EVP_CIPHER_get_flags(cipher) & \s-1EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK\s0) to retrieve the +TLS ciphers. +Use (EVP_CIPHER_get_flags(cipher) & EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK) to retrieve the cached value. -.ie n .IP """has-randkey"" (\fB\s-1OSSL_CIPHER_PARAM_HAS_RANDKEY\s0\fR) <integer>" 4 -.el .IP "``has-randkey'' (\fB\s-1OSSL_CIPHER_PARAM_HAS_RANDKEY\s0\fR) <integer>" 4 -.IX Item "has-randkey (OSSL_CIPHER_PARAM_HAS_RANDKEY) <integer>" -Gets 1 if the cipher algorithm \fIcipher\fR supports the gettable \s-1EVP_CIPHER_CTX\s0 -parameter \fB\s-1OSSL_CIPHER_PARAM_RANDOM_KEY\s0\fR. Only \s-1DES\s0 and 3DES set this to 1, +.IP """has-randkey"" (\fBOSSL_CIPHER_PARAM_HAS_RANDKEY\fR) <integer>" 4 +.IX Item """has-randkey"" (OSSL_CIPHER_PARAM_HAS_RANDKEY) <integer>" +Gets 1 if the cipher algorithm \fIcipher\fR supports the gettable EVP_CIPHER_CTX +parameter \fBOSSL_CIPHER_PARAM_RANDOM_KEY\fR. Only DES and 3DES set this to 1, all other OpenSSL ciphers return 0. -.SS "Gettable and Settable \s-1EVP_CIPHER_CTX\s0 parameters" +.IP """decrypt-only"" (\fBOSSL_CIPHER_PARAM_DECRYPT_ONLY) <integer\fR" 4 +.IX Item """decrypt-only"" (OSSL_CIPHER_PARAM_DECRYPT_ONLY) <integer" +Gets 1 if the cipher algorithm \fIcipher\fR implementation supports only +the decryption operation such as the 3DES ciphers in the fips provider. +Otherwise gets 0 or the parameter might not be present at all. +.SS "Gettable and Settable EVP_CIPHER_CTX parameters" .IX Subsection "Gettable and Settable EVP_CIPHER_CTX parameters" -The following \s-1\fBOSSL_PARAM\s0\fR\|(3) keys can be used with both \fBEVP_CIPHER_CTX_get_params()\fR +The following \fBOSSL_PARAM\fR\|(3) keys can be used with both \fBEVP_CIPHER_CTX_get_params()\fR and \fBEVP_CIPHER_CTX_set_params()\fR. -.ie n .IP """padding"" (\fB\s-1OSSL_CIPHER_PARAM_PADDING\s0\fR) <unsigned integer>" 4 -.el .IP "``padding'' (\fB\s-1OSSL_CIPHER_PARAM_PADDING\s0\fR) <unsigned integer>" 4 -.IX Item "padding (OSSL_CIPHER_PARAM_PADDING) <unsigned integer>" +.IP """padding"" (\fBOSSL_CIPHER_PARAM_PADDING\fR) <unsigned integer>" 4 +.IX Item """padding"" (OSSL_CIPHER_PARAM_PADDING) <unsigned integer>" Gets or sets the padding mode for the cipher context \fIctx\fR. Padding is enabled if the value is 1, and disabled if the value is 0. See also \fBEVP_CIPHER_CTX_set_padding()\fR. -.ie n .IP """num"" (\fB\s-1OSSL_CIPHER_PARAM_NUM\s0\fR) <unsigned integer>" 4 -.el .IP "``num'' (\fB\s-1OSSL_CIPHER_PARAM_NUM\s0\fR) <unsigned integer>" 4 -.IX Item "num (OSSL_CIPHER_PARAM_NUM) <unsigned integer>" -Gets or sets the cipher specific \*(L"num\*(R" parameter for the cipher context \fIctx\fR. +.IP """num"" (\fBOSSL_CIPHER_PARAM_NUM\fR) <unsigned integer>" 4 +.IX Item """num"" (OSSL_CIPHER_PARAM_NUM) <unsigned integer>" +Gets or sets the cipher specific "num" parameter for the cipher context \fIctx\fR. Built-in ciphers typically use this to track how much of the current underlying -block has been \*(L"used\*(R" already. +block has been "used" already. See also \fBEVP_CIPHER_CTX_get_num()\fR and \fBEVP_CIPHER_CTX_set_num()\fR. -.ie n .IP """keylen"" (\fB\s-1OSSL_CIPHER_PARAM_KEYLEN\s0\fR) <unsigned integer>" 4 -.el .IP "``keylen'' (\fB\s-1OSSL_CIPHER_PARAM_KEYLEN\s0\fR) <unsigned integer>" 4 -.IX Item "keylen (OSSL_CIPHER_PARAM_KEYLEN) <unsigned integer>" +.IP """keylen"" (\fBOSSL_CIPHER_PARAM_KEYLEN\fR) <unsigned integer>" 4 +.IX Item """keylen"" (OSSL_CIPHER_PARAM_KEYLEN) <unsigned integer>" Gets or sets the key length for the cipher context \fIctx\fR. -The length of the \*(L"keylen\*(R" parameter should not exceed that of a \fBsize_t\fR. +The length of the "keylen" parameter should not exceed that of a \fBsize_t\fR. See also \fBEVP_CIPHER_CTX_get_key_length()\fR and \fBEVP_CIPHER_CTX_set_key_length()\fR. -.ie n .IP """tag"" (\fB\s-1OSSL_CIPHER_PARAM_AEAD_TAG\s0\fR) <octet string>" 4 -.el .IP "``tag'' (\fB\s-1OSSL_CIPHER_PARAM_AEAD_TAG\s0\fR) <octet string>" 4 -.IX Item "tag (OSSL_CIPHER_PARAM_AEAD_TAG) <octet string>" -Gets or sets the \s-1AEAD\s0 tag for the associated cipher context \fIctx\fR. -See \*(L"\s-1AEAD\s0 Interface\*(R" in \fBEVP_EncryptInit\fR\|(3). -.ie n .IP """keybits"" (\fB\s-1OSSL_CIPHER_PARAM_RC2_KEYBITS\s0\fR) <unsigned integer>" 4 -.el .IP "``keybits'' (\fB\s-1OSSL_CIPHER_PARAM_RC2_KEYBITS\s0\fR) <unsigned integer>" 4 -.IX Item "keybits (OSSL_CIPHER_PARAM_RC2_KEYBITS) <unsigned integer>" -Gets or sets the effective keybits used for a \s-1RC2\s0 cipher. -The length of the \*(L"keybits\*(R" parameter should not exceed that of a \fBsize_t\fR. -.ie n .IP """rounds"" (\fB\s-1OSSL_CIPHER_PARAM_ROUNDS\s0\fR) <unsigned integer>" 4 -.el .IP "``rounds'' (\fB\s-1OSSL_CIPHER_PARAM_ROUNDS\s0\fR) <unsigned integer>" 4 -.IX Item "rounds (OSSL_CIPHER_PARAM_ROUNDS) <unsigned integer>" +.IP """tag"" (\fBOSSL_CIPHER_PARAM_AEAD_TAG\fR) <octet string>" 4 +.IX Item """tag"" (OSSL_CIPHER_PARAM_AEAD_TAG) <octet string>" +Gets or sets the AEAD tag for the associated cipher context \fIctx\fR. +See "AEAD Interface" in \fBEVP_EncryptInit\fR\|(3). +.IP """pipeline-tag"" (\fBOSSL_CIPHER_PARAM_PIPELINE_AEAD_TAG\fR) <octet ptr>" 4 +.IX Item """pipeline-tag"" (OSSL_CIPHER_PARAM_PIPELINE_AEAD_TAG) <octet ptr>" +Gets or sets the AEAD tag when using cipher pipelining. The pointer must +point to an array of buffers, where the aead tag will be read from or written to. +The array size must be equal to \fInumpipes\fR used in +\&\fBEVP_CipherPipelineEncryptInit()\fR or \fBEVP_CipherPipelineDecryptInit()\fR. +.IP """keybits"" (\fBOSSL_CIPHER_PARAM_RC2_KEYBITS\fR) <unsigned integer>" 4 +.IX Item """keybits"" (OSSL_CIPHER_PARAM_RC2_KEYBITS) <unsigned integer>" +Gets or sets the effective keybits used for a RC2 cipher. +The length of the "keybits" parameter should not exceed that of a \fBsize_t\fR. +.IP """rounds"" (\fBOSSL_CIPHER_PARAM_ROUNDS\fR) <unsigned integer>" 4 +.IX Item """rounds"" (OSSL_CIPHER_PARAM_ROUNDS) <unsigned integer>" Gets or sets the number of rounds to be used for a cipher. -This is used by the \s-1RC5\s0 cipher. -.ie n .IP """alg_id_param"" (\fB\s-1OSSL_CIPHER_PARAM_ALGORITHM_ID_PARAMS\s0\fR) <octet string>" 4 -.el .IP "``alg_id_param'' (\fB\s-1OSSL_CIPHER_PARAM_ALGORITHM_ID_PARAMS\s0\fR) <octet string>" 4 -.IX Item "alg_id_param (OSSL_CIPHER_PARAM_ALGORITHM_ID_PARAMS) <octet string>" -Used to pass the \s-1DER\s0 encoded AlgorithmIdentifier parameter to or from -the cipher implementation. Functions like \fBEVP_CIPHER_param_to_asn1\fR\|(3) -and \fBEVP_CIPHER_asn1_to_param\fR\|(3) use this parameter for any implementation -that has the flag \fB\s-1EVP_CIPH_FLAG_CUSTOM_ASN1\s0\fR set. -.ie n .IP """cts_mode"" (\fB\s-1OSSL_CIPHER_PARAM_CTS_MODE\s0\fR) <\s-1UTF8\s0 string>" 4 -.el .IP "``cts_mode'' (\fB\s-1OSSL_CIPHER_PARAM_CTS_MODE\s0\fR) <\s-1UTF8\s0 string>" 4 -.IX Item "cts_mode (OSSL_CIPHER_PARAM_CTS_MODE) <UTF8 string>" +This is used by the RC5 cipher. +.IP """algorithm-id"" (\fBOSSL_CIPHER_PARAM_ALGORITHM_ID\fR) <octet string>" 4 +.IX Item """algorithm-id"" (OSSL_CIPHER_PARAM_ALGORITHM_ID) <octet string>" +Used to get the DER encoded AlgorithmIdentifier from the cipher +implementation. Functions like \fBEVP_PKEY_CTX_get_algor\fR\|(3) use this +parameter. +.IP """algorithm-id-params"" (\fBOSSL_CIPHER_PARAM_ALGORITHM_ID_PARAMS\fR) <octet string>" 4 +.IX Item """algorithm-id-params"" (OSSL_CIPHER_PARAM_ALGORITHM_ID_PARAMS) <octet string>" +Used to pass the DER encoded AlgorithmIdentifier parameter to or from +the cipher implementation. +Functions like \fBEVP_CIPHER_CTX_set_algor_params\fR\|(3) and +\&\fBEVP_CIPHER_CTX_get_algor_params\fR\|(3) use this parameter. +.IP """alg_id_params"" (\fBOSSL_CIPHER_PARAM_ALGORITHM_ID_PARAMS_OLD\fR) <octet string>" 4 +.IX Item """alg_id_params"" (OSSL_CIPHER_PARAM_ALGORITHM_ID_PARAMS_OLD) <octet string>" +An deprecated alias for "algorithm-id-params", only used by +\&\fBEVP_CIPHER_param_to_asn1\fR\|(3) and \fBEVP_CIPHER_asn1_to_param\fR\|(3). +.IP """cts_mode"" (\fBOSSL_CIPHER_PARAM_CTS_MODE\fR) <UTF8 string>" 4 +.IX Item """cts_mode"" (OSSL_CIPHER_PARAM_CTS_MODE) <UTF8 string>" Gets or sets the cipher text stealing mode. For all modes the output size is the same as the input size. The input length must be greater than or equal to the -block size. (The block size for \s-1AES\s0 and \s-1CAMELLIA\s0 is 16 bytes). +block size. (The block size for AES and CAMELLIA is 16 bytes). .Sp Valid values for the mode are: .RS 4 -.ie n .IP """\s-1CS1""\s0" 4 -.el .IP "``\s-1CS1''\s0" 4 -.IX Item "CS1" -The \s-1NIST\s0 variant of cipher text stealing. +.IP """CS1""" 4 +.IX Item """CS1""" +The NIST variant of cipher text stealing. For input lengths that are multiples of the block size it is equivalent to -using a \*(L"AES-XXX-CBC\*(R" or \*(L"CAMELLIA-XXX-CBC\*(R" cipher otherwise the second last +using a "AES-XXX-CBC" or "CAMELLIA-XXX-CBC" cipher otherwise the second last cipher text block is a partial block. -.ie n .IP """\s-1CS2""\s0" 4 -.el .IP "``\s-1CS2''\s0" 4 -.IX Item "CS2" +.IP """CS2""" 4 +.IX Item """CS2""" For input lengths that are multiples of the block size it is equivalent to -using a \*(L"AES-XXX-CBC\*(R" or \*(L"CAMELLIA-XXX-CBC\*(R" cipher, otherwise it is the same as -\&\*(L"\s-1CS3\*(R"\s0 mode. -.ie n .IP """\s-1CS3""\s0" 4 -.el .IP "``\s-1CS3''\s0" 4 -.IX Item "CS3" +using a "AES-XXX-CBC" or "CAMELLIA-XXX-CBC" cipher, otherwise it is the same as +"CS3" mode. +.IP """CS3""" 4 +.IX Item """CS3""" The Kerberos5 variant of cipher text stealing which always swaps the last cipher text block with the previous block (which may be a partial or full block depending on the input length). If the input length is exactly one full block -then this is equivalent to using a \*(L"AES-XXX-CBC\*(R" or \*(L"CAMELLIA-XXX-CBC\*(R" cipher. +then this is equivalent to using a "AES-XXX-CBC" or "CAMELLIA-XXX-CBC" cipher. .RE .RS 4 .Sp -The default is \*(L"\s-1CS1\*(R".\s0 -This is only supported for \*(L"\s-1AES\-128\-CBC\-CTS\*(R", \*(L"AES\-192\-CBC\-CTS\*(R", \*(L"AES\-256\-CBC\-CTS\*(R", -\&\*(L"CAMELLIA\-128\-CBC\-CTS\*(R", \*(L"CAMELLIA\-192\-CBC\-CTS\*(R"\s0 and \*(L"\s-1CAMELLIA\-256\-CBC\-CTS\*(R".\s0 +The default is "CS1". +This is only supported for "AES\-128\-CBC\-CTS", "AES\-192\-CBC\-CTS", "AES\-256\-CBC\-CTS", +"CAMELLIA\-128\-CBC\-CTS", "CAMELLIA\-192\-CBC\-CTS" and "CAMELLIA\-256\-CBC\-CTS". .RE -.ie n .IP """tls1multi_interleave"" (\fB\s-1OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_INTERLEAVE\s0\fR) <unsigned integer>" 4 -.el .IP "``tls1multi_interleave'' (\fB\s-1OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_INTERLEAVE\s0\fR) <unsigned integer>" 4 -.IX Item "tls1multi_interleave (OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_INTERLEAVE) <unsigned integer>" +.IP """tls1multi_interleave"" (\fBOSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_INTERLEAVE\fR) <unsigned integer>" 4 +.IX Item """tls1multi_interleave"" (OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_INTERLEAVE) <unsigned integer>" Sets or gets the number of records being sent in one go for a tls1 multiblock cipher operation (either 4 or 8 records). -.SS "Gettable \s-1EVP_CIPHER_CTX\s0 parameters" +.SS "Gettable EVP_CIPHER_CTX parameters" .IX Subsection "Gettable EVP_CIPHER_CTX parameters" -The following \s-1\fBOSSL_PARAM\s0\fR\|(3) keys can be used with \fBEVP_CIPHER_CTX_get_params()\fR: -.ie n .IP """ivlen"" (\fB\s-1OSSL_CIPHER_PARAM_IVLEN\s0\fR and <\fB\s-1OSSL_CIPHER_PARAM_AEAD_IVLEN\s0\fR) <unsigned integer>" 4 -.el .IP "``ivlen'' (\fB\s-1OSSL_CIPHER_PARAM_IVLEN\s0\fR and <\fB\s-1OSSL_CIPHER_PARAM_AEAD_IVLEN\s0\fR) <unsigned integer>" 4 -.IX Item "ivlen (OSSL_CIPHER_PARAM_IVLEN and <OSSL_CIPHER_PARAM_AEAD_IVLEN) <unsigned integer>" -Gets the \s-1IV\s0 length for the cipher context \fIctx\fR. -The length of the \*(L"ivlen\*(R" parameter should not exceed that of a \fBsize_t\fR. +The following \fBOSSL_PARAM\fR\|(3) keys can be used with \fBEVP_CIPHER_CTX_get_params()\fR: +.IP """ivlen"" (\fBOSSL_CIPHER_PARAM_IVLEN\fR and <\fBOSSL_CIPHER_PARAM_AEAD_IVLEN\fR) <unsigned integer>" 4 +.IX Item """ivlen"" (OSSL_CIPHER_PARAM_IVLEN and <OSSL_CIPHER_PARAM_AEAD_IVLEN) <unsigned integer>" +Gets the IV length for the cipher context \fIctx\fR. +The length of the "ivlen" parameter should not exceed that of a \fBsize_t\fR. See also \fBEVP_CIPHER_CTX_get_iv_length()\fR. -.ie n .IP """iv"" (\fB\s-1OSSL_CIPHER_PARAM_IV\s0\fR) <octet string \s-1OR\s0 octet ptr>" 4 -.el .IP "``iv'' (\fB\s-1OSSL_CIPHER_PARAM_IV\s0\fR) <octet string \s-1OR\s0 octet ptr>" 4 -.IX Item "iv (OSSL_CIPHER_PARAM_IV) <octet string OR octet ptr>" -Gets the \s-1IV\s0 used to initialize the associated cipher context \fIctx\fR. +.IP """iv"" (\fBOSSL_CIPHER_PARAM_IV\fR) <octet string OR octet ptr>" 4 +.IX Item """iv"" (OSSL_CIPHER_PARAM_IV) <octet string OR octet ptr>" +Gets the IV used to initialize the associated cipher context \fIctx\fR. See also \fBEVP_CIPHER_CTX_get_original_iv()\fR. -.ie n .IP """updated-iv"" (\fB\s-1OSSL_CIPHER_PARAM_UPDATED_IV\s0\fR) <octet string \s-1OR\s0 octet ptr>" 4 -.el .IP "``updated-iv'' (\fB\s-1OSSL_CIPHER_PARAM_UPDATED_IV\s0\fR) <octet string \s-1OR\s0 octet ptr>" 4 -.IX Item "updated-iv (OSSL_CIPHER_PARAM_UPDATED_IV) <octet string OR octet ptr>" +.IP """updated-iv"" (\fBOSSL_CIPHER_PARAM_UPDATED_IV\fR) <octet string OR octet ptr>" 4 +.IX Item """updated-iv"" (OSSL_CIPHER_PARAM_UPDATED_IV) <octet string OR octet ptr>" Gets the updated pseudo-IV state for the associated cipher context, e.g., -the previous ciphertext block for \s-1CBC\s0 mode or the iteratively encrypted \s-1IV\s0 -value for \s-1OFB\s0 mode. Note that octet pointer access is deprecated and is +the previous ciphertext block for CBC mode or the iteratively encrypted IV +value for OFB mode. Note that octet pointer access is deprecated and is provided only for backwards compatibility with historical libcrypto APIs. See also \fBEVP_CIPHER_CTX_get_updated_iv()\fR. -.ie n .IP """randkey"" (\fB\s-1OSSL_CIPHER_PARAM_RANDOM_KEY\s0\fR) <octet string>" 4 -.el .IP "``randkey'' (\fB\s-1OSSL_CIPHER_PARAM_RANDOM_KEY\s0\fR) <octet string>" 4 -.IX Item "randkey (OSSL_CIPHER_PARAM_RANDOM_KEY) <octet string>" +.IP """randkey"" (\fBOSSL_CIPHER_PARAM_RANDOM_KEY\fR) <octet string>" 4 +.IX Item """randkey"" (OSSL_CIPHER_PARAM_RANDOM_KEY) <octet string>" Gets an implementation specific randomly generated key for the associated -cipher context \fIctx\fR. This is currently only supported by \s-1DES\s0 and 3DES (which set +cipher context \fIctx\fR. This is currently only supported by DES and 3DES (which set the key to odd parity). -.ie n .IP """taglen"" (\fB\s-1OSSL_CIPHER_PARAM_AEAD_TAGLEN\s0\fR) <unsigned integer>" 4 -.el .IP "``taglen'' (\fB\s-1OSSL_CIPHER_PARAM_AEAD_TAGLEN\s0\fR) <unsigned integer>" 4 -.IX Item "taglen (OSSL_CIPHER_PARAM_AEAD_TAGLEN) <unsigned integer>" -Gets the tag length to be used for an \s-1AEAD\s0 cipher for the associated cipher +.IP """taglen"" (\fBOSSL_CIPHER_PARAM_AEAD_TAGLEN\fR) <unsigned integer>" 4 +.IX Item """taglen"" (OSSL_CIPHER_PARAM_AEAD_TAGLEN) <unsigned integer>" +Gets the tag length to be used for an AEAD cipher for the associated cipher context \fIctx\fR. It gets a default value if it has not been set. -The length of the \*(L"taglen\*(R" parameter should not exceed that of a \fBsize_t\fR. +The length of the "taglen" parameter should not exceed that of a \fBsize_t\fR. See also \fBEVP_CIPHER_CTX_get_tag_length()\fR. -.ie n .IP """tlsaadpad"" (\fB\s-1OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD\s0\fR) <unsigned integer>" 4 -.el .IP "``tlsaadpad'' (\fB\s-1OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD\s0\fR) <unsigned integer>" 4 -.IX Item "tlsaadpad (OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD) <unsigned integer>" -Gets the length of the tag that will be added to a \s-1TLS\s0 record for the \s-1AEAD\s0 +.IP """tlsaadpad"" (\fBOSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD\fR) <unsigned integer>" 4 +.IX Item """tlsaadpad"" (OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD) <unsigned integer>" +Gets the length of the tag that will be added to a TLS record for the AEAD tag for the associated cipher context \fIctx\fR. -The length of the \*(L"tlsaadpad\*(R" parameter should not exceed that of a \fBsize_t\fR. -.ie n .IP """tlsivgen"" (\fB\s-1OSSL_CIPHER_PARAM_AEAD_TLS1_GET_IV_GEN\s0\fR) <octet string>" 4 -.el .IP "``tlsivgen'' (\fB\s-1OSSL_CIPHER_PARAM_AEAD_TLS1_GET_IV_GEN\s0\fR) <octet string>" 4 -.IX Item "tlsivgen (OSSL_CIPHER_PARAM_AEAD_TLS1_GET_IV_GEN) <octet string>" +The length of the "tlsaadpad" parameter should not exceed that of a \fBsize_t\fR. +.IP """tlsivgen"" (\fBOSSL_CIPHER_PARAM_AEAD_TLS1_GET_IV_GEN\fR) <octet string>" 4 +.IX Item """tlsivgen"" (OSSL_CIPHER_PARAM_AEAD_TLS1_GET_IV_GEN) <octet string>" Gets the invocation field generated for encryption. -Can only be called after \*(L"tlsivfixed\*(R" is set. -This is only used for \s-1GCM\s0 mode. -.ie n .IP """tls1multi_enclen"" (\fB\s-1OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC_LEN\s0\fR) <unsigned integer>" 4 -.el .IP "``tls1multi_enclen'' (\fB\s-1OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC_LEN\s0\fR) <unsigned integer>" 4 -.IX Item "tls1multi_enclen (OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC_LEN) <unsigned integer>" -Get the total length of the record returned from the \*(L"tls1multi_enc\*(R" operation. -.ie n .IP """tls1multi_maxbufsz"" (\fB\s-1OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_MAX_BUFSIZE\s0\fR) <unsigned integer>" 4 -.el .IP "``tls1multi_maxbufsz'' (\fB\s-1OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_MAX_BUFSIZE\s0\fR) <unsigned integer>" 4 -.IX Item "tls1multi_maxbufsz (OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_MAX_BUFSIZE) <unsigned integer>" -Gets the maximum record length for a \s-1TLS1\s0 multiblock cipher operation. -The length of the \*(L"tls1multi_maxbufsz\*(R" parameter should not exceed that of a \fBsize_t\fR. -.ie n .IP """tls1multi_aadpacklen"" (\fB\s-1OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_AAD_PACKLEN\s0\fR) <unsigned integer>" 4 -.el .IP "``tls1multi_aadpacklen'' (\fB\s-1OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_AAD_PACKLEN\s0\fR) <unsigned integer>" 4 -.IX Item "tls1multi_aadpacklen (OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_AAD_PACKLEN) <unsigned integer>" -Gets the result of running the \*(L"tls1multi_aad\*(R" operation. -.ie n .IP """tls-mac"" (\fB\s-1OSSL_CIPHER_PARAM_TLS_MAC\s0\fR) <octet ptr>" 4 -.el .IP "``tls-mac'' (\fB\s-1OSSL_CIPHER_PARAM_TLS_MAC\s0\fR) <octet ptr>" 4 -.IX Item "tls-mac (OSSL_CIPHER_PARAM_TLS_MAC) <octet ptr>" -Used to pass the \s-1TLS MAC\s0 data. -.SS "Settable \s-1EVP_CIPHER_CTX\s0 parameters" +Can only be called after "tlsivfixed" is set. +This is only used for GCM mode. +.IP """tls1multi_enclen"" (\fBOSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC_LEN\fR) <unsigned integer>" 4 +.IX Item """tls1multi_enclen"" (OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC_LEN) <unsigned integer>" +Get the total length of the record returned from the "tls1multi_enc" operation. +.IP """tls1multi_maxbufsz"" (\fBOSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_MAX_BUFSIZE\fR) <unsigned integer>" 4 +.IX Item """tls1multi_maxbufsz"" (OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_MAX_BUFSIZE) <unsigned integer>" +Gets the maximum record length for a TLS1 multiblock cipher operation. +The length of the "tls1multi_maxbufsz" parameter should not exceed that of a \fBsize_t\fR. +.IP """tls1multi_aadpacklen"" (\fBOSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_AAD_PACKLEN\fR) <unsigned integer>" 4 +.IX Item """tls1multi_aadpacklen"" (OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_AAD_PACKLEN) <unsigned integer>" +Gets the result of running the "tls1multi_aad" operation. +.IP """tls-mac"" (\fBOSSL_CIPHER_PARAM_TLS_MAC\fR) <octet ptr>" 4 +.IX Item """tls-mac"" (OSSL_CIPHER_PARAM_TLS_MAC) <octet ptr>" +Used to pass the TLS MAC data. +.IP """fips-indicator"" (\fBOSSL_CIPHER_PARAM_FIPS_APPROVED_INDICATOR\fR) <integer>" 4 +.IX Item """fips-indicator"" (OSSL_CIPHER_PARAM_FIPS_APPROVED_INDICATOR) <integer>" +This option is used by the OpenSSL FIPS provider. +.Sp +A getter that returns 1 if the operation is FIPS approved, or 0 otherwise. +This may be used after calling a cipher final operation such as +\&\fBEVP_EncryptFinal_ex()\fR. It may return 0 if the "encrypt-check" option is set to 0. +.IP """iv-generated"" (\fBOSSL_CIPHER_PARAM_AEAD_IV_GENERATED\fR) <unsigned integer>" 4 +.IX Item """iv-generated"" (OSSL_CIPHER_PARAM_AEAD_IV_GENERATED) <unsigned integer>" +An indicator that returns 1 if an IV was generated internally during encryption, +or O otherwise. +This may be used by GCM ciphers after calling a cipher final operation such +as \fBEVP_EncryptFinal_ex()\fR. +GCM should generate an IV internally if the IV is not specified during a +cipher initialisation call such as \fBEVP_CipherInit_ex()\fR. +See FIPS 140\-3 IG C.H for information related to IV requirements. +.SS "Settable EVP_CIPHER_CTX parameters" .IX Subsection "Settable EVP_CIPHER_CTX parameters" -The following \s-1\fBOSSL_PARAM\s0\fR\|(3) keys can be used with \fBEVP_CIPHER_CTX_set_params()\fR: -.ie n .IP """mackey"" (\fB\s-1OSSL_CIPHER_PARAM_AEAD_MAC_KEY\s0\fR) <octet string>" 4 -.el .IP "``mackey'' (\fB\s-1OSSL_CIPHER_PARAM_AEAD_MAC_KEY\s0\fR) <octet string>" 4 -.IX Item "mackey (OSSL_CIPHER_PARAM_AEAD_MAC_KEY) <octet string>" -Sets the \s-1MAC\s0 key used by composite \s-1AEAD\s0 ciphers such as \s-1AES\-CBC\-HMAC\-SHA256.\s0 -.ie n .IP """speed"" (\fB\s-1OSSL_CIPHER_PARAM_SPEED\s0\fR) <unsigned integer>" 4 -.el .IP "``speed'' (\fB\s-1OSSL_CIPHER_PARAM_SPEED\s0\fR) <unsigned integer>" 4 -.IX Item "speed (OSSL_CIPHER_PARAM_SPEED) <unsigned integer>" +The following \fBOSSL_PARAM\fR\|(3) keys can be used with \fBEVP_CIPHER_CTX_set_params()\fR: +.IP """mackey"" (\fBOSSL_CIPHER_PARAM_AEAD_MAC_KEY\fR) <octet string>" 4 +.IX Item """mackey"" (OSSL_CIPHER_PARAM_AEAD_MAC_KEY) <octet string>" +Sets the MAC key used by composite AEAD ciphers such as AES\-CBC\-HMAC\-SHA256. +.IP """speed"" (\fBOSSL_CIPHER_PARAM_SPEED\fR) <unsigned integer>" 4 +.IX Item """speed"" (OSSL_CIPHER_PARAM_SPEED) <unsigned integer>" Sets the speed option for the associated cipher context. This is only supported -by \s-1AES SIV\s0 ciphers which disallow multiple operations by default. -Setting \*(L"speed\*(R" to 1 allows another encrypt or decrypt operation to be +by AES SIV ciphers which disallow multiple operations by default. +Setting "speed" to 1 allows another encrypt or decrypt operation to be performed. This is used for performance testing. -.ie n .IP """use-bits"" (\fB\s-1OSSL_CIPHER_PARAM_USE_BITS\s0\fR) <unsigned integer>" 4 -.el .IP "``use-bits'' (\fB\s-1OSSL_CIPHER_PARAM_USE_BITS\s0\fR) <unsigned integer>" 4 -.IX Item "use-bits (OSSL_CIPHER_PARAM_USE_BITS) <unsigned integer>" +.IP """use-bits"" (\fBOSSL_CIPHER_PARAM_USE_BITS\fR) <unsigned integer>" 4 +.IX Item """use-bits"" (OSSL_CIPHER_PARAM_USE_BITS) <unsigned integer>" Determines if the input length \fIinl\fR passed to \fBEVP_EncryptUpdate()\fR, \&\fBEVP_DecryptUpdate()\fR and \fBEVP_CipherUpdate()\fR is the number of bits or number of bytes. -Setting \*(L"use-bits\*(R" to 1 uses bits. The default is in bytes. -This is only used for \fB\s-1CFB1\s0\fR ciphers. +Setting "use-bits" to 1 uses bits. The default is in bytes. +This is only used for \fBCFB1\fR ciphers. .Sp -This can be set using EVP_CIPHER_CTX_set_flags(ctx, \s-1EVP_CIPH_FLAG_LENGTH_BITS\s0). -.ie n .IP """tls-version"" (\fB\s-1OSSL_CIPHER_PARAM_TLS_VERSION\s0\fR) <integer>" 4 -.el .IP "``tls-version'' (\fB\s-1OSSL_CIPHER_PARAM_TLS_VERSION\s0\fR) <integer>" 4 -.IX Item "tls-version (OSSL_CIPHER_PARAM_TLS_VERSION) <integer>" -Sets the \s-1TLS\s0 version. -.ie n .IP """tls-mac-size"" (\fB\s-1OSSL_CIPHER_PARAM_TLS_MAC_SIZE\s0\fR) <unsigned integer>" 4 -.el .IP "``tls-mac-size'' (\fB\s-1OSSL_CIPHER_PARAM_TLS_MAC_SIZE\s0\fR) <unsigned integer>" 4 -.IX Item "tls-mac-size (OSSL_CIPHER_PARAM_TLS_MAC_SIZE) <unsigned integer>" -Set the \s-1TLS MAC\s0 size. -.ie n .IP """tlsaad"" (\fB\s-1OSSL_CIPHER_PARAM_AEAD_TLS1_AAD\s0\fR) <octet string>" 4 -.el .IP "``tlsaad'' (\fB\s-1OSSL_CIPHER_PARAM_AEAD_TLS1_AAD\s0\fR) <octet string>" 4 -.IX Item "tlsaad (OSSL_CIPHER_PARAM_AEAD_TLS1_AAD) <octet string>" -Sets TLSv1.2 \s-1AAD\s0 information for the associated cipher context \fIctx\fR. -TLSv1.2 \s-1AAD\s0 information is always 13 bytes in length and is as defined for the -\&\*(L"additional_data\*(R" field described in section 6.2.3.3 of \s-1RFC5246.\s0 -.ie n .IP """tlsivfixed"" (\fB\s-1OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED\s0\fR) <octet string>" 4 -.el .IP "``tlsivfixed'' (\fB\s-1OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED\s0\fR) <octet string>" 4 -.IX Item "tlsivfixed (OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED) <octet string>" -Sets the fixed portion of an \s-1IV\s0 for an \s-1AEAD\s0 cipher used in a \s-1TLS\s0 record +This can be set using EVP_CIPHER_CTX_set_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS). +.IP """tls-version"" (\fBOSSL_CIPHER_PARAM_TLS_VERSION\fR) <integer>" 4 +.IX Item """tls-version"" (OSSL_CIPHER_PARAM_TLS_VERSION) <integer>" +Sets the TLS version. +.IP """tls-mac-size"" (\fBOSSL_CIPHER_PARAM_TLS_MAC_SIZE\fR) <unsigned integer>" 4 +.IX Item """tls-mac-size"" (OSSL_CIPHER_PARAM_TLS_MAC_SIZE) <unsigned integer>" +Set the TLS MAC size. +.IP """tlsaad"" (\fBOSSL_CIPHER_PARAM_AEAD_TLS1_AAD\fR) <octet string>" 4 +.IX Item """tlsaad"" (OSSL_CIPHER_PARAM_AEAD_TLS1_AAD) <octet string>" +Sets TLSv1.2 AAD information for the associated cipher context \fIctx\fR. +TLSv1.2 AAD information is always 13 bytes in length and is as defined for the +"additional_data" field described in section 6.2.3.3 of RFC5246. +.IP """tlsivfixed"" (\fBOSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED\fR) <octet string>" 4 +.IX Item """tlsivfixed"" (OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED) <octet string>" +Sets the fixed portion of an IV for an AEAD cipher used in a TLS record encryption/ decryption for the associated cipher context. -\&\s-1TLS\s0 record encryption/decryption always occurs \*(L"in place\*(R" so that the input and +TLS record encryption/decryption always occurs "in place" so that the input and output buffers are always the same memory location. -\&\s-1AEAD\s0 IVs in TLSv1.2 consist of an implicit \*(L"fixed\*(R" part and an explicit part +AEAD IVs in TLSv1.2 consist of an implicit "fixed" part and an explicit part that varies with every record. -Setting a \s-1TLS\s0 fixed \s-1IV\s0 changes a cipher to encrypt/decrypt \s-1TLS\s0 records. -\&\s-1TLS\s0 records are encrypted/decrypted using a single OSSL_FUNC_cipher_cipher call per +Setting a TLS fixed IV changes a cipher to encrypt/decrypt TLS records. +TLS records are encrypted/decrypted using a single OSSL_FUNC_cipher_cipher call per record. For a record decryption the first bytes of the input buffer will be the explicit -part of the \s-1IV\s0 and the final bytes of the input buffer will be the \s-1AEAD\s0 tag. -The length of the explicit part of the \s-1IV\s0 and the tag length will depend on the -cipher in use and will be defined in the \s-1RFC\s0 for the relevant ciphersuite. -In order to allow for \*(L"in place\*(R" decryption the plaintext output should be +part of the IV and the final bytes of the input buffer will be the AEAD tag. +The length of the explicit part of the IV and the tag length will depend on the +cipher in use and will be defined in the RFC for the relevant ciphersuite. +In order to allow for "in place" decryption the plaintext output should be written to the same location in the output buffer that the ciphertext payload -was read from, i.e. immediately after the explicit \s-1IV.\s0 +was read from, i.e. immediately after the explicit IV. .Sp When encrypting a record the first bytes of the input buffer should be empty to -allow space for the explicit \s-1IV,\s0 as will the final bytes where the tag will +allow space for the explicit IV, as will the final bytes where the tag will be written. -The length of the input buffer will include the length of the explicit \s-1IV,\s0 the +The length of the input buffer will include the length of the explicit IV, the payload, and the tag bytes. -The cipher implementation should generate the explicit \s-1IV\s0 and write it to the -beginning of the output buffer, do \*(L"in place\*(R" encryption of the payload and +The cipher implementation should generate the explicit IV and write it to the +beginning of the output buffer, do "in place" encryption of the payload and write that to the output buffer, and finally add the tag onto the end of the output buffer. .Sp Whether encrypting or decrypting the value written to \fI*outl\fR in the OSSL_FUNC_cipher_cipher call should be the length of the payload excluding the explicit -\&\s-1IV\s0 length and the tag length. -.ie n .IP """tlsivinv"" (\fB\s-1OSSL_CIPHER_PARAM_AEAD_TLS1_SET_IV_INV\s0\fR) <octet string>" 4 -.el .IP "``tlsivinv'' (\fB\s-1OSSL_CIPHER_PARAM_AEAD_TLS1_SET_IV_INV\s0\fR) <octet string>" 4 -.IX Item "tlsivinv (OSSL_CIPHER_PARAM_AEAD_TLS1_SET_IV_INV) <octet string>" +IV length and the tag length. +.IP """tlsivinv"" (\fBOSSL_CIPHER_PARAM_AEAD_TLS1_SET_IV_INV\fR) <octet string>" 4 +.IX Item """tlsivinv"" (OSSL_CIPHER_PARAM_AEAD_TLS1_SET_IV_INV) <octet string>" Sets the invocation field used for decryption. -Can only be called after \*(L"tlsivfixed\*(R" is set. -This is only used for \s-1GCM\s0 mode. -.ie n .IP """tls1multi_enc"" (\fB\s-1OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC\s0\fR) <octet string>" 4 -.el .IP "``tls1multi_enc'' (\fB\s-1OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC\s0\fR) <octet string>" 4 -.IX Item "tls1multi_enc (OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC) <octet string>" -Triggers a multiblock \s-1TLS1\s0 encrypt operation for a \s-1TLS1\s0 aware cipher that +Can only be called after "tlsivfixed" is set. +This is only used for GCM mode. +.IP """tls1multi_enc"" (\fBOSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC\fR) <octet string>" 4 +.IX Item """tls1multi_enc"" (OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC) <octet string>" +Triggers a multiblock TLS1 encrypt operation for a TLS1 aware cipher that supports sending 4 or 8 records in one go. -The cipher performs both the \s-1MAC\s0 and encrypt stages and constructs the record +The cipher performs both the MAC and encrypt stages and constructs the record headers itself. -\&\*(L"tls1multi_enc\*(R" supplies the output buffer for the encrypt operation, -\&\*(L"tls1multi_encin\*(R" & \*(L"tls1multi_interleave\*(R" must also be set in order to supply +"tls1multi_enc" supplies the output buffer for the encrypt operation, +"tls1multi_encin" & "tls1multi_interleave" must also be set in order to supply values to the encrypt operation. -.ie n .IP """tls1multi_encin"" (\fB\s-1OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC_IN\s0\fR) <octet string>" 4 -.el .IP "``tls1multi_encin'' (\fB\s-1OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC_IN\s0\fR) <octet string>" 4 -.IX Item "tls1multi_encin (OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC_IN) <octet string>" -Supplies the data to encrypt for a \s-1TLS1\s0 multiblock cipher operation. -.ie n .IP """tls1multi_maxsndfrag"" (\fB\s-1OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_MAX_SEND_FRAGMENT\s0\fR) <unsigned integer>" 4 -.el .IP "``tls1multi_maxsndfrag'' (\fB\s-1OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_MAX_SEND_FRAGMENT\s0\fR) <unsigned integer>" 4 -.IX Item "tls1multi_maxsndfrag (OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_MAX_SEND_FRAGMENT) <unsigned integer>" -Sets the maximum send fragment size for a \s-1TLS1\s0 multiblock cipher operation. -It must be set before using \*(L"tls1multi_maxbufsz\*(R". -The length of the \*(L"tls1multi_maxsndfrag\*(R" parameter should not exceed that of a \fBsize_t\fR. -.ie n .IP """tls1multi_aad"" (\fB\s-1OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_AAD\s0\fR) <octet string>" 4 -.el .IP "``tls1multi_aad'' (\fB\s-1OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_AAD\s0\fR) <octet string>" 4 -.IX Item "tls1multi_aad (OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_AAD) <octet string>" -Sets the authenticated additional data used by a \s-1TLS1\s0 multiblock cipher operation. +.IP """tls1multi_encin"" (\fBOSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC_IN\fR) <octet string>" 4 +.IX Item """tls1multi_encin"" (OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC_IN) <octet string>" +Supplies the data to encrypt for a TLS1 multiblock cipher operation. +.IP """tls1multi_maxsndfrag"" (\fBOSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_MAX_SEND_FRAGMENT\fR) <unsigned integer>" 4 +.IX Item """tls1multi_maxsndfrag"" (OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_MAX_SEND_FRAGMENT) <unsigned integer>" +Sets the maximum send fragment size for a TLS1 multiblock cipher operation. +It must be set before using "tls1multi_maxbufsz". +The length of the "tls1multi_maxsndfrag" parameter should not exceed that of a \fBsize_t\fR. +.IP """tls1multi_aad"" (\fBOSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_AAD\fR) <octet string>" 4 +.IX Item """tls1multi_aad"" (OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_AAD) <octet string>" +Sets the authenticated additional data used by a TLS1 multiblock cipher operation. The supplied data consists of 13 bytes of record data containing: Bytes 0\-7: The sequence number of the first record Byte 8: The record type Byte 9\-10: The protocol version Byte 11\-12: Input length (Always 0) .Sp -\&\*(L"tls1multi_interleave\*(R" must also be set for this operation. -.SH "CONTROLS" +"tls1multi_interleave" must also be set for this operation. +.IP """xts_standard"" (\fBOSSL_CIPHER_PARAM_XTS_STANDARD\fR) <UTF8 string>" 4 +.IX Item """xts_standard"" (OSSL_CIPHER_PARAM_XTS_STANDARD) <UTF8 string>" +Sets the XTS standard to use with SM4\-XTS algorithm. XTS mode has two +implementations, one is standardized in IEEE Std. 1619\-2007 and has +been widely used (e.g., XTS AES), the other is proposed recently +(GB/T 17964\-2021 implemented in May 2022) and is currently only used +in SM4. +.Sp +The main difference between them is the multiplication by the +primitive element α to calculate the tweak values. The IEEE +Std 1619\-2007 noted that the multiplication "is a left shift of each +byte by one bit with carry propagating from one byte to the next +one", which means that in each byte, the leftmost bit is the most +significant bit. But in GB/T 17964\-2021, the rightmost bit is the +most significant bit, thus the multiplication becomes a right shift +of each byte by one bit with carry propagating from one byte to the +next one. +.Sp +Valid values for the mode are: +.RS 4 +.IP """GB""" 4 +.IX Item """GB""" +The GB/T 17964\-2021 variant of SM4\-XTS algorithm. +.IP """IEEE""" 4 +.IX Item """IEEE""" +The IEEE Std. 1619\-2007 variant of SM4\-XTS algorithm. +.RE +.RS 4 +.Sp +The default value is "GB". +.RE +.IP """encrypt-check"" (\fBOSSL_CIPHER_PARAM_FIPS_ENCRYPT_CHECK\fR) <integer>" 4 +.IX Item """encrypt-check"" (OSSL_CIPHER_PARAM_FIPS_ENCRYPT_CHECK) <integer>" +This option is used by the OpenSSL FIPS provider. +.Sp +If required this parameter should be set early via an cipher encrypt init +function such as \fBEVP_EncryptInit_ex2()\fR. +The default value of 1 causes an error when an encryption operation is triggered. +Setting this to 0 will ignore the error and set the approved "fips-indicator" to +0. +This option breaks FIPS compliance if it causes the approved "fips-indicator" +to return 0. +.SH CONTROLS .IX Header "CONTROLS" -The Mappings from \fBEVP_CIPHER_CTX_ctrl()\fR identifiers to \s-1PARAMETERS\s0 are listed -in the following section. See the \*(L"\s-1PARAMETERS\*(R"\s0 section for more details. +The Mappings from \fBEVP_CIPHER_CTX_ctrl()\fR identifiers to PARAMETERS are listed +in the following section. See the "PARAMETERS" section for more details. .PP \&\fBEVP_CIPHER_CTX_ctrl()\fR can be used to send the following standard controls: -.IP "\s-1EVP_CTRL_AEAD_SET_IVLEN\s0 and \s-1EVP_CTRL_GET_IVLEN\s0" 4 +.IP "EVP_CTRL_AEAD_SET_IVLEN and EVP_CTRL_GET_IVLEN" 4 .IX Item "EVP_CTRL_AEAD_SET_IVLEN and EVP_CTRL_GET_IVLEN" -When used with a fetched \fB\s-1EVP_CIPHER\s0\fR, \fBEVP_CIPHER_CTX_set_params()\fR and -\&\fBEVP_CIPHER_CTX_get_params()\fR get called with an \s-1\fBOSSL_PARAM\s0\fR\|(3) item with the -key \*(L"ivlen\*(R" (\fB\s-1OSSL_CIPHER_PARAM_IVLEN\s0\fR). -.IP "\s-1EVP_CTRL_AEAD_SET_IV_FIXED\s0" 4 +When used with a fetched \fBEVP_CIPHER\fR, \fBEVP_CIPHER_CTX_set_params()\fR and +\&\fBEVP_CIPHER_CTX_get_params()\fR get called with an \fBOSSL_PARAM\fR\|(3) item with the +key "ivlen" (\fBOSSL_CIPHER_PARAM_IVLEN\fR). +.IP EVP_CTRL_AEAD_SET_IV_FIXED 4 .IX Item "EVP_CTRL_AEAD_SET_IV_FIXED" -When used with a fetched \fB\s-1EVP_CIPHER\s0\fR, \fBEVP_CIPHER_CTX_set_params()\fR gets called -with an \s-1\fBOSSL_PARAM\s0\fR\|(3) item with the key \*(L"tlsivfixed\*(R" -(\fB\s-1OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED\s0\fR). -.IP "\s-1EVP_CTRL_AEAD_SET_MAC_KEY\s0" 4 +When used with a fetched \fBEVP_CIPHER\fR, \fBEVP_CIPHER_CTX_set_params()\fR gets called +with an \fBOSSL_PARAM\fR\|(3) item with the key "tlsivfixed" +(\fBOSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED\fR). +.IP EVP_CTRL_AEAD_SET_MAC_KEY 4 .IX Item "EVP_CTRL_AEAD_SET_MAC_KEY" -When used with a fetched \fB\s-1EVP_CIPHER\s0\fR, \fBEVP_CIPHER_CTX_set_params()\fR gets called -with an \s-1\fBOSSL_PARAM\s0\fR\|(3) item with the key \*(L"mackey\*(R" -(\fB\s-1OSSL_CIPHER_PARAM_AEAD_MAC_KEY\s0\fR). -.IP "\s-1EVP_CTRL_AEAD_SET_TAG\s0 and \s-1EVP_CTRL_AEAD_GET_TAG\s0" 4 +When used with a fetched \fBEVP_CIPHER\fR, \fBEVP_CIPHER_CTX_set_params()\fR gets called +with an \fBOSSL_PARAM\fR\|(3) item with the key "mackey" +(\fBOSSL_CIPHER_PARAM_AEAD_MAC_KEY\fR). +.IP "EVP_CTRL_AEAD_SET_TAG and EVP_CTRL_AEAD_GET_TAG" 4 .IX Item "EVP_CTRL_AEAD_SET_TAG and EVP_CTRL_AEAD_GET_TAG" -When used with a fetched \fB\s-1EVP_CIPHER\s0\fR, \fBEVP_CIPHER_CTX_set_params()\fR and -\&\fBEVP_CIPHER_CTX_get_params()\fR get called with an \s-1\fBOSSL_PARAM\s0\fR\|(3) item with the -key \*(L"tag\*(R" (\fB\s-1OSSL_CIPHER_PARAM_AEAD_TAG\s0\fR). -.IP "\s-1EVP_CTRL_CCM_SET_L\s0" 4 +When used with a fetched \fBEVP_CIPHER\fR, \fBEVP_CIPHER_CTX_set_params()\fR and +\&\fBEVP_CIPHER_CTX_get_params()\fR get called with an \fBOSSL_PARAM\fR\|(3) item with the +key "tag" (\fBOSSL_CIPHER_PARAM_AEAD_TAG\fR). +.IP EVP_CTRL_CCM_SET_L 4 .IX Item "EVP_CTRL_CCM_SET_L" -When used with a fetched \fB\s-1EVP_CIPHER\s0\fR, \fBEVP_CIPHER_CTX_set_params()\fR gets called -with an \s-1\fBOSSL_PARAM\s0\fR\|(3) item with the key \*(L"ivlen\*(R" (\fB\s-1OSSL_CIPHER_PARAM_IVLEN\s0\fR) +When used with a fetched \fBEVP_CIPHER\fR, \fBEVP_CIPHER_CTX_set_params()\fR gets called +with an \fBOSSL_PARAM\fR\|(3) item with the key "ivlen" (\fBOSSL_CIPHER_PARAM_IVLEN\fR) with a value of (15 \- L) -.IP "\s-1EVP_CTRL_COPY\s0" 4 +.IP EVP_CTRL_COPY 4 .IX Item "EVP_CTRL_COPY" -There is no \s-1OSSL_PARAM\s0 mapping for this. Use \fBEVP_CIPHER_CTX_copy()\fR instead. -.IP "\s-1EVP_CTRL_GCM_SET_IV_INV\s0" 4 +There is no OSSL_PARAM mapping for this. Use \fBEVP_CIPHER_CTX_copy()\fR instead. +.IP EVP_CTRL_GCM_SET_IV_INV 4 .IX Item "EVP_CTRL_GCM_SET_IV_INV" -When used with a fetched \fB\s-1EVP_CIPHER\s0\fR, \fBEVP_CIPHER_CTX_set_params()\fR gets called -with an \s-1\fBOSSL_PARAM\s0\fR\|(3) item with the key \*(L"tlsivinv\*(R" -(\fB\s-1OSSL_CIPHER_PARAM_AEAD_TLS1_SET_IV_INV\s0\fR). -.IP "\s-1EVP_CTRL_RAND_KEY\s0" 4 +When used with a fetched \fBEVP_CIPHER\fR, \fBEVP_CIPHER_CTX_set_params()\fR gets called +with an \fBOSSL_PARAM\fR\|(3) item with the key "tlsivinv" +(\fBOSSL_CIPHER_PARAM_AEAD_TLS1_SET_IV_INV\fR). +.IP EVP_CTRL_RAND_KEY 4 .IX Item "EVP_CTRL_RAND_KEY" -When used with a fetched \fB\s-1EVP_CIPHER\s0\fR, \fBEVP_CIPHER_CTX_set_params()\fR gets called -with an \s-1\fBOSSL_PARAM\s0\fR\|(3) item with the key \*(L"randkey\*(R" -(\fB\s-1OSSL_CIPHER_PARAM_RANDOM_KEY\s0\fR). -.IP "\s-1EVP_CTRL_SET_KEY_LENGTH\s0" 4 +When used with a fetched \fBEVP_CIPHER\fR, \fBEVP_CIPHER_CTX_set_params()\fR gets called +with an \fBOSSL_PARAM\fR\|(3) item with the key "randkey" +(\fBOSSL_CIPHER_PARAM_RANDOM_KEY\fR). +.IP EVP_CTRL_SET_KEY_LENGTH 4 .IX Item "EVP_CTRL_SET_KEY_LENGTH" -When used with a fetched \fB\s-1EVP_CIPHER\s0\fR, \fBEVP_CIPHER_CTX_set_params()\fR gets called -with an \s-1\fBOSSL_PARAM\s0\fR\|(3) item with the key \*(L"keylen\*(R" (\fB\s-1OSSL_CIPHER_PARAM_KEYLEN\s0\fR). -.IP "\s-1EVP_CTRL_SET_RC2_KEY_BITS\s0 and \s-1EVP_CTRL_GET_RC2_KEY_BITS\s0" 4 +When used with a fetched \fBEVP_CIPHER\fR, \fBEVP_CIPHER_CTX_set_params()\fR gets called +with an \fBOSSL_PARAM\fR\|(3) item with the key "keylen" (\fBOSSL_CIPHER_PARAM_KEYLEN\fR). +.IP "EVP_CTRL_SET_RC2_KEY_BITS and EVP_CTRL_GET_RC2_KEY_BITS" 4 .IX Item "EVP_CTRL_SET_RC2_KEY_BITS and EVP_CTRL_GET_RC2_KEY_BITS" -When used with a fetched \fB\s-1EVP_CIPHER\s0\fR, \fBEVP_CIPHER_CTX_set_params()\fR and -\&\fBEVP_CIPHER_CTX_get_params()\fR get called with an \s-1\fBOSSL_PARAM\s0\fR\|(3) item with the -key \*(L"keybits\*(R" (\fB\s-1OSSL_CIPHER_PARAM_RC2_KEYBITS\s0\fR). -.IP "\s-1EVP_CTRL_SET_RC5_ROUNDS\s0 and \s-1EVP_CTRL_GET_RC5_ROUNDS\s0" 4 +When used with a fetched \fBEVP_CIPHER\fR, \fBEVP_CIPHER_CTX_set_params()\fR and +\&\fBEVP_CIPHER_CTX_get_params()\fR get called with an \fBOSSL_PARAM\fR\|(3) item with the +key "keybits" (\fBOSSL_CIPHER_PARAM_RC2_KEYBITS\fR). +.IP "EVP_CTRL_SET_RC5_ROUNDS and EVP_CTRL_GET_RC5_ROUNDS" 4 .IX Item "EVP_CTRL_SET_RC5_ROUNDS and EVP_CTRL_GET_RC5_ROUNDS" -When used with a fetched \fB\s-1EVP_CIPHER\s0\fR, \fBEVP_CIPHER_CTX_set_params()\fR and -\&\fBEVP_CIPHER_CTX_get_params()\fR get called with an \s-1\fBOSSL_PARAM\s0\fR\|(3) item with the -key \*(L"rounds\*(R" (\fB\s-1OSSL_CIPHER_PARAM_ROUNDS\s0\fR). -.IP "\s-1EVP_CTRL_SET_SPEED\s0" 4 +When used with a fetched \fBEVP_CIPHER\fR, \fBEVP_CIPHER_CTX_set_params()\fR and +\&\fBEVP_CIPHER_CTX_get_params()\fR get called with an \fBOSSL_PARAM\fR\|(3) item with the +key "rounds" (\fBOSSL_CIPHER_PARAM_ROUNDS\fR). +.IP EVP_CTRL_SET_SPEED 4 .IX Item "EVP_CTRL_SET_SPEED" -When used with a fetched \fB\s-1EVP_CIPHER\s0\fR, \fBEVP_CIPHER_CTX_set_params()\fR gets called -with an \s-1\fBOSSL_PARAM\s0\fR\|(3) item with the key \*(L"speed\*(R" (\fB\s-1OSSL_CIPHER_PARAM_SPEED\s0\fR). -.IP "\s-1EVP_CTRL_GCM_IV_GEN\s0" 4 +When used with a fetched \fBEVP_CIPHER\fR, \fBEVP_CIPHER_CTX_set_params()\fR gets called +with an \fBOSSL_PARAM\fR\|(3) item with the key "speed" (\fBOSSL_CIPHER_PARAM_SPEED\fR). +.IP EVP_CTRL_GCM_IV_GEN 4 .IX Item "EVP_CTRL_GCM_IV_GEN" -When used with a fetched \fB\s-1EVP_CIPHER\s0\fR, \fBEVP_CIPHER_CTX_get_params()\fR gets called -with an \s-1\fBOSSL_PARAM\s0\fR\|(3) item with the key -\&\*(L"tlsivgen\*(R" (\fB\s-1OSSL_CIPHER_PARAM_AEAD_TLS1_GET_IV_GEN\s0\fR). -.IP "\s-1EVP_CTRL_AEAD_TLS1_AAD\s0" 4 +When used with a fetched \fBEVP_CIPHER\fR, \fBEVP_CIPHER_CTX_get_params()\fR gets called +with an \fBOSSL_PARAM\fR\|(3) item with the key +"tlsivgen" (\fBOSSL_CIPHER_PARAM_AEAD_TLS1_GET_IV_GEN\fR). +.IP EVP_CTRL_AEAD_TLS1_AAD 4 .IX Item "EVP_CTRL_AEAD_TLS1_AAD" -When used with a fetched \fB\s-1EVP_CIPHER\s0\fR, \fBEVP_CIPHER_CTX_set_params()\fR get called -with an \s-1\fBOSSL_PARAM\s0\fR\|(3) item with the key -\&\*(L"tlsaad\*(R" (\fB\s-1OSSL_CIPHER_PARAM_AEAD_TLS1_AAD\s0\fR) +When used with a fetched \fBEVP_CIPHER\fR, \fBEVP_CIPHER_CTX_set_params()\fR get called +with an \fBOSSL_PARAM\fR\|(3) item with the key +"tlsaad" (\fBOSSL_CIPHER_PARAM_AEAD_TLS1_AAD\fR) followed by \fBEVP_CIPHER_CTX_get_params()\fR with a key of -\&\*(L"tlsaadpad\*(R" (\fB\s-1OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD\s0\fR). -.IP "\s-1EVP_CTRL_TLS1_1_MULTIBLOCK_MAX_BUFSIZE\s0" 4 +"tlsaadpad" (\fBOSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD\fR). +.IP EVP_CTRL_TLS1_1_MULTIBLOCK_MAX_BUFSIZE 4 .IX Item "EVP_CTRL_TLS1_1_MULTIBLOCK_MAX_BUFSIZE" -When used with a fetched \fB\s-1EVP_CIPHER\s0\fR, -\&\fBEVP_CIPHER_CTX_set_params()\fR gets called with an \s-1\fBOSSL_PARAM\s0\fR\|(3) item with the -key \s-1OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_MAX_SEND_FRAGMENT\s0 +When used with a fetched \fBEVP_CIPHER\fR, +\&\fBEVP_CIPHER_CTX_set_params()\fR gets called with an \fBOSSL_PARAM\fR\|(3) item with the +key OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_MAX_SEND_FRAGMENT followed by \fBEVP_CIPHER_CTX_get_params()\fR with a key of -\&\*(L"tls1multi_maxbufsz\*(R" (\fB\s-1OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_MAX_BUFSIZE\s0\fR). -.IP "\s-1EVP_CTRL_TLS1_1_MULTIBLOCK_AAD\s0" 4 +"tls1multi_maxbufsz" (\fBOSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_MAX_BUFSIZE\fR). +.IP EVP_CTRL_TLS1_1_MULTIBLOCK_AAD 4 .IX Item "EVP_CTRL_TLS1_1_MULTIBLOCK_AAD" -When used with a fetched \fB\s-1EVP_CIPHER\s0\fR, \fBEVP_CIPHER_CTX_set_params()\fR gets called -with \s-1\fBOSSL_PARAM\s0\fR\|(3) items with the keys -\&\*(L"tls1multi_aad\*(R" (\fB\s-1OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_AAD\s0\fR) and -\&\*(L"tls1multi_interleave\*(R" (\fB\s-1OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_INTERLEAVE\s0\fR) +When used with a fetched \fBEVP_CIPHER\fR, \fBEVP_CIPHER_CTX_set_params()\fR gets called +with \fBOSSL_PARAM\fR\|(3) items with the keys +"tls1multi_aad" (\fBOSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_AAD\fR) and +"tls1multi_interleave" (\fBOSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_INTERLEAVE\fR) followed by \fBEVP_CIPHER_CTX_get_params()\fR with keys of -\&\*(L"tls1multi_aadpacklen\*(R" (\fB\s-1OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_AAD_PACKLEN\s0\fR) and -\&\*(L"tls1multi_interleave\*(R" (\fB\s-1OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_INTERLEAVE\s0\fR). -.IP "\s-1EVP_CTRL_TLS1_1_MULTIBLOCK_ENCRYPT\s0" 4 +"tls1multi_aadpacklen" (\fBOSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_AAD_PACKLEN\fR) and +"tls1multi_interleave" (\fBOSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_INTERLEAVE\fR). +.IP EVP_CTRL_TLS1_1_MULTIBLOCK_ENCRYPT 4 .IX Item "EVP_CTRL_TLS1_1_MULTIBLOCK_ENCRYPT" -When used with a fetched \fB\s-1EVP_CIPHER\s0\fR, \fBEVP_CIPHER_CTX_set_params()\fR gets called -with \s-1\fBOSSL_PARAM\s0\fR\|(3) items with the keys -\&\*(L"tls1multi_enc\*(R" (\fB\s-1OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC\s0\fR), -\&\*(L"tls1multi_encin\*(R" (\fB\s-1OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC_IN\s0\fR) and -\&\*(L"tls1multi_interleave\*(R" (\fB\s-1OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_INTERLEAVE\s0\fR), +When used with a fetched \fBEVP_CIPHER\fR, \fBEVP_CIPHER_CTX_set_params()\fR gets called +with \fBOSSL_PARAM\fR\|(3) items with the keys +"tls1multi_enc" (\fBOSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC\fR), +"tls1multi_encin" (\fBOSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC_IN\fR) and +"tls1multi_interleave" (\fBOSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_INTERLEAVE\fR), followed by \fBEVP_CIPHER_CTX_get_params()\fR with a key of -\&\*(L"tls1multi_enclen\*(R" (\fB\s-1OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC_LEN\s0\fR). -.SH "FLAGS" +"tls1multi_enclen" (\fBOSSL_CIPHER_PARAM_TLS1_MULTIBLOCK_ENC_LEN\fR). +.SH FLAGS .IX Header "FLAGS" \&\fBEVP_CIPHER_CTX_set_flags()\fR, \fBEVP_CIPHER_CTX_clear_flags()\fR and \fBEVP_CIPHER_CTX_test_flags()\fR. -can be used to manipulate and test these \fB\s-1EVP_CIPHER_CTX\s0\fR flags: -.IP "\s-1EVP_CIPH_NO_PADDING\s0" 4 +can be used to manipulate and test these \fBEVP_CIPHER_CTX\fR flags: +.IP EVP_CIPH_NO_PADDING 4 .IX Item "EVP_CIPH_NO_PADDING" Used by \fBEVP_CIPHER_CTX_set_padding()\fR. .Sp -See also \*(L"Gettable and Settable \s-1EVP_CIPHER_CTX\s0 parameters\*(R" \*(L"padding\*(R" -.IP "\s-1EVP_CIPH_FLAG_LENGTH_BITS\s0" 4 +See also "Gettable and Settable EVP_CIPHER_CTX parameters" "padding" +.IP EVP_CIPH_FLAG_LENGTH_BITS 4 .IX Item "EVP_CIPH_FLAG_LENGTH_BITS" -See \*(L"Settable \s-1EVP_CIPHER_CTX\s0 parameters\*(R" \*(L"use-bits\*(R". -.IP "\s-1EVP_CIPHER_CTX_FLAG_WRAP_ALLOW\s0" 4 +See "Settable EVP_CIPHER_CTX parameters" "use-bits". +.IP EVP_CIPHER_CTX_FLAG_WRAP_ALLOW 4 .IX Item "EVP_CIPHER_CTX_FLAG_WRAP_ALLOW" Used for Legacy purposes only. This flag needed to be set to indicate the cipher handled wrapping. .PP \&\fBEVP_CIPHER_flags()\fR uses the following flags that -have mappings to \*(L"Gettable \s-1EVP_CIPHER\s0 parameters\*(R": -.IP "\s-1EVP_CIPH_FLAG_AEAD_CIPHER\s0" 4 +have mappings to "Gettable EVP_CIPHER parameters": +.IP EVP_CIPH_FLAG_AEAD_CIPHER 4 .IX Item "EVP_CIPH_FLAG_AEAD_CIPHER" -See \*(L"Gettable \s-1EVP_CIPHER\s0 parameters\*(R" \*(L"aead\*(R". -.IP "\s-1EVP_CIPH_CUSTOM_IV\s0" 4 +See "Gettable EVP_CIPHER parameters" "aead". +.IP EVP_CIPH_CUSTOM_IV 4 .IX Item "EVP_CIPH_CUSTOM_IV" -See \*(L"Gettable \s-1EVP_CIPHER\s0 parameters\*(R" \*(L"custom-iv\*(R". -.IP "\s-1EVP_CIPH_FLAG_CTS\s0" 4 +See "Gettable EVP_CIPHER parameters" "custom-iv". +.IP EVP_CIPH_FLAG_CTS 4 .IX Item "EVP_CIPH_FLAG_CTS" -See \*(L"Gettable \s-1EVP_CIPHER\s0 parameters\*(R" \*(L"cts\*(R". -.IP "\s-1EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK\s0;" 4 +See "Gettable EVP_CIPHER parameters" "cts". +.IP EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK; 4 .IX Item "EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK;" -See \*(L"Gettable \s-1EVP_CIPHER\s0 parameters\*(R" \*(L"tls-multi\*(R". -.IP "\s-1EVP_CIPH_RAND_KEY\s0" 4 +See "Gettable EVP_CIPHER parameters" "tls-multi". +.IP EVP_CIPH_RAND_KEY 4 .IX Item "EVP_CIPH_RAND_KEY" -See \*(L"Gettable \s-1EVP_CIPHER\s0 parameters\*(R" \*(L"has-randkey\*(R". +See "Gettable EVP_CIPHER parameters" "has-randkey". .PP \&\fBEVP_CIPHER_flags()\fR uses the following flags for legacy purposes only: -.IP "\s-1EVP_CIPH_VARIABLE_LENGTH\s0" 4 +.IP EVP_CIPH_VARIABLE_LENGTH 4 .IX Item "EVP_CIPH_VARIABLE_LENGTH" .PD 0 -.IP "\s-1EVP_CIPH_FLAG_CUSTOM_CIPHER\s0" 4 +.IP EVP_CIPH_FLAG_CUSTOM_CIPHER 4 .IX Item "EVP_CIPH_FLAG_CUSTOM_CIPHER" -.IP "\s-1EVP_CIPH_ALWAYS_CALL_INIT\s0" 4 +.IP EVP_CIPH_ALWAYS_CALL_INIT 4 .IX Item "EVP_CIPH_ALWAYS_CALL_INIT" -.IP "\s-1EVP_CIPH_CTRL_INIT\s0" 4 +.IP EVP_CIPH_CTRL_INIT 4 .IX Item "EVP_CIPH_CTRL_INIT" -.IP "\s-1EVP_CIPH_CUSTOM_KEY_LENGTH\s0" 4 +.IP EVP_CIPH_CUSTOM_KEY_LENGTH 4 .IX Item "EVP_CIPH_CUSTOM_KEY_LENGTH" -.IP "\s-1EVP_CIPH_CUSTOM_COPY\s0" 4 +.IP EVP_CIPH_CUSTOM_COPY 4 .IX Item "EVP_CIPH_CUSTOM_COPY" -.IP "\s-1EVP_CIPH_FLAG_DEFAULT_ASN1\s0" 4 +.IP EVP_CIPH_FLAG_DEFAULT_ASN1 4 .IX Item "EVP_CIPH_FLAG_DEFAULT_ASN1" .PD See \fBEVP_CIPHER_meth_set_flags\fR\|(3) for further information related to the above flags. .SH "RETURN VALUES" .IX Header "RETURN VALUES" -\&\fBEVP_CIPHER_fetch()\fR returns a pointer to a \fB\s-1EVP_CIPHER\s0\fR for success -and \fB\s-1NULL\s0\fR for failure. +\&\fBEVP_CIPHER_fetch()\fR returns a pointer to a \fBEVP_CIPHER\fR for success +and NULL for failure. .PP \&\fBEVP_CIPHER_up_ref()\fR returns 1 for success or 0 otherwise. .PP \&\fBEVP_CIPHER_CTX_new()\fR returns a pointer to a newly created -\&\fB\s-1EVP_CIPHER_CTX\s0\fR for success and \fB\s-1NULL\s0\fR for failure. +\&\fBEVP_CIPHER_CTX\fR for success and NULL for failure. +.PP +\&\fBEVP_CIPHER_CTX_dup()\fR returns a new EVP_CIPHER_CTX if successful or NULL on failure. +.PP +\&\fBEVP_CIPHER_CTX_copy()\fR returns 1 if successful or 0 for failure. .PP \&\fBEVP_EncryptInit_ex2()\fR, \fBEVP_EncryptUpdate()\fR and \fBEVP_EncryptFinal_ex()\fR return 1 for success and 0 for failure. @@ -1210,44 +1276,56 @@ return 1 for success and 0 for failure. \&\fBEVP_DecryptInit_ex2()\fR and \fBEVP_DecryptUpdate()\fR return 1 for success and 0 for failure. \&\fBEVP_DecryptFinal_ex()\fR returns 0 if the decrypt failed or 1 for success. .PP -\&\fBEVP_CipherInit_ex2()\fR and \fBEVP_CipherUpdate()\fR return 1 for success and 0 for failure. -\&\fBEVP_CipherFinal_ex()\fR returns 0 for a decryption failure or 1 for success. +\&\fBEVP_CipherInit_ex2()\fR, \fBEVP_CipherInit_SKEY()\fR and \fBEVP_CipherUpdate()\fR return 1 for +success and 0 for failure. +\&\fBEVP_CipherFinal_ex()\fR returns 0 for an encryption/decryption failure or 1 for +success. +.PP +\&\fBEVP_Cipher()\fR returns 1 on success and <= 0 on failure, if the flag +\&\fBEVP_CIPH_FLAG_CUSTOM_CIPHER\fR is not set for the cipher, or if the cipher has +not been initialized via a call to \fBEVP_CipherInit_ex2\fR. +\&\fBEVP_Cipher()\fR returns the number of bytes written to \fIout\fR for +encryption/decryption, or the number of bytes authenticated in a call specifying +AAD for an AEAD cipher, if the flag \fBEVP_CIPH_FLAG_CUSTOM_CIPHER\fR is set for +the cipher. .PP -\&\fBEVP_Cipher()\fR returns 1 on success or 0 on failure, if the flag -\&\fB\s-1EVP_CIPH_FLAG_CUSTOM_CIPHER\s0\fR is not set for the cipher. -\&\fBEVP_Cipher()\fR returns the number of bytes written to \fIout\fR for encryption / decryption, or -the number of bytes authenticated in a call specifying \s-1AAD\s0 for an \s-1AEAD\s0 cipher, if the flag -\&\fB\s-1EVP_CIPH_FLAG_CUSTOM_CIPHER\s0\fR is set for the cipher. +\&\fBEVP_CIPHER_can_pipeline()\fR returns 1 if the cipher can be used in a pipeline, 0 otherwise. +.PP +\&\fBEVP_CipherPipelineEncryptInit()\fR and \fBEVP_CipherPipelineDecryptInit()\fR +return 1 for success and 0 for failure. +.PP +\&\fBEVP_CipherPipelineUpdate()\fR and \fBEVP_CipherPipelineFinal()\fR +return 1 for success and 0 for failure. .PP \&\fBEVP_CIPHER_CTX_reset()\fR returns 1 for success and 0 for failure. .PP \&\fBEVP_get_cipherbyname()\fR, \fBEVP_get_cipherbynid()\fR and \fBEVP_get_cipherbyobj()\fR -return an \fB\s-1EVP_CIPHER\s0\fR structure or \s-1NULL\s0 on error. +return an \fBEVP_CIPHER\fR structure or NULL on error. .PP -\&\fBEVP_CIPHER_get_nid()\fR and \fBEVP_CIPHER_CTX_get_nid()\fR return a \s-1NID.\s0 +\&\fBEVP_CIPHER_get_nid()\fR and \fBEVP_CIPHER_CTX_get_nid()\fR return a NID. .PP \&\fBEVP_CIPHER_get_block_size()\fR and \fBEVP_CIPHER_CTX_get_block_size()\fR return the -block size. +block size, or 0 on error. .PP \&\fBEVP_CIPHER_get_key_length()\fR and \fBEVP_CIPHER_CTX_get_key_length()\fR return the key length. .PP \&\fBEVP_CIPHER_CTX_set_padding()\fR always returns 1. .PP -\&\fBEVP_CIPHER_get_iv_length()\fR and \fBEVP_CIPHER_CTX_get_iv_length()\fR return the \s-1IV\s0 -length or zero if the cipher does not use an \s-1IV.\s0 +\&\fBEVP_CIPHER_get_iv_length()\fR and \fBEVP_CIPHER_CTX_get_iv_length()\fR return the IV +length, zero if the cipher does not use an IV and a negative value on error. .PP \&\fBEVP_CIPHER_CTX_get_tag_length()\fR return the tag length or zero if the cipher does not use a tag. .PP -\&\fBEVP_CIPHER_get_type()\fR and \fBEVP_CIPHER_CTX_get_type()\fR return the \s-1NID\s0 of the -cipher's \s-1OBJECT IDENTIFIER\s0 or NID_undef if it has no defined -\&\s-1OBJECT IDENTIFIER.\s0 +\&\fBEVP_CIPHER_get_type()\fR and \fBEVP_CIPHER_CTX_get_type()\fR return the NID of the +cipher's OBJECT IDENTIFIER or NID_undef if it has no defined +OBJECT IDENTIFIER. .PP -\&\fBEVP_CIPHER_CTX_cipher()\fR returns an \fB\s-1EVP_CIPHER\s0\fR structure. +\&\fBEVP_CIPHER_CTX_cipher()\fR returns an \fBEVP_CIPHER\fR structure. .PP \&\fBEVP_CIPHER_CTX_get_num()\fR returns a nonnegative num value or -\&\fB\s-1EVP_CTRL_RET_UNSUPPORTED\s0\fR if the implementation does not support the call +\&\fBEVP_CTRL_RET_UNSUPPORTED\fR if the implementation does not support the call or on any other error. .PP \&\fBEVP_CIPHER_CTX_set_num()\fR returns 1 on success and 0 if the implementation @@ -1268,170 +1346,180 @@ A return value of 0 means that the callback was not called for any names. .IX Header "CIPHER LISTING" All algorithms have a fixed key length unless otherwise stated. .PP -Refer to \*(L"\s-1SEE ALSO\*(R"\s0 for the full list of ciphers available through the \s-1EVP\s0 +Refer to "SEE ALSO" for the full list of ciphers available through the EVP interface. -.IP "\fBEVP_enc_null()\fR" 4 +.IP \fBEVP_enc_null()\fR 4 .IX Item "EVP_enc_null()" Null cipher: does nothing. .SH "AEAD INTERFACE" .IX Header "AEAD INTERFACE" -The \s-1EVP\s0 interface for Authenticated Encryption with Associated Data (\s-1AEAD\s0) +The EVP interface for Authenticated Encryption with Associated Data (AEAD) modes are subtly altered and several additional \fIctrl\fR operations are supported depending on the mode specified. .PP -To specify additional authenticated data (\s-1AAD\s0), a call to \fBEVP_CipherUpdate()\fR, +To specify additional authenticated data (AAD), a call to \fBEVP_CipherUpdate()\fR, \&\fBEVP_EncryptUpdate()\fR or \fBEVP_DecryptUpdate()\fR should be made with the output -parameter \fIout\fR set to \fB\s-1NULL\s0\fR. In this case, on success, the parameter +parameter \fIout\fR set to NULL. In this case, on success, the parameter \&\fIoutl\fR is set to the number of bytes authenticated. .PP When decrypting, the return value of \fBEVP_DecryptFinal()\fR or \fBEVP_CipherFinal()\fR indicates whether the operation was successful. If it does not indicate success, -the authentication operation has failed and any output data \fB\s-1MUST NOT\s0\fR be used +the authentication operation has failed and any output data \fBMUST NOT\fR be used as it is corrupted. -.SS "\s-1GCM\s0 and \s-1OCB\s0 Modes" +.PP +Please note that the number of authenticated bytes returned by +\&\fBEVP_CipherUpdate()\fR depends on the cipher used. Stream ciphers, such as ChaCha20 +or ciphers in GCM mode, can handle 1 byte at a time, resulting in an effective +"block" size of 1. Conversely, ciphers in OCB mode must process data one block +at a time, and the block size is returned. +.PP +Regardless of the returned size, it is safe to pass unpadded data to an +\&\fBEVP_CipherUpdate()\fR call in a single operation. +.SS "GCM and OCB Modes" .IX Subsection "GCM and OCB Modes" -The following \fIctrl\fRs are supported in \s-1GCM\s0 and \s-1OCB\s0 modes. -.IP "EVP_CIPHER_CTX_ctrl(ctx, \s-1EVP_CTRL_AEAD_SET_IVLEN,\s0 ivlen, \s-1NULL\s0)" 4 +The following \fIctrl\fRs are supported in GCM and OCB modes. +.IP "EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_SET_IVLEN, ivlen, NULL)" 4 .IX Item "EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_SET_IVLEN, ivlen, NULL)" -Sets the \s-1IV\s0 length. This call can only be made before specifying an \s-1IV.\s0 If -not called a default \s-1IV\s0 length is used. +Sets the IV length. This call can only be made before specifying an IV. If +not called a default IV length is used. .Sp -For \s-1GCM AES\s0 and \s-1OCB AES\s0 the default is 12 (i.e. 96 bits). For \s-1OCB\s0 mode the +For GCM AES and OCB AES the default is 12 (i.e. 96 bits). For OCB mode the maximum is 15. -.IP "EVP_CIPHER_CTX_ctrl(ctx, \s-1EVP_CTRL_AEAD_GET_TAG,\s0 taglen, tag)" 4 +.IP "EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_GET_TAG, taglen, tag)" 4 .IX Item "EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_GET_TAG, taglen, tag)" Writes \f(CW\*(C`taglen\*(C'\fR bytes of the tag value to the buffer indicated by \f(CW\*(C`tag\*(C'\fR. This call can only be made when encrypting data and \fBafter\fR all data has been processed (e.g. after an \fBEVP_EncryptFinal()\fR call). .Sp -For \s-1OCB,\s0 \f(CW\*(C`taglen\*(C'\fR must either be 16 or the value previously set via -\&\fB\s-1EVP_CTRL_AEAD_SET_TAG\s0\fR. -.IP "EVP_CIPHER_CTX_ctrl(ctx, \s-1EVP_CTRL_AEAD_SET_TAG,\s0 taglen, tag)" 4 +For OCB, \f(CW\*(C`taglen\*(C'\fR must either be 16 or the value previously set via +\&\fBEVP_CTRL_AEAD_SET_TAG\fR. +.IP "EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_SET_TAG, taglen, tag)" 4 .IX Item "EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_SET_TAG, taglen, tag)" When decrypting, this call sets the expected tag to \f(CW\*(C`taglen\*(C'\fR bytes from \f(CW\*(C`tag\*(C'\fR. \&\f(CW\*(C`taglen\*(C'\fR must be between 1 and 16 inclusive. The tag must be set prior to any call to \fBEVP_DecryptFinal()\fR or \&\fBEVP_DecryptFinal_ex()\fR. .Sp -For \s-1GCM,\s0 this call is only valid when decrypting data. +For GCM, this call is only valid when decrypting data. .Sp -For \s-1OCB,\s0 this call is valid when decrypting data to set the expected tag, +For OCB, this call is valid when decrypting data to set the expected tag, and when encrypting to set the desired tag length. .Sp -In \s-1OCB\s0 mode, calling this when encrypting with \f(CW\*(C`tag\*(C'\fR set to \f(CW\*(C`NULL\*(C'\fR sets the -tag length. The tag length can only be set before specifying an \s-1IV.\s0 If this is -not called prior to setting the \s-1IV\s0 during encryption, then a default tag length -is used. +In OCB mode, calling this with \f(CW\*(C`tag\*(C'\fR set to \f(CW\*(C`NULL\*(C'\fR sets the tag length. +The tag length can only be set before specifying an IV. If this is not called +prior to setting the IV, then a default tag length is used. .Sp -For \s-1OCB AES,\s0 the default tag length is 16 (i.e. 128 bits). It is also the -maximum tag length for \s-1OCB.\s0 -.SS "\s-1CCM\s0 Mode" +For OCB AES, the default tag length is 16 (i.e. 128 bits). It is also the +maximum tag length for OCB. +.SS "CCM Mode" .IX Subsection "CCM Mode" -The \s-1EVP\s0 interface for \s-1CCM\s0 mode is similar to that of the \s-1GCM\s0 mode but with a +The EVP interface for CCM mode is similar to that of the GCM mode but with a few additional requirements and different \fIctrl\fR values. .PP -For \s-1CCM\s0 mode, the total plaintext or ciphertext length \fB\s-1MUST\s0\fR be passed to +For CCM mode, the total plaintext or ciphertext length \fBMUST\fR be passed to \&\fBEVP_CipherUpdate()\fR, \fBEVP_EncryptUpdate()\fR or \fBEVP_DecryptUpdate()\fR with the output -and input parameters (\fIin\fR and \fIout\fR) set to \fB\s-1NULL\s0\fR and the length passed in +and input parameters (\fIin\fR and \fIout\fR) set to NULL and the length passed in the \fIinl\fR parameter. .PP -The following \fIctrl\fRs are supported in \s-1CCM\s0 mode. -.IP "EVP_CIPHER_CTX_ctrl(ctx, \s-1EVP_CTRL_AEAD_SET_TAG,\s0 taglen, tag)" 4 +The following \fIctrl\fRs are supported in CCM mode. +.IP "EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_SET_TAG, taglen, tag)" 4 .IX Item "EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_SET_TAG, taglen, tag)" -This call is made to set the expected \fB\s-1CCM\s0\fR tag value when decrypting or -the length of the tag (with the \f(CW\*(C`tag\*(C'\fR parameter set to \s-1NULL\s0) when encrypting. +This call is made to set the expected \fBCCM\fR tag value when decrypting or +the length of the tag (with the \f(CW\*(C`tag\*(C'\fR parameter set to NULL) when encrypting. The tag length is often referred to as \fBM\fR. If not set a default value is -used (12 for \s-1AES\s0). When decrypting, the tag needs to be set before passing -in data to be decrypted, but as in \s-1GCM\s0 and \s-1OCB\s0 mode, it can be set after -passing additional authenticated data (see \*(L"\s-1AEAD INTERFACE\*(R"\s0). -.IP "EVP_CIPHER_CTX_ctrl(ctx, \s-1EVP_CTRL_CCM_SET_L,\s0 ivlen, \s-1NULL\s0)" 4 +used (12 for AES). When decrypting, the tag needs to be set before passing +in data to be decrypted, but as in GCM and OCB mode, it can be set after +passing additional authenticated data (see "AEAD INTERFACE"). +.IP "EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_CCM_SET_L, ivlen, NULL)" 4 .IX Item "EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_CCM_SET_L, ivlen, NULL)" -Sets the \s-1CCM\s0 \fBL\fR value. If not set a default is used (8 for \s-1AES\s0). -.IP "EVP_CIPHER_CTX_ctrl(ctx, \s-1EVP_CTRL_AEAD_SET_IVLEN,\s0 ivlen, \s-1NULL\s0)" 4 +Sets the CCM \fBL\fR value. If not set a default is used (8 for AES). +.IP "EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_SET_IVLEN, ivlen, NULL)" 4 .IX Item "EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_SET_IVLEN, ivlen, NULL)" -Sets the \s-1CCM\s0 nonce (\s-1IV\s0) length. This call can only be made before specifying a +Sets the CCM nonce (IV) length. This call can only be made before specifying a nonce value. The nonce length is given by \fB15 \- L\fR so it is 7 by default for -\&\s-1AES.\s0 -.SS "\s-1SIV\s0 Mode" +AES. +.SS "SIV Mode" .IX Subsection "SIV Mode" -For \s-1SIV\s0 mode ciphers the behaviour of the \s-1EVP\s0 interface is subtly +Both the AES-SIV and AES-GCM-SIV ciphers fall under this mode. +.PP +For SIV mode ciphers the behaviour of the EVP interface is subtly altered and several additional ctrl operations are supported. .PP -To specify any additional authenticated data (\s-1AAD\s0) and/or a Nonce, a call to +To specify any additional authenticated data (AAD) and/or a Nonce, a call to \&\fBEVP_CipherUpdate()\fR, \fBEVP_EncryptUpdate()\fR or \fBEVP_DecryptUpdate()\fR should be made -with the output parameter \fIout\fR set to \fB\s-1NULL\s0\fR. +with the output parameter \fIout\fR set to NULL. .PP -\&\s-1RFC5297\s0 states that the Nonce is the last piece of \s-1AAD\s0 before the actual -encrypt/decrypt takes place. The \s-1API\s0 does not differentiate the Nonce from -other \s-1AAD.\s0 +RFC5297 states that the Nonce is the last piece of AAD before the actual +encrypt/decrypt takes place. The API does not differentiate the Nonce from +other AAD. .PP When decrypting the return value of \fBEVP_DecryptFinal()\fR or \fBEVP_CipherFinal()\fR indicates if the operation was successful. If it does not indicate success -the authentication operation has failed and any output data \fB\s-1MUST NOT\s0\fR +the authentication operation has failed and any output data \fBMUST NOT\fR be used as it is corrupted. .PP -The \s-1API\s0 does not store the the \s-1SIV\s0 (Synthetic Initialization Vector) in -the cipher text. Instead, it is stored as the tag within the \s-1EVP_CIPHER_CTX.\s0 -The \s-1SIV\s0 must be retrieved from the context after encryption, and set into +The API does not store the SIV (Synthetic Initialization Vector) in +the cipher text. Instead, it is stored as the tag within the EVP_CIPHER_CTX. +The SIV must be retrieved from the context after encryption, and set into the context before decryption. .PP -This differs from \s-1RFC5297\s0 in that the cipher output from encryption, and -the cipher input to decryption, does not contain the \s-1SIV.\s0 This also means +This differs from RFC5297 in that the cipher output from encryption, and +the cipher input to decryption, does not contain the SIV. This also means that the plain text and cipher text lengths are identical. .PP -The following ctrls are supported in \s-1SIV\s0 mode, and are used to get and set +The following ctrls are supported in SIV mode, and are used to get and set the Synthetic Initialization Vector: -.IP "EVP_CIPHER_CTX_ctrl(ctx, \s-1EVP_CTRL_AEAD_GET_TAG,\s0 taglen, tag);" 4 +.IP "EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_GET_TAG, taglen, tag);" 4 .IX Item "EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_GET_TAG, taglen, tag);" Writes \fItaglen\fR bytes of the tag value (the Synthetic Initialization Vector) to the buffer indicated by \fItag\fR. This call can only be made when encrypting data and \fBafter\fR all data has been processed (e.g. after an \fBEVP_EncryptFinal()\fR -call). For \s-1SIV\s0 mode the taglen must be 16. -.IP "EVP_CIPHER_CTX_ctrl(ctx, \s-1EVP_CTRL_AEAD_SET_TAG,\s0 taglen, tag);" 4 +call). For SIV mode the taglen must be 16. +.IP "EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_SET_TAG, taglen, tag);" 4 .IX Item "EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_SET_TAG, taglen, tag);" Sets the expected tag (the Synthetic Initialization Vector) to \fItaglen\fR bytes from \fItag\fR. This call is only legal when decrypting data and must be made \fBbefore\fR any data is processed (e.g. before any \fBEVP_DecryptUpdate()\fR -calls). For \s-1SIV\s0 mode the taglen must be 16. +calls). For SIV mode the taglen must be 16. .PP -\&\s-1SIV\s0 mode makes two passes over the input data, thus, only one call to +SIV mode makes two passes over the input data, thus, only one call to \&\fBEVP_CipherUpdate()\fR, \fBEVP_EncryptUpdate()\fR or \fBEVP_DecryptUpdate()\fR should be made -with \fIout\fR set to a non\-\fB\s-1NULL\s0\fR value. A call to \fBEVP_DecryptFinal()\fR or +with \fIout\fR set to a non-NULL value. A call to \fBEVP_DecryptFinal()\fR or \&\fBEVP_CipherFinal()\fR is not required, but will indicate if the update operation succeeded. -.SS "ChaCha20\-Poly1305" +.SS ChaCha20\-Poly1305 .IX Subsection "ChaCha20-Poly1305" -The following \fIctrl\fRs are supported for the ChaCha20\-Poly1305 \s-1AEAD\s0 algorithm. -.IP "EVP_CIPHER_CTX_ctrl(ctx, \s-1EVP_CTRL_AEAD_SET_IVLEN,\s0 ivlen, \s-1NULL\s0)" 4 +The following \fIctrl\fRs are supported for the ChaCha20\-Poly1305 AEAD algorithm. +.IP "EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_SET_IVLEN, ivlen, NULL)" 4 .IX Item "EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_SET_IVLEN, ivlen, NULL)" Sets the nonce length. This call is now redundant since the only valid value is the default length of 12 (i.e. 96 bits). Prior to OpenSSL 3.0 a nonce of less than 12 bytes could be used to automatically pad the iv with leading 0 bytes to make it 12 bytes in length. -.IP "EVP_CIPHER_CTX_ctrl(ctx, \s-1EVP_CTRL_AEAD_GET_TAG,\s0 taglen, tag)" 4 +.IP "EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_GET_TAG, taglen, tag)" 4 .IX Item "EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_GET_TAG, taglen, tag)" Writes \f(CW\*(C`taglen\*(C'\fR bytes of the tag value to the buffer indicated by \f(CW\*(C`tag\*(C'\fR. This call can only be made when encrypting data and \fBafter\fR all data has been processed (e.g. after an \fBEVP_EncryptFinal()\fR call). .Sp -\&\f(CW\*(C`taglen\*(C'\fR specified here must be 16 (\fB\s-1POLY1305_BLOCK_SIZE\s0\fR, i.e. 128\-bits) or +\&\f(CW\*(C`taglen\*(C'\fR specified here must be 16 (\fBPOLY1305_BLOCK_SIZE\fR, i.e. 128\-bits) or less. -.IP "EVP_CIPHER_CTX_ctrl(ctx, \s-1EVP_CTRL_AEAD_SET_TAG,\s0 taglen, tag)" 4 +.IP "EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_SET_TAG, taglen, tag)" 4 .IX Item "EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_SET_TAG, taglen, tag)" Sets the expected tag to \f(CW\*(C`taglen\*(C'\fR bytes from \f(CW\*(C`tag\*(C'\fR. -The tag length can only be set before specifying an \s-1IV.\s0 -\&\f(CW\*(C`taglen\*(C'\fR must be between 1 and 16 (\fB\s-1POLY1305_BLOCK_SIZE\s0\fR) inclusive. +The tag length can only be set before specifying an IV. +\&\f(CW\*(C`taglen\*(C'\fR must be between 1 and 16 (\fBPOLY1305_BLOCK_SIZE\fR) inclusive. This call is only valid when decrypting data. -.SH "NOTES" +.SH NOTES .IX Header "NOTES" -Where possible the \fB\s-1EVP\s0\fR interface to symmetric ciphers should be used in +Where possible the \fBEVP\fR interface to symmetric ciphers should be used in preference to the low-level interfaces. This is because the code then becomes transparent to the cipher used and much more flexible. Additionally, the -\&\fB\s-1EVP\s0\fR interface will ensure the use of platform specific cryptographic +\&\fBEVP\fR interface will ensure the use of platform specific cryptographic acceleration such as AES-NI (the low-level interfaces do not provide the guarantee). .PP -\&\s-1PKCS\s0 padding works by adding \fBn\fR padding bytes of value \fBn\fR to make the total +PKCS padding works by adding \fBn\fR padding bytes of value \fBn\fR to make the total length of the encrypted data a multiple of the block size. Padding is always added so if the data is already a multiple of the block size \fBn\fR will equal the block size. For example if the block size is 8 and 11 bytes are to be @@ -1460,31 +1548,31 @@ There are some differences between functions \fBEVP_CipherInit()\fR and \&\fBEVP_CipherInit_ex()\fR, significant in some circumstances. \fBEVP_CipherInit()\fR fills the passed context object with zeros. As a consequence, \fBEVP_CipherInit()\fR does not allow step-by-step initialization of the ctx when the \fIkey\fR and \fIiv\fR are -passed in separate calls. It also means that the flags set for the \s-1CTX\s0 are +passed in separate calls. It also means that the flags set for the CTX are removed, and it is especially important for the -\&\fB\s-1EVP_CIPHER_CTX_FLAG_WRAP_ALLOW\s0\fR flag treated specially in +\&\fBEVP_CIPHER_CTX_FLAG_WRAP_ALLOW\fR flag treated specially in \&\fBEVP_CipherInit_ex()\fR. .PP -Ignoring failure returns of the \fB\s-1EVP_CIPHER_CTX\s0\fR initialization functions can +Ignoring failure returns of the \fBEVP_CIPHER_CTX\fR initialization functions can lead to subsequent undefined behavior when calling the functions that update or -finalize the context. The only valid calls on the \fB\s-1EVP_CIPHER_CTX\s0\fR when +finalize the context. The only valid calls on the \fBEVP_CIPHER_CTX\fR when initialization fails are calls that attempt another initialization of the context or release the context. .PP \&\fBEVP_get_cipherbynid()\fR, and \fBEVP_get_cipherbyobj()\fR are implemented as macros. -.SH "BUGS" +.SH BUGS .IX Header "BUGS" -\&\fB\s-1EVP_MAX_KEY_LENGTH\s0\fR and \fB\s-1EVP_MAX_IV_LENGTH\s0\fR only refer to the internal +\&\fBEVP_MAX_KEY_LENGTH\fR and \fBEVP_MAX_IV_LENGTH\fR only refer to the internal ciphers with default key lengths. If custom ciphers exceed these values the results are unpredictable. This is because it has become standard practice to define a generic key as a fixed unsigned char array containing -\&\fB\s-1EVP_MAX_KEY_LENGTH\s0\fR bytes. +\&\fBEVP_MAX_KEY_LENGTH\fR bytes. .PP -The \s-1ASN1\s0 code is incomplete (and sometimes inaccurate) it has only been tested -for certain common S/MIME ciphers (\s-1RC2, DES,\s0 triple \s-1DES\s0) in \s-1CBC\s0 mode. -.SH "EXAMPLES" +The ASN1 code is incomplete (and sometimes inaccurate) it has only been tested +for certain common S/MIME ciphers (RC2, DES, triple DES) in CBC mode. +.SH EXAMPLES .IX Header "EXAMPLES" -Encrypt a string using \s-1IDEA:\s0 +Encrypt a string using IDEA: .PP .Vb 10 \& int do_crypt(char *outfile) @@ -1549,7 +1637,7 @@ utility with the command line (shown on two lines for clarity): \& \-K 000102030405060708090A0B0C0D0E0F \-iv 0102030405060708 <filename .Ve .PP -General encryption and decryption function example using \s-1FILE I/O\s0 and \s-1AES128\s0 +General encryption and decryption function example using FILE I/O and AES128 with a 128\-bit key: .PP .Vb 12 @@ -1607,7 +1695,7 @@ with a 128\-bit key: \& } .Ve .PP -Encryption using AES-CBC with a 256\-bit key with \*(L"\s-1CS1\*(R"\s0 ciphertext stealing. +Encryption using AES-CBC with a 256\-bit key with "CS1" ciphertext stealing. .PP .Vb 10 \& int encrypt(const unsigned char *key, const unsigned char *iv, @@ -1656,7 +1744,7 @@ Encryption using AES-CBC with a 256\-bit key with \*(L"\s-1CS1\*(R"\s0 ciphertex .IX Header "SEE ALSO" \&\fBevp\fR\|(7), \&\fBproperty\fR\|(7), -\&\*(L"\s-1ALGORITHM FETCHING\*(R"\s0 in \fBcrypto\fR\|(7), +"ALGORITHM FETCHING" in \fBcrypto\fR\|(7), \&\fBprovider\-cipher\fR\|(7), \&\fBlife_cycle\-cipher\fR\|(7) .PP @@ -1676,11 +1764,11 @@ Supported ciphers are listed in: \&\fBEVP_rc5_32_12_16_cbc\fR\|(3), \&\fBEVP_seed_cbc\fR\|(3), \&\fBEVP_sm4_cbc\fR\|(3), -.SH "HISTORY" +.SH HISTORY .IX Header "HISTORY" -Support for \s-1OCB\s0 mode was added in OpenSSL 1.1.0. +Support for OCB mode was added in OpenSSL 1.1.0. .PP -\&\fB\s-1EVP_CIPHER_CTX\s0\fR was made opaque in OpenSSL 1.1.0. As a result, +\&\fBEVP_CIPHER_CTX\fR was made opaque in OpenSSL 1.1.0. As a result, \&\fBEVP_CIPHER_CTX_reset()\fR appeared and \fBEVP_CIPHER_CTX_cleanup()\fR disappeared. \fBEVP_CIPHER_CTX_init()\fR remains as an alias for \&\fBEVP_CIPHER_CTX_reset()\fR. @@ -1712,11 +1800,19 @@ The \fBEVP_CIPHER_CTX_encrypting()\fR function was renamed to non-deprecated alias macro. .PP The \fBEVP_CIPHER_CTX_flags()\fR macro was deprecated in OpenSSL 1.1.0. -.SH "COPYRIGHT" +.PP +\&\fBEVP_CIPHER_CTX_dup()\fR was added in OpenSSL 3.2. +.PP +\&\fBEVP_CipherInit_SKEY()\fR was added in OpenSSL 3.5. +.PP +Prior to OpenSSL 3.5, passing a NULL \fIctx\fR to +\&\fBEVP_CIPHER_CTX_get_block_size()\fR would result in a NULL pointer dereference, +rather than a 0 return value indicating an error. +.SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2000\-2023 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2000\-2025 The OpenSSL Project Authors. All Rights Reserved. .PP -Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use +Licensed under the Apache License 2.0 (the "License"). 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 +in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>. |