Synchronize man3 EVP cipher list with existing implementations, adding:
[openssl.git] / doc / man3 / EVP_rc5_32_12_16_cbc.pod
1 =pod
2
3 =head1 NAME
4
5 EVP_rc5_32_12_16_cbc,
6 EVP_rc5_32_12_16_cfb,
7 EVP_rc5_32_12_16_ecb,
8 EVP_rc5_32_12_16_ofb
9 - EVP RC5 cipher
10
11 =head1 SYNOPSIS
12
13  #include <openssl/evp.h>
14
15  const EVP_CIPHER *EVP_rc5_32_12_16_cbc(void)
16  const EVP_CIPHER *EVP_rc5_32_12_16_cfb(void)
17  const EVP_CIPHER *EVP_rc5_32_12_16_ecb(void)
18  const EVP_CIPHER *EVP_rc5_32_12_16_ofb(void)
19
20 =head1 DESCRIPTION
21
22 The RC5 encryption algorithm for EVP.
23
24 =over 4
25
26 =item EVP_rc5_32_12_16_cbc(),
27 EVP_rc5_32_12_16_cfb(),
28 EVP_rc5_32_12_16_ecb(),
29 EVP_rc5_32_12_16_ofb()
30
31 RC5 encryption algorithm in CBC, CFB, ECB and OFB modes respectively. This is a
32 variable key length cipher with an additional "number of rounds" parameter. By
33 default the key length is set to 128 bits and 12 rounds.
34
35 =back
36
37 =head1 RETURN VALUES
38
39 These functions return an B<EVP_CIPHER> structure that contains the
40 implementation of the symmetric cipher. See L<EVP_CIPHER_meth_new(3)> for
41 details of the B<EVP_CIPHER> structure.
42
43 =head1 BUGS
44
45 Currently the number of rounds in RC5 can only be set to 8, 12 or 16.
46 This is a limitation of the current RC5 code rather than the EVP interface.
47
48 =head1 SEE ALSO
49
50 L<evp(7)>,
51 L<EVP_EncryptInit(3)>,
52 L<EVP_CIPHER_meth_new(3)>
53
54 =head1 COPYRIGHT
55
56 Copyright 2017 The OpenSSL Project Authors. All Rights Reserved.
57
58 Licensed under the OpenSSL license (the "License").  You may not use
59 this file except in compliance with the License.  You can obtain a copy
60 in the file LICENSE in the source distribution or at
61 L<https://www.openssl.org/source/license.html>.
62
63 =cut
64