ASN1_STRING_print_ex 3 2007-03-06 0.9.9-dev OpenSSL

NAME

ASN1_STRING_print_ex, ASN1_STRING_print_ex_fp - ASN1_STRING output routines.

LIBRARY

libcrypto, -lcrypto

SYNOPSIS


 #include 


 int ASN1_STRING_print_ex(BIO *out, ASN1_STRING *str, unsigned long flags);
 int ASN1_STRING_print_ex_fp(FILE *fp, ASN1_STRING *str, unsigned long flags);
 int ASN1_STRING_print(BIO *out, ASN1_STRING *str);

DESCRIPTION

These functions output an AASSNN11__SSTTRRIINNGG structure. AASSNN11__SSTTRRIINNGG is used to represent all the ASN1 string types.

_A_S_N_1___S_T_R_I_N_G___p_r_i_n_t___e_x_(_) outputs ssttrr to oouutt, the format is determined by the options ffllaaggss. _A_S_N_1___S_T_R_I_N_G___p_r_i_n_t___e_x___f_p_(_) is identical except it outputs to ffpp instead.

_A_S_N_1___S_T_R_I_N_G___p_r_i_n_t_(_) prints ssttrr to oouutt but using a different format to _A_S_N_1___S_T_R_I_N_G___p_r_i_n_t___e_x_(_). It replaces unprintable characters (other than CR, LF) with '.'.

NOTES

_A_S_N_1___S_T_R_I_N_G___p_r_i_n_t_(_) is a legacy function which should be avoided in new applications.

Although there are a large number of options frequently AASSNN11__SSTTRRFFLLGGSS__RRFFCC22225533 is suitable, or on UTF8 terminals AASSNN11__SSTTRRFFLLGGSS__RRFFCC22225533 && ~~AASSNN11__SSTTRRFFLLGGSS__EESSCC__MMSSBB.

The complete set of supported options for ffllaaggss is listed below.

Various characters can be escaped. If AASSNN11__SSTTRRFFLLGGSS__EESSCC__22225533 is set the characters determined by RFC2253 are escaped. If AASSNN11__SSTTRRFFLLGGSS__EESSCC__CCTTRRLL is set control characters are escaped. If AASSNN11__SSTTRRFFLLGGSS__EESSCC__MMSSBB is set characters with the MSB set are escaped: this option should nnoott be used if the terminal correctly interprets UTF8 sequences.

Escaping takes several forms.

If the character being escaped is a 16 bit character then the form "\UXXXX" is used using exactly four characters for the hex representation. If it is 32 bits then "\WXXXXXXXX" is used using eight characters of its hex representation. These forms will only be used if UTF8 conversion is not set (see below).

Printable characters are normally escaped using the backslash '\' character. If AASSNN11__SSTTRRFFLLGGSS__EESSCC__QQUUOOTTEE is set then the whole string is instead surrounded by double quote characters: this is arguably more readable than the backslash notation. Other characters use the "\XX" using exactly two characters of the hex representation.

If AASSNN11__SSTTRRFFLLGGSS__UUTTFF88__CCOONNVVEERRTT is set then characters are converted to UTF8 format first. If the terminal supports the display of UTF8 sequences then this option will correctly display multi byte characters.

If AASSNN11__SSTTRRFFLLGGSS__IIGGNNOORREE__TTYYPPEE is set then the string type is not interpreted at all: everything is assumed to be one byte per character. This is primarily for debugging purposes and can result in confusing output in multi character strings.

If AASSNN11__SSTTRRFFLLGGSS__SSHHOOWW__TTYYPPEE is set then the string type itself is printed out before its value (for example "BMPSTRING"), this actually uses _A_S_N_1___t_a_g_2_s_t_r_(_).

The content of a string instead of being interpreted can be "dumped": this just outputs the value of the string using the form #XXXX using hex format for each octet.

If AASSNN11__SSTTRRFFLLGGSS__DDUUMMPP__AALLLL is set then any type is dumped.

Normally non character string types (such as OCTET STRING) are assumed to be one byte per character, if AASSNN11__SSTTRRFFLLGGSS__DDUUMMPP__UUNNKKNNOOWWNN is set then they will be dumped instead.

When a type is dumped normally just the content octets are printed, if AASSNN11__SSTTRRFFLLGGSS__DDUUMMPP__DDEERR is set then the complete encoding is dumped instead (including tag and length octets).

AASSNN11__SSTTRRFFLLGGSS__RRFFCC22225533 includes all the flags required by RFC2253. It is equivalent to: ASN1_STRFLGS_ESC_2253 | ASN1_STRFLGS_ESC_CTRL | ASN1_STRFLGS_ESC_MSB | ASN1_STRFLGS_UTF8_CONVERT | ASN1_STRFLGS_DUMP_UNKNOWN ASN1_STRFLGS_DUMP_DER

SEE ALSO

_X_5_0_9___N_A_M_E___p_r_i_n_t___e_x(3), _A_S_N_1___t_a_g_2_s_t_r(3)

HISTORY

TBA