| 1 |
.\" -*- mode: troff; coding: utf-8 -*- |
| 2 |
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) |
| 3 |
.\" |
| 4 |
.\" Standard preamble: |
| 5 |
.\" ======================================================================== |
| 6 |
.de Sp \" Vertical space (when we can't use .PP) |
| 7 |
.if t .sp .5v |
| 8 |
.if n .sp |
| 9 |
.. |
| 10 |
.de Vb \" Begin verbatim text |
| 11 |
.ft CW |
| 12 |
.nf |
| 13 |
.ne \\$1 |
| 14 |
.. |
| 15 |
.de Ve \" End verbatim text |
| 16 |
.ft R |
| 17 |
.fi |
| 18 |
.. |
| 19 |
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. |
| 20 |
.ie n \{\ |
| 21 |
. ds C` "" |
| 22 |
. ds C' "" |
| 23 |
'br\} |
| 24 |
.el\{\ |
| 25 |
. ds C` |
| 26 |
. ds C' |
| 27 |
'br\} |
| 28 |
.\" |
| 29 |
.\" Escape single quotes in literal strings from groff's Unicode transform. |
| 30 |
.ie \n(.g .ds Aq \(aq |
| 31 |
.el .ds Aq ' |
| 32 |
.\" |
| 33 |
.\" If the F register is >0, we'll generate index entries on stderr for |
| 34 |
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 35 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 36 |
.\" output yourself in some meaningful fashion. |
| 37 |
.\" |
| 38 |
.\" Avoid warning from groff about undefined register 'F'. |
| 39 |
.de IX |
| 40 |
.. |
| 41 |
.nr rF 0 |
| 42 |
.if \n(.g .if rF .nr rF 1 |
| 43 |
.if (\n(rF:(\n(.g==0)) \{\ |
| 44 |
. if \nF \{\ |
| 45 |
. de IX |
| 46 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 47 |
.. |
| 48 |
. if !\nF==2 \{\ |
| 49 |
. nr % 0 |
| 50 |
. nr F 2 |
| 51 |
. \} |
| 52 |
. \} |
| 53 |
.\} |
| 54 |
.rr rF |
| 55 |
.\" ======================================================================== |
| 56 |
.\" |
| 57 |
.IX Title "OPENSSL-NAMEDISPLAY-OPTIONS 1SSL" |
| 58 |
.TH OPENSSL-NAMEDISPLAY-OPTIONS 1SSL 2026-04-07 3.6.2 OpenSSL |
| 59 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 60 |
.\" way too many mistakes in technical documents. |
| 61 |
.if n .ad l |
| 62 |
.nh |
| 63 |
.SH NAME |
| 64 |
openssl\-namedisplay\-options \- Distinguished name display options |
| 65 |
.SH SYNOPSIS |
| 66 |
.IX Header "SYNOPSIS" |
| 67 |
\&\fBopenssl\fR |
| 68 |
\&\fIcommand\fR |
| 69 |
[ \fIoptions\fR ... ] |
| 70 |
[ \fIparameters\fR ... ] |
| 71 |
.SH DESCRIPTION |
| 72 |
.IX Header "DESCRIPTION" |
| 73 |
OpenSSL provides fine-grain control over how the subject and issuer DN's are |
| 74 |
displayed. |
| 75 |
This is specified by using the \fB\-nameopt\fR option, which takes a |
| 76 |
comma-separated list of options from the following set. |
| 77 |
An option may be preceded by a minus sign, \f(CW\*(C`\-\*(C'\fR, to turn it off. |
| 78 |
The first four option arguments are the most commonly used. |
| 79 |
.PP |
| 80 |
The default value is |
| 81 |
\&\f(CW\*(C`esc_ctrl,utf8,dump_unknown,dump_der,sep_comma_plus_space,sname\*(C'\fR. |
| 82 |
.SH OPTIONS |
| 83 |
.IX Header "OPTIONS" |
| 84 |
.SS "Name Format Option Arguments" |
| 85 |
.IX Subsection "Name Format Option Arguments" |
| 86 |
The DN output format can be fine tuned with the following flags. |
| 87 |
.IP \fBcompat\fR 4 |
| 88 |
.IX Item "compat" |
| 89 |
Display the name using an old format from previous OpenSSL versions. |
| 90 |
.IP \fBRFC2253\fR 4 |
| 91 |
.IX Item "RFC2253" |
| 92 |
Display the name using the format defined in RFC 2253. |
| 93 |
It is equivalent to \fBesc_2253\fR, \fBesc_ctrl\fR, \fBesc_msb\fR, \fButf8\fR, |
| 94 |
\&\fBdump_nostr\fR, \fBdump_unknown\fR, \fBdump_der\fR, \fBsep_comma_plus\fR, \fBdn_rev\fR |
| 95 |
and \fBsname\fR. |
| 96 |
.IP \fBoneline\fR 4 |
| 97 |
.IX Item "oneline" |
| 98 |
Display the name in one line, using a format that is more readable |
| 99 |
RFC 2253. |
| 100 |
It is equivalent to \fBesc_2253\fR, \fBesc_ctrl\fR, \fBesc_msb\fR, \fButf8\fR, |
| 101 |
\&\fBdump_nostr\fR, \fBdump_der\fR, \fBuse_quote\fR, \fBsep_comma_plus_space\fR, |
| 102 |
\&\fBspace_eq\fR and \fBsname\fR options. |
| 103 |
.IP \fBmultiline\fR 4 |
| 104 |
.IX Item "multiline" |
| 105 |
Display the name using multiple lines. |
| 106 |
It is equivalent to \fBesc_ctrl\fR, \fBesc_msb\fR, \fBsep_multiline\fR, \fBspace_eq\fR, |
| 107 |
\&\fBlname\fR and \fBalign\fR. |
| 108 |
.IP \fBesc_2253\fR 4 |
| 109 |
.IX Item "esc_2253" |
| 110 |
Escape the "special" characters in a field, as required by RFC 2253. |
| 111 |
That is, any of the characters \f(CW\*(C`,+"<>;\*(C'\fR, \f(CW\*(C`#\*(C'\fR at the beginning of |
| 112 |
a string and leading or trailing spaces. |
| 113 |
.IP \fBesc_2254\fR 4 |
| 114 |
.IX Item "esc_2254" |
| 115 |
Escape the "special" characters in a field as required by RFC 2254 in a field. |
| 116 |
That is, the \fBNUL\fR character and of \f(CW\*(C`()*\*(C'\fR. |
| 117 |
.IP \fBesc_ctrl\fR 4 |
| 118 |
.IX Item "esc_ctrl" |
| 119 |
Escape non-printable ASCII characters, codes less than 0x20 (space) |
| 120 |
or greater than 0x7F (DELETE). They are displayed using RFC 2253 \f(CW\*(C`\eXX\*(C'\fR |
| 121 |
notation where \fBXX\fR are the two hex digits representing the character value. |
| 122 |
.IP \fBesc_msb\fR 4 |
| 123 |
.IX Item "esc_msb" |
| 124 |
Escape any characters with the most significant bit set, that is with |
| 125 |
values larger than 127, as described in \fBesc_ctrl\fR. |
| 126 |
.IP \fBuse_quote\fR 4 |
| 127 |
.IX Item "use_quote" |
| 128 |
Escapes some characters by surrounding the entire string with quotation |
| 129 |
marks, \f(CW\*(C`"\*(C'\fR. |
| 130 |
Without this option, individual special characters are preceded with |
| 131 |
a backslash character, \f(CW\*(C`\e\*(C'\fR. |
| 132 |
.IP \fButf8\fR 4 |
| 133 |
.IX Item "utf8" |
| 134 |
Convert all strings to UTF\-8 format first as required by RFC 2253. |
| 135 |
If the output device is UTF\-8 compatible, then using this option (and |
| 136 |
not setting \fBesc_msb\fR) may give the correct display of multibyte |
| 137 |
characters. |
| 138 |
If this option is not set, then multibyte characters larger than 0xFF |
| 139 |
will be output as \f(CW\*(C`\eUXXXX\*(C'\fR for 16 bits or \f(CW\*(C`\eWXXXXXXXX\*(C'\fR for 32 bits. |
| 140 |
In addition, any UTF8Strings will be converted to their character form first. |
| 141 |
.IP \fBignore_type\fR 4 |
| 142 |
.IX Item "ignore_type" |
| 143 |
This option does not attempt to interpret multibyte characters in any |
| 144 |
way. That is, the content octets are merely dumped as though one octet |
| 145 |
represents each character. This is useful for diagnostic purposes but |
| 146 |
will result in rather odd looking output. |
| 147 |
.IP \fBshow_type\fR 4 |
| 148 |
.IX Item "show_type" |
| 149 |
Display the type of the ASN1 character string before the value, |
| 150 |
such as \f(CW\*(C`BMPSTRING: Hello World\*(C'\fR. |
| 151 |
.IP \fBdump_der\fR 4 |
| 152 |
.IX Item "dump_der" |
| 153 |
Any fields that would be output in hex format are displayed using |
| 154 |
the DER encoding of the field. |
| 155 |
If not set, just the content octets are displayed. |
| 156 |
Either way, the \fB#XXXX...\fR format of RFC 2253 is used. |
| 157 |
.IP \fBdump_nostr\fR 4 |
| 158 |
.IX Item "dump_nostr" |
| 159 |
Dump non-character strings, such as ASN.1 \fBOCTET STRING\fR. |
| 160 |
If this option is not set, then non character string types will be displayed |
| 161 |
as though each content octet represents a single character. |
| 162 |
.IP \fBdump_all\fR 4 |
| 163 |
.IX Item "dump_all" |
| 164 |
Dump all fields. When this used with \fBdump_der\fR, this allows the |
| 165 |
DER encoding of the structure to be unambiguously determined. |
| 166 |
.IP \fBdump_unknown\fR 4 |
| 167 |
.IX Item "dump_unknown" |
| 168 |
Dump any field whose OID is not recognised by OpenSSL. |
| 169 |
.IP "\fBsep_comma_plus\fR, \fBsep_comma_plus_space\fR, \fBsep_semi_plus_space\fR, \fBsep_multiline\fR" 4 |
| 170 |
.IX Item "sep_comma_plus, sep_comma_plus_space, sep_semi_plus_space, sep_multiline" |
| 171 |
Specify the field separators. The first word is used between the |
| 172 |
Relative Distinguished Names (RDNs) and the second is between |
| 173 |
multiple Attribute Value Assertions (AVAs). Multiple AVAs are |
| 174 |
very rare and their use is discouraged. |
| 175 |
The options ending in "space" additionally place a space after the separator to make it more readable. |
| 176 |
The \fBsep_multiline\fR starts each field on its own line, and uses "plus space" |
| 177 |
for the AVA separator. |
| 178 |
It also indents the fields by four characters. |
| 179 |
The default value is \fBsep_comma_plus_space\fR. |
| 180 |
.IP \fBdn_rev\fR 4 |
| 181 |
.IX Item "dn_rev" |
| 182 |
Reverse the fields of the DN as required by RFC 2253. |
| 183 |
This also reverses the order of multiple AVAs in a field, but this is |
| 184 |
permissible as there is no ordering on values. |
| 185 |
.IP "\fBnofname\fR, \fBsname\fR, \fBlname\fR, \fBoid\fR" 4 |
| 186 |
.IX Item "nofname, sname, lname, oid" |
| 187 |
Specify how the field name is displayed. |
| 188 |
\&\fBnofname\fR does not display the field at all. |
| 189 |
\&\fBsname\fR uses the "short name" form (CN for commonName for example). |
| 190 |
\&\fBlname\fR uses the long form. |
| 191 |
\&\fBoid\fR represents the OID in numerical form and is useful for |
| 192 |
diagnostic purpose. |
| 193 |
.IP \fBalign\fR 4 |
| 194 |
.IX Item "align" |
| 195 |
Align field values for a more readable output. Only usable with |
| 196 |
\&\fBsep_multiline\fR. |
| 197 |
.IP \fBspace_eq\fR 4 |
| 198 |
.IX Item "space_eq" |
| 199 |
Places spaces round the equal sign, \f(CW\*(C`=\*(C'\fR, character which follows the field |
| 200 |
name. |
| 201 |
.SH COPYRIGHT |
| 202 |
.IX Header "COPYRIGHT" |
| 203 |
Copyright 2000\-2025 The OpenSSL Project Authors. All Rights Reserved. |
| 204 |
.PP |
| 205 |
Licensed under the Apache License 2.0 (the "License"). You may not use |
| 206 |
this file except in compliance with the License. You can obtain a copy |
| 207 |
in the file LICENSE in the source distribution or at |
| 208 |
<https://www.openssl.org/source/license.html>. |