xref: /openssl/doc/man3/EVP_rc5_32_12_16_cbc.pod (revision b6eb95fa)
1=pod
2
3=head1 NAME
4
5EVP_rc5_32_12_16_cbc,
6EVP_rc5_32_12_16_cfb,
7EVP_rc5_32_12_16_cfb64,
8EVP_rc5_32_12_16_ecb,
9EVP_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
24The RC5 encryption algorithm for EVP.
25
26=over 4
27
28=item EVP_rc5_32_12_16_cbc(),
29EVP_rc5_32_12_16_cfb(),
30EVP_rc5_32_12_16_cfb64(),
31EVP_rc5_32_12_16_ecb(),
32EVP_rc5_32_12_16_ofb()
33
34RC5 encryption algorithm in CBC, CFB, ECB and OFB modes respectively. This is a
35variable key length cipher with an additional "number of rounds" parameter. By
36default the key length is set to 128 bits and 12 rounds. Alternative key lengths
37can be set using L<EVP_CIPHER_CTX_set_key_length(3)>. The maximum key length is
382040 bits.
39
40The following rc5 specific I<ctrl>s are supported (see
41L<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
47Sets the number of rounds to B<rounds>. This must be one of RC5_8_ROUNDS,
48RC5_12_ROUNDS or RC5_16_ROUNDS.
49
50=item EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_GET_RC5_ROUNDS, 0, &rounds)
51
52Stores the number of rounds currently configured in B<*rounds> where B<*rounds>
53is an int.
54
55=back
56
57=back
58
59=head1 NOTES
60
61Developers should be aware of the negative performance implications of
62calling these functions multiple times and should consider using
63L<EVP_CIPHER_fetch(3)> with L<EVP_CIPHER-RC5(7)> instead.
64See L<crypto(7)/Performance> for further information.
65
66=head1 RETURN VALUES
67
68These functions return an B<EVP_CIPHER> structure that contains the
69implementation of the symmetric cipher. See L<EVP_CIPHER_meth_new(3)> for
70details of the B<EVP_CIPHER> structure.
71
72
73=head1 SEE ALSO
74
75L<evp(7)>,
76L<EVP_EncryptInit(3)>,
77L<EVP_CIPHER_meth_new(3)>
78
79=head1 COPYRIGHT
80
81Copyright 2017-2023 The OpenSSL Project Authors. All Rights Reserved.
82
83Licensed under the Apache License 2.0 (the "License").  You may not use
84this file except in compliance with the License.  You can obtain a copy
85in the file LICENSE in the source distribution or at
86L<https://www.openssl.org/source/license.html>.
87
88=cut
89