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