secure/lib/libcrypto/man/OBJ_nid2obj.3

   1 .\" Automatically generated by Pod::Man 2.12 (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 .\" 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"
  58 ..
  59 .    nr % 0
  60 .    rr F
  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 "2007-10-24" "0.9.8g" "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 3
 139 \& ASN1_OBJECT * OBJ_nid2obj(int n);
 140 \& const char *  OBJ_nid2ln(int n);
 141 \& const char *  OBJ_nid2sn(int n);
 142 \&
 143 \& int OBJ_obj2nid(const ASN1_OBJECT *o);
 144 \& int OBJ_ln2nid(const char *ln);
 145 \& int OBJ_sn2nid(const char *sn);
 146 \&
 147 \& int OBJ_txt2nid(const char *s);
 148 \&
 149 \& ASN1_OBJECT * OBJ_txt2obj(const char *s, int no_name);
 150 \& int OBJ_obj2txt(char *buf, int buf_len, const ASN1_OBJECT *a, int no_name);
 151 \&
 152 \& int OBJ_cmp(const ASN1_OBJECT *a,const ASN1_OBJECT *b);
 153 \& ASN1_OBJECT * OBJ_dup(const ASN1_OBJECT *o);
 154 \&
 155 \& int OBJ_create(const char *oid,const char *sn,const char *ln);
 156 \& void OBJ_cleanup(void);
 157 .Ve
 158 .SH "DESCRIPTION"
 159 .IX Header "DESCRIPTION"
 160 The \s-1ASN1\s0 object utility functions process \s-1ASN1_OBJECT\s0 structures which are
 161 a representation of the \s-1ASN1\s0 \s-1OBJECT\s0 \s-1IDENTIFIER\s0 (\s-1OID\s0) type.
 162 .PP
 163 \&\fIOBJ_nid2obj()\fR, \fIOBJ_nid2ln()\fR and \fIOBJ_nid2sn()\fR convert the \s-1NID\s0 \fBn\fR to
 164 an \s-1ASN1_OBJECT\s0 structure, its long name and its short name respectively,
 165 or \fB\s-1NULL\s0\fR is an error occurred.
 166 .PP
 167 \&\fIOBJ_obj2nid()\fR, \fIOBJ_ln2nid()\fR, \fIOBJ_sn2nid()\fR return the corresponding \s-1NID\s0
 168 for the object \fBo\fR, the long name <ln> or the short name <sn> respectively
 169 or NID_undef if an error occurred.
 170 .PP
 171 \&\fIOBJ_txt2nid()\fR returns \s-1NID\s0 corresponding to text string <s>. \fBs\fR can be
 172 a long name, a short name or the numerical respresentation of an object.
 173 .PP
 174 \&\fIOBJ_txt2obj()\fR converts the text string \fBs\fR into an \s-1ASN1_OBJECT\s0 structure.
 175 If \fBno_name\fR is 0 then long names and short names will be interpreted
 176 as well as numerical forms. If \fBno_name\fR is 1 only the numerical form
 177 is acceptable.
 178 .PP
 179 \&\fIOBJ_obj2txt()\fR converts the \fB\s-1ASN1_OBJECT\s0\fR \fBa\fR into a textual representation.
 180 The representation is written as a null terminated string to \fBbuf\fR
 181 at most \fBbuf_len\fR bytes are written, truncating the result if necessary.
 182 The total amount of space required is returned. If \fBno_name\fR is 0 then
 183 if the object has a long or short name then that will be used, otherwise
 184 the numerical form will be used. If \fBno_name\fR is 1 then the numerical
 185 form will always be used.
 186 .PP
 187 \&\fIOBJ_cmp()\fR compares \fBa\fR to \fBb\fR. If the two are identical 0 is returned.
 188 .PP
 189 \&\fIOBJ_dup()\fR returns a copy of \fBo\fR.
 190 .PP
 191 \&\fIOBJ_create()\fR adds a new object to the internal table. \fBoid\fR is the
 192 numerical form of the object, \fBsn\fR the short name and \fBln\fR the
 193 long name. A new \s-1NID\s0 is returned for the created object.
 194 .PP
 195 \&\fIOBJ_cleanup()\fR cleans up OpenSSLs internal object table: this should
 196 be called before an application exits if any new objects were added
 197 using \fIOBJ_create()\fR.
 198 .SH "NOTES"
 199 .IX Header "NOTES"
 200 Objects in OpenSSL can have a short name, a long name and a numerical
 201 identifier (\s-1NID\s0) associated with them. A standard set of objects is
 202 represented in an internal table. The appropriate values are defined
 203 in the header file \fBobjects.h\fR.
 204 .PP
 205 For example the \s-1OID\s0 for commonName has the following definitions:
 206 .PP
 207 .Vb 3
 208 \& #define SN_commonName                   "CN"
 209 \& #define LN_commonName                   "commonName"
 210 \& #define NID_commonName                  13
 211 .Ve
 212 .PP
 213 New objects can be added by calling \fIOBJ_create()\fR.
 214 .PP
 215 Table objects have certain advantages over other objects: for example
 216 their NIDs can be used in a C language switch statement. They are
 217 also static constant structures which are shared: that is there
 218 is only a single constant structure for each table object.
 219 .PP
 220 Objects which are not in the table have the \s-1NID\s0 value NID_undef.
 221 .PP
 222 Objects do not need to be in the internal tables to be processed,
 223 the functions \fIOBJ_txt2obj()\fR and \fIOBJ_obj2txt()\fR can process the numerical
 224 form of an \s-1OID\s0.
 225 .SH "EXAMPLES"
 226 .IX Header "EXAMPLES"
 227 Create an object for \fBcommonName\fR:
 228 .PP
 229 .Vb 2
 230 \& ASN1_OBJECT *o;
 231 \& o = OBJ_nid2obj(NID_commonName);
 232 .Ve
 233 .PP
 234 Check if an object is \fBcommonName\fR
 235 .PP
 236 .Vb 2
 237 \& if (OBJ_obj2nid(obj) == NID_commonName)
 238 \&        /* Do something */
 239 .Ve
 240 .PP
 241 Create a new \s-1NID\s0 and initialize an object from it:
 242 .PP
 243 .Vb 3
 244 \& int new_nid;
 245 \& ASN1_OBJECT *obj;
 246 \& new_nid = OBJ_create("1.2.3.4", "NewOID", "New Object Identifier");
 247 \&
 248 \& obj = OBJ_nid2obj(new_nid);
 249 .Ve
 250 .PP
 251 Create a new object directly:
 252 .PP
 253 .Vb 1
 254 \& obj = OBJ_txt2obj("1.2.3.4", 1);
 255 .Ve
 256 .SH "BUGS"
 257 .IX Header "BUGS"
 258 \&\fIOBJ_obj2txt()\fR is awkward and messy to use: it doesn't follow the
 259 convention of other OpenSSL functions where the buffer can be set
 260 to \fB\s-1NULL\s0\fR to determine the amount of data that should be written.
 261 Instead \fBbuf\fR must point to a valid buffer and \fBbuf_len\fR should
 262 be set to a positive value. A buffer length of 80 should be more
 263 than enough to handle any \s-1OID\s0 encountered in practice.
 264 .SH "RETURN VALUES"
 265 .IX Header "RETURN VALUES"
 266 \&\fIOBJ_nid2obj()\fR returns an \fB\s-1ASN1_OBJECT\s0\fR structure or \fB\s-1NULL\s0\fR is an
 267 error occurred.
 268 .PP
 269 \&\fIOBJ_nid2ln()\fR and \fIOBJ_nid2sn()\fR returns a valid string or \fB\s-1NULL\s0\fR
 270 on error.
 271 .PP
 272 \&\fIOBJ_obj2nid()\fR, \fIOBJ_ln2nid()\fR, \fIOBJ_sn2nid()\fR and \fIOBJ_txt2nid()\fR return
 273 a \s-1NID\s0 or \fBNID_undef\fR on error.
 274 .SH "SEE ALSO"
 275 .IX Header "SEE ALSO"
 276 \&\fIERR_get_error\fR\|(3)
 277 .SH "HISTORY"
 278 .IX Header "HISTORY"
 279 \&\s-1TBA\s0