Document the provider side SM2 Asymmetric Cipher support
authorMatt Caswell <matt@openssl.org>
Fri, 18 Sep 2020 11:10:21 +0000 (12:10 +0100)
committerMatt Caswell <matt@openssl.org>
Fri, 25 Sep 2020 10:13:54 +0000 (11:13 +0100)
Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/12913)

doc/man7/EVP_ASYM_CIPHER-SM2.pod [new file with mode: 0644]
doc/man7/EVP_PKEY-SM2.pod [moved from doc/man7/SM2.pod with 94% similarity]
doc/man7/OSSL_PROVIDER-default.pod
doc/man7/provider-asym_cipher.pod

diff --git a/doc/man7/EVP_ASYM_CIPHER-SM2.pod b/doc/man7/EVP_ASYM_CIPHER-SM2.pod
new file mode 100644 (file)
index 0000000..27f0032
--- /dev/null
@@ -0,0 +1,41 @@
+=pod
+
+=head1 NAME
+
+EVP_ASYM_CIPHER-SM2
+- SM2 Asymmetric Cipher algorithm support
+
+=head1 DESCRIPTION
+
+Asymmetric Cipher support for the B<SM2> key type.
+
+=head2 SM2 Asymmetric Cipher parameters
+
+=over 4
+
+=item "digest" (B<OSSL_ASYM_CIPHER_PARAM_DIGEST>) <UTF8 string>
+
+=item "digest-props" (B<OSSL_ASYM_CIPHER_PARAM_DIGEST_PROPS>) <UTF8 string>
+
+See L<provider-asym_cipher(7)/Asymmetric Cipher Parameters>.
+
+=back
+
+=head1 SEE ALSO
+
+L<EVP_PKEY-SM2(7)>,
+L<EVP_PKEY(3)>,
+L<provider-asym_cipher(7)>,
+L<provider-keymgmt(7)>,
+L<OSSL_PROVIDER-default(7)>
+
+=head1 COPYRIGHT
+
+Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.
+
+Licensed under the Apache License 2.0 (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
similarity index 94%
rename from doc/man7/SM2.pod
rename to doc/man7/EVP_PKEY-SM2.pod
index de52d05..bb6258c 100644 (file)
@@ -2,7 +2,8 @@
 
 =head1 NAME
 
-SM2 - Chinese SM2 signature and encryption algorithm support
+EVP_PKEY-SM2, EVP_KEYMGMT-SM2, SM2
+- EVP_PKEY keytype support for the Chinese SM2 signature and encryption algorithms
 
 =head1 DESCRIPTION
 
@@ -33,7 +34,7 @@ that B<EVP_PKEY_CTX> should be assigned to the B<EVP_MD_CTX>, like this:
 There is normally no need to pass a B<pctx> parameter to EVP_DigestSignInit()
 or EVP_DigestVerifyInit() in such a scenario.
 
-SM2 can be tested with the L<openssl-speed(1)> application since version 3.0.0.
+SM2 can be tested with the L<openssl-speed(1)> application since version 3.0.
 Currently, the only valid algorithm name is B<sm2>.
 
 =head1 EXAMPLES
index 848c887..da6185c 100644 (file)
@@ -180,6 +180,8 @@ The OpenSSL default provider supports these operations and algorithms:
 
 =item RSA, see L<EVP_ASYM_CIPHER-RSA(7)>
 
+=item SM2, see L<EVP_ASYM_CIPHER-SM2(7)>
+
 =back
 
 =head2 Asymmetric Key Encapsulation
index 5531a08..ca3e12f 100644 (file)
@@ -193,10 +193,19 @@ further details.
 Gets or sets the name of the OAEP digest algorithm used when OAEP padding is in
 use.
 
+=item "digest" (B<OSSL_ASYM_CIPHER_PARAM_DIGEST>) <UTF8 string>
+
+Gets or sets the name of the digest algorithm used by the algorithm (where
+applicable).
+
 =item "digest-props" (B<OSSL_ASYM_CIPHER_PARAM_OAEP_DIGEST_PROPS>) <UTF8 string>
 
 Gets or sets the properties to use when fetching the OAEP digest algorithm.
 
+=item "digest-props" (B<OSSL_ASYM_CIPHER_PARAM_DIGEST_PROPS>) <UTF8 string>
+
+Gets or sets the properties to use when fetching the cipher digest algorithm.
+
 =item "mgf1-digest" (B<OSSL_ASYM_CIPHER_PARAM_MGF1_DIGEST>) <UTF8 string>
 
 Gets or sets the name of the MGF1 digest algorithm used when OAEP or PSS padding