Debian Codegraph @

upstream/debian-unstable/man3/EVP_rc5_32_12_16_cbc.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "EVP_RC5_32_12_16_CBC 3SSL"
58 .TH EVP_RC5_32_12_16_CBC 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 EVP_rc5_32_12_16_cbc,
65 EVP_rc5_32_12_16_cfb,
66 EVP_rc5_32_12_16_cfb64,
67 EVP_rc5_32_12_16_ecb,
68 EVP_rc5_32_12_16_ofb
69 \&\- EVP RC5 cipher
70 .SH SYNOPSIS
71 .IX Header "SYNOPSIS"
72 .Vb 1
73 \& #include <openssl/evp.h>
74 \&
75 \& const EVP_CIPHER *EVP_rc5_32_12_16_cbc(void);
76 \& const EVP_CIPHER *EVP_rc5_32_12_16_cfb(void);
77 \& const EVP_CIPHER *EVP_rc5_32_12_16_cfb64(void);
78 \& const EVP_CIPHER *EVP_rc5_32_12_16_ecb(void);
79 \& const EVP_CIPHER *EVP_rc5_32_12_16_ofb(void);
80 .Ve
81 .SH DESCRIPTION
82 .IX Header "DESCRIPTION"
83 The RC5 encryption algorithm for EVP.
84 .IP "\fBEVP_rc5_32_12_16_cbc()\fR, \fBEVP_rc5_32_12_16_cfb()\fR, \fBEVP_rc5_32_12_16_cfb64()\fR, \fBEVP_rc5_32_12_16_ecb()\fR, \fBEVP_rc5_32_12_16_ofb()\fR" 4
85 .IX Item "EVP_rc5_32_12_16_cbc(), EVP_rc5_32_12_16_cfb(), EVP_rc5_32_12_16_cfb64(), EVP_rc5_32_12_16_ecb(), EVP_rc5_32_12_16_ofb()"
86 RC5 encryption algorithm in CBC, CFB, ECB and OFB modes respectively. This is a
87 variable key length cipher with an additional "number of rounds" parameter. By
88 default the key length is set to 128 bits and 12 rounds. Alternative key lengths
89 can be set using \fBEVP_CIPHER_CTX_set_key_length\fR\|(3). The maximum key length is
90 2040 bits.
91 .Sp
92 The following rc5 specific \fIctrl\fRs are supported (see
93 \&\fBEVP_CIPHER_CTX_ctrl\fR\|(3)).
94 .RS 4
95 .IP "EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_SET_RC5_ROUNDS, rounds, NULL)" 4
96 .IX Item "EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_SET_RC5_ROUNDS, rounds, NULL)"
97 Sets the number of rounds to \fBrounds\fR. This must be one of RC5_8_ROUNDS,
98 RC5_12_ROUNDS or RC5_16_ROUNDS.
99 .IP "EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_GET_RC5_ROUNDS, 0, &rounds)" 4
100 .IX Item "EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_GET_RC5_ROUNDS, 0, &rounds)"
101 Stores the number of rounds currently configured in \fB*rounds\fR where \fB*rounds\fR
102 is an int.
103 .RE
104 .RS 4
105 .RE
106 .SH NOTES
107 .IX Header "NOTES"
108 Developers should be aware of the negative performance implications of
109 calling these functions multiple times and should consider using
110 \&\fBEVP_CIPHER_fetch\fR\|(3) with \fBEVP_CIPHER\-RC5\fR\|(7) instead.
111 See "Performance" in \fBcrypto\fR\|(7) for further information.
112 .SH "RETURN VALUES"
113 .IX Header "RETURN VALUES"
114 These functions return an \fBEVP_CIPHER\fR structure that contains the
115 implementation of the symmetric cipher. See \fBEVP_CIPHER_meth_new\fR\|(3) for
116 details of the \fBEVP_CIPHER\fR structure.
117 .SH "SEE ALSO"
118 .IX Header "SEE ALSO"
119 \&\fBevp\fR\|(7),
120 \&\fBEVP_EncryptInit\fR\|(3),
121 \&\fBEVP_CIPHER_meth_new\fR\|(3)
122 .SH COPYRIGHT
123 .IX Header "COPYRIGHT"
124 Copyright 2017\-2023 The OpenSSL Project Authors. All Rights Reserved.
125 .PP
126 Licensed under the Apache License 2.0 (the "License"). You may not use
127 this file except in compliance with the License. You can obtain a copy
128 in the file LICENSE in the source distribution or at
129 <https://www.openssl.org/source/license.html>.