Correct EVP_CIPHER_meth_new.pod and EVP_MD_meth_new.pod
[openssl.git] / doc / man3 / EVP_rc2_cbc.pod
1 =pod
2
3 =head1 NAME
4
5 EVP_rc2_cbc,
6 EVP_rc2_cfb,
7 EVP_rc2_ecb,
8 EVP_rc2_ofb,
9 EVP_rc2_40_cbc,
10 EVP_rc2_64_cbc
11 - EVP RC2 cipher
12
13 =head1 SYNOPSIS
14
15  #include <openssl/evp.h>
16
17  const EVP_CIPHER *EVP_rc2_cbc(void)
18  const EVP_CIPHER *EVP_rc2_cfb(void)
19  const EVP_CIPHER *EVP_rc2_ecb(void)
20  const EVP_CIPHER *EVP_rc2_ofb(void)
21  const EVP_CIPHER *EVP_rc2_40_cbc(void)
22  const EVP_CIPHER *EVP_rc2_64_cbc(void)
23
24 =head1 DESCRIPTION
25
26 The RC2 encryption algorithm for EVP.
27
28 =over 4
29
30 =item EVP_rc2_cbc(),
31 EVP_rc2_cfb(),
32 EVP_rc2_ecb(),
33 EVP_rc2_ofb()
34
35 RC2 encryption algorithm in CBC, CFB, ECB and OFB modes respectively. This is a
36 variable key length cipher with an additional parameter called "effective key
37 bits" or "effective key length". By default both are set to 128 bits.
38
39 =item EVP_rc2_40_cbc(),
40 EVP_rc2_64_cbc()
41
42 RC2 algorithm in CBC mode with a default key length and effective key length of
43 40 and 64 bits.
44
45 WARNING: these functions are obsolete. Their usage should be replaced with the
46 EVP_rc2_cbc(), EVP_CIPHER_CTX_set_key_length() and EVP_CIPHER_CTX_ctrl()
47 functions to set the key length and effective key length.
48
49 =back
50
51 =head1 RETURN VALUES
52
53 These functions return an B<EVP_CIPHER> structure that contains the
54 implementation of the symmetric cipher. See L<EVP_CIPHER_meth_new(3)> for
55 details of the B<EVP_CIPHER> structure.
56
57 =head1 SEE ALSO
58
59 L<evp(7)>,
60 L<EVP_EncryptInit(3)>,
61 L<EVP_CIPHER_meth_new(3)>
62
63 =head1 COPYRIGHT
64
65 Copyright 2017 The OpenSSL Project Authors. All Rights Reserved.
66
67 Licensed under the OpenSSL license (the "License").  You may not use
68 this file except in compliance with the License.  You can obtain a copy
69 in the file LICENSE in the source distribution or at
70 L<https://www.openssl.org/source/license.html>.
71
72 =cut
73