diff options
author | Ronald Tse <ronald.tse@ribose.com> | 2017-10-21 11:59:09 +0900 |
---|---|---|
committer | Richard Levitte <levitte@openssl.org> | 2017-10-31 16:28:42 +0100 |
commit | 8fa4d95e8e2c95a61748313b33d3493cfb67a027 (patch) | |
tree | 26335548356a487b838ea2cd7dc476fdbdc43938 /doc/man3/EVP_des.pod | |
parent | bbda8ce9da37af41a83cbe188ac3747d7053b553 (diff) |
Synchronize man3 EVP cipher list with existing implementations, adding:
* ARIA, SEED, Camellia
* AES-XTS, OCB, CTR
* Key wrap for 3DES, AES
* RC4-MD5 AD
* CFB modes with 1-bit and 8-bit shifts
Split EVP_EncryptInit cipher list to individual man pages.
Consolidate cipher bit-lengths in EVP_EncryptInit cipher list.
Clarify
Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/4564)
Diffstat (limited to 'doc/man3/EVP_des.pod')
-rw-r--r-- | doc/man3/EVP_des.pod | 96 |
1 files changed, 96 insertions, 0 deletions
diff --git a/doc/man3/EVP_des.pod b/doc/man3/EVP_des.pod new file mode 100644 index 0000000000..836c399c84 --- /dev/null +++ b/doc/man3/EVP_des.pod @@ -0,0 +1,96 @@ +=pod + +=head1 NAME + +EVP_des_cbc, +EVP_des_cfb, +EVP_des_cfb1, +EVP_des_cfb8, +EVP_des_ecb, +EVP_des_ede, +EVP_des_ede_cfb, +EVP_des_ede_ofb, +EVP_des_ofb, +EVP_des_ede3, +EVP_des_ede3_cbc, +EVP_des_ede3_cfb, +EVP_des_ede3_cfb1, +EVP_des_ede3_cfb8, +EVP_des_ede3_ofb, +EVP_des_ede3_wrap, +EVP_des_ede_cbc +- EVP DES cipher + +=head1 SYNOPSIS + +=for comment generic + + #include <openssl/evp.h> + + const EVP_CIPHER *EVP_ciphername(void) + +I<EVP_ciphername> is used a placeholder for any of the described cipher +functions, such as I<EVP_des_cbc>. + +=head1 DESCRIPTION + +The DES encryption algorithm for EVP. + +=over 4 + +=item EVP_des_cbc(), +EVP_des_ecb(), +EVP_des_cfb(), +EVP_des_cfb1(), +EVP_des_cfb8(), +EVP_des_ofb() + +DES in CBC, ECB, CFB with 128-bit shift, CFB with 1-bit shift, CFB with 8-bit +shift and OFB modes respectively. + +=item EVP_des_ede(), +EVP_des_ede_cbc(), +EVP_des_ede_ofb(), +EVP_des_ede_cfb() + +Two key triple DES in ECB, CBC, CFB and OFB modes respectively. + +=item EVP_des_ede3(), +EVP_des_ede3_cbc(), +EVP_des_ede3_cfb(), +EVP_des_ede3_cfb1(), +EVP_des_ede3_cfb8(), +EVP_des_ede3_ofb() + +Three-key triple DES in ECB, CBC, CFB with 128-bit shift, CFB with 1-bit shift, +CFB with 8-bit shift and OFB modes respectively. + +=item EVP_des_ede3_wrap() + +Triple-DES key wrap according to RFC 3217 Section 3. + +=back + +=head1 RETURN VALUES + +These functions return an B<EVP_CIPHER> structure that contains the +implementation of the symmetric cipher. See L<EVP_CIPHER_meth_new(3)> for +details of the B<EVP_CIPHER> structure. + +=head1 SEE ALSO + +L<evp(7)>, +L<EVP_EncryptInit(3)>, +L<EVP_CIPHER_meth_new(3)> + +=head1 COPYRIGHT + +Copyright 2017 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the OpenSSL license (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L<https://www.openssl.org/source/license.html>. + +=cut + |