X509_NAME_print_ex_fp(3ssl)

1X509_NAME_PRINT_EX(3)               OpenSSL              X509_NAME_PRINT_EX(3)
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, int indent, unsigned long flags);
13        int X509_NAME_print_ex_fp(FILE *fp, const X509_NAME *nm, int indent, unsigned long flags);
14        char *X509_NAME_oneline(const X509_NAME *a, char *buf, int size);
15        int X509_NAME_print(BIO *bp, const X509_NAME *name, int obase);
16

DESCRIPTION

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

NOTES

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

RETURN VALUES

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

COPYRIGHT

118       Copyright 2002-2018 The OpenSSL Project Authors. All Rights Reserved.
119
120       Licensed under the OpenSSL license (the "License").  You may not use
121       this file except in compliance with the License.  You can obtain a copy
122       in the file LICENSE in the source distribution or at
123       <https://www.openssl.org/source/license.html>.
124
125
126
1271.1.1q                            2022-07-07             X509_NAME_PRINT_EX(3)

NAME

SYNOPSIS

DESCRIPTION

NOTES

RETURN VALUES

SEE ALSO

COPYRIGHT