From: Pauli <ppzgs1@gmail.com>
Date: Tue, 6 May 2025 02:09:53 +0000 (+1000)
Subject: doc: document the security category param for pkeys
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=8f373f11d2356d691416810f89f6f961f48d24ac;p=thirdparty%2Fopenssl.git

doc: document the security category param for pkeys

Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
Reviewed-by: Dmitry Belyavskiy <beldmit@gmail.com>
(Merged from https://github.com/openssl/openssl/pull/27571)
---

diff --git a/doc/man7/provider-keymgmt.pod b/doc/man7/provider-keymgmt.pod
index 420b7cdbfcd..1860814d318 100644
--- a/doc/man7/provider-keymgmt.pod
+++ b/doc/man7/provider-keymgmt.pod
@@ -406,6 +406,12 @@ dimensions handled in the rest of the same provider.
 The value should be the number of security bits of the given key.
 Bits of security is defined in SP800-57.
 
+=item "security-category" (B<OSSL_PKEY_PARAM_SECURITY_CATEGORY>) <integer>
+
+The value is the NIST
+L<post-quantum security category|https://nvlpubs.nist.gov/nistpubs/ir/2024/NIST.IR.8547.ipd.pdf>
+for the algorithm.  It is an integer value in the range [0, 5] inclusive.
+
 =item "mandatory-digest" (B<OSSL_PKEY_PARAM_MANDATORY_DIGEST>) <UTF8 string>
 
 If there is a mandatory digest for performing a signature operation with