Add some missing OSSL_PKEY_PARAM_GROUP_NAME documentation
authorMatt Caswell <matt@openssl.org>
Thu, 21 May 2020 15:16:41 +0000 (16:16 +0100)
committerMatt Caswell <matt@openssl.org>
Fri, 19 Jun 2020 09:19:31 +0000 (10:19 +0100)
Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/11914)

doc/man7/EVP_PKEY-EC.pod
doc/man7/EVP_PKEY-X25519.pod

index ea25d5d..ff074b9 100644 (file)
@@ -16,7 +16,7 @@ The following Import/Export types are available for the built-in EC algorithm:
 
 =over 4
 
-=item "group-name" (B<OSSL_PKEY_PARAM_GROUP_NAME>) <utf8 string>
+=item "group" (B<OSSL_PKEY_PARAM_GROUP_NAME>) <utf8 string>
 
 The curve name.
 
index ebeda8d..2937f24 100644 (file)
@@ -26,6 +26,12 @@ support the following.
 
 =over 4
 
+=item "group" (B<OSSL_PKEY_PARAM_GROUP_NAME>) <UTF8 string>
+
+This is only supported by X25519 and X448. The group name must be "x25519" or
+"x448" repsectively for those algorithms. This is only present for consistency
+with other key exchange algorithms and is typically not needed.
+
 =item "pub" (B<OSSL_PKEY_PARAM_PUB_KEY>) <octet string>
 
 The public key value.