Merge branch 'vendor/LIBPCAP'
[dragonfly.git] / secure / lib / libcrypto / man / OBJ_nid2obj.3
1 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
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.  \*(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-
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 .\" Escape single quotes in literal strings from groff's Unicode transform.
52 .ie \n(.g .ds Aq \(aq
53 .el       .ds Aq '
54 .\"
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.
59 .ie \nF \{\
60 .    de IX
61 .    tm Index:\\$1\t\\n%\t"\\$2"
62 ..
63 .    nr % 0
64 .    rr F
65 .\}
66 .el \{\
67 .    de IX
68 ..
69 .\}
70 .\"
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
74 .if n \{\
75 .    ds #H 0
76 .    ds #V .8m
77 .    ds #F .3m
78 .    ds #[ \f1
79 .    ds #] \fP
80 .\}
81 .if t \{\
82 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
83 .    ds #V .6m
84 .    ds #F 0
85 .    ds #[ \&
86 .    ds #] \&
87 .\}
88 .    \" simple accents for nroff and troff
89 .if n \{\
90 .    ds ' \&
91 .    ds ` \&
92 .    ds ^ \&
93 .    ds , \&
94 .    ds ~ ~
95 .    ds /
96 .\}
97 .if t \{\
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'
104 .\}
105 .    \" troff and (daisy-wheel) nroff accents
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
115 .    \" corrections for vroff
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'
118 .    \" for low resolution devices (crt and lpr)
119 .if \n(.H>23 .if \n(.V>19 \
120 \{\
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
130 .\}
131 .rm #[ #] #H #V #F C
132 .\" ========================================================================
133 .\"
134 .IX Title "OBJ_nid2obj 3"
135 .TH OBJ_nid2obj 3 "2009-04-11" "0.9.8k" "OpenSSL"
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
140 .SH "NAME"
141 OBJ_nid2obj, OBJ_nid2ln, OBJ_nid2sn, OBJ_obj2nid, OBJ_txt2nid, OBJ_ln2nid, OBJ_sn2nid,
142 OBJ_cmp, OBJ_dup, OBJ_txt2obj, OBJ_obj2txt, OBJ_create, OBJ_cleanup \- ASN1 object utility
143 functions
144 .SH "SYNOPSIS"
145 .IX Header "SYNOPSIS"
146 .Vb 3
147 \& ASN1_OBJECT * OBJ_nid2obj(int n);
148 \& const char *  OBJ_nid2ln(int n);
149 \& const char *  OBJ_nid2sn(int n);
150 \&
151 \& int OBJ_obj2nid(const ASN1_OBJECT *o);
152 \& int OBJ_ln2nid(const char *ln);
153 \& int OBJ_sn2nid(const char *sn);
154 \&
155 \& int OBJ_txt2nid(const char *s);
156 \&
157 \& ASN1_OBJECT * OBJ_txt2obj(const char *s, int no_name);
158 \& int OBJ_obj2txt(char *buf, int buf_len, const ASN1_OBJECT *a, int no_name);
159 \&
160 \& int OBJ_cmp(const ASN1_OBJECT *a,const ASN1_OBJECT *b);
161 \& ASN1_OBJECT * OBJ_dup(const ASN1_OBJECT *o);
162 \&
163 \& int OBJ_create(const char *oid,const char *sn,const char *ln);
164 \& void OBJ_cleanup(void);
165 .Ve
166 .SH "DESCRIPTION"
167 .IX Header "DESCRIPTION"
168 The \s-1ASN1\s0 object utility functions process \s-1ASN1_OBJECT\s0 structures which are
169 a representation of the \s-1ASN1\s0 \s-1OBJECT\s0 \s-1IDENTIFIER\s0 (\s-1OID\s0) type.
170 .PP
171 \&\fIOBJ_nid2obj()\fR, \fIOBJ_nid2ln()\fR and \fIOBJ_nid2sn()\fR convert the \s-1NID\s0 \fBn\fR to 
172 an \s-1ASN1_OBJECT\s0 structure, its long name and its short name respectively,
173 or \fB\s-1NULL\s0\fR is an error occurred.
174 .PP
175 \&\fIOBJ_obj2nid()\fR, \fIOBJ_ln2nid()\fR, \fIOBJ_sn2nid()\fR return the corresponding \s-1NID\s0
176 for the object \fBo\fR, the long name <ln> or the short name <sn> respectively
177 or NID_undef if an error occurred.
178 .PP
179 \&\fIOBJ_txt2nid()\fR returns \s-1NID\s0 corresponding to text string <s>. \fBs\fR can be
180 a long name, a short name or the numerical respresentation of an object.
181 .PP
182 \&\fIOBJ_txt2obj()\fR converts the text string \fBs\fR into an \s-1ASN1_OBJECT\s0 structure.
183 If \fBno_name\fR is 0 then long names and short names will be interpreted
184 as well as numerical forms. If \fBno_name\fR is 1 only the numerical form
185 is acceptable.
186 .PP
187 \&\fIOBJ_obj2txt()\fR converts the \fB\s-1ASN1_OBJECT\s0\fR \fBa\fR into a textual representation.
188 The representation is written as a null terminated string to \fBbuf\fR
189 at most \fBbuf_len\fR bytes are written, truncating the result if necessary.
190 The total amount of space required is returned. If \fBno_name\fR is 0 then
191 if the object has a long or short name then that will be used, otherwise
192 the numerical form will be used. If \fBno_name\fR is 1 then the numerical
193 form will always be used.
194 .PP
195 \&\fIOBJ_cmp()\fR compares \fBa\fR to \fBb\fR. If the two are identical 0 is returned.
196 .PP
197 \&\fIOBJ_dup()\fR returns a copy of \fBo\fR.
198 .PP
199 \&\fIOBJ_create()\fR adds a new object to the internal table. \fBoid\fR is the 
200 numerical form of the object, \fBsn\fR the short name and \fBln\fR the
201 long name. A new \s-1NID\s0 is returned for the created object.
202 .PP
203 \&\fIOBJ_cleanup()\fR cleans up OpenSSLs internal object table: this should
204 be called before an application exits if any new objects were added
205 using \fIOBJ_create()\fR.
206 .SH "NOTES"
207 .IX Header "NOTES"
208 Objects in OpenSSL can have a short name, a long name and a numerical
209 identifier (\s-1NID\s0) associated with them. A standard set of objects is
210 represented in an internal table. The appropriate values are defined
211 in the header file \fBobjects.h\fR.
212 .PP
213 For example the \s-1OID\s0 for commonName has the following definitions:
214 .PP
215 .Vb 3
216 \& #define SN_commonName                   "CN"
217 \& #define LN_commonName                   "commonName"
218 \& #define NID_commonName                  13
219 .Ve
220 .PP
221 New objects can be added by calling \fIOBJ_create()\fR.
222 .PP
223 Table objects have certain advantages over other objects: for example
224 their NIDs can be used in a C language switch statement. They are
225 also static constant structures which are shared: that is there
226 is only a single constant structure for each table object.
227 .PP
228 Objects which are not in the table have the \s-1NID\s0 value NID_undef.
229 .PP
230 Objects do not need to be in the internal tables to be processed,
231 the functions \fIOBJ_txt2obj()\fR and \fIOBJ_obj2txt()\fR can process the numerical
232 form of an \s-1OID\s0.
233 .SH "EXAMPLES"
234 .IX Header "EXAMPLES"
235 Create an object for \fBcommonName\fR:
236 .PP
237 .Vb 2
238 \& ASN1_OBJECT *o;
239 \& o = OBJ_nid2obj(NID_commonName);
240 .Ve
241 .PP
242 Check if an object is \fBcommonName\fR
243 .PP
244 .Vb 2
245 \& if (OBJ_obj2nid(obj) == NID_commonName)
246 \&        /* Do something */
247 .Ve
248 .PP
249 Create a new \s-1NID\s0 and initialize an object from it:
250 .PP
251 .Vb 3
252 \& int new_nid;
253 \& ASN1_OBJECT *obj;
254 \& new_nid = OBJ_create("1.2.3.4", "NewOID", "New Object Identifier");
255 \&
256 \& obj = OBJ_nid2obj(new_nid);
257 .Ve
258 .PP
259 Create a new object directly:
260 .PP
261 .Vb 1
262 \& obj = OBJ_txt2obj("1.2.3.4", 1);
263 .Ve
264 .SH "BUGS"
265 .IX Header "BUGS"
266 \&\fIOBJ_obj2txt()\fR is awkward and messy to use: it doesn't follow the 
267 convention of other OpenSSL functions where the buffer can be set
268 to \fB\s-1NULL\s0\fR to determine the amount of data that should be written.
269 Instead \fBbuf\fR must point to a valid buffer and \fBbuf_len\fR should
270 be set to a positive value. A buffer length of 80 should be more
271 than enough to handle any \s-1OID\s0 encountered in practice.
272 .SH "RETURN VALUES"
273 .IX Header "RETURN VALUES"
274 \&\fIOBJ_nid2obj()\fR returns an \fB\s-1ASN1_OBJECT\s0\fR structure or \fB\s-1NULL\s0\fR is an
275 error occurred.
276 .PP
277 \&\fIOBJ_nid2ln()\fR and \fIOBJ_nid2sn()\fR returns a valid string or \fB\s-1NULL\s0\fR
278 on error.
279 .PP
280 \&\fIOBJ_obj2nid()\fR, \fIOBJ_ln2nid()\fR, \fIOBJ_sn2nid()\fR and \fIOBJ_txt2nid()\fR return
281 a \s-1NID\s0 or \fBNID_undef\fR on error.
282 .SH "SEE ALSO"
283 .IX Header "SEE ALSO"
284 \&\fIERR_get_error\fR\|(3)
285 .SH "HISTORY"
286 .IX Header "HISTORY"
287 \&\s-1TBA\s0