Debian Codegraph @

upstream/debian-unstable/man3/RC4_set_key.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 "RC4_SET_KEY 3SSL"
58 .TH RC4_SET_KEY 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 RC4_set_key, RC4 \- RC4 encryption
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/rc4.h>
69 .Ve
70 .PP
71 The following functions have been deprecated since OpenSSL 3.0, and can be
72 hidden entirely by defining \fBOPENSSL_API_COMPAT\fR with a suitable version value,
73 see \fBopenssl_user_macros\fR\|(7):
74 .PP
75 .Vb 1
76 \& void RC4_set_key(RC4_KEY *key, int len, const unsigned char *data);
77 \&
78 \& void RC4(RC4_KEY *key, unsigned long len, const unsigned char *indata,
79 \& unsigned char *outdata);
80 .Ve
81 .SH DESCRIPTION
82 .IX Header "DESCRIPTION"
83 All of the functions described on this page are deprecated. Applications should
84 instead use \fBEVP_EncryptInit_ex\fR\|(3), \fBEVP_EncryptUpdate\fR\|(3) and
85 \&\fBEVP_EncryptFinal_ex\fR\|(3) or the equivalently named decrypt functions.
86 .PP
87 This library implements the Alleged RC4 cipher, which is described for
88 example in \fIApplied Cryptography\fR. It is believed to be compatible
89 with RC4[TM], a proprietary cipher of RSA Security Inc.
90 .PP
91 RC4 is a stream cipher with variable key length. Typically, 128 bit
92 (16 byte) keys are used for strong encryption, but shorter insecure
93 key sizes have been widely used due to export restrictions.
94 .PP
95 RC4 consists of a key setup phase and the actual encryption or
96 decryption phase.
97 .PP
98 \&\fBRC4_set_key()\fR sets up the \fBRC4_KEY\fR \fBkey\fR using the \fBlen\fR bytes long
99 key at \fBdata\fR.
100 .PP
101 \&\fBRC4()\fR encrypts or decrypts the \fBlen\fR bytes of data at \fBindata\fR using
102 \&\fBkey\fR and places the result at \fBoutdata\fR. Repeated \fBRC4()\fR calls with
103 the same \fBkey\fR yield a continuous key stream.
104 .PP
105 Since RC4 is a stream cipher (the input is XORed with a pseudo-random
106 key stream to produce the output), decryption uses the same function
107 calls as encryption.
108 .SH "RETURN VALUES"
109 .IX Header "RETURN VALUES"
110 \&\fBRC4_set_key()\fR and \fBRC4()\fR do not return values.
111 .SH NOTE
112 .IX Header "NOTE"
113 Applications should use the higher level functions
114 \&\fBEVP_EncryptInit\fR\|(3) etc. instead of calling these
115 functions directly.
116 .PP
117 It is difficult to securely use stream ciphers. For example, do not perform
118 multiple encryptions using the same key stream.
119 .SH "SEE ALSO"
120 .IX Header "SEE ALSO"
121 \&\fBEVP_EncryptInit\fR\|(3)
122 .SH HISTORY
123 .IX Header "HISTORY"
124 All of these functions were deprecated in OpenSSL 3.0.
125 .SH COPYRIGHT
126 .IX Header "COPYRIGHT"
127 Copyright 2000\-2020 The OpenSSL Project Authors. All Rights Reserved.
128 .PP
129 Licensed under the Apache License 2.0 (the "License"). You may not use
130 this file except in compliance with the License. You can obtain a copy
131 in the file LICENSE in the source distribution or at
132 <https://www.openssl.org/source/license.html>.