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