DOCS: Add documentation for EVP_PKEY_CTX_set_rsa_pss_keygen_mgf1_md_name()
authorRichard Levitte <levitte@openssl.org>
Thu, 18 Jun 2020 10:28:36 +0000 (12:28 +0200)
committerRichard Levitte <levitte@openssl.org>
Tue, 23 Jun 2020 09:30:11 +0000 (11:30 +0200)
At the same, align documentation markup to be closer to man-pages(7)
recommendations.

Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/12188)

doc/man3/EVP_PKEY_CTX_set_rsa_pss_keygen_md.pod

index e3ed14c..d4af8aa 100644 (file)
@@ -4,6 +4,7 @@
 
 EVP_PKEY_CTX_set_rsa_pss_keygen_md,
 EVP_PKEY_CTX_set_rsa_pss_keygen_mgf1_md,
+EVP_PKEY_CTX_set_rsa_pss_keygen_mgf1_md_name,
 EVP_PKEY_CTX_set_rsa_pss_keygen_saltlen
 - EVP_PKEY RSA-PSS algorithm support functions
 
@@ -15,6 +16,8 @@ EVP_PKEY_CTX_set_rsa_pss_keygen_saltlen
                                         const EVP_MD *md);
  int EVP_PKEY_CTX_set_rsa_pss_keygen_mgf1_md(EVP_PKEY_CTX *pctx,
                                              const EVP_MD *md);
+ int EVP_PKEY_CTX_set_rsa_pss_keygen_mgf1_md_name(EVP_PKEY_CTX *pctx,
+                                                  const char *mdname);
  int EVP_PKEY_CTX_set_rsa_pss_keygen_saltlen(EVP_PKEY_CTX *pctx,
                                              int saltlen);
 
@@ -36,7 +39,7 @@ RSA_PSS_SALTLEN_AUTO) is not supported for verification if the key has
 usage restrictions.
 
 The L<EVP_PKEY_CTX_set_signature_md(3)> and L<EVP_PKEY_CTX_set_rsa_mgf1_md(3)>
-fuunctions are used to set the digest and MGF1 algorithms respectively. If the
+functions are used to set the digest and MGF1 algorithms respectively. If the
 key has usage restrictions then an error is returned if an attempt is made to
 set the digest to anything other than the restricted value. Otherwise these are
 similar to the B<RSA> versions.
@@ -55,13 +58,15 @@ then they are reflected in the corresponding parameters of the public key
 when (for example) a certificate request is signed.
 
 EVP_PKEY_CTX_set_rsa_pss_keygen_md() restricts the digest algorithm the
-generated key can use to B<md>.
+generated key can use to I<md>.
 
 EVP_PKEY_CTX_set_rsa_pss_keygen_mgf1_md() restricts the MGF1 algorithm the
-generated key can use to B<md>.
+generated key can use to I<md>.
+EVP_PKEY_CTX_set_rsa_pss_keygen_mgf1_md_name() does the same thing, but
+passes the algorithm by name rather than by B<EVP_MD>.
 
 EVP_PKEY_CTX_set_rsa_pss_keygen_saltlen() restricts the minimum salt length
-to B<saltlen>.
+to I<saltlen>.
 
 =head1 NOTES