diff options
Diffstat (limited to 'upstream/archlinux/man3/EVP_EncryptInit.3ssl')
-rw-r--r-- | upstream/archlinux/man3/EVP_EncryptInit.3ssl | 29 |
1 files changed, 18 insertions, 11 deletions
diff --git a/upstream/archlinux/man3/EVP_EncryptInit.3ssl b/upstream/archlinux/man3/EVP_EncryptInit.3ssl index 352e1206..05b77551 100644 --- a/upstream/archlinux/man3/EVP_EncryptInit.3ssl +++ b/upstream/archlinux/man3/EVP_EncryptInit.3ssl @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "EVP_ENCRYPTINIT 3ssl" -.TH EVP_ENCRYPTINIT 3ssl 2024-01-30 3.2.1 OpenSSL +.TH EVP_ENCRYPTINIT 3ssl 2024-04-28 3.3.0 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -520,7 +520,9 @@ The cipher objects returned from these functions do not need to be freed with .IX Item "EVP_CIPHER_get_nid() and EVP_CIPHER_CTX_get_nid()" 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. +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 "FLAGS" below for more information. @@ -552,8 +554,10 @@ 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 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. -The constant \fBEVP_MAX_IV_LENGTH\fR is the maximum IV length for all ciphers. +\&\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 AEAD cipher when passed a \fBEVP_CIPHER_CTX\fR. It will @@ -563,7 +567,8 @@ the tag length has not been set. .IX Item "EVP_CIPHER_get_block_size() and EVP_CIPHER_CTX_get_block_size()" 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. +maximum block length for all ciphers. A value of 0 is returned if the cipher +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 "type" is the actual NID @@ -598,7 +603,7 @@ Returns an \fBOSSL_PROVIDER\fR pointer to the provider that implements the given .IX Item "EVP_CIPHER_CTX_get0_cipher()" 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: @@ -628,7 +633,8 @@ 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 "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. +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 ASN1 AlgorithmIdentifier "parameter". @@ -1144,8 +1150,9 @@ return 1 for success and 0 for failure. \&\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. .PP -\&\fBEVP_Cipher()\fR returns 1 on success or 0 on failure, if the flag -\&\fBEVP_CIPH_FLAG_CUSTOM_CIPHER\fR is not set for the cipher. +\&\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. @@ -1158,7 +1165,7 @@ return an \fBEVP_CIPHER\fR structure or NULL on error. \&\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. @@ -1649,7 +1656,7 @@ The \fBEVP_CIPHER_CTX_flags()\fR macro was deprecated in OpenSSL 1.1.0. \&\fBEVP_CIPHER_CTX_dup()\fR was added in OpenSSL 3.2. .SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2000\-2023 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2000\-2024 The OpenSSL Project Authors. All Rights Reserved. .PP 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 |