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