summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJob Snijders <job@sobornost.net>2024-02-27 19:14:32 +0000
committerTomas Mraz <tomas@openssl.org>2024-04-04 08:35:41 +0200
commit2410cb42e62c3be69dcf1aad1bdf1eb0233b670f (patch)
tree8c5c3643083522b032e46e3cdda9fe5f16e294f1 /doc
parent5962c717c4c00654bc8120e81db9978c3efd91fd (diff)
Align 'openssl req' string_mask docs to how the software really works
Reviewed-by: Shane Lontis <shane.lontis@oracle.com> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/23699)
Diffstat (limited to 'doc')
-rw-r--r--doc/man1/openssl-req.pod.in33
1 files changed, 23 insertions, 10 deletions
diff --git a/doc/man1/openssl-req.pod.in b/doc/man1/openssl-req.pod.in
index c1480ef07b..7b2e19b1d1 100644
--- a/doc/man1/openssl-req.pod.in
+++ b/doc/man1/openssl-req.pod.in
@@ -497,16 +497,29 @@ any digest that has been set.
=item B<string_mask>
This option masks out the use of certain string types in certain
-fields. Most users will not need to change this option.
-
-It can be set to several values B<default> which is also the default
-option uses PrintableStrings, T61Strings and BMPStrings if the
-B<pkix> value is used then only PrintableStrings and BMPStrings will
-be used. This follows the PKIX recommendation in RFC2459. If the
-B<utf8only> option is used then only UTF8Strings will be used: this
-is the PKIX recommendation in RFC2459 after 2003. Finally the B<nombstr>
-option just uses PrintableStrings and T61Strings: certain software has
-problems with BMPStrings and UTF8Strings: in particular Netscape.
+fields. Most users will not need to change this option. It can be set to
+several values:
+
+=over 4
+
+=item B<utf8only>
+- only UTF8Strings are used (this is the default value)
+
+=item B<pkix>
+- any string type except T61Strings
+
+=item B<nombstr>
+- any string type except BMPStrings and UTF8Strings
+
+=item B<default>
+- any kind of string type
+
+=back
+
+Note that B<utf8only> is the PKIX recommendation in RFC2459 after 2003, and the
+default B<string_mask>; B<default> is not the default option. The B<nombstr>
+value is a workaround for some software that has problems with variable-sized
+BMPStrings and UTF8Strings.
=item B<req_extensions>