| | 1 | .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05) |
| | 2 | .\" |
| | 3 | .\" Standard preamble: |
| | 4 | .\" ======================================================================== |
| | 5 | .de Sh \" Subsection heading |
| | 6 | .br |
| | 7 | .if t .Sp |
| | 8 | .ne 5 |
| | 9 | .PP |
| | 10 | \fB\\$1\fR |
| | 11 | .PP |
| | 12 | .. |
| | 13 | .de Sp \" Vertical space (when we can't use .PP) |
| | 14 | .if t .sp .5v |
| | 15 | .if n .sp |
| | 16 | .. |
| | 17 | .de Vb \" Begin verbatim text |
| | 18 | .ft CW |
| | 19 | .nf |
| | 20 | .ne \\$1 |
| | 21 | .. |
| | 22 | .de Ve \" End verbatim text |
| | 23 | .ft R |
| | 24 | .fi |
| | 25 | .. |
| | 26 | .\" Set up some character translations and predefined strings. \*(-- will |
| | 27 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left |
| | 28 | .\" double quote, and \*(R" will give a right double quote. \*(C+ will |
| | 29 | .\" give a nicer C++. Capital omega is used to do unbreakable dashes and |
| | 30 | .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, |
| | 31 | .\" nothing in troff, for use with C<>. |
| | 32 | .tr \(*W- |
| | 33 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
| | 34 | .ie n \{\ |
| | 35 | . ds -- \(*W- |
| | 36 | . ds PI pi |
| | 37 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
| | 38 | . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch |
| | 39 | . ds L" "" |
| | 40 | . ds R" "" |
| | 41 | . ds C` "" |
| | 42 | . ds C' "" |
| | 43 | 'br\} |
| | 44 | .el\{\ |
| | 45 | . ds -- \|\(em\| |
| | 46 | . ds PI \(*p |
| | 47 | . ds L" `` |
| | 48 | . ds R" '' |
| | 49 | 'br\} |
| | 50 | .\" |
| | 51 | .\" Escape single quotes in literal strings from groff's Unicode transform. |
| | 52 | .ie \n(.g .ds Aq \(aq |
| | 53 | .el .ds Aq ' |
| | 54 | .\" |
| | 55 | .\" If the F register is turned on, we'll generate index entries on stderr for |
| | 56 | .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index |
| | 57 | .\" entries marked with X<> in POD. Of course, you'll have to process the |
| | 58 | .\" output yourself in some meaningful fashion. |
| | 59 | .ie \nF \{\ |
| | 60 | . de IX |
| | 61 | . tm Index:\\$1\t\\n%\t"\\$2" |
| | 62 | .. |
| | 63 | . nr % 0 |
| | 64 | . rr F |
| | 65 | .\} |
| | 66 | .el \{\ |
| | 67 | . de IX |
| | 68 | .. |
| | 69 | .\} |
| | 70 | .\" |
| | 71 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
| | 72 | .\" Fear. Run. Save yourself. No user-serviceable parts. |
| | 73 | . \" fudge factors for nroff and troff |
| | 74 | .if n \{\ |
| | 75 | . ds #H 0 |
| | 76 | . ds #V .8m |
| | 77 | . ds #F .3m |
| | 78 | . ds #[ \f1 |
| | 79 | . ds #] \fP |
| | 80 | .\} |
| | 81 | .if t \{\ |
| | 82 | . ds #H ((1u-(\\\\n(.fu%2u))*.13m) |
| | 83 | . ds #V .6m |
| | 84 | . ds #F 0 |
| | 85 | . ds #[ \& |
| | 86 | . ds #] \& |
| | 87 | .\} |
| | 88 | . \" simple accents for nroff and troff |
| | 89 | .if n \{\ |
| | 90 | . ds ' \& |
| | 91 | . ds ` \& |
| | 92 | . ds ^ \& |
| | 93 | . ds , \& |
| | 94 | . ds ~ ~ |
| | 95 | . ds / |
| | 96 | .\} |
| | 97 | .if t \{\ |
| | 98 | . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" |
| | 99 | . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' |
| | 100 | . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' |
| | 101 | . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' |
| | 102 | . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' |
| | 103 | . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' |
| | 104 | .\} |
| | 105 | . \" troff and (daisy-wheel) nroff accents |
| | 106 | .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' |
| | 107 | .ds 8 \h'\*(#H'\(*b\h'-\*(#H' |
| | 108 | .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] |
| | 109 | .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' |
| | 110 | .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' |
| | 111 | .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] |
| | 112 | .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] |
| | 113 | .ds ae a\h'-(\w'a'u*4/10)'e |
| | 114 | .ds Ae A\h'-(\w'A'u*4/10)'E |
| | 115 | . \" corrections for vroff |
| | 116 | .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' |
| | 117 | .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' |
| | 118 | . \" for low resolution devices (crt and lpr) |
| | 119 | .if \n(.H>23 .if \n(.V>19 \ |
| | 120 | \{\ |
| | 121 | . ds : e |
| | 122 | . ds 8 ss |
| | 123 | . ds o a |
| | 124 | . ds d- d\h'-1'\(ga |
| | 125 | . ds D- D\h'-1'\(hy |
| | 126 | . ds th \o'bp' |
| | 127 | . ds Th \o'LP' |
| | 128 | . ds ae ae |
| | 129 | . ds Ae AE |
| | 130 | .\} |
| | 131 | .rm #[ #] #H #V #F C |
| | 132 | .\" ======================================================================== |
| | 133 | .\" |
| | 134 | .IX Title "X509_NAME_print_ex 3" |
| | 135 | .TH X509_NAME_print_ex 3 "2009-01-11" "0.9.8j" "OpenSSL" |
| | 136 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| | 137 | .\" way too many mistakes in technical documents. |
| | 138 | .if n .ad l |
| | 139 | .nh |
| | 140 | .SH "NAME" |
| | 141 | X509_NAME_print_ex, X509_NAME_print_ex_fp, X509_NAME_print, |
| | 142 | X509_NAME_oneline \- X509_NAME printing routines. |
| | 143 | .SH "SYNOPSIS" |
| | 144 | .IX Header "SYNOPSIS" |
| | 145 | .Vb 1 |
| | 146 | \& #include <openssl/x509.h> |
| | 147 | \& |
| | 148 | \& int X509_NAME_print_ex(BIO *out, X509_NAME *nm, int indent, unsigned long flags); |
| | 149 | \& int X509_NAME_print_ex_fp(FILE *fp, X509_NAME *nm, int indent, unsigned long flags); |
| | 150 | \& char * X509_NAME_oneline(X509_NAME *a,char *buf,int size); |
| | 151 | \& int X509_NAME_print(BIO *bp, X509_NAME *name, int obase); |
| | 152 | .Ve |
| | 153 | .SH "DESCRIPTION" |
| | 154 | .IX Header "DESCRIPTION" |
| | 155 | \&\fIX509_NAME_print_ex()\fR prints a human readable version of \fBnm\fR to \s-1BIO\s0 \fBout\fR. Each |
| | 156 | line (for multiline formats) is indented by \fBindent\fR spaces. The output format |
| | 157 | can be extensively customised by use of the \fBflags\fR parameter. |
| | 158 | .PP |
| | 159 | \&\fIX509_NAME_print_ex_fp()\fR is identical to \fIX509_NAME_print_ex()\fR except the output is |
| | 160 | written to \s-1FILE\s0 pointer \fBfp\fR. |
| | 161 | .PP |
| | 162 | \&\fIX509_NAME_oneline()\fR prints an \s-1ASCII\s0 version of \fBa\fR to \fBbuf\fR. At most \fBsize\fR |
| | 163 | bytes will be written. If \fBbuf\fR is \fB\s-1NULL\s0\fR then a buffer is dynamically allocated |
| | 164 | and returned, otherwise \fBbuf\fR is returned. |
| | 165 | .PP |
| | 166 | \&\fIX509_NAME_print()\fR prints out \fBname\fR to \fBbp\fR indenting each line by \fBobase\fR |
| | 167 | characters. Multiple lines are used if the output (including indent) exceeds |
| | 168 | 80 characters. |
| | 169 | .SH "NOTES" |
| | 170 | .IX Header "NOTES" |
| | 171 | The functions \fIX509_NAME_oneline()\fR and \fIX509_NAME_print()\fR are legacy functions which |
| | 172 | produce a non standard output form, they don't handle multi character fields and |
| | 173 | have various quirks and inconsistencies. Their use is strongly discouraged in new |
| | 174 | applications. |
| | 175 | .PP |
| | 176 | Although there are a large number of possible flags for most purposes |
| | 177 | \&\fB\s-1XN_FLAG_ONELINE\s0\fR, \fB\s-1XN_FLAG_MULTILINE\s0\fR or \fB\s-1XN_FLAG_RFC2253\s0\fR will suffice. |
| | 178 | As noted on the \fIASN1_STRING_print_ex\fR\|(3) manual page |
| | 179 | for \s-1UTF8\s0 terminals the \fB\s-1ASN1_STRFLGS_ESC_MSB\s0\fR should be unset: so for example |
| | 180 | \&\fB\s-1XN_FLAG_ONELINE\s0 & ~ASN1_STRFLGS_ESC_MSB\fR would be used. |
| | 181 | .PP |
| | 182 | The complete set of the flags supported by \fIX509_NAME_print_ex()\fR is listed below. |
| | 183 | .PP |
| | 184 | Several options can be ored together. |
| | 185 | .PP |
| | 186 | The options \fB\s-1XN_FLAG_SEP_COMMA_PLUS\s0\fR, \fB\s-1XN_FLAG_SEP_CPLUS_SPC\s0\fR, |
| | 187 | \&\fB\s-1XN_FLAG_SEP_SPLUS_SPC\s0\fR and \fB\s-1XN_FLAG_SEP_MULTILINE\s0\fR determine the field separators |
| | 188 | to use. Two distinct separators are used between distinct RelativeDistinguishedName |
| | 189 | components and separate values in the same \s-1RDN\s0 for a multi-valued \s-1RDN\s0. Multi-valued |
| | 190 | RDNs are currently very rare so the second separator will hardly ever be used. |
| | 191 | .PP |
| | 192 | \&\fB\s-1XN_FLAG_SEP_COMMA_PLUS\s0\fR uses comma and plus as separators. \fB\s-1XN_FLAG_SEP_CPLUS_SPC\s0\fR |
| | 193 | uses comma and plus with spaces: this is more readable that plain comma and plus. |
| | 194 | \&\fB\s-1XN_FLAG_SEP_SPLUS_SPC\s0\fR uses spaced semicolon and plus. \fB\s-1XN_FLAG_SEP_MULTILINE\s0\fR uses |
| | 195 | spaced newline and plus respectively. |
| | 196 | .PP |
| | 197 | If \fB\s-1XN_FLAG_DN_REV\s0\fR is set the whole \s-1DN\s0 is printed in reversed order. |
| | 198 | .PP |
| | 199 | The fields \fB\s-1XN_FLAG_FN_SN\s0\fR, \fB\s-1XN_FLAG_FN_LN\s0\fR, \fB\s-1XN_FLAG_FN_OID\s0\fR, |
| | 200 | \&\fB\s-1XN_FLAG_FN_NONE\s0\fR determine how a field name is displayed. It will |
| | 201 | use the short name (e.g. \s-1CN\s0) the long name (e.g. commonName) always |
| | 202 | use \s-1OID\s0 numerical form (normally OIDs are only used if the field name is not |
| | 203 | recognised) and no field name respectively. |
| | 204 | .PP |
| | 205 | If \fB\s-1XN_FLAG_SPC_EQ\s0\fR is set then spaces will be placed around the '=' character |
| | 206 | separating field names and values. |
| | 207 | .PP |
| | 208 | If \fB\s-1XN_FLAG_DUMP_UNKNOWN_FIELDS\s0\fR is set then the encoding of unknown fields is |
| | 209 | printed instead of the values. |
| | 210 | .PP |
| | 211 | If \fB\s-1XN_FLAG_FN_ALIGN\s0\fR is set then field names are padded to 20 characters: this |
| | 212 | is only of use for multiline format. |
| | 213 | .PP |
| | 214 | Additionally all the options supported by \fIASN1_STRING_print_ex()\fR can be used to |
| | 215 | control how each field value is displayed. |
| | 216 | .PP |
| | 217 | In addition a number options can be set for commonly used formats. |
| | 218 | .PP |
| | 219 | \&\fB\s-1XN_FLAG_RFC2253\s0\fR sets options which produce an output compatible with \s-1RFC2253\s0 it |
| | 220 | is equivalent to: |
| | 221 | \fB\s-1ASN1_STRFLGS_RFC2253\s0 | \s-1XN_FLAG_SEP_COMMA_PLUS\s0 | \s-1XN_FLAG_DN_REV\s0 | \s-1XN_FLAG_FN_SN\s0 | \s-1XN_FLAG_DUMP_UNKNOWN_FIELDS\s0\fR |
| | 222 | .PP |
| | 223 | \&\fB\s-1XN_FLAG_ONELINE\s0\fR is a more readable one line format which is the same as: |
| | 224 | \fB\s-1ASN1_STRFLGS_RFC2253\s0 | \s-1ASN1_STRFLGS_ESC_QUOTE\s0 | \s-1XN_FLAG_SEP_CPLUS_SPC\s0 | \s-1XN_FLAG_SPC_EQ\s0 | \s-1XN_FLAG_FN_SN\s0\fR |
| | 225 | .PP |
| | 226 | \&\fB\s-1XN_FLAG_MULTILINE\s0\fR is a multiline format which is the same as: |
| | 227 | \fB\s-1ASN1_STRFLGS_ESC_CTRL\s0 | \s-1ASN1_STRFLGS_ESC_MSB\s0 | \s-1XN_FLAG_SEP_MULTILINE\s0 | \s-1XN_FLAG_SPC_EQ\s0 | \s-1XN_FLAG_FN_LN\s0 | \s-1XN_FLAG_FN_ALIGN\s0\fR |
| | 228 | .PP |
| | 229 | \&\fB\s-1XN_FLAG_COMPAT\s0\fR uses a format identical to \fIX509_NAME_print()\fR: in fact it calls \fIX509_NAME_print()\fR internally. |
| | 230 | .SH "SEE ALSO" |
| | 231 | .IX Header "SEE ALSO" |
| | 232 | \&\fIASN1_STRING_print_ex\fR\|(3) |
| | 233 | .SH "HISTORY" |
| | 234 | .IX Header "HISTORY" |
| | 235 | \&\s-1TBA\s0 |
projects / dragonfly.git / blame_incremental