diff options
author | Matt Caswell <matt@openssl.org> | 2020-10-09 14:19:42 +0100 |
---|---|---|
committer | Matt Caswell <matt@openssl.org> | 2020-10-20 16:39:41 +0100 |
commit | 5ac8fb584a0ba8e4223e98b87a5416d67340360e (patch) | |
tree | d127cc3bc9bb60a2c0a0da2dab13b9ed779eb4dd /doc | |
parent | 6a13c9c9842f54ed8d98c6f37cc4ae6c1cde8b7a (diff) |
Rename EVP_PKEY_set1_tls_encodedpoint to EVP_PKEY_set1_encoded_public_key
We do the same thing for the "get1" version. In reality this has broader
use than just TLS (it can also be used in CMS), and "encodedpoint" only
makes sense when you are talking about EC based algorithms.
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
(Merged from https://github.com/openssl/openssl/pull/13105)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man3/EVP_PKEY_ASN1_METHOD.pod | 4 | ||||
-rw-r--r-- | doc/man7/EVP_PKEY-DH.pod | 2 | ||||
-rw-r--r-- | doc/man7/EVP_PKEY-EC.pod | 7 | ||||
-rw-r--r-- | doc/man7/EVP_PKEY-X25519.pod | 7 |
4 files changed, 11 insertions, 9 deletions
diff --git a/doc/man3/EVP_PKEY_ASN1_METHOD.pod b/doc/man3/EVP_PKEY_ASN1_METHOD.pod index bc1f1ad04d..9f50a56964 100644 --- a/doc/man3/EVP_PKEY_ASN1_METHOD.pod +++ b/doc/man3/EVP_PKEY_ASN1_METHOD.pod @@ -258,8 +258,8 @@ L<EVP_PKEY_set_type_str(3)>, and L<EVP_PKEY_assign(3)>. The pkey_ctrl() method adds extra algorithm specific control. It's called by L<EVP_PKEY_get_default_digest_nid(3)>, L<EVP_PKEY_supports_digest_nid(3)>, -L<EVP_PKEY_set1_tls_encodedpoint(3)>, -L<EVP_PKEY_get1_tls_encodedpoint(3)>, L<PKCS7_SIGNER_INFO_set(3)>, +L<EVP_PKEY_set1_encoded_public_key(3)>, +L<EVP_PKEY_get1_encoded_public_key(3)>, L<PKCS7_SIGNER_INFO_set(3)>, L<PKCS7_RECIP_INFO_set(3)>, ... int (*old_priv_decode) (EVP_PKEY *pkey, diff --git a/doc/man7/EVP_PKEY-DH.pod b/doc/man7/EVP_PKEY-DH.pod index 45d7c6ed5f..64ba7079dc 100644 --- a/doc/man7/EVP_PKEY-DH.pod +++ b/doc/man7/EVP_PKEY-DH.pod @@ -54,7 +54,7 @@ validation is required. The default value is 2. These are not named safe prime groups so setting this value for the OpenSSL FIPS provider will instead choose a named safe prime group based on the size of I<p>. -=item "tls-encoded-pt" (B<OSSL_PKEY_PARAM_TLS_ENCODED_PT>) <octet string> +=item "encoded-pub-key" (B<OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY>) <octet string> Used for getting and setting the encoding of the DH public key used in a key exchange message for the TLS protocol. diff --git a/doc/man7/EVP_PKEY-EC.pod b/doc/man7/EVP_PKEY-EC.pod index 9b195810d0..be6e507169 100644 --- a/doc/man7/EVP_PKEY-EC.pod +++ b/doc/man7/EVP_PKEY-EC.pod @@ -91,10 +91,11 @@ The public key value in EC point format. The private key value. -=item "tls-encoded-pt" (B<OSSL_PKEY_PARAM_TLS_ENCODED_PT>) <octet string> +=item "encoded-pub-key" (B<OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY>) <octet string> -Used for getting and setting the encoding of the EC public key used in key -exchange message for the TLS protocol. +Used for getting and setting the encoding of an EC public key. The public key +is expected to be a point conforming to Sec. 2.3.4 of the SECG SEC 1 ("Elliptic +Curve Cryptography") standard. =back diff --git a/doc/man7/EVP_PKEY-X25519.pod b/doc/man7/EVP_PKEY-X25519.pod index 63760389c9..80a1a627d0 100644 --- a/doc/man7/EVP_PKEY-X25519.pod +++ b/doc/man7/EVP_PKEY-X25519.pod @@ -40,10 +40,11 @@ The public key value. The private key value. -=item "tls-encoded-pt" (B<OSSL_PKEY_PARAM_TLS_ENCODED_PT>) <octet string> +=item "encoded-pub-key" (B<OSSL_PKEY_PARAM_ENCODED_PUBLIC_KEY>) <octet string> -Used for getting and setting the encoding of the public key used in a key exchange -message for the TLS protocol. +Used for getting and setting the encoding of a public key for the B<X25519> and +B<X448> key types. Public keys are expected be encoded in a format as defined by +RFC7748. =back |