evp_rand: documentation
[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. Alternative key lengths
37 can be set using L<EVP_CIPHER_CTX_set_key_length(3)>. The maximum key length is
38 2040 bits.
39
40 The following rc5 specific I<ctrl>s are supported (see
41 L<EVP_CIPHER_CTX_ctrl(3)>).
42
43 =over 4
44
45 =item EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_SET_RC5_ROUNDS, rounds, NULL)
46
47 Sets the number of rounds to B<rounds>. This must be one of RC5_8_ROUNDS,
48 RC5_12_ROUNDS or RC5_16_ROUNDS.
49
50 =item EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_GET_RC5_ROUNDS, 0, &rounds)
51
52 Stores the number of rounds currently configured in B<*rounds> where B<*rounds>
53 is an int.
54
55 =back
56
57 =back
58
59 =head1 RETURN VALUES
60
61 These functions return an B<EVP_CIPHER> structure that contains the
62 implementation of the symmetric cipher. See L<EVP_CIPHER_meth_new(3)> for
63 details of the B<EVP_CIPHER> structure.
64
65
66 =head1 SEE ALSO
67
68 L<evp(7)>,
69 L<EVP_EncryptInit(3)>,
70 L<EVP_CIPHER_meth_new(3)>
71
72 =head1 COPYRIGHT
73
74 Copyright 2017-2018 The OpenSSL Project Authors. All Rights Reserved.
75
76 Licensed under the Apache License 2.0 (the "License").  You may not use
77 this file except in compliance with the License.  You can obtain a copy
78 in the file LICENSE in the source distribution or at
79 L<https://www.openssl.org/source/license.html>.
80
81 =cut
82