Clarify documentation in regards to EC key parameters
authorTomas Mraz <tomas@openssl.org>
Thu, 28 Jul 2022 13:45:02 +0000 (15:45 +0200)
committerTomas Mraz <tomas@openssl.org>
Thu, 18 Aug 2022 08:22:04 +0000 (10:22 +0200)
Also clarify that EVP_PKEY_fromdata ignores parameters that
are unknown or incorrect for given selection.

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

(cherry picked from commit 58135cb3c020805354ecc869aca040934d1299c8)

doc/man3/EVP_PKEY_fromdata.pod
doc/man7/EVP_PKEY-EC.pod

index fdab94cd4f1bdc3c4442b72a900cac261625c706..158d1bf42d5a1c929109b14eb5d3c032cd93588a 100644 (file)
@@ -53,6 +53,9 @@ the settable parameters that can be used with EVP_PKEY_fromdata().
 I<selection> is described in L</Selections>.
 See L<OSSL_PARAM(3)> for the use of B<OSSL_PARAM> as parameter descriptor.
 
+Parameters in the I<params> array that are not among the settable parameters
+for the given I<selection> are ignored.
+
 =head2 Selections
 
 The following constants can be used for I<selection>:
index c58f35547ae5e51185978de707de74d75e4c9776..d9b1666b2eb804b4e3d9db306ff1ce0e50e0dd81 100644 (file)
@@ -110,7 +110,9 @@ per-operation basis.
 
 =item "pub" (B<OSSL_PKEY_PARAM_PUB_KEY>) <octet string>
 
-The public key value in EC point format.
+The public key value in encoded EC point format. This parameter is used
+when importing or exporting the public key value with the EVP_PKEY_fromdata()
+and EVP_PKEY_todata() functions.
 
 =item "priv" (B<OSSL_PKEY_PARAM_PRIV_KEY>) <unsigned integer>