xref: /openssl/doc/man3/EVP_sm4_cbc.pod (revision b6eb95fa)
1=pod
2
3=head1 NAME
4
5EVP_sm4_cbc,
6EVP_sm4_ecb,
7EVP_sm4_cfb,
8EVP_sm4_cfb128,
9EVP_sm4_ofb,
10EVP_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
26The SM4 blockcipher (GB/T 32907-2016) for EVP.
27
28All 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(),
33EVP_sm4_ecb(),
34EVP_sm4_cfb(),
35EVP_sm4_cfb128(),
36EVP_sm4_ofb(),
37EVP_sm4_ctr()
38
39The SM4 blockcipher with a 128-bit key in CBC, ECB, CFB, OFB and CTR modes
40respectively.
41
42=back
43
44=head1 NOTES
45
46Developers should be aware of the negative performance implications of
47calling these functions multiple times and should consider using
48L<EVP_CIPHER_fetch(3)> with L<EVP_CIPHER-SM4(7)> instead.
49See L<crypto(7)/Performance> for further information.
50
51=head1 RETURN VALUES
52
53These functions return a B<EVP_CIPHER> structure that contains the
54implementation of the symmetric cipher. See L<EVP_CIPHER_meth_new(3)> for
55details of the B<EVP_CIPHER> structure.
56
57=head1 SEE ALSO
58
59L<evp(7)>,
60L<EVP_EncryptInit(3)>,
61L<EVP_CIPHER_meth_new(3)>
62
63=head1 COPYRIGHT
64
65Copyright 2017-2023 The OpenSSL Project Authors. All Rights Reserved.
66Copyright 2017 Ribose Inc. All Rights Reserved.
67
68Licensed under the Apache License 2.0 (the "License").  You may not use
69this file except in compliance with the License.  You can obtain a copy
70in the file LICENSE in the source distribution or at
71L<https://www.openssl.org/source/license.html>.
72
73=cut
74
75