1 =pod 2 3 =head1 NAME 4 5 X509_NAME_print_ex, X509_NAME_print_ex_fp, X509_NAME_print, 6 X509_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, 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 19 =head1 DESCRIPTION 20 21 X509_NAME_print_ex() prints a human readable version of I<nm> to BIO I<out>. 22 Each line (for multiline formats) is indented by I<indent> spaces. The 23 output format can be extensively customised by use of the I<flags> parameter. 24 25 X509_NAME_print_ex_fp() is identical to X509_NAME_print_ex() 26 except the output is written to FILE pointer I<fp>. 27 28 X509_NAME_oneline() prints an ASCII version of I<a> to I<buf>. 29 This supports multi-valued RDNs and escapes B</> and B<+> characters in values. 30 If I<buf> is B<NULL> then a buffer is dynamically allocated and returned, and 31 I<size> is ignored. 32 Otherwise, at most I<size> bytes will be written, including the ending '\0', 33 and I<buf> is returned. 34 35 X509_NAME_print() prints out I<name> to I<bp> on a single line. 36 The I<obase> parameter is ignored and retained only for API compatibility. 37 38 =head1 NOTES 39 40 The functions X509_NAME_oneline() and X509_NAME_print() 41 produce a non standard output form, they don't handle multi-character fields and 42 have various quirks and inconsistencies. 43 Their use is strongly discouraged in new applications and they could 44 be deprecated in a future release. 45 46 Although there are a large number of possible flags for most purposes 47 B<XN_FLAG_ONELINE>, B<XN_FLAG_MULTILINE> or B<XN_FLAG_RFC2253> will suffice. 48 As noted on the L<ASN1_STRING_print_ex(3)> manual page 49 for UTF8 terminals the B<ASN1_STRFLGS_ESC_MSB> should be unset: so for example 50 B<XN_FLAG_ONELINE & ~ASN1_STRFLGS_ESC_MSB> would be used. 51 52 The complete set of the flags supported by X509_NAME_print_ex() is listed below. 53 54 Several options can be ored together. 55 56 The options B<XN_FLAG_SEP_COMMA_PLUS>, B<XN_FLAG_SEP_CPLUS_SPC>, 57 B<XN_FLAG_SEP_SPLUS_SPC> and B<XN_FLAG_SEP_MULTILINE> 58 determine the field separators to use. 59 Two distinct separators are used between distinct RelativeDistinguishedName 60 components and separate values in the same RDN for a multi-valued RDN. 61 Multi-valued RDNs are currently very rare 62 so the second separator will hardly ever be used. 63 64 B<XN_FLAG_SEP_COMMA_PLUS> uses comma and plus as separators. 65 B<XN_FLAG_SEP_CPLUS_SPC> uses comma and plus with spaces: 66 this is more readable that plain comma and plus. 67 B<XN_FLAG_SEP_SPLUS_SPC> uses spaced semicolon and plus. 68 B<XN_FLAG_SEP_MULTILINE> uses spaced newline and plus respectively. 69 70 If B<XN_FLAG_DN_REV> is set the whole DN is printed in reversed order. 71 72 The fields B<XN_FLAG_FN_SN>, B<XN_FLAG_FN_LN>, B<XN_FLAG_FN_OID>, 73 B<XN_FLAG_FN_NONE> determine how a field name is displayed. It will 74 use the short name (e.g. CN) the long name (e.g. commonName) always 75 use OID numerical form (normally OIDs are only used if the field name is not 76 recognised) and no field name respectively. 77 78 If B<XN_FLAG_SPC_EQ> is set then spaces will be placed around the '=' character 79 separating field names and values. 80 81 If B<XN_FLAG_DUMP_UNKNOWN_FIELDS> is set then the encoding of unknown fields is 82 printed instead of the values. 83 84 If B<XN_FLAG_FN_ALIGN> is set then field names are padded to 20 characters: this 85 is only of use for multiline format. 86 87 Additionally all the options supported by ASN1_STRING_print_ex() can be used to 88 control how each field value is displayed. 89 90 In addition a number options can be set for commonly used formats. 91 92 B<XN_FLAG_RFC2253> sets options which produce an output compatible with RFC2253. 93 It is equivalent to: 94 C<ASN1_STRFLGS_RFC2253 | XN_FLAG_SEP_COMMA_PLUS | XN_FLAG_DN_REV 95 | XN_FLAG_FN_SN | XN_FLAG_DUMP_UNKNOWN_FIELDS> 96 97 B<XN_FLAG_ONELINE> is a more readable one line format which is the same as: 98 C<ASN1_STRFLGS_RFC2253 | ASN1_STRFLGS_ESC_QUOTE | XN_FLAG_SEP_CPLUS_SPC 99 | XN_FLAG_SPC_EQ | XN_FLAG_FN_SN> 100 101 B<XN_FLAG_MULTILINE> is a multiline format which is the same as: 102 C<ASN1_STRFLGS_ESC_CTRL | ASN1_STRFLGS_ESC_MSB | XN_FLAG_SEP_MULTILINE 103 | XN_FLAG_SPC_EQ | XN_FLAG_FN_LN | XN_FLAG_FN_ALIGN> 104 105 B<XN_FLAG_COMPAT> uses a format identical to X509_NAME_print(): 106 in fact it calls X509_NAME_print() internally. 107 108 =head1 RETURN VALUES 109 110 X509_NAME_oneline() returns a valid string on success or NULL on error. 111 112 X509_NAME_print() returns 1 on success or 0 on error. 113 114 X509_NAME_print_ex() and X509_NAME_print_ex_fp() return 1 on success or 0 on 115 error if the B<XN_FLAG_COMPAT> is set, which is the same as X509_NAME_print(). 116 Otherwise, it returns -1 on error or other values on success. 117 118 =head1 SEE ALSO 119 120 L<ASN1_STRING_print_ex(3)> 121 122 =head1 COPYRIGHT 123 124 Copyright 2002-2026 The OpenSSL Project Authors. All Rights Reserved. 125 126 Licensed under the Apache License 2.0 (the "License"). You may not use 127 this file except in compliance with the License. You can obtain a copy 128 in the file LICENSE in the source distribution or at 129 L<https://www.openssl.org/source/license.html>. 130 131 =cut 132
Indexes created Sat Jun 27 00:24:51 UTC 2026