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