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