1X509_NAME_PRINT_EX(3ossl)           OpenSSL          X509_NAME_PRINT_EX(3ossl)
2
3
4

NAME

6       X509_NAME_print_ex, X509_NAME_print_ex_fp, X509_NAME_print,
7       X509_NAME_oneline - X509_NAME printing routines
8

SYNOPSIS

10        #include <openssl/x509.h>
11
12        int X509_NAME_print_ex(BIO *out, const X509_NAME *nm,
13                               int indent, unsigned long flags);
14        int X509_NAME_print_ex_fp(FILE *fp, const X509_NAME *nm,
15                                  int indent, unsigned long flags);
16        char *X509_NAME_oneline(const X509_NAME *a, char *buf, int size);
17        int X509_NAME_print(BIO *bp, const X509_NAME *name, int obase);
18

DESCRIPTION

20       X509_NAME_print_ex() prints a human readable version of nm to BIO out.
21       Each line (for multiline formats) is indented by indent spaces. The
22       output format can be extensively customised by use of the flags
23       parameter.
24
25       X509_NAME_print_ex_fp() is identical to X509_NAME_print_ex() except the
26       output is written to FILE pointer fp.
27
28       X509_NAME_oneline() prints an ASCII version of a to buf.  This supports
29       multi-valued RDNs and escapes / and + characters in values.  If buf is
30       NULL then a buffer is dynamically allocated and returned, and size is
31       ignored.  Otherwise, at most size bytes will be written, including the
32       ending '\0', and buf is returned.
33
34       X509_NAME_print() prints out name to bp indenting each line by obase
35       characters. Multiple lines are used if the output (including indent)
36       exceeds 80 characters.
37

NOTES

39       The functions X509_NAME_oneline() and X509_NAME_print() produce a non
40       standard output form, they don't handle multi-character fields and have
41       various quirks and inconsistencies.  Their use is strongly discouraged
42       in new applications and they could be deprecated in a future release.
43
44       Although there are a large number of possible flags for most purposes
45       XN_FLAG_ONELINE, XN_FLAG_MULTILINE or XN_FLAG_RFC2253 will suffice.  As
46       noted on the ASN1_STRING_print_ex(3) manual page for UTF8 terminals the
47       ASN1_STRFLGS_ESC_MSB should be unset: so for example XN_FLAG_ONELINE &
48       ~ASN1_STRFLGS_ESC_MSB would be used.
49
50       The complete set of the flags supported by X509_NAME_print_ex() is
51       listed below.
52
53       Several options can be ored together.
54
55       The options XN_FLAG_SEP_COMMA_PLUS, XN_FLAG_SEP_CPLUS_SPC,
56       XN_FLAG_SEP_SPLUS_SPC and XN_FLAG_SEP_MULTILINE determine the field
57       separators to use.  Two distinct separators are used between distinct
58       RelativeDistinguishedName components and separate values in the same
59       RDN for a multi-valued RDN.  Multi-valued RDNs are currently very rare
60       so the second separator will hardly ever be used.
61
62       XN_FLAG_SEP_COMMA_PLUS uses comma and plus as separators.
63       XN_FLAG_SEP_CPLUS_SPC uses comma and plus with spaces: this is more
64       readable that plain comma and plus.  XN_FLAG_SEP_SPLUS_SPC uses spaced
65       semicolon and plus.  XN_FLAG_SEP_MULTILINE uses spaced newline and plus
66       respectively.
67
68       If XN_FLAG_DN_REV is set the whole DN is printed in reversed order.
69
70       The fields XN_FLAG_FN_SN, XN_FLAG_FN_LN, XN_FLAG_FN_OID,
71       XN_FLAG_FN_NONE determine how a field name is displayed. It will use
72       the short name (e.g. CN) the long name (e.g. commonName) always use OID
73       numerical form (normally OIDs are only used if the field name is not
74       recognised) and no field name respectively.
75
76       If XN_FLAG_SPC_EQ is set then spaces will be placed around the '='
77       character separating field names and values.
78
79       If XN_FLAG_DUMP_UNKNOWN_FIELDS is set then the encoding of unknown
80       fields is printed instead of the values.
81
82       If XN_FLAG_FN_ALIGN is set then field names are padded to 20
83       characters: this is only of use for multiline format.
84
85       Additionally all the options supported by ASN1_STRING_print_ex() can be
86       used to control how each field value is displayed.
87
88       In addition a number options can be set for commonly used formats.
89
90       XN_FLAG_RFC2253 sets options which produce an output compatible with
91       RFC2253.  It is equivalent to:
92        "ASN1_STRFLGS_RFC2253 | XN_FLAG_SEP_COMMA_PLUS | XN_FLAG_DN_REV
93          | XN_FLAG_FN_SN | XN_FLAG_DUMP_UNKNOWN_FIELDS"
94
95       XN_FLAG_ONELINE is a more readable one line format which is the same
96       as:
97        "ASN1_STRFLGS_RFC2253 | ASN1_STRFLGS_ESC_QUOTE | XN_FLAG_SEP_CPLUS_SPC
98          | XN_FLAG_SPC_EQ | XN_FLAG_FN_SN"
99
100       XN_FLAG_MULTILINE is a multiline format which is the same as:
101        "ASN1_STRFLGS_ESC_CTRL | ASN1_STRFLGS_ESC_MSB | XN_FLAG_SEP_MULTILINE
102          | XN_FLAG_SPC_EQ | XN_FLAG_FN_LN | XN_FLAG_FN_ALIGN"
103
104       XN_FLAG_COMPAT uses a format identical to X509_NAME_print(): in fact it
105       calls X509_NAME_print() internally.
106

RETURN VALUES

108       X509_NAME_oneline() returns a valid string on success or NULL on error.
109
110       X509_NAME_print() returns 1 on success or 0 on error.
111
112       X509_NAME_print_ex() and X509_NAME_print_ex_fp() return 1 on success or
113       0 on error if the XN_FLAG_COMPAT is set, which is the same as
114       X509_NAME_print().  Otherwise, it returns -1 on error or other values
115       on success.
116

SEE ALSO

118       ASN1_STRING_print_ex(3)
119

121       Copyright 2002-2020 The OpenSSL Project Authors. All Rights Reserved.
122
123       Licensed under the Apache License 2.0 (the "License").  You may not use
124       this file except in compliance with the License.  You can obtain a copy
125       in the file LICENSE in the source distribution or at
126       <https://www.openssl.org/source/license.html>.
127
128
129
1303.1.1                             2023-08-31         X509_NAME_PRINT_EX(3ossl)
Impressum