1 .\" Automatically generated by Pod::Man version 1.15
2 .\" Wed Feb 19 16:42:42 2003
5 .\" ======================================================================
6 .de Sh \" Subsection heading
14 .de Sp \" Vertical space (when we can't use .PP)
20 .ie \\n(.$>=3 .ne \\$3
24 .de Vb \" Begin verbatim text
29 .de Ve \" End verbatim text
34 .\" Set up some character translations and predefined strings. \*(-- will
35 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
36 .\" double quote, and \*(R" will give a right double quote. | will give a
37 .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used
38 .\" to do unbreakable dashes and therefore won't be available. \*(C` and
39 .\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
41 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
45 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
46 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
59 .\" If the F register is turned on, we'll generate index entries on stderr
60 .\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
61 .\" index entries marked with X<> in POD. Of course, you'll have to process
62 .\" the output yourself in some meaningful fashion.
65 . tm Index:\\$1\t\\n%\t"\\$2"
71 .\" For nroff, turn off justification. Always turn off hyphenation; it
72 .\" makes way too many mistakes in technical documents.
76 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
77 .\" Fear. Run. Save yourself. No user-serviceable parts.
79 . \" fudge factors for nroff and troff
88 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
94 . \" simple accents for nroff and troff
104 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
105 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
106 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
107 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
108 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
109 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
111 . \" troff and (daisy-wheel) nroff accents
112 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
113 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
114 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
115 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
116 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
117 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
118 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
119 .ds ae a\h'-(\w'a'u*4/10)'e
120 .ds Ae A\h'-(\w'A'u*4/10)'E
121 . \" corrections for vroff
122 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
123 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
124 . \" for low resolution devices (crt and lpr)
125 .if \n(.H>23 .if \n(.V>19 \
138 .\" ======================================================================
140 .IX Title "ASN1_STRING_length 3"
141 .TH ASN1_STRING_length 3 "0.9.7a" "2003-02-19" "OpenSSL"
144 ASN1_STRING_dup, ASN1_STRING_cmp, ASN1_STRING_set, ASN1_STRING_length,
145 ASN1_STRING_length_set, ASN1_STRING_type, ASN1_STRING_data \-
146 \&\s-1ASN1_STRING\s0 utility functions
148 .IX Header "SYNOPSIS"
150 \& int ASN1_STRING_length(ASN1_STRING *x);
151 \& unsigned char * ASN1_STRING_data(ASN1_STRING *x);
154 \& ASN1_STRING * ASN1_STRING_dup(ASN1_STRING *a);
157 \& int ASN1_STRING_cmp(ASN1_STRING *a, ASN1_STRING *b);
160 \& int ASN1_STRING_set(ASN1_STRING *str, const void *data, int len);
163 \& int ASN1_STRING_type(ASN1_STRING *x);
166 \& int ASN1_STRING_to_UTF8(unsigned char **out, ASN1_STRING *in);
169 .IX Header "DESCRIPTION"
170 These functions allow an \fB\s-1ASN1_STRING\s0\fR structure to be manipulated.
172 \&\fIASN1_STRING_length()\fR returns the length of the content of \fBx\fR.
174 \&\fIASN1_STRING_data()\fR returns an internal pointer to the data of \fBx\fR.
175 Since this is an internal pointer it should \fBnot\fR be freed or
178 \&\fIASN1_STRING_dup()\fR returns a copy of the structure \fBa\fR.
180 \&\fIASN1_STRING_cmp()\fR compares \fBa\fR and \fBb\fR returning 0 if the two
181 are identical. The string types and content are compared.
183 \&\fIASN1_STRING_set()\fR sets the data of string \fBstr\fR to the buffer
184 \&\fBdata\fR or length \fBlen\fR. The supplied data is copied. If \fBlen\fR
185 is \-1 then the length is determined by strlen(data).
187 \&\fIASN1_STRING_type()\fR returns the type of \fBx\fR, using standard constants
188 such as \fBV_ASN1_OCTET_STRING\fR.
190 \&\fIASN1_STRING_to_UTF8()\fR converts the string \fBin\fR to \s-1UTF8\s0 format, the
191 converted data is allocated in a buffer in \fB*out\fR. The length of
192 \&\fBout\fR is returned or a negative error code. The buffer \fB*out\fR
193 should be free using \fIOPENSSL_free()\fR.
196 Almost all \s-1ASN1\s0 types in OpenSSL are represented as an \fB\s-1ASN1_STRING\s0\fR
197 structure. Other types such as \fB\s-1ASN1_OCTET_STRING\s0\fR are simply typedefed
198 to \fB\s-1ASN1_STRING\s0\fR and the functions call the \fB\s-1ASN1_STRING\s0\fR equivalents.
199 \&\fB\s-1ASN1_STRING\s0\fR is also used for some \fB\s-1CHOICE\s0\fR types which consist
200 entirely of primitive string types such as \fBDirectoryString\fR and
203 These functions should \fBnot\fR be used to examine or modify \fB\s-1ASN1_INTEGER\s0\fR
204 or \fB\s-1ASN1_ENUMERATED\s0\fR types: the relevant \fB\s-1INTEGER\s0\fR or \fB\s-1ENUMERATED\s0\fR
205 utility functions should be used instead.
207 In general it cannot be assumed that the data returned by \fIASN1_STRING_data()\fR
208 is null terminated or does not contain embedded nulls. The actual format
209 of the data will depend on the actual string type itself: for example
210 for and IA5String the data will be \s-1ASCII\s0, for a BMPString two bytes per
211 character in big endian format, UTF8String will be in \s-1UTF8\s0 format.
213 Similar care should be take to ensure the data is in the correct format
214 when calling \fIASN1_STRING_set()\fR.
216 .IX Header "RETURN VALUES"
218 .IX Header "SEE ALSO"