diff options
author | Ronald Tse <ronald.tse@ribose.com> | 2017-10-31 15:19:14 +1000 |
---|---|---|
committer | Pauli <paul.dale@oracle.com> | 2017-10-31 15:19:14 +1000 |
commit | f19a5ff9ab85313f5b30cfc9fbed3a2eea60a59d (patch) | |
tree | e93336cc7c31d2a41e19b1c906135a6ec91cabfc /doc | |
parent | ffd23209933ea0ad5543f15ca6303d63d8dac826 (diff) |
SM4: Add SM4 block cipher to EVP
Reviewed-by: Richard Levitte <levitte@openssl.org>
Reviewed-by: Paul Dale <paul.dale@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/4552)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man3/EVP_sm4.pod | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/doc/man3/EVP_sm4.pod b/doc/man3/EVP_sm4.pod new file mode 100644 index 0000000000..d5c99cd4d9 --- /dev/null +++ b/doc/man3/EVP_sm4.pod @@ -0,0 +1,65 @@ +=pod + +=head1 NAME + +EVP_sm4_cbc, +EVP_sm4_ecb, +EVP_sm4_cfb, +EVP_sm4_ofb, +EVP_sm4_ctr +- EVP SM4 cipher + +=head1 SYNOPSIS + +=for comment generic + + #include <openssl/evp.h> + + const EVP_CIPHER *EVP_ciphername(void) + +I<EVP_ciphername> is used a placeholder for any of the described cipher +functions, such as I<EVP_sm4_cbc>. + +=head1 DESCRIPTION + +The SM4 blockcipher (GB/T 32907-2016) for EVP. + +All modes below use a key length of 128 bits and acts on blocks of 128 bits. + +=over 4 + +=item EVP_sm4_cbc(), +EVP_sm4_ecb(), +EVP_sm4_cfb(), +EVP_sm4_ofb(), +EVP_sm4_ctr() + +The SM4 blockcipher with a 128-bit key in CBC, ECB, CFB, OFB and CTR modes +respectively. + +=back + +=head1 RETURN VALUES + +These functions return a B<EVP_CIPHER> structure that contains the +implementation of the symmetric cipher. See L<EVP_CIPHER_meth_new(3)> for +details of the B<EVP_CIPHER> structure. + +=head1 SEE ALSO + +L<evp(7)>, +L<EVP_EncryptInit(3)>, +L<EVP_CIPHER_meth_new(3)> + +=head1 COPYRIGHT + +Copyright 2017 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2017 Ribose Inc. All Rights Reserved. + +Licensed under the OpenSSL license (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L<https://www.openssl.org/source/license.html>. + +=cut + |