Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)

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

..

.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is turned on, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF
Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "ASN1_STRING_length 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
ASN1_STRING_dup, ASN1_STRING_cmp, ASN1_STRING_set, ASN1_STRING_length, ASN1_STRING_length_set, ASN1_STRING_type, ASN1_STRING_data - ASN1_STRING utility functions Header "SYNOPSIS" .Vb 1 #include <openssl/asn1.h> \& int ASN1_STRING_length(ASN1_STRING *x); unsigned char * ASN1_STRING_data(ASN1_STRING *x); \& ASN1_STRING * ASN1_STRING_dup(ASN1_STRING *a); \& int ASN1_STRING_cmp(ASN1_STRING *a, ASN1_STRING *b); \& int ASN1_STRING_set(ASN1_STRING *str, const void *data, int len); \& int ASN1_STRING_type(ASN1_STRING *x); \& int ASN1_STRING_to_UTF8(unsigned char **out, ASN1_STRING *in); .Ve Header "DESCRIPTION" These functions allow an \s-1ASN1_STRING\s0 structure to be manipulated.

\fIASN1_STRING_length() returns the length of the content of x.

\fIASN1_STRING_data() returns an internal pointer to the data of x. Since this is an internal pointer it should not be freed or modified in any way.

\fIASN1_STRING_dup() returns a copy of the structure a.

\fIASN1_STRING_cmp() compares a and b returning 0 if the two are identical. The string types and content are compared.

\fIASN1_STRING_set() sets the data of string str to the buffer \fBdata or length len. The supplied data is copied. If len is -1 then the length is determined by strlen(data).

\fIASN1_STRING_type() returns the type of x, using standard constants such as V_ASN1_OCTET_STRING.

\fIASN1_STRING_to_UTF8() converts the string in to \s-1UTF8\s0 format, the converted data is allocated in a buffer in *out. The length of \fBout is returned or a negative error code. The buffer *out should be free using OPENSSL_free().

Header "NOTES" Almost all \s-1ASN1\s0 types in OpenSSL are represented as an \s-1ASN1_STRING\s0 structure. Other types such as \s-1ASN1_OCTET_STRING\s0 are simply typedefed to \s-1ASN1_STRING\s0 and the functions call the \s-1ASN1_STRING\s0 equivalents. \fB\s-1ASN1_STRING\s0 is also used for some \s-1CHOICE\s0 types which consist entirely of primitive string types such as DirectoryString and \fBTime.

These functions should not be used to examine or modify \s-1ASN1_INTEGER\s0 or \s-1ASN1_ENUMERATED\s0 types: the relevant \s-1INTEGER\s0 or \s-1ENUMERATED\s0 utility functions should be used instead.

In general it cannot be assumed that the data returned by ASN1_STRING_data() is null terminated or does not contain embedded nulls. The actual format of the data will depend on the actual string type itself: for example for and IA5String the data will be \s-1ASCII,\s0 for a BMPString two bytes per character in big endian format, UTF8String will be in \s-1UTF8\s0 format.

Similar care should be take to ensure the data is in the correct format when calling ASN1_STRING_set().

Header "RETURN VALUES" Header "SEE ALSO" \fIERR_get_error\|(3) Header "HISTORY"