]> git.ipfire.org Git - thirdparty/openssl.git/commitdiff
doc: clarify algorithm discovery in openssl-genpkey.pod.in
authorZoey Chapell <zac9557@rit.edu>
Tue, 24 Mar 2026 15:30:52 +0000 (11:30 -0400)
committerEugene Syromiatnikov <esyr@openssl.org>
Sun, 10 May 2026 23:56:18 +0000 (01:56 +0200)
Add a reference to 'openssl list -public-key-algorithms' in the
-algorithm description to improve discoverability and long term
consistency. Documentation only change.

Add clarification for how to select the naming output in the correct spot.

Reviewed-by: Eugene Syromiatnikov <esyr@openssl.org>
Reviewed-by: Dmitry Belyavskiy <beldmit@gmail.com>
MergeDate: Sun May 10 23:59:03 2026
(Merged from https://github.com/openssl/openssl/pull/30556)

doc/man1/openssl-genpkey.pod.in

index a25db3053e819aeacc9a9e55af13220db131ccbf..214b9b322a82aa8547df51a3ea187b4b189e72d8 100644 (file)
@@ -91,6 +91,13 @@ precede any B<-pkeyopt> options. The options B<-paramfile> and B<-algorithm>
 are mutually exclusive. Providers may add algorithms in addition to
 the standard built-in ones.
 
+A complete list of available algorithms can be obtained using:
+    openssl list -public-key-algorithms
+
+When selecting an algorithm from this output, use the C<PEM string> for legacy
+algorithms, or the portion of the C<IDs> field before the C<@> symbol for
+provided algorithms.
+
 Valid built-in algorithm names for private key generation are RSA, RSA-PSS, EC,
 X25519, X448, ED25519, ED448, ML-DSA and ML-KEM.