Merge commit 'origin/vendor/PAM_PASSWDQC'
[dragonfly.git] / secure / lib / libcrypto / man / OBJ_nid2obj.3
1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sh \" Subsection heading
6 .br
7 .if t .Sp
8 .ne 5
9 .PP
10 \fB\\$1\fR
11 .PP
12 ..
13 .de Sp \" Vertical space (when we can't use .PP)
14 .if t .sp .5v
15 .if n .sp
16 ..
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
21 ..
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
25 ..
26 .\" Set up some character translations and predefined strings.  \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote.  | will give a
29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
32 .tr \(*W-|\(bv\*(Tr
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
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' ""
43 'br\}
44 .el\{\
45 .    ds -- \|\(em\|
46 .    ds PI \(*p
47 .    ds L" ``
48 .    ds R" ''
49 'br\}
50 .\"
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
55 .if \nF \{\
56 .    de IX
57 .    tm Index:\\$1\t\\n%\t"\\$2"
58 ..
59 .    nr % 0
60 .    rr F
61 .\}
62 .\"
63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
65 .hy 0
66 .if n .na
67 .\"
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
70 .    \" fudge factors for nroff and troff
71 .if n \{\
72 .    ds #H 0
73 .    ds #V .8m
74 .    ds #F .3m
75 .    ds #[ \f1
76 .    ds #] \fP
77 .\}
78 .if t \{\
79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 .    ds #V .6m
81 .    ds #F 0
82 .    ds #[ \&
83 .    ds #] \&
84 .\}
85 .    \" simple accents for nroff and troff
86 .if n \{\
87 .    ds ' \&
88 .    ds ` \&
89 .    ds ^ \&
90 .    ds , \&
91 .    ds ~ ~
92 .    ds /
93 .\}
94 .if t \{\
95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101 .\}
102 .    \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 .    \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 .    \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
117 \{\
118 .    ds : e
119 .    ds 8 ss
120 .    ds o a
121 .    ds d- d\h'-1'\(ga
122 .    ds D- D\h'-1'\(hy
123 .    ds th \o'bp'
124 .    ds Th \o'LP'
125 .    ds ae ae
126 .    ds Ae AE
127 .\}
128 .rm #[ #] #H #V #F C
129 .\" ========================================================================
130 .\"
131 .IX Title "OBJ_nid2obj 3"
132 .TH OBJ_nid2obj 3 "2008-09-27" "0.9.8i" "OpenSSL"
133 .SH "NAME"
134 OBJ_nid2obj, OBJ_nid2ln, OBJ_nid2sn, OBJ_obj2nid, OBJ_txt2nid, OBJ_ln2nid, OBJ_sn2nid,
135 OBJ_cmp, OBJ_dup, OBJ_txt2obj, OBJ_obj2txt, OBJ_create, OBJ_cleanup \- ASN1 object utility
136 functions
137 .SH "SYNOPSIS"
138 .IX Header "SYNOPSIS"
139 .Vb 3
140 \& ASN1_OBJECT * OBJ_nid2obj(int n);
141 \& const char *  OBJ_nid2ln(int n);
142 \& const char *  OBJ_nid2sn(int n);
143 .Ve
144 .PP
145 .Vb 3
146 \& int OBJ_obj2nid(const ASN1_OBJECT *o);
147 \& int OBJ_ln2nid(const char *ln);
148 \& int OBJ_sn2nid(const char *sn);
149 .Ve
150 .PP
151 .Vb 1
152 \& int OBJ_txt2nid(const char *s);
153 .Ve
154 .PP
155 .Vb 2
156 \& ASN1_OBJECT * OBJ_txt2obj(const char *s, int no_name);
157 \& int OBJ_obj2txt(char *buf, int buf_len, const ASN1_OBJECT *a, int no_name);
158 .Ve
159 .PP
160 .Vb 2
161 \& int OBJ_cmp(const ASN1_OBJECT *a,const ASN1_OBJECT *b);
162 \& ASN1_OBJECT * OBJ_dup(const ASN1_OBJECT *o);
163 .Ve
164 .PP
165 .Vb 2
166 \& int OBJ_create(const char *oid,const char *sn,const char *ln);
167 \& void OBJ_cleanup(void);
168 .Ve
169 .SH "DESCRIPTION"
170 .IX Header "DESCRIPTION"
171 The \s-1ASN1\s0 object utility functions process \s-1ASN1_OBJECT\s0 structures which are
172 a representation of the \s-1ASN1\s0 \s-1OBJECT\s0 \s-1IDENTIFIER\s0 (\s-1OID\s0) type.
173 .PP
174 \&\fIOBJ_nid2obj()\fR, \fIOBJ_nid2ln()\fR and \fIOBJ_nid2sn()\fR convert the \s-1NID\s0 \fBn\fR to 
175 an \s-1ASN1_OBJECT\s0 structure, its long name and its short name respectively,
176 or \fB\s-1NULL\s0\fR is an error occurred.
177 .PP
178 \&\fIOBJ_obj2nid()\fR, \fIOBJ_ln2nid()\fR, \fIOBJ_sn2nid()\fR return the corresponding \s-1NID\s0
179 for the object \fBo\fR, the long name <ln> or the short name <sn> respectively
180 or NID_undef if an error occurred.
181 .PP
182 \&\fIOBJ_txt2nid()\fR returns \s-1NID\s0 corresponding to text string <s>. \fBs\fR can be
183 a long name, a short name or the numerical respresentation of an object.
184 .PP
185 \&\fIOBJ_txt2obj()\fR converts the text string \fBs\fR into an \s-1ASN1_OBJECT\s0 structure.
186 If \fBno_name\fR is 0 then long names and short names will be interpreted
187 as well as numerical forms. If \fBno_name\fR is 1 only the numerical form
188 is acceptable.
189 .PP
190 \&\fIOBJ_obj2txt()\fR converts the \fB\s-1ASN1_OBJECT\s0\fR \fBa\fR into a textual representation.
191 The representation is written as a null terminated string to \fBbuf\fR
192 at most \fBbuf_len\fR bytes are written, truncating the result if necessary.
193 The total amount of space required is returned. If \fBno_name\fR is 0 then
194 if the object has a long or short name then that will be used, otherwise
195 the numerical form will be used. If \fBno_name\fR is 1 then the numerical
196 form will always be used.
197 .PP
198 \&\fIOBJ_cmp()\fR compares \fBa\fR to \fBb\fR. If the two are identical 0 is returned.
199 .PP
200 \&\fIOBJ_dup()\fR returns a copy of \fBo\fR.
201 .PP
202 \&\fIOBJ_create()\fR adds a new object to the internal table. \fBoid\fR is the 
203 numerical form of the object, \fBsn\fR the short name and \fBln\fR the
204 long name. A new \s-1NID\s0 is returned for the created object.
205 .PP
206 \&\fIOBJ_cleanup()\fR cleans up OpenSSLs internal object table: this should
207 be called before an application exits if any new objects were added
208 using \fIOBJ_create()\fR.
209 .SH "NOTES"
210 .IX Header "NOTES"
211 Objects in OpenSSL can have a short name, a long name and a numerical
212 identifier (\s-1NID\s0) associated with them. A standard set of objects is
213 represented in an internal table. The appropriate values are defined
214 in the header file \fBobjects.h\fR.
215 .PP
216 For example the \s-1OID\s0 for commonName has the following definitions:
217 .PP
218 .Vb 3
219 \& #define SN_commonName                   "CN"
220 \& #define LN_commonName                   "commonName"
221 \& #define NID_commonName                  13
222 .Ve
223 .PP
224 New objects can be added by calling \fIOBJ_create()\fR.
225 .PP
226 Table objects have certain advantages over other objects: for example
227 their NIDs can be used in a C language switch statement. They are
228 also static constant structures which are shared: that is there
229 is only a single constant structure for each table object.
230 .PP
231 Objects which are not in the table have the \s-1NID\s0 value NID_undef.
232 .PP
233 Objects do not need to be in the internal tables to be processed,
234 the functions \fIOBJ_txt2obj()\fR and \fIOBJ_obj2txt()\fR can process the numerical
235 form of an \s-1OID\s0.
236 .SH "EXAMPLES"
237 .IX Header "EXAMPLES"
238 Create an object for \fBcommonName\fR:
239 .PP
240 .Vb 2
241 \& ASN1_OBJECT *o;
242 \& o = OBJ_nid2obj(NID_commonName);
243 .Ve
244 .PP
245 Check if an object is \fBcommonName\fR
246 .PP
247 .Vb 2
248 \& if (OBJ_obj2nid(obj) == NID_commonName)
249 \&        /* Do something */
250 .Ve
251 .PP
252 Create a new \s-1NID\s0 and initialize an object from it:
253 .PP
254 .Vb 3
255 \& int new_nid;
256 \& ASN1_OBJECT *obj;
257 \& new_nid = OBJ_create("1.2.3.4", "NewOID", "New Object Identifier");
258 .Ve
259 .PP
260 .Vb 1
261 \& obj = OBJ_nid2obj(new_nid);
262 .Ve
263 .PP
264 Create a new object directly:
265 .PP
266 .Vb 1
267 \& obj = OBJ_txt2obj("1.2.3.4", 1);
268 .Ve
269 .SH "BUGS"
270 .IX Header "BUGS"
271 \&\fIOBJ_obj2txt()\fR is awkward and messy to use: it doesn't follow the 
272 convention of other OpenSSL functions where the buffer can be set
273 to \fB\s-1NULL\s0\fR to determine the amount of data that should be written.
274 Instead \fBbuf\fR must point to a valid buffer and \fBbuf_len\fR should
275 be set to a positive value. A buffer length of 80 should be more
276 than enough to handle any \s-1OID\s0 encountered in practice.
277 .SH "RETURN VALUES"
278 .IX Header "RETURN VALUES"
279 \&\fIOBJ_nid2obj()\fR returns an \fB\s-1ASN1_OBJECT\s0\fR structure or \fB\s-1NULL\s0\fR is an
280 error occurred.
281 .PP
282 \&\fIOBJ_nid2ln()\fR and \fIOBJ_nid2sn()\fR returns a valid string or \fB\s-1NULL\s0\fR
283 on error.
284 .PP
285 \&\fIOBJ_obj2nid()\fR, \fIOBJ_ln2nid()\fR, \fIOBJ_sn2nid()\fR and \fIOBJ_txt2nid()\fR return
286 a \s-1NID\s0 or \fBNID_undef\fR on error.
287 .SH "SEE ALSO"
288 .IX Header "SEE ALSO"
289 \&\fIERR_get_error\fR\|(3)
290 .SH "HISTORY"
291 .IX Header "HISTORY"
292 \&\s-1TBA\s0