diff options
author | schwarze <> | 2016-11-05 13:36:33 +0000 |
---|---|---|
committer | schwarze <> | 2016-11-05 13:36:33 +0000 |
commit | 71b431bd059aaefaa67b54a34adfaadc4014902c (patch) | |
tree | 7bf60aef63735e9638d12b0d8302b14d9860466e /src/lib/libcrypto/doc/RC4.pod | |
parent | 5074288f0801a2b426584402e81b5953f706a44f (diff) | |
download | openbsd-71b431bd059aaefaa67b54a34adfaadc4014902c.tar.gz openbsd-71b431bd059aaefaa67b54a34adfaadc4014902c.tar.bz2 openbsd-71b431bd059aaefaa67b54a34adfaadc4014902c.zip |
convert the remaining manual pages from pod to mdoc
Diffstat (limited to 'src/lib/libcrypto/doc/RC4.pod')
-rw-r--r-- | src/lib/libcrypto/doc/RC4.pod | 62 |
1 files changed, 0 insertions, 62 deletions
diff --git a/src/lib/libcrypto/doc/RC4.pod b/src/lib/libcrypto/doc/RC4.pod deleted file mode 100644 index b6d3a4342c..0000000000 --- a/src/lib/libcrypto/doc/RC4.pod +++ /dev/null | |||
@@ -1,62 +0,0 @@ | |||
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 | Applications should use the higher level functions | ||
41 | L<EVP_EncryptInit(3)|EVP_EncryptInit(3)> | ||
42 | etc. instead of calling the RC4 functions directly. | ||
43 | |||
44 | =head1 RETURN VALUES | ||
45 | |||
46 | RC4_set_key() and RC4() do not return values. | ||
47 | |||
48 | =head1 NOTE | ||
49 | |||
50 | Certain conditions have to be observed to securely use stream ciphers. | ||
51 | It is not permissible to perform multiple encryptions using the same | ||
52 | key stream. | ||
53 | |||
54 | =head1 SEE ALSO | ||
55 | |||
56 | L<blowfish(3)|blowfish(3)>, L<des(3)|des(3)>, L<rc2(3)|rc2(3)> | ||
57 | |||
58 | =head1 HISTORY | ||
59 | |||
60 | RC4_set_key() and RC4() are available in all versions of SSLeay and OpenSSL. | ||
61 | |||
62 | =cut | ||