diff options
author | Ronald Tse <ronald.tse@ribose.com> | 2017-10-21 04:59:09 +0200 |
---|---|---|
committer | Richard Levitte <levitte@openssl.org> | 2017-10-31 16:28:42 +0100 |
commit | 8fa4d95e8e2c95a61748313b33d3493cfb67a027 (patch) | |
tree | 26335548356a487b838ea2cd7dc476fdbdc43938 /doc/man3/EVP_rc4.pod | |
parent | EVP digest list: one hash algorithm per file, synchronize EVP list, overall c... (diff) | |
download | openssl-8fa4d95e8e2c95a61748313b33d3493cfb67a027.tar.xz openssl-8fa4d95e8e2c95a61748313b33d3493cfb67a027.zip |
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_rc4.pod')
-rw-r--r-- | doc/man3/EVP_rc4.pod | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/doc/man3/EVP_rc4.pod b/doc/man3/EVP_rc4.pod new file mode 100644 index 0000000000..7d642efdd9 --- /dev/null +++ b/doc/man3/EVP_rc4.pod @@ -0,0 +1,68 @@ +=pod + +=head1 NAME + +EVP_rc4, +EVP_rc4_40, +EVP_rc4_hmac_md5 +- EVP RC4 stream cipher + +=head1 SYNOPSIS + + #include <openssl/evp.h> + + const EVP_CIPHER *EVP_rc4(void) + const EVP_CIPHER *EVP_rc4_40(void) + const EVP_CIPHER *EVP_rc4_hmac_md5(void) + +=head1 DESCRIPTION + +The RC4 stream cipher for EVP. + +=over 4 + +=item EVP_rc4() + +RC4 stream cipher. This is a variable key length cipher with a default key +length of 128 bits. + +=item EVP_rc4_40() + +RC4 stream cipher with 40 bit key length. + +WARNING: this function is obsolete. Its usage should be replaced with the +EVP_rc4() and the EVP_CIPHER_CTX_set_key_length() functions. + +=item EVP_rc4_hmac_md5() + +Authenticated encryption with the RC4 stream cipher with MD5 as HMAC. + +WARNING: this is not intended for usage outside of TLS and requires calling of +some undocumented ctrl functions. These ciphers do not conform to the EVP AEAD +interface. + +=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 + |