Provide documentation for i2d_ECPrivateKey and d2i_ECPrivateKey
[openssl.git] / doc / crypto / rc4.pod
1 =pod
2
3 =head1 NAME
4
5 RC4_set_key, RC4 - RC4 encryption
6
7 =head1 SYNOPSIS
8
9  #include <openssl/rc4.h>
10
11  void RC4_set_key(RC4_KEY *key, int len, const unsigned char *data);
12
13  void RC4(RC4_KEY *key, unsigned long len, const unsigned char *indata,
14           unsigned char *outdata);
15
16 =head1 DESCRIPTION
17
18 This library implements the Alleged RC4 cipher, which is described for
19 example in I<Applied Cryptography>.  It is believed to be compatible
20 with RC4[TM], a proprietary cipher of RSA Security Inc.
21
22 RC4 is a stream cipher with variable key length.  Typically, 128 bit
23 (16 byte) keys are used for strong encryption, but shorter insecure
24 key sizes have been widely used due to export restrictions.
25
26 RC4 consists of a key setup phase and the actual encryption or
27 decryption phase.
28
29 RC4_set_key() sets up the B<RC4_KEY> B<key> using the B<len> bytes long
30 key at B<data>.
31
32 RC4() encrypts or decrypts the B<len> bytes of data at B<indata> using
33 B<key> and places the result at B<outdata>.  Repeated RC4() calls with
34 the same B<key> yield a continuous key stream.
35
36 Since RC4 is a stream cipher (the input is XORed with a pseudo-random
37 key stream to produce the output), decryption uses the same function
38 calls as encryption.
39
40 =head1 RETURN VALUES
41
42 RC4_set_key() and RC4() do not return values.
43
44 =head1 NOTE
45
46 Applications should use the higher level functions
47 L<EVP_EncryptInit(3)|EVP_EncryptInit(3)> etc. instead of calling these
48 functions directly.
49
50 It is difficult to securely use stream ciphers. For example, do not perform
51 multiple encryptions using the same key stream.
52
53 =head1 HISTORY
54
55 RC4_set_key() and RC4() are available in all versions of SSLeay and OpenSSL.
56
57 =head1 SEE ALSO
58
59 L<EVP_EncryptInit(3)|EVP_EncryptInit(3)>
60
61 =cut