9b42656c0207008bd22d45e5ef87d0e375db7826
[openssl.git] / doc / man3 / EVP_des.pod
1 =pod
2
3 =head1 NAME
4
5 EVP_des_cbc,
6 EVP_des_cfb,
7 EVP_des_cfb1,
8 EVP_des_cfb8,
9 EVP_des_cfb64,
10 EVP_des_ecb,
11 EVP_des_ofb,
12 EVP_des_ede,
13 EVP_des_ede_cbc,
14 EVP_des_ede_cfb,
15 EVP_des_ede_cfb64,
16 EVP_des_ede_ecb,
17 EVP_des_ede_ofb,
18 EVP_des_ede3,
19 EVP_des_ede3_cbc,
20 EVP_des_ede3_cfb,
21 EVP_des_ede3_cfb1,
22 EVP_des_ede3_cfb8,
23 EVP_des_ede3_cfb64,
24 EVP_des_ede3_ecb,
25 EVP_des_ede3_ofb,
26 EVP_des_ede3_wrap
27 - EVP DES cipher
28
29 =head1 SYNOPSIS
30
31 =for comment generic
32
33  #include <openssl/evp.h>
34
35  const EVP_CIPHER *EVP_ciphername(void)
36
37 I<EVP_ciphername> is used a placeholder for any of the described cipher
38 functions, such as I<EVP_des_cbc>.
39
40 =head1 DESCRIPTION
41
42 The DES encryption algorithm for EVP.
43
44 =over 4
45
46 =item EVP_des_cbc(),
47 EVP_des_ecb(),
48 EVP_des_cfb(),
49 EVP_des_cfb1(),
50 EVP_des_cfb8(),
51 EVP_des_cfb64(),
52 EVP_des_ofb()
53
54 DES in CBC, ECB, CFB with 64-bit shift, CFB with 1-bit shift, CFB with 8-bit
55 shift and OFB modes.
56
57 =item EVP_des_ede(),
58 EVP_des_ede_cbc(),
59 EVP_des_ede_cfb(),
60 EVP_des_ede_cfb64(),
61 EVP_des_ede_ecb(),
62 EVP_des_ede_ofb()
63
64 Two key triple DES in ECB, CBC, CFB with 64-bit shift and OFB modes.
65
66 =item EVP_des_ede3(),
67 EVP_des_ede3_cbc(),
68 EVP_des_ede3_cfb(),
69 EVP_des_ede3_cfb1(),
70 EVP_des_ede3_cfb8(),
71 EVP_des_ede3_cfb64(),
72 EVP_des_ede3_ecb(),
73 EVP_des_ede3_ofb()
74
75 Three-key triple DES in ECB, CBC, CFB with 64-bit shift, CFB with 1-bit shift,
76 CFB with 8-bit shift and OFB modes.
77
78 =item EVP_des_ede3_wrap()
79
80 Triple-DES key wrap according to RFC 3217 Section 3.
81
82 =back
83
84 =head1 RETURN VALUES
85
86 These functions return an B<EVP_CIPHER> structure that contains the
87 implementation of the symmetric cipher. See L<EVP_CIPHER_meth_new(3)> for
88 details of the B<EVP_CIPHER> structure.
89
90 =head1 SEE ALSO
91
92 L<evp(7)>,
93 L<EVP_EncryptInit(3)>,
94 L<EVP_CIPHER_meth_new(3)>
95
96 =head1 COPYRIGHT
97
98 Copyright 2017 The OpenSSL Project Authors. All Rights Reserved.
99
100 Licensed under the OpenSSL license (the "License").  You may not use
101 this file except in compliance with the License.  You can obtain a copy
102 in the file LICENSE in the source distribution or at
103 L<https://www.openssl.org/source/license.html>.
104
105 =cut
106