projects / thirdparty / openssl.git / blame
| Commit | Line | Data |
|---|---|---|
| f19a5ff9 RT |
1 | =pod |
| 2 | ||
| 3 | =head1 NAME | |
| 4 | ||
| 5 | EVP_sm4_cbc, | |
| 6 | EVP_sm4_ecb, | |
| 7 | EVP_sm4_cfb, | |
| ffd89124 | 8 | EVP_sm4_cfb128, |
| f19a5ff9 RT |
9 | EVP_sm4_ofb, |
| 10 | EVP_sm4_ctr | |
| 11 | - EVP SM4 cipher | |
| 12 | ||
| 13 | =head1 SYNOPSIS | |
| 14 | ||
| f19a5ff9 RT |
15 | #include <openssl/evp.h> |
| 16 | ||
| 21ebd2fc PY |
17 | const EVP_CIPHER *EVP_sm4_cbc(void); |
| 18 | const EVP_CIPHER *EVP_sm4_ecb(void); | |
| 19 | const EVP_CIPHER *EVP_sm4_cfb(void); | |
| ffd89124 | 20 | const EVP_CIPHER *EVP_sm4_cfb128(void); |
| 21ebd2fc PY |
21 | const EVP_CIPHER *EVP_sm4_ofb(void); |
| 22 | const EVP_CIPHER *EVP_sm4_ctr(void); | |
| f19a5ff9 RT |
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(), | |
| ffd89124 | 35 | EVP_sm4_cfb128(), |
| f19a5ff9 RT |
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 | ||
| e798248c | 44 | =head1 NOTES |
| 45 | ||
| 46 | Developers should be aware of the negative performance implications of | |
| 47 | calling these functions multiple times and should consider using | |
| 48 | L<EVP_CIPHER_fetch(3)> instead. | |
| 49 | See L<crypto(7)/Performance> for further information. | |
| 50 | ||
| f19a5ff9 RT |
51 | =head1 RETURN VALUES |
| 52 | ||
| 53 | These functions return a B<EVP_CIPHER> structure that contains the | |
| 54 | implementation of the symmetric cipher. See L<EVP_CIPHER_meth_new(3)> for | |
| 55 | details of the B<EVP_CIPHER> structure. | |
| 56 | ||
| 57 | =head1 SEE ALSO | |
| 58 | ||
| 59 | L<evp(7)>, | |
| 60 | L<EVP_EncryptInit(3)>, | |
| 61 | L<EVP_CIPHER_meth_new(3)> | |
| 62 | ||
| 63 | =head1 COPYRIGHT | |
| 64 | ||
| da1c088f | 65 | Copyright 2017-2023 The OpenSSL Project Authors. All Rights Reserved. |
| f19a5ff9 RT |
66 | Copyright 2017 Ribose Inc. All Rights Reserved. |
| 67 | ||
| 4746f25a | 68 | Licensed under the Apache License 2.0 (the "License"). You may not use |
| f19a5ff9 RT |
69 | this file except in compliance with the License. You can obtain a copy |
| 70 | in the file LICENSE in the source distribution or at | |
| 71 | L<https://www.openssl.org/source/license.html>. | |
| 72 | ||
| 73 | =cut | |
| 74 |