summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorTomas Mraz <tomas@openssl.org>2022-07-28 15:45:02 +0200
committerTomas Mraz <tomas@openssl.org>2022-08-18 10:22:04 +0200
commite2fccd7b1eed8d4ec4fe74eae9320ced2bac203b (patch)
tree815ef0605668c3eb809ab3bb5d837301acb109e8 /doc
parentd6d977c807343112d137ced096dece84303ded46 (diff)
Clarify documentation in regards to EC key parameters
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)
Diffstat (limited to 'doc')
-rw-r--r--doc/man3/EVP_PKEY_fromdata.pod3
-rw-r--r--doc/man7/EVP_PKEY-EC.pod4
2 files changed, 6 insertions, 1 deletions
diff --git a/doc/man3/EVP_PKEY_fromdata.pod b/doc/man3/EVP_PKEY_fromdata.pod
index fdab94cd4f..158d1bf42d 100644
--- a/doc/man3/EVP_PKEY_fromdata.pod
+++ b/doc/man3/EVP_PKEY_fromdata.pod
@@ -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>:
diff --git a/doc/man7/EVP_PKEY-EC.pod b/doc/man7/EVP_PKEY-EC.pod
index c58f35547a..d9b1666b2e 100644
--- a/doc/man7/EVP_PKEY-EC.pod
+++ b/doc/man7/EVP_PKEY-EC.pod
@@ -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>