X509_NAME_print (3)

Leading comments

Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)

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

(The comments found at the beginning of the groff file "man3/X509_NAME_print.3ssl".)

NAME

X509_NAME_print_ex, X509_NAME_print_ex_fp, X509_NAME_print, X509_NAME_oneline - X509_NAME printing routines.

SYNOPSIS

 #include <openssl/x509.h>

 int X509_NAME_print_ex(BIO *out, X509_NAME *nm, int indent, unsigned long flags);
 int X509_NAME_print_ex_fp(FILE *fp, X509_NAME *nm, int indent, unsigned long flags);
 char * X509_NAME_oneline(X509_NAME *a,char *buf,int size);
 int X509_NAME_print(BIO *bp, X509_NAME *name, int obase);

DESCRIPTION

X509_NAME_print_ex() prints a human readable version of nm to out. Each line (for multiline formats) is indented by indent spaces. The output format can be extensively customised by use of the flags parameter.

X509_NAME_print_ex_fp() is identical to X509_NAME_print_ex() except the output is written to

pointer fp.

X509_NAME_oneline() prints an

version of a to buf. At most size bytes will be written. If buf is then a buffer is dynamically allocated and returned, otherwise buf is returned.

X509_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.

NOTES

The functions X509_NAME_oneline() and X509_NAME_print() are legacy functions which 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.

Although there are a large number of possible flags for most purposes

, or will suffice. As noted on the ASN1_STRING_print_ex(3) manual page for terminals the should be unset: so for example ~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

, , and determine the field separators to use. Two distinct separators are used between distinct RelativeDistinguishedName components and separate values in the same for a multi-valued Multi-valued RDNs are currently very rare so the second separator will hardly ever be used.

uses comma and plus as separators. uses comma and plus with spaces: this is more readable that plain comma and plus. uses spaced semicolon and plus. uses spaced newline and plus respectively.

If

is set the whole is printed in reversed order.

The fields

, , , determine how a field name is displayed. It will use the short name (e.g. ) the long name (e.g. commonName) always use numerical form (normally OIDs are only used if the field name is not recognised) and no field name respectively.

If

is set then spaces will be placed around the '=' character separating field names and values.

If

is set then the encoding of unknown fields is printed instead of the values.

If

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.

sets options which produce an output compatible with it is equivalent to:
  |  |  |  | 

is a more readable one line format which is the same as:
  |  |  |  | 

is a multiline format which is the same as:
  |  |  |  |  | 

uses a format identical to X509_NAME_print(): in fact it calls X509_NAME_print() internally.

SEE ALSO

ASN1_STRING_print_ex(3)

HISTORY