xref: /openbsd/lib/libcrypto/man/EVP_rc4.3 (revision 274d7c50)
1.\" $OpenBSD: EVP_rc4.3,v 1.1 2019/03/21 13:37:25 schwarze Exp $
2.\" full merge up to: OpenSSL 8fa4d95e Oct 21 11:59:09 2017 +0900
3.\"
4.\" This file was written by Ronald Tse <ronald.tse@ribose.com>
5.\" Copyright (c) 2017 The OpenSSL Project.  All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\"
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\"
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in
16.\"    the documentation and/or other materials provided with the
17.\"    distribution.
18.\"
19.\" 3. All advertising materials mentioning features or use of this
20.\"    software must display the following acknowledgment:
21.\"    "This product includes software developed by the OpenSSL Project
22.\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
23.\"
24.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
25.\"    endorse or promote products derived from this software without
26.\"    prior written permission. For written permission, please contact
27.\"    openssl-core@openssl.org.
28.\"
29.\" 5. Products derived from this software may not be called "OpenSSL"
30.\"    nor may "OpenSSL" appear in their names without prior written
31.\"    permission of the OpenSSL Project.
32.\"
33.\" 6. Redistributions of any form whatsoever must retain the following
34.\"    acknowledgment:
35.\"    "This product includes software developed by the OpenSSL Project
36.\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
37.\"
38.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
39.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
40.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
41.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
42.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
43.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
44.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
45.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
46.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
47.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
49.\" OF THE POSSIBILITY OF SUCH DAMAGE.
50.\"
51.Dd $Mdocdate: March 21 2019 $
52.Dt EVP_RC4 3
53.Os
54.Sh NAME
55.Nm EVP_rc4 ,
56.Nm EVP_rc4_40 ,
57.Nm EVP_rc4_hmac_md5
58.Nd EVP RC4 stream cipher
59.Sh SYNOPSIS
60.In openssl/evp.h
61.Ft const EVP_CIPHER *
62.Fn EVP_rc4 void
63.Ft const EVP_CIPHER *
64.Fn EVP_rc4_40 void
65.Ft const EVP_CIPHER *
66.Fn EVP_rc4_hmac_md5 void
67.Sh DESCRIPTION
68These functions provide the RC4 stream cipher in the
69.Xr evp 3
70framework.
71It is a variable key length cipher.
72.Pp
73.Fn EVP_rc4
74uses a default key length of 128 bits.
75.Pp
76.Fn EVP_rc4_40
77uses a key length of 40 bits instead.
78This function is deprecated.
79Use
80.Fn EVP_rc4
81and
82.Xr EVP_CIPHER_CTX_set_key_length 3
83instead.
84.Pp
85.Fn EVP_rc4_hmac_md5
86provides authenticated encryption with the RC4 stream cipher
87with MD5 as HMAC.
88This function is not intended for usage outside of TLS
89and requires calling of some undocumented control functions.
90It does not conform to the EVP AEAD interface.
91.Sh RETURN VALUES
92These functions return an
93.Vt EVP_CIPHER
94structure that provides the implementation of the symmetric cipher.
95.Sh SEE ALSO
96.Xr evp 3 ,
97.Xr EVP_EncryptInit 3
98.Sh HISTORY
99.Fn EVP_rc4
100first appeared in SSLeay 0.5.1
101and
102.Fn EVP_rc4_40
103in OpenSSL 0.9.1.
104These functions have been available since
105.Ox 2.4 .
106.Pp
107.Fn EVP_rc4_hmac_md5
108first appeared in OpenSSL 1.0.1 and has been available since
109.Ox 5.3 .
110