OpenGrok

$NetBSD: X509_NAME_print_ex.3,v 1.1.1.2 2023/04/18 14:19:15 christos Exp $

Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)

Standard preamble:
========================================================================
..

..

.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF
Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "X509_NAME_print_ex 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
.nh X509_NAME_print_ex, X509_NAME_print_ex_fp, X509_NAME_print, X509_NAME_oneline - X509_NAME printing routines libcrypto, -lcrypto Header "SYNOPSIS" .Vb 1 #include <openssl/x509.h> \& int X509_NAME_print_ex(BIO *out, const X509_NAME *nm, int indent, unsigned long flags); int X509_NAME_print_ex_fp(FILE *fp, const X509_NAME *nm, int indent, unsigned long flags); char *X509_NAME_oneline(const X509_NAME *a, char *buf, int size); int X509_NAME_print(BIO *bp, const X509_NAME *name, int obase); .Ve Header "DESCRIPTION" \fBX509_NAME_print_ex() prints a human readable version of nm to \s-1BIO\s0 out. Each line (for multiline formats) is indented by indent spaces. The output format can be extensively customised by use of the flags parameter.

\fBX509_NAME_print_ex_fp() is identical to X509_NAME_print_ex() except the output is written to \s-1FILE\s0 pointer fp.

\fBX509_NAME_oneline() prints an \s-1ASCII\s0 version of a to buf. If buf is \s-1NULL\s0 then a buffer is dynamically allocated and returned, and \fBsize is ignored. Otherwise, at most size bytes will be written, including the ending '\e0', and buf is returned.

\fBX509_NAME_print() prints out name to bp indenting each line by obase characters. Multiple lines are used if the output (including indent) exceeds 80 characters.

Header "NOTES" The functions X509_NAME_oneline() and X509_NAME_print() produce a non standard output form, they don't handle multi character fields and have various quirks and inconsistencies. Their use is strongly discouraged in new applications and they could be deprecated in a future release.

Although there are a large number of possible flags for most purposes \fB\s-1XN_FLAG_ONELINE\s0, \s-1XN_FLAG_MULTILINE\s0 or \s-1XN_FLAG_RFC2253\s0 will suffice. As noted on the ASN1_STRING_print_ex\|(3) manual page for \s-1UTF8\s0 terminals the \s-1ASN1_STRFLGS_ESC_MSB\s0 should be unset: so for example \fB\s-1XN_FLAG_ONELINE &\s0 ~ASN1_STRFLGS_ESC_MSB would be used.

The complete set of the flags supported by X509_NAME_print_ex() is listed below.

Several options can be ored together.

The options \s-1XN_FLAG_SEP_COMMA_PLUS\s0, \s-1XN_FLAG_SEP_CPLUS_SPC\s0, \fB\s-1XN_FLAG_SEP_SPLUS_SPC\s0 and \s-1XN_FLAG_SEP_MULTILINE\s0 determine the field separators to use. Two distinct separators are used between distinct RelativeDistinguishedName components and separate values in the same \s-1RDN\s0 for a multi-valued \s-1RDN.\s0 Multi-valued RDNs are currently very rare so the second separator will hardly ever be used.

\fB\s-1XN_FLAG_SEP_COMMA_PLUS\s0 uses comma and plus as separators. \s-1XN_FLAG_SEP_CPLUS_SPC\s0 uses comma and plus with spaces: this is more readable that plain comma and plus. \fB\s-1XN_FLAG_SEP_SPLUS_SPC\s0 uses spaced semicolon and plus. \s-1XN_FLAG_SEP_MULTILINE\s0 uses spaced newline and plus respectively.

If \s-1XN_FLAG_DN_REV\s0 is set the whole \s-1DN\s0 is printed in reversed order.

The fields \s-1XN_FLAG_FN_SN\s0, \s-1XN_FLAG_FN_LN\s0, \s-1XN_FLAG_FN_OID\s0, \fB\s-1XN_FLAG_FN_NONE\s0 determine how a field name is displayed. It will use the short name (e.g. \s-1CN\s0) the long name (e.g. commonName) always use \s-1OID\s0 numerical form (normally OIDs are only used if the field name is not recognised) and no field name respectively.

If \s-1XN_FLAG_SPC_EQ\s0 is set then spaces will be placed around the '=' character separating field names and values.

If \s-1XN_FLAG_DUMP_UNKNOWN_FIELDS\s0 is set then the encoding of unknown fields is printed instead of the values.

If \s-1XN_FLAG_FN_ALIGN\s0 is set then field names are padded to 20 characters: this is only of use for multiline format.

Additionally all the options supported by ASN1_STRING_print_ex() can be used to control how each field value is displayed.

In addition a number options can be set for commonly used formats.

\fB\s-1XN_FLAG_RFC2253\s0 sets options which produce an output compatible with \s-1RFC2253\s0 it is equivalent to: \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

\fB\s-1XN_FLAG_ONELINE\s0 is a more readable one line format which is the same as: \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

\fB\s-1XN_FLAG_MULTILINE\s0 is a multiline format which is the same as: \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

\fB\s-1XN_FLAG_COMPAT\s0 uses a format identical to X509_NAME_print(): in fact it calls X509_NAME_print() internally.

Header "RETURN VALUES" \fBX509_NAME_oneline() returns a valid string on success or \s-1NULL\s0 on error.

\fBX509_NAME_print() returns 1 on success or 0 on error.

\fBX509_NAME_print_ex() and X509_NAME_print_ex_fp() return 1 on success or 0 on error if the \s-1XN_FLAG_COMPAT\s0 is set, which is the same as X509_NAME_print(). Otherwise, it returns -1 on error or other values on success.

Header "SEE ALSO" \fBASN1_STRING_print_ex\|(3) Header "COPYRIGHT" Copyright 2002-2018 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.

Indexes created Mon Apr 27 00:23:16 UTC 2026