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