EVP module documentation pass
[openssl.git] / doc / man3 / EVP_sm4_cbc.pod
1 =pod
2
3 =head1 NAME
4
5 EVP_sm4_cbc,
6 EVP_sm4_ecb,
7 EVP_sm4_cfb,
8 EVP_sm4_cfb128,
9 EVP_sm4_ofb,
10 EVP_sm4_ctr
11 - EVP SM4 cipher
12
13 =head1 SYNOPSIS
14
15  #include <openssl/evp.h>
16
17  const EVP_CIPHER *EVP_sm4_cbc(void);
18  const EVP_CIPHER *EVP_sm4_ecb(void);
19  const EVP_CIPHER *EVP_sm4_cfb(void);
20  const EVP_CIPHER *EVP_sm4_cfb128(void);
21  const EVP_CIPHER *EVP_sm4_ofb(void);
22  const EVP_CIPHER *EVP_sm4_ctr(void);
23
24 =head1 DESCRIPTION
25
26 The SM4 blockcipher (GB/T 32907-2016) for EVP.
27
28 All modes below use a key length of 128 bits and acts on blocks of 128 bits.
29
30 =over 4
31
32 =item EVP_sm4_cbc(),
33 EVP_sm4_ecb(),
34 EVP_sm4_cfb(),
35 EVP_sm4_cfb128(),
36 EVP_sm4_ofb(),
37 EVP_sm4_ctr()
38
39 The SM4 blockcipher with a 128-bit key in CBC, ECB, CFB, OFB and CTR modes
40 respectively.
41
42 =back
43
44 =head1 RETURN VALUES
45
46 These functions return a B<EVP_CIPHER> structure that contains the
47 implementation of the symmetric cipher. See L<EVP_CIPHER_meth_new(3)> for
48 details of the B<EVP_CIPHER> structure.
49
50 =head1 SEE ALSO
51
52 L<evp(7)>,
53 L<EVP_EncryptInit(3)>,
54 L<EVP_CIPHER_meth_new(3)>
55
56 =head1 COPYRIGHT
57
58 Copyright 2017-2018 The OpenSSL Project Authors. All Rights Reserved.
59 Copyright 2017 Ribose Inc. All Rights Reserved.
60
61 Licensed under the OpenSSL license (the "License").  You may not use
62 this file except in compliance with the License.  You can obtain a copy
63 in the file LICENSE in the source distribution or at
64 L<https://www.openssl.org/source/license.html>.
65
66 =cut
67