1 .\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.30)
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
9 .de Vb \" Begin verbatim text
14 .de Ve \" End verbatim text
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<>.
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
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
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
49 .\" If the F register is turned on, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD. Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
54 .\" Avoid warning from groff about undefined register 'F'.
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{
62 . tm Index:\\$1\t\\n%\t"\\$2"
72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73 .\" Fear. Run. Save yourself. No user-serviceable parts.
74 . \" fudge factors for nroff and troff
83 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
89 . \" simple accents for nroff and troff
99 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
106 . \" troff and (daisy-wheel) nroff accents
107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114 .ds ae a\h'-(\w'a'u*4/10)'e
115 .ds Ae A\h'-(\w'A'u*4/10)'E
116 . \" corrections for vroff
117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119 . \" for low resolution devices (crt and lpr)
120 .if \n(.H>23 .if \n(.V>19 \
133 .\" ========================================================================
135 .IX Title "OBJ_nid2obj 3"
136 .TH OBJ_nid2obj 3 "2015-03-19" "0.9.8zf" "OpenSSL"
137 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
142 OBJ_nid2obj, OBJ_nid2ln, OBJ_nid2sn, OBJ_obj2nid, OBJ_txt2nid, OBJ_ln2nid, OBJ_sn2nid,
143 OBJ_cmp, OBJ_dup, OBJ_txt2obj, OBJ_obj2txt, OBJ_create, OBJ_cleanup \- ASN1 object utility
146 .IX Header "SYNOPSIS"
148 \& #include <openssl/objects.h>
150 \& ASN1_OBJECT * OBJ_nid2obj(int n);
151 \& const char * OBJ_nid2ln(int n);
152 \& const char * OBJ_nid2sn(int n);
154 \& int OBJ_obj2nid(const ASN1_OBJECT *o);
155 \& int OBJ_ln2nid(const char *ln);
156 \& int OBJ_sn2nid(const char *sn);
158 \& int OBJ_txt2nid(const char *s);
160 \& ASN1_OBJECT * OBJ_txt2obj(const char *s, int no_name);
161 \& int OBJ_obj2txt(char *buf, int buf_len, const ASN1_OBJECT *a, int no_name);
163 \& int OBJ_cmp(const ASN1_OBJECT *a,const ASN1_OBJECT *b);
164 \& ASN1_OBJECT * OBJ_dup(const ASN1_OBJECT *o);
166 \& int OBJ_create(const char *oid,const char *sn,const char *ln);
167 \& void OBJ_cleanup(void);
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 OBJECT IDENTIFIER \s0(\s-1OID\s0) type.
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.
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.
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.
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
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.
198 \&\fIOBJ_cmp()\fR compares \fBa\fR to \fBb\fR. If the two are identical 0 is returned.
200 \&\fIOBJ_dup()\fR returns a copy of \fBo\fR.
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.
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.
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.
216 For example the \s-1OID\s0 for commonName has the following definitions:
219 \& #define SN_commonName "CN"
220 \& #define LN_commonName "commonName"
221 \& #define NID_commonName 13
224 New objects can be added by calling \fIOBJ_create()\fR.
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.
231 Objects which are not in the table have the \s-1NID\s0 value NID_undef.
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
237 .IX Header "EXAMPLES"
238 Create an object for \fBcommonName\fR:
242 \& o = OBJ_nid2obj(NID_commonName);
245 Check if an object is \fBcommonName\fR
248 \& if (OBJ_obj2nid(obj) == NID_commonName)
249 \& /* Do something */
252 Create a new \s-1NID\s0 and initialize an object from it:
257 \& new_nid = OBJ_create("1.2.3.4", "NewOID", "New Object Identifier");
259 \& obj = OBJ_nid2obj(new_nid);
262 Create a new object directly:
265 \& obj = OBJ_txt2obj("1.2.3.4", 1);
269 \&\fIOBJ_obj2txt()\fR is awkward and messy to use: it doesn't follow the
270 convention of other OpenSSL functions where the buffer can be set
271 to \fB\s-1NULL\s0\fR to determine the amount of data that should be written.
272 Instead \fBbuf\fR must point to a valid buffer and \fBbuf_len\fR should
273 be set to a positive value. A buffer length of 80 should be more
274 than enough to handle any \s-1OID\s0 encountered in practice.
276 .IX Header "RETURN VALUES"
277 \&\fIOBJ_nid2obj()\fR returns an \fB\s-1ASN1_OBJECT\s0\fR structure or \fB\s-1NULL\s0\fR is an
280 \&\fIOBJ_nid2ln()\fR and \fIOBJ_nid2sn()\fR returns a valid string or \fB\s-1NULL\s0\fR
283 \&\fIOBJ_obj2nid()\fR, \fIOBJ_ln2nid()\fR, \fIOBJ_sn2nid()\fR and \fIOBJ_txt2nid()\fR return
284 a \s-1NID\s0 or \fBNID_undef\fR on error.
286 .IX Header "SEE ALSO"
287 \&\fIERR_get_error\fR\|(3)