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