]> git.ipfire.org Git - thirdparty/openssl.git/commitdiff
doc/man7/EVP_KDF-SNMPKDF.pod: fix password parameter documentation
authordannyward630 <djwarding888@gmail.com>
Thu, 18 Jun 2026 17:30:54 +0000 (19:30 +0200)
committerEugene Syromiatnikov <esyr@openssl.org>
Fri, 26 Jun 2026 16:28:51 +0000 (18:28 +0200)
Document the SNMPKDF "pass" parameter with OSSL_KDF_PARAM_PASSWORD,
matching the implementation and other KDF documentation.  Also, fix
the nearby grammar.

Resolves: https://github.com/openssl/openssl/issues/31543
Fixes: 1b035166bdb2 "Add SNMPKDF implementation"
CLA: trivial

Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
Reviewed-by: Paul Dale <paul.dale@oracle.com>
Reviewed-by: Eugene Syromiatnikov <esyr@openssl.org>
Reviewed-by: Norbert Pocs <norbertp@openssl.org>
MergeDate: Fri Jun 26 16:29:54 2026
(Merged from https://github.com/openssl/openssl/pull/31592)

doc/man7/EVP_KDF-SNMPKDF.pod

index c0bcb70deeb68031383d8900f3ca697e261d6017..9a2973722b4042e4b41a70d4371c64cd234d6950 100644 (file)
@@ -29,9 +29,9 @@ The supported parameters are:
 
 =item "digest" (B<OSSL_KDF_PARAM_DIGEST>) <UTF8 string>
 
-=item "pass" (B<OSSL_KDF_PARAM_PASS>) <octet string>
+=item "pass" (B<OSSL_KDF_PARAM_PASSWORD>) <octet string>
 
-These parameters works as described in L<EVP_KDF(3)/PARAMETERS>.
+These parameters work as described in L<EVP_KDF(3)/PARAMETERS>.
 
 =item "eid" (B<OSSL_KDF_PARAM_SNMPKDF_EID>) <octet string>
 
@@ -70,7 +70,7 @@ This example derives an 8 byte IV using SHA1 with a 1K "key" and appropriate
 
  *p++ = OSSL_PARAM_construct_utf8_string(OSSL_KDF_PARAM_DIGEST,
                                          SN_sha1, strlen(SN_sha1));
- *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_PASS,
+ *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_PASSWORD,
                                           pass, sizeof(pass));
  *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_SNMPKDF_EID,
                                           eid, sizeof(eid));
@@ -100,7 +100,7 @@ This functionality was added in OpenSSL 4.0.
 
 =head1 COPYRIGHT
 
-Copyright 2025 The OpenSSL Project Authors. All Rights Reserved.
+Copyright 2025-2026 The OpenSSL Project Authors. All Rights Reserved.
 
 Licensed under the Apache License 2.0 (the "License").  You may not use
 this file except in compliance with the License.  You can obtain a copy