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