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