651622df56a40957187561464ee300463d1fcc96
[openssl.git] / doc / man3 / EVP_des_cbc.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 openssl 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 None of these algorithms are provided by the OpenSSL default provider.
58 To use them it is necessary to load either the OpenSSL legacy provider or another
59 implementation.
60
61 =item EVP_des_ede(),
62 EVP_des_ede_cbc(),
63 EVP_des_ede_cfb(),
64 EVP_des_ede_cfb64(),
65 EVP_des_ede_ecb(),
66 EVP_des_ede_ofb()
67
68 Two key triple DES in ECB, CBC, CFB with 64-bit shift and OFB modes.
69
70 =item EVP_des_ede3(),
71 EVP_des_ede3_cbc(),
72 EVP_des_ede3_cfb(),
73 EVP_des_ede3_cfb1(),
74 EVP_des_ede3_cfb8(),
75 EVP_des_ede3_cfb64(),
76 EVP_des_ede3_ecb(),
77 EVP_des_ede3_ofb()
78
79 Three-key triple DES in ECB, CBC, CFB with 64-bit shift, CFB with 1-bit shift,
80 CFB with 8-bit shift and OFB modes.
81
82 =item EVP_des_ede3_wrap()
83
84 Triple-DES key wrap according to RFC 3217 Section 3.
85
86 =back
87
88 =head1 NOTES
89
90 Developers should be aware of the negative performance implications of
91 calling these functions multiple times and should consider using
92 L<EVP_CIPHER_fetch(3)> instead.
93 See L<crypto(7)/Performance> for further information.
94
95 =head1 RETURN VALUES
96
97 These functions return an B<EVP_CIPHER> structure that contains the
98 implementation of the symmetric cipher. See L<EVP_CIPHER_meth_new(3)> for
99 details of the B<EVP_CIPHER> structure.
100
101 =head1 SEE ALSO
102
103 L<evp(7)>,
104 L<EVP_EncryptInit(3)>,
105 L<EVP_CIPHER_meth_new(3)>
106
107 =head1 COPYRIGHT
108
109 Copyright 2017-2021 The OpenSSL Project Authors. All Rights Reserved.
110
111 Licensed under the Apache License 2.0 (the "License").  You may not use
112 this file except in compliance with the License.  You can obtain a copy
113 in the file LICENSE in the source distribution or at
114 L<https://www.openssl.org/source/license.html>.
115
116 =cut
117