diff options
Diffstat (limited to 'secure/lib/libcrypto/man/EVP_CIPHER_meth_new.3')
| -rw-r--r-- | secure/lib/libcrypto/man/EVP_CIPHER_meth_new.3 | 96 |
1 files changed, 50 insertions, 46 deletions
diff --git a/secure/lib/libcrypto/man/EVP_CIPHER_meth_new.3 b/secure/lib/libcrypto/man/EVP_CIPHER_meth_new.3 index 6f31f3f3174a1..009c634d31863 100644 --- a/secure/lib/libcrypto/man/EVP_CIPHER_meth_new.3 +++ b/secure/lib/libcrypto/man/EVP_CIPHER_meth_new.3 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) +.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== @@ -54,16 +54,20 @@ .\" Avoid warning from groff about undefined register 'F'. .de IX .. -.if !\nF .nr F 0 -.if \nF>0 \{\ -. de IX -. tm Index:\\$1\t\\n%\t"\\$2" +.nr rF 0 +.if \n(.g .if rF .nr rF 1 +.if (\n(rF:(\n(.g==0)) \{\ +. if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" .. -. if !\nF==2 \{\ -. nr % 0 -. nr F 2 +. if !\nF==2 \{\ +. nr % 0 +. nr F 2 +. \} . \} .\} +.rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. @@ -129,7 +133,7 @@ .\" ======================================================================== .\" .IX Title "EVP_CIPHER_METH_NEW 3" -.TH EVP_CIPHER_METH_NEW 3 "2018-11-20" "1.1.1a" "OpenSSL" +.TH EVP_CIPHER_METH_NEW 3 "2019-02-26" "1.1.1b" "OpenSSL" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -192,16 +196,16 @@ EVP_CIPHER_meth_new, EVP_CIPHER_meth_dup, EVP_CIPHER_meth_free, EVP_CIPHER_meth_ The \fB\s-1EVP_CIPHER\s0\fR type is a structure for symmetric cipher method implementation. .PP -\&\fIEVP_CIPHER_meth_new()\fR creates a new \fB\s-1EVP_CIPHER\s0\fR structure. +\&\fBEVP_CIPHER_meth_new()\fR creates a new \fB\s-1EVP_CIPHER\s0\fR structure. .PP -\&\fIEVP_CIPHER_meth_dup()\fR creates a copy of \fBcipher\fR. +\&\fBEVP_CIPHER_meth_dup()\fR creates a copy of \fBcipher\fR. .PP -\&\fIEVP_CIPHER_meth_free()\fR destroys a \fB\s-1EVP_CIPHER\s0\fR structure. +\&\fBEVP_CIPHER_meth_free()\fR destroys a \fB\s-1EVP_CIPHER\s0\fR structure. .PP -\&\fIEVP_CIPHER_meth_set_iv_length()\fR sets the length of the \s-1IV.\s0 +\&\fBEVP_CIPHER_meth_set_iv_length()\fR sets the length of the \s-1IV.\s0 This is only needed when the implemented cipher mode requires it. .PP -\&\fIEVP_CIPHER_meth_set_flags()\fR sets the flags to describe optional +\&\fBEVP_CIPHER_meth_set_flags()\fR sets the flags to describe optional behaviours in the particular \fBcipher\fR. With the exception of cipher modes, of which only one may be present, several flags can be or'd together. @@ -218,18 +222,18 @@ Storing and initialising the \s-1IV\s0 is left entirely to the implementation. .IP "\s-1EVP_CIPH_ALWAYS_CALL_INIT\s0" 4 .IX Item "EVP_CIPH_ALWAYS_CALL_INIT" -Set this if the implementation's \fIinit()\fR function should be called even +Set this if the implementation's \fBinit()\fR function should be called even if \fBkey\fR is \fB\s-1NULL\s0\fR. .IP "\s-1EVP_CIPH_CTRL_INIT\s0" 4 .IX Item "EVP_CIPH_CTRL_INIT" -Set this to have the implementation's \fIctrl()\fR function called with +Set this to have the implementation's \fBctrl()\fR function called with command code \fB\s-1EVP_CTRL_INIT\s0\fR early in its setup. .IP "\s-1EVP_CIPH_CUSTOM_KEY_LENGTH\s0" 4 .IX Item "EVP_CIPH_CUSTOM_KEY_LENGTH" Checking and setting the key length after creating the \fB\s-1EVP_CIPHER\s0\fR is left to the implementation. -Whenever someone uses \fIEVP_CIPHER_CTX_set_key_length()\fR on a -\&\fB\s-1EVP_CIPHER\s0\fR with this flag set, the implementation's \fIctrl()\fR function +Whenever someone uses \fBEVP_CIPHER_CTX_set_key_length()\fR on a +\&\fB\s-1EVP_CIPHER\s0\fR with this flag set, the implementation's \fBctrl()\fR function will be called with the control code \fB\s-1EVP_CTRL_SET_KEY_LENGTH\s0\fR and the key length in \fBarg\fR. .IP "\s-1EVP_CIPH_NO_PADDING\s0" 4 @@ -238,19 +242,19 @@ Don't use standard block padding. .IP "\s-1EVP_CIPH_RAND_KEY\s0" 4 .IX Item "EVP_CIPH_RAND_KEY" Making a key with random content is left to the implementation. -This is done by calling the implementation's \fIctrl()\fR function with the +This is done by calling the implementation's \fBctrl()\fR function with the control code \fB\s-1EVP_CTRL_RAND_KEY\s0\fR and the pointer to the key memory storage in \fBptr\fR. .IP "\s-1EVP_CIPH_CUSTOM_COPY\s0" 4 .IX Item "EVP_CIPH_CUSTOM_COPY" -Set this to have the implementation's \fIctrl()\fR function called with -command code \fB\s-1EVP_CTRL_COPY\s0\fR at the end of \fIEVP_CIPHER_CTX_copy()\fR. +Set this to have the implementation's \fBctrl()\fR function called with +command code \fB\s-1EVP_CTRL_COPY\s0\fR at the end of \fBEVP_CIPHER_CTX_copy()\fR. The intended use is for further things to deal with after the implementation specific data block has been copied. The destination \fB\s-1EVP_CIPHER_CTX\s0\fR is passed to the control with the \&\fBptr\fR parameter. The implementation specific data block is reached with -\&\fIEVP_CIPHER_CTX_get_cipher_data()\fR. +\&\fBEVP_CIPHER_CTX_get_cipher_data()\fR. .IP "\s-1EVP_CIPH_FLAG_DEFAULT_ASN1\s0" 4 .IX Item "EVP_CIPH_FLAG_DEFAULT_ASN1" Use the default \s-1EVP\s0 routines to pass \s-1IV\s0 to and from \s-1ASN.1.\s0 @@ -273,52 +277,52 @@ This indicates that this is an \s-1AEAD\s0 cipher implementation. Allow interleaving of crypto blocks, a particular optimization only applicable to certain \s-1TLS\s0 ciphers. .PP -\&\fIEVP_CIPHER_meth_set_impl_ctx_size()\fR sets the size of the \s-1EVP_CIPHER\s0's +\&\fBEVP_CIPHER_meth_set_impl_ctx_size()\fR sets the size of the \s-1EVP_CIPHER\s0's implementation context so that it can be automatically allocated. .PP -\&\fIEVP_CIPHER_meth_set_init()\fR sets the cipher init function for +\&\fBEVP_CIPHER_meth_set_init()\fR sets the cipher init function for \&\fBcipher\fR. -The cipher init function is called by \fIEVP_CipherInit()\fR, -\&\fIEVP_CipherInit_ex()\fR, \fIEVP_EncryptInit()\fR, \fIEVP_EncryptInit_ex()\fR, -\&\fIEVP_DecryptInit()\fR, \fIEVP_DecryptInit_ex()\fR. +The cipher init function is called by \fBEVP_CipherInit()\fR, +\&\fBEVP_CipherInit_ex()\fR, \fBEVP_EncryptInit()\fR, \fBEVP_EncryptInit_ex()\fR, +\&\fBEVP_DecryptInit()\fR, \fBEVP_DecryptInit_ex()\fR. .PP -\&\fIEVP_CIPHER_meth_set_do_cipher()\fR sets the cipher function for +\&\fBEVP_CIPHER_meth_set_do_cipher()\fR sets the cipher function for \&\fBcipher\fR. -The cipher function is called by \fIEVP_CipherUpdate()\fR, -\&\fIEVP_EncryptUpdate()\fR, \fIEVP_DecryptUpdate()\fR, \fIEVP_CipherFinal()\fR, -\&\fIEVP_EncryptFinal()\fR, \fIEVP_EncryptFinal_ex()\fR, \fIEVP_DecryptFinal()\fR and -\&\fIEVP_DecryptFinal_ex()\fR. +The cipher function is called by \fBEVP_CipherUpdate()\fR, +\&\fBEVP_EncryptUpdate()\fR, \fBEVP_DecryptUpdate()\fR, \fBEVP_CipherFinal()\fR, +\&\fBEVP_EncryptFinal()\fR, \fBEVP_EncryptFinal_ex()\fR, \fBEVP_DecryptFinal()\fR and +\&\fBEVP_DecryptFinal_ex()\fR. .PP -\&\fIEVP_CIPHER_meth_set_cleanup()\fR sets the function for \fBcipher\fR to do +\&\fBEVP_CIPHER_meth_set_cleanup()\fR sets the function for \fBcipher\fR to do extra cleanup before the method's private data structure is cleaned out and freed. Note that the cleanup function is passed a \fB\s-1EVP_CIPHER_CTX\s0 *\fR, the private data structure is then available with -\&\fIEVP_CIPHER_CTX_get_cipher_data()\fR. -This cleanup function is called by \fIEVP_CIPHER_CTX_reset()\fR and -\&\fIEVP_CIPHER_CTX_free()\fR. +\&\fBEVP_CIPHER_CTX_get_cipher_data()\fR. +This cleanup function is called by \fBEVP_CIPHER_CTX_reset()\fR and +\&\fBEVP_CIPHER_CTX_free()\fR. .PP -\&\fIEVP_CIPHER_meth_set_set_asn1_params()\fR sets the function for \fBcipher\fR +\&\fBEVP_CIPHER_meth_set_set_asn1_params()\fR sets the function for \fBcipher\fR to set the AlgorithmIdentifier \*(L"parameter\*(R" based on the passed cipher. -This function is called by \fIEVP_CIPHER_param_to_asn1()\fR. -\&\fIEVP_CIPHER_meth_set_get_asn1_params()\fR sets the function for \fBcipher\fR +This function is called by \fBEVP_CIPHER_param_to_asn1()\fR. +\&\fBEVP_CIPHER_meth_set_get_asn1_params()\fR sets the function for \fBcipher\fR that sets the cipher parameters based on an \s-1ASN.1\s0 AlgorithmIdentifier \&\*(L"parameter\*(R". Both these functions are needed when there is a need for custom data (more or other than the cipher \s-1IV\s0). -They are called by \fIEVP_CIPHER_param_to_asn1()\fR and -\&\fIEVP_CIPHER_asn1_to_param()\fR respectively if defined. +They are called by \fBEVP_CIPHER_param_to_asn1()\fR and +\&\fBEVP_CIPHER_asn1_to_param()\fR respectively if defined. .PP -\&\fIEVP_CIPHER_meth_set_ctrl()\fR sets the control function for \fBcipher\fR. +\&\fBEVP_CIPHER_meth_set_ctrl()\fR sets the control function for \fBcipher\fR. .PP -\&\fIEVP_CIPHER_meth_get_init()\fR, \fIEVP_CIPHER_meth_get_do_cipher()\fR, -\&\fIEVP_CIPHER_meth_get_cleanup()\fR, \fIEVP_CIPHER_meth_get_set_asn1_params()\fR, -\&\fIEVP_CIPHER_meth_get_get_asn1_params()\fR and \fIEVP_CIPHER_meth_get_ctrl()\fR +\&\fBEVP_CIPHER_meth_get_init()\fR, \fBEVP_CIPHER_meth_get_do_cipher()\fR, +\&\fBEVP_CIPHER_meth_get_cleanup()\fR, \fBEVP_CIPHER_meth_get_set_asn1_params()\fR, +\&\fBEVP_CIPHER_meth_get_get_asn1_params()\fR and \fBEVP_CIPHER_meth_get_ctrl()\fR are all used to retrieve the method data given with the EVP_CIPHER_meth_set_*() functions above. .SH "RETURN VALUES" .IX Header "RETURN VALUES" -\&\fIEVP_CIPHER_meth_new()\fR and \fIEVP_CIPHER_meth_dup()\fR return a pointer to a +\&\fBEVP_CIPHER_meth_new()\fR and \fBEVP_CIPHER_meth_dup()\fR return a pointer to a newly created \fB\s-1EVP_CIPHER\s0\fR, or \s-1NULL\s0 on failure. All EVP_CIPHER_meth_set_*() functions return 1. All EVP_CIPHER_meth_get_*() functions return pointers to their |