Update files for OpenSSL-1.0.0f import.
[dragonfly.git] / secure / lib / libcrypto / man / ASN1_STRING_length.3
CommitLineData
e3261593 1.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.19)
8b0cefbb
JR
2.\"
3.\" Standard preamble:
4.\" ========================================================================
8b0cefbb 5.de Sp \" Vertical space (when we can't use .PP)
984263bc
MD
6.if t .sp .5v
7.if n .sp
8..
8b0cefbb 9.de Vb \" Begin verbatim text
984263bc
MD
10.ft CW
11.nf
12.ne \\$1
13..
8b0cefbb 14.de Ve \" End verbatim text
984263bc 15.ft R
984263bc
MD
16.fi
17..
8b0cefbb
JR
18.\" Set up some character translations and predefined strings. \*(-- will
19.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
e257b235
PA
20.\" double quote, and \*(R" will give a right double quote. \*(C+ will
21.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23.\" nothing in troff, for use with C<>.
24.tr \(*W-
8b0cefbb 25.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
984263bc 26.ie n \{\
8b0cefbb
JR
27. ds -- \(*W-
28. ds PI pi
29. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
31. ds L" ""
32. ds R" ""
33. ds C` ""
34. ds C' ""
984263bc
MD
35'br\}
36.el\{\
8b0cefbb
JR
37. ds -- \|\(em\|
38. ds PI \(*p
39. ds L" ``
40. ds R" ''
984263bc 41'br\}
8b0cefbb 42.\"
e257b235
PA
43.\" Escape single quotes in literal strings from groff's Unicode transform.
44.ie \n(.g .ds Aq \(aq
45.el .ds Aq '
46.\"
8b0cefbb 47.\" If the F register is turned on, we'll generate index entries on stderr for
01185282 48.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
8b0cefbb
JR
49.\" entries marked with X<> in POD. Of course, you'll have to process the
50.\" output yourself in some meaningful fashion.
e257b235 51.ie \nF \{\
8b0cefbb
JR
52. de IX
53. tm Index:\\$1\t\\n%\t"\\$2"
984263bc 54..
8b0cefbb
JR
55. nr % 0
56. rr F
984263bc 57.\}
e257b235
PA
58.el \{\
59. de IX
60..
61.\}
aac4ff6f 62.\"
8b0cefbb
JR
63.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64.\" Fear. Run. Save yourself. No user-serviceable parts.
65. \" fudge factors for nroff and troff
984263bc 66.if n \{\
8b0cefbb
JR
67. ds #H 0
68. ds #V .8m
69. ds #F .3m
70. ds #[ \f1
71. ds #] \fP
984263bc
MD
72.\}
73.if t \{\
8b0cefbb
JR
74. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75. ds #V .6m
76. ds #F 0
77. ds #[ \&
78. ds #] \&
984263bc 79.\}
8b0cefbb 80. \" simple accents for nroff and troff
984263bc 81.if n \{\
8b0cefbb
JR
82. ds ' \&
83. ds ` \&
84. ds ^ \&
85. ds , \&
86. ds ~ ~
87. ds /
984263bc
MD
88.\}
89.if t \{\
8b0cefbb
JR
90. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
984263bc 96.\}
8b0cefbb 97. \" troff and (daisy-wheel) nroff accents
984263bc
MD
98.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105.ds ae a\h'-(\w'a'u*4/10)'e
106.ds Ae A\h'-(\w'A'u*4/10)'E
8b0cefbb 107. \" corrections for vroff
984263bc
MD
108.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
8b0cefbb 110. \" for low resolution devices (crt and lpr)
984263bc
MD
111.if \n(.H>23 .if \n(.V>19 \
112\{\
8b0cefbb
JR
113. ds : e
114. ds 8 ss
115. ds o a
116. ds d- d\h'-1'\(ga
117. ds D- D\h'-1'\(hy
118. ds th \o'bp'
119. ds Th \o'LP'
120. ds ae ae
121. ds Ae AE
984263bc
MD
122.\}
123.rm #[ #] #H #V #F C
8b0cefbb
JR
124.\" ========================================================================
125.\"
126.IX Title "ASN1_STRING_length 3"
e3261593 127.TH ASN1_STRING_length 3 "2012-01-04" "1.0.0f" "OpenSSL"
e257b235
PA
128.\" For nroff, turn off justification. Always turn off hyphenation; it makes
129.\" way too many mistakes in technical documents.
130.if n .ad l
131.nh
984263bc
MD
132.SH "NAME"
133ASN1_STRING_dup, ASN1_STRING_cmp, ASN1_STRING_set, ASN1_STRING_length,
134ASN1_STRING_length_set, ASN1_STRING_type, ASN1_STRING_data \-
74dab6c2 135ASN1_STRING utility functions
984263bc 136.SH "SYNOPSIS"
8b0cefbb 137.IX Header "SYNOPSIS"
01185282
PA
138.Vb 1
139\& #include <openssl/asn1.h>
140\&
984263bc
MD
141\& int ASN1_STRING_length(ASN1_STRING *x);
142\& unsigned char * ASN1_STRING_data(ASN1_STRING *x);
e257b235 143\&
984263bc 144\& ASN1_STRING * ASN1_STRING_dup(ASN1_STRING *a);
e257b235 145\&
984263bc 146\& int ASN1_STRING_cmp(ASN1_STRING *a, ASN1_STRING *b);
e257b235 147\&
984263bc 148\& int ASN1_STRING_set(ASN1_STRING *str, const void *data, int len);
e257b235 149\&
984263bc 150\& int ASN1_STRING_type(ASN1_STRING *x);
e257b235 151\&
984263bc
MD
152\& int ASN1_STRING_to_UTF8(unsigned char **out, ASN1_STRING *in);
153.Ve
154.SH "DESCRIPTION"
8b0cefbb
JR
155.IX Header "DESCRIPTION"
156These functions allow an \fB\s-1ASN1_STRING\s0\fR structure to be manipulated.
984263bc 157.PP
8b0cefbb 158\&\fIASN1_STRING_length()\fR returns the length of the content of \fBx\fR.
984263bc 159.PP
8b0cefbb 160\&\fIASN1_STRING_data()\fR returns an internal pointer to the data of \fBx\fR.
984263bc
MD
161Since this is an internal pointer it should \fBnot\fR be freed or
162modified in any way.
163.PP
8b0cefbb 164\&\fIASN1_STRING_dup()\fR returns a copy of the structure \fBa\fR.
984263bc 165.PP
8b0cefbb 166\&\fIASN1_STRING_cmp()\fR compares \fBa\fR and \fBb\fR returning 0 if the two
984263bc
MD
167are identical. The string types and content are compared.
168.PP
8b0cefbb
JR
169\&\fIASN1_STRING_set()\fR sets the data of string \fBstr\fR to the buffer
170\&\fBdata\fR or length \fBlen\fR. The supplied data is copied. If \fBlen\fR
171is \-1 then the length is determined by strlen(data).
984263bc 172.PP
8b0cefbb 173\&\fIASN1_STRING_type()\fR returns the type of \fBx\fR, using standard constants
984263bc
MD
174such as \fBV_ASN1_OCTET_STRING\fR.
175.PP
8b0cefbb 176\&\fIASN1_STRING_to_UTF8()\fR converts the string \fBin\fR to \s-1UTF8\s0 format, the
984263bc 177converted data is allocated in a buffer in \fB*out\fR. The length of
8b0cefbb 178\&\fBout\fR is returned or a negative error code. The buffer \fB*out\fR
984263bc
MD
179should be free using \fIOPENSSL_free()\fR.
180.SH "NOTES"
8b0cefbb
JR
181.IX Header "NOTES"
182Almost all \s-1ASN1\s0 types in OpenSSL are represented as an \fB\s-1ASN1_STRING\s0\fR
183structure. Other types such as \fB\s-1ASN1_OCTET_STRING\s0\fR are simply typedefed
184to \fB\s-1ASN1_STRING\s0\fR and the functions call the \fB\s-1ASN1_STRING\s0\fR equivalents.
185\&\fB\s-1ASN1_STRING\s0\fR is also used for some \fB\s-1CHOICE\s0\fR types which consist
984263bc 186entirely of primitive string types such as \fBDirectoryString\fR and
8b0cefbb 187\&\fBTime\fR.
984263bc 188.PP
8b0cefbb
JR
189These functions should \fBnot\fR be used to examine or modify \fB\s-1ASN1_INTEGER\s0\fR
190or \fB\s-1ASN1_ENUMERATED\s0\fR types: the relevant \fB\s-1INTEGER\s0\fR or \fB\s-1ENUMERATED\s0\fR
984263bc
MD
191utility functions should be used instead.
192.PP
193In general it cannot be assumed that the data returned by \fIASN1_STRING_data()\fR
194is null terminated or does not contain embedded nulls. The actual format
195of the data will depend on the actual string type itself: for example
8b0cefbb
JR
196for and IA5String the data will be \s-1ASCII\s0, for a BMPString two bytes per
197character in big endian format, UTF8String will be in \s-1UTF8\s0 format.
984263bc
MD
198.PP
199Similar care should be take to ensure the data is in the correct format
200when calling \fIASN1_STRING_set()\fR.
201.SH "RETURN VALUES"
74dab6c2 202.IX Header "RETURN VALUES"
8b0cefbb 203.SH "SEE ALSO"
74dab6c2 204.IX Header "SEE ALSO"
8b0cefbb
JR
205\&\fIERR_get_error\fR\|(3)
206.SH "HISTORY"
984263bc 207.IX Header "HISTORY"