xref: /netbsd-src/crypto/external/bsd/openssl/lib/libcrypto/man/RC4_set_key.3 (revision 7d9ffdb3e9da593a05c5e2169f72fc7bada08bc9)
$NetBSD: RC4_set_key.3,v 1.9 2024/09/08 13:08:29 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..
..
.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "RC4_set_key 3"
RC4_set_key 3 2024-09-03 3.0.15 OpenSSL
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
NAME
RC4_set_key, RC4 - RC4 encryption
SYNOPSIS
Header "SYNOPSIS" .Vb 1 #include <openssl/rc4.h> .Ve

The following functions have been deprecated since OpenSSL 3.0, and can be hidden entirely by defining OPENSSL_API_COMPAT with a suitable version value, see openssl_user_macros\|(7):

.Vb 1 void RC4_set_key(RC4_KEY *key, int len, const unsigned char *data); \& void RC4(RC4_KEY *key, unsigned long len, const unsigned char *indata, unsigned char *outdata); .Ve

DESCRIPTION
Header "DESCRIPTION" All of the functions described on this page are deprecated. Applications should instead use EVP_EncryptInit_ex\|(3), EVP_EncryptUpdate\|(3) and \fBEVP_EncryptFinal_ex\|(3) or the equivalently named decrypt functions.

This library implements the Alleged RC4 cipher, which is described for example in Applied Cryptography. It is believed to be compatible with RC4[TM], a proprietary cipher of RSA Security Inc.

RC4 is a stream cipher with variable key length. Typically, 128 bit (16 byte) keys are used for strong encryption, but shorter insecure key sizes have been widely used due to export restrictions.

RC4 consists of a key setup phase and the actual encryption or decryption phase.

\fBRC4_set_key() sets up the RC4_KEY key using the len bytes long key at data.

\fBRC4() encrypts or decrypts the len bytes of data at indata using \fBkey and places the result at outdata. Repeated RC4() calls with the same key yield a continuous key stream.

Since RC4 is a stream cipher (the input is XORed with a pseudo-random key stream to produce the output), decryption uses the same function calls as encryption.

"RETURN VALUES"
Header "RETURN VALUES" \fBRC4_set_key() and RC4() do not return values.
NOTE
Header "NOTE" Applications should use the higher level functions \fBEVP_EncryptInit\|(3) etc. instead of calling these functions directly.

It is difficult to securely use stream ciphers. For example, do not perform multiple encryptions using the same key stream.

"SEE ALSO"
Header "SEE ALSO" \fBEVP_EncryptInit\|(3)
HISTORY
Header "HISTORY" All of these functions were deprecated in OpenSSL 3.0.
COPYRIGHT
Header "COPYRIGHT" Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.