From: Pauli <ppzgs1@gmail.com>
Date: Tue, 30 Jul 2024 01:29:32 +0000 (+1000)
Subject: doc: add verify-digested param for EdDSA
X-Git-Tag: openssl-3.4.0-alpha1~232
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=ab02a297eb3d7f314eea371038c0b8e4038f658b;p=thirdparty%2Fopenssl.git

doc: add verify-digested param for EdDSA

Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/25032)
---

diff --git a/doc/man7/EVP_SIGNATURE-ED25519.pod b/doc/man7/EVP_SIGNATURE-ED25519.pod
index aba56f31824..a525147bcb9 100644
--- a/doc/man7/EVP_SIGNATURE-ED25519.pod
+++ b/doc/man7/EVP_SIGNATURE-ED25519.pod
@@ -38,9 +38,9 @@ instance, a nonempty context-string is not permitted.
 
 =head2 ED25519 and ED448 Signature Parameters
 
-Two parameters can be set during signing or verification: the EdDSA
-B<instance name> and the B<context-string value>.  They can be set by
-passing an OSSL_PARAM array to EVP_DigestSignInit_ex().
+The following parameters can be set during signing or verification by
+passing an OSSL_PARAM array to EVP_DigestSignInit_ex() or
+EVP_PKEY_CTX_set_params():
 
 =over 4
 
@@ -56,9 +56,14 @@ One of the five strings "Ed25519", "Ed25519ctx", "Ed25519ph", "Ed448", "Ed448ph"
 
 A string of octets with length at most 255.
 
+=item * "verify-digested" (B<OSSL_SIGNATURE_PARAM_EDDSA_VERIFY_DIGESTED> <integer>
+
+If set to a nonzero value, EdDSA can be used to verify a hash of a message.
+If zero, EdDSA will digest the message internally.
+
 =back
 
-Both of these parameters are optional.
+All of these parameters are optional.
 
 If the instance name is not specified, then the default "Ed25519" or
 "Ed448" is used.
@@ -82,6 +87,8 @@ EVP_PKEY_CTX_get_params().
 
 =item * "context-string" (B<OSSL_SIGNATURE_PARAM_CONTEXT_STRING>) <octet string>
 
+=item * "fips-indicator" (B<OSSL_SIGNATURE_PARAM_FIPS_APPROVED_INDICATOR>) <integer>
+
 =back
 
 The parameters are described in L<provider-signature(7)>.