Merge branch 'vendor/OPENSSL'
[dragonfly.git] / secure / lib / libcrypto / man / X509_NAME_get_index_by_NID.3
CommitLineData
e257b235 1.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
8b0cefbb
JR
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
984263bc
MD
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
8b0cefbb 13.de Sp \" Vertical space (when we can't use .PP)
984263bc
MD
14.if t .sp .5v
15.if n .sp
16..
8b0cefbb 17.de Vb \" Begin verbatim text
984263bc
MD
18.ft CW
19.nf
20.ne \\$1
21..
8b0cefbb 22.de Ve \" End verbatim text
984263bc 23.ft R
984263bc
MD
24.fi
25..
8b0cefbb
JR
26.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
e257b235
PA
28.\" double quote, and \*(R" will give a right double quote. \*(C+ will
29.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
30.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
31.\" nothing in troff, for use with C<>.
32.tr \(*W-
8b0cefbb 33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
984263bc 34.ie n \{\
8b0cefbb
JR
35. ds -- \(*W-
36. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39. ds L" ""
40. ds R" ""
41. ds C` ""
42. ds C' ""
984263bc
MD
43'br\}
44.el\{\
8b0cefbb
JR
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
984263bc 49'br\}
8b0cefbb 50.\"
e257b235
PA
51.\" Escape single quotes in literal strings from groff's Unicode transform.
52.ie \n(.g .ds Aq \(aq
53.el .ds Aq '
54.\"
8b0cefbb
JR
55.\" If the F register is turned on, we'll generate index entries on stderr for
56.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
57.\" entries marked with X<> in POD. Of course, you'll have to process the
58.\" output yourself in some meaningful fashion.
e257b235 59.ie \nF \{\
8b0cefbb
JR
60. de IX
61. tm Index:\\$1\t\\n%\t"\\$2"
984263bc 62..
8b0cefbb
JR
63. nr % 0
64. rr F
984263bc 65.\}
e257b235
PA
66.el \{\
67. de IX
68..
69.\}
aac4ff6f 70.\"
8b0cefbb
JR
71.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
72.\" Fear. Run. Save yourself. No user-serviceable parts.
73. \" fudge factors for nroff and troff
984263bc 74.if n \{\
8b0cefbb
JR
75. ds #H 0
76. ds #V .8m
77. ds #F .3m
78. ds #[ \f1
79. ds #] \fP
984263bc
MD
80.\}
81.if t \{\
8b0cefbb
JR
82. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
83. ds #V .6m
84. ds #F 0
85. ds #[ \&
86. ds #] \&
984263bc 87.\}
8b0cefbb 88. \" simple accents for nroff and troff
984263bc 89.if n \{\
8b0cefbb
JR
90. ds ' \&
91. ds ` \&
92. ds ^ \&
93. ds , \&
94. ds ~ ~
95. ds /
984263bc
MD
96.\}
97.if t \{\
8b0cefbb
JR
98. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
99. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
100. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
101. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
102. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
103. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
984263bc 104.\}
8b0cefbb 105. \" troff and (daisy-wheel) nroff accents
984263bc
MD
106.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
107.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
108.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
109.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
110.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
111.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
112.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
113.ds ae a\h'-(\w'a'u*4/10)'e
114.ds Ae A\h'-(\w'A'u*4/10)'E
8b0cefbb 115. \" corrections for vroff
984263bc
MD
116.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
117.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
8b0cefbb 118. \" for low resolution devices (crt and lpr)
984263bc
MD
119.if \n(.H>23 .if \n(.V>19 \
120\{\
8b0cefbb
JR
121. ds : e
122. ds 8 ss
123. ds o a
124. ds d- d\h'-1'\(ga
125. ds D- D\h'-1'\(hy
126. ds th \o'bp'
127. ds Th \o'LP'
128. ds ae ae
129. ds Ae AE
984263bc
MD
130.\}
131.rm #[ #] #H #V #F C
8b0cefbb
JR
132.\" ========================================================================
133.\"
134.IX Title "X509_NAME_get_index_by_NID 3"
fc468453 135.TH X509_NAME_get_index_by_NID 3 "2010-02-27" "0.9.8m" "OpenSSL"
e257b235
PA
136.\" For nroff, turn off justification. Always turn off hyphenation; it makes
137.\" way too many mistakes in technical documents.
138.if n .ad l
139.nh
984263bc
MD
140.SH "NAME"
141X509_NAME_get_index_by_NID, X509_NAME_get_index_by_OBJ, X509_NAME_get_entry,
142X509_NAME_entry_count, X509_NAME_get_text_by_NID, X509_NAME_get_text_by_OBJ \-
143X509_NAME lookup and enumeration functions
144.SH "SYNOPSIS"
8b0cefbb
JR
145.IX Header "SYNOPSIS"
146int X509_NAME_get_index_by_NID(X509_NAME *name,int nid,int lastpos);
147int X509_NAME_get_index_by_OBJ(X509_NAME *name,ASN1_OBJECT *obj, int lastpos);
984263bc 148.PP
8b0cefbb
JR
149int X509_NAME_entry_count(X509_NAME *name);
150X509_NAME_ENTRY *X509_NAME_get_entry(X509_NAME *name, int loc);
984263bc 151.PP
8b0cefbb
JR
152int X509_NAME_get_text_by_NID(X509_NAME *name, int nid, char *buf,int len);
153int X509_NAME_get_text_by_OBJ(X509_NAME *name, \s-1ASN1_OBJECT\s0 *obj, char *buf,int len);
984263bc 154.SH "DESCRIPTION"
8b0cefbb 155.IX Header "DESCRIPTION"
984263bc 156These functions allow an \fBX509_NAME\fR structure to be examined. The
8b0cefbb
JR
157\&\fBX509_NAME\fR structure is the same as the \fBName\fR type defined in
158\&\s-1RFC2459\s0 (and elsewhere) and used for example in certificate subject
984263bc
MD
159and issuer names.
160.PP
8b0cefbb 161\&\fIX509_NAME_get_index_by_NID()\fR and \fIX509_NAME_get_index_by_OBJ()\fR retrieve
984263bc
MD
162the next index matching \fBnid\fR or \fBobj\fR after \fBlastpos\fR. \fBlastpos\fR
163should initially be set to \-1. If there are no more entries \-1 is returned.
164.PP
8b0cefbb 165\&\fIX509_NAME_entry_count()\fR returns the total number of entries in \fBname\fR.
984263bc 166.PP
8b0cefbb 167\&\fIX509_NAME_get_entry()\fR retrieves the \fBX509_NAME_ENTRY\fR from \fBname\fR
984263bc 168corresponding to index \fBloc\fR. Acceptable values for \fBloc\fR run from
8b0cefbb 1690 to (X509_NAME_entry_count(name) \- 1). The value returned is an
984263bc
MD
170internal pointer which must not be freed.
171.PP
8b0cefbb 172\&\fIX509_NAME_get_text_by_NID()\fR, \fIX509_NAME_get_text_by_OBJ()\fR retrieve
984263bc 173the \*(L"text\*(R" from the first entry in \fBname\fR which matches \fBnid\fR or
8b0cefbb 174\&\fBobj\fR, if no such entry exists \-1 is returned. At most \fBlen\fR bytes
984263bc
MD
175will be written and the text written to \fBbuf\fR will be null
176terminated. The length of the output string written is returned
8b0cefbb 177excluding the terminating null. If \fBbuf\fR is <\s-1NULL\s0> then the amount
e257b235 178of space needed in \fBbuf\fR (excluding the final null) is returned.
984263bc 179.SH "NOTES"
8b0cefbb
JR
180.IX Header "NOTES"
181\&\fIX509_NAME_get_text_by_NID()\fR and \fIX509_NAME_get_text_by_OBJ()\fR are
984263bc
MD
182legacy functions which have various limitations which make them
183of minimal use in practice. They can only find the first matching
184entry and will copy the contents of the field verbatim: this can
185be highly confusing if the target is a muticharacter string type
186like a BMPString or a UTF8String.
187.PP
188For a more general solution \fIX509_NAME_get_index_by_NID()\fR or
8b0cefbb
JR
189\&\fIX509_NAME_get_index_by_OBJ()\fR should be used followed by
190\&\fIX509_NAME_get_entry()\fR on any matching indices and then the
984263bc
MD
191various \fBX509_NAME_ENTRY\fR utility functions on the result.
192.SH "EXAMPLES"
8b0cefbb 193.IX Header "EXAMPLES"
984263bc
MD
194Process all entries:
195.PP
196.Vb 2
197\& int i;
198\& X509_NAME_ENTRY *e;
e257b235 199\&
984263bc
MD
200\& for (i = 0; i < X509_NAME_entry_count(nm); i++)
201\& {
202\& e = X509_NAME_get_entry(nm, i);
203\& /* Do something with e */
204\& }
205.Ve
8b0cefbb 206.PP
984263bc
MD
207Process all commonName entries:
208.PP
209.Vb 2
210\& int loc;
211\& X509_NAME_ENTRY *e;
e257b235
PA
212\&
213\& loc = \-1;
984263bc
MD
214\& for (;;)
215\& {
216\& lastpos = X509_NAME_get_index_by_NID(nm, NID_commonName, lastpos);
e257b235 217\& if (lastpos == \-1)
984263bc
MD
218\& break;
219\& e = X509_NAME_get_entry(nm, lastpos);
220\& /* Do something with e */
221\& }
222.Ve
223.SH "RETURN VALUES"
8b0cefbb
JR
224.IX Header "RETURN VALUES"
225\&\fIX509_NAME_get_index_by_NID()\fR and \fIX509_NAME_get_index_by_OBJ()\fR
984263bc
MD
226return the index of the next matching entry or \-1 if not found.
227.PP
8b0cefbb 228\&\fIX509_NAME_entry_count()\fR returns the total number of entries.
984263bc 229.PP
8b0cefbb
JR
230\&\fIX509_NAME_get_entry()\fR returns an \fBX509_NAME\fR pointer to the
231requested entry or \fB\s-1NULL\s0\fR if the index is invalid.
984263bc 232.SH "SEE ALSO"
74dab6c2 233.IX Header "SEE ALSO"
8b0cefbb
JR
234\&\fIERR_get_error\fR\|(3), \fId2i_X509_NAME\fR\|(3)
235.SH "HISTORY"
984263bc 236.IX Header "HISTORY"
8b0cefbb 237\&\s-1TBA\s0