X509_NAME_print_ex.pod revision 312826 
1=pod
2
3=head1 NAME
4
5X509_NAME_print_ex, X509_NAME_print_ex_fp, X509_NAME_print,
6X509_NAME_oneline - X509_NAME printing routines.
7
8=head1 SYNOPSIS
9
10 #include <openssl/x509.h>
11
12 int X509_NAME_print_ex(BIO *out, X509_NAME *nm, int indent, unsigned long flags);
13 int X509_NAME_print_ex_fp(FILE *fp, X509_NAME *nm, int indent, unsigned long flags);
14 char *	X509_NAME_oneline(X509_NAME *a,char *buf,int size);
15 int X509_NAME_print(BIO *bp, X509_NAME *name, int obase);
16
17=head1 DESCRIPTION
18
19X509_NAME_print_ex() prints a human readable version of B<nm> to BIO B<out>. Each
20line (for multiline formats) is indented by B<indent> spaces. The output format
21can be extensively customised by use of the B<flags> parameter.
22
23X509_NAME_print_ex_fp() is identical to X509_NAME_print_ex() except the output is
24written to FILE pointer B<fp>.
25
26X509_NAME_oneline() prints an ASCII version of B<a> to B<buf>.
27If B<buf> is B<NULL> then a buffer is dynamically allocated and returned, and
28B<size> is ignored.
29Otherwise, at most B<size> bytes will be written, including the ending '\0',
30and B<buf> is returned.
31
32X509_NAME_print() prints out B<name> to B<bp> indenting each line by B<obase> 
33characters. Multiple lines are used if the output (including indent) exceeds
3480 characters.
35
36=head1 NOTES
37
38The functions X509_NAME_oneline() and X509_NAME_print() are legacy functions which
39produce a non standard output form, they don't handle multi character fields and
40have various quirks and inconsistencies. Their use is strongly discouraged in new
41applications.
42
43Although there are a large number of possible flags for most purposes
44B<XN_FLAG_ONELINE>, B<XN_FLAG_MULTILINE> or B<XN_FLAG_RFC2253> will suffice.
45As noted on the L<ASN1_STRING_print_ex(3)|ASN1_STRING_print_ex(3)> manual page
46for UTF8 terminals the B<ASN1_STRFLGS_ESC_MSB> should be unset: so for example
47B<XN_FLAG_ONELINE & ~ASN1_STRFLGS_ESC_MSB> would be used.
48
49The complete set of the flags supported by X509_NAME_print_ex() is listed below.
50
51Several options can be ored together.
52
53The options B<XN_FLAG_SEP_COMMA_PLUS>, B<XN_FLAG_SEP_CPLUS_SPC>,
54B<XN_FLAG_SEP_SPLUS_SPC> and B<XN_FLAG_SEP_MULTILINE> determine the field separators
55to use. Two distinct separators are used between distinct RelativeDistinguishedName
56components and separate values in the same RDN for a multi-valued RDN. Multi-valued
57RDNs are currently very rare so the second separator will hardly ever be used.
58
59B<XN_FLAG_SEP_COMMA_PLUS> uses comma and plus as separators. B<XN_FLAG_SEP_CPLUS_SPC>
60uses comma and plus with spaces: this is more readable that plain comma and plus.
61B<XN_FLAG_SEP_SPLUS_SPC> uses spaced semicolon and plus. B<XN_FLAG_SEP_MULTILINE> uses
62spaced newline and plus respectively.
63
64If B<XN_FLAG_DN_REV> is set the whole DN is printed in reversed order.
65
66The fields B<XN_FLAG_FN_SN>, B<XN_FLAG_FN_LN>, B<XN_FLAG_FN_OID>,
67B<XN_FLAG_FN_NONE> determine how a field name is displayed. It will
68use the short name (e.g. CN) the long name (e.g. commonName) always
69use OID numerical form (normally OIDs are only used if the field name is not
70recognised) and no field name respectively.
71
72If B<XN_FLAG_SPC_EQ> is set then spaces will be placed around the '=' character
73separating field names and values.
74
75If B<XN_FLAG_DUMP_UNKNOWN_FIELDS> is set then the encoding of unknown fields is
76printed instead of the values.
77
78If B<XN_FLAG_FN_ALIGN> is set then field names are padded to 20 characters: this
79is only of use for multiline format.
80
81Additionally all the options supported by ASN1_STRING_print_ex() can be used to 
82control how each field value is displayed.
83
84In addition a number options can be set for commonly used formats.
85
86B<XN_FLAG_RFC2253> sets options which produce an output compatible with RFC2253 it
87is equivalent to:
88 B<ASN1_STRFLGS_RFC2253 | XN_FLAG_SEP_COMMA_PLUS | XN_FLAG_DN_REV | XN_FLAG_FN_SN | XN_FLAG_DUMP_UNKNOWN_FIELDS>
89
90
91B<XN_FLAG_ONELINE> is a more readable one line format which is the same as:
92 B<ASN1_STRFLGS_RFC2253 | ASN1_STRFLGS_ESC_QUOTE | XN_FLAG_SEP_CPLUS_SPC | XN_FLAG_SPC_EQ | XN_FLAG_FN_SN>
93
94B<XN_FLAG_MULTILINE> is a multiline format which is the same as:
95 B<ASN1_STRFLGS_ESC_CTRL | ASN1_STRFLGS_ESC_MSB | XN_FLAG_SEP_MULTILINE | XN_FLAG_SPC_EQ | XN_FLAG_FN_LN | XN_FLAG_FN_ALIGN>
96
97B<XN_FLAG_COMPAT> uses a format identical to X509_NAME_print(): in fact it calls X509_NAME_print() internally.
98
99=head1 SEE ALSO
100
101L<ASN1_STRING_print_ex(3)|ASN1_STRING_print_ex(3)>
102
103=head1 HISTORY
104
105TBA
106
107=cut
108