secure/lib/libcrypto/man/OBJ_nid2obj.3

   1 .\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
   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 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  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.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{
  60 .    if \nF \{
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  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
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  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'
 105 .\}
 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 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "OBJ_nid2obj 3"
 136 .TH OBJ_nid2obj 3 "2016-09-22" "1.0.2i" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 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
 144 functions
 145 .SH "SYNOPSIS"
 146 .IX Header "SYNOPSIS"
 147 .Vb 1
 148 \& #include <openssl/objects.h>
 149 \&
 150 \& ASN1_OBJECT * OBJ_nid2obj(int n);
 151 \& const char *  OBJ_nid2ln(int n);
 152 \& const char *  OBJ_nid2sn(int n);
 153 \&
 154 \& int OBJ_obj2nid(const ASN1_OBJECT *o);
 155 \& int OBJ_ln2nid(const char *ln);
 156 \& int OBJ_sn2nid(const char *sn);
 157 \&
 158 \& int OBJ_txt2nid(const char *s);
 159 \&
 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);
 162 \&
 163 \& int OBJ_cmp(const ASN1_OBJECT *a,const ASN1_OBJECT *b);
 164 \& ASN1_OBJECT * OBJ_dup(const ASN1_OBJECT *o);
 165 \&
 166 \& int OBJ_create(const char *oid,const char *sn,const char *ln);
 167 \& void OBJ_cleanup(void);
 168 .Ve
 169 .SH "DESCRIPTION"
 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.
 173 For convenience, OIDs are usually represented in source code as numeric
 174 identifiers, or \fB\s-1NID\s0\fRs.  OpenSSL has an internal table of OIDs that
 175 are generated when the library is built, and their corresponding NIDs
 176 are available as defined constants.  For the functions below, application
 177 code should treat all returned values \*(-- OIDs, NIDs, or names \*(-- as
 178 constants.
 179 .PP
 180 \&\fIOBJ_nid2obj()\fR, \fIOBJ_nid2ln()\fR and \fIOBJ_nid2sn()\fR convert the \s-1NID \s0\fBn\fR to
 181 an \s-1ASN1_OBJECT\s0 structure, its long name and its short name respectively,
 182 or \fB\s-1NULL\s0\fR is an error occurred.
 183 .PP
 184 \&\fIOBJ_obj2nid()\fR, \fIOBJ_ln2nid()\fR, \fIOBJ_sn2nid()\fR return the corresponding \s-1NID\s0
 185 for the object \fBo\fR, the long name <ln> or the short name <sn> respectively
 186 or NID_undef if an error occurred.
 187 .PP
 188 \&\fIOBJ_txt2nid()\fR returns \s-1NID\s0 corresponding to text string <s>. \fBs\fR can be
 189 a long name, a short name or the numerical respresentation of an object.
 190 .PP
 191 \&\fIOBJ_txt2obj()\fR converts the text string \fBs\fR into an \s-1ASN1_OBJECT\s0 structure.
 192 If \fBno_name\fR is 0 then long names and short names will be interpreted
 193 as well as numerical forms. If \fBno_name\fR is 1 only the numerical form
 194 is acceptable.
 195 .PP
 196 \&\fIOBJ_obj2txt()\fR converts the \fB\s-1ASN1_OBJECT\s0\fR \fBa\fR into a textual representation.
 197 The representation is written as a null terminated string to \fBbuf\fR
 198 at most \fBbuf_len\fR bytes are written, truncating the result if necessary.
 199 The total amount of space required is returned. If \fBno_name\fR is 0 then
 200 if the object has a long or short name then that will be used, otherwise
 201 the numerical form will be used. If \fBno_name\fR is 1 then the numerical
 202 form will always be used.
 203 .PP
 204 \&\fIOBJ_cmp()\fR compares \fBa\fR to \fBb\fR. If the two are identical 0 is returned.
 205 .PP
 206 \&\fIOBJ_dup()\fR returns a copy of \fBo\fR.
 207 .PP
 208 \&\fIOBJ_create()\fR adds a new object to the internal table. \fBoid\fR is the
 209 numerical form of the object, \fBsn\fR the short name and \fBln\fR the
 210 long name. A new \s-1NID\s0 is returned for the created object.
 211 .PP
 212 \&\fIOBJ_cleanup()\fR cleans up OpenSSLs internal object table: this should
 213 be called before an application exits if any new objects were added
 214 using \fIOBJ_create()\fR.
 215 .SH "NOTES"
 216 .IX Header "NOTES"
 217 Objects in OpenSSL can have a short name, a long name and a numerical
 218 identifier (\s-1NID\s0) associated with them. A standard set of objects is
 219 represented in an internal table. The appropriate values are defined
 220 in the header file \fBobjects.h\fR.
 221 .PP
 222 For example the \s-1OID\s0 for commonName has the following definitions:
 223 .PP
 224 .Vb 3
 225 \& #define SN_commonName                   "CN"
 226 \& #define LN_commonName                   "commonName"
 227 \& #define NID_commonName                  13
 228 .Ve
 229 .PP
 230 New objects can be added by calling \fIOBJ_create()\fR.
 231 .PP
 232 Table objects have certain advantages over other objects: for example
 233 their NIDs can be used in a C language switch statement. They are
 234 also static constant structures which are shared: that is there
 235 is only a single constant structure for each table object.
 236 .PP
 237 Objects which are not in the table have the \s-1NID\s0 value NID_undef.
 238 .PP
 239 Objects do not need to be in the internal tables to be processed,
 240 the functions \fIOBJ_txt2obj()\fR and \fIOBJ_obj2txt()\fR can process the numerical
 241 form of an \s-1OID.\s0
 242 .PP
 243 Some objects are used to represent algorithms which do not have a
 244 corresponding \s-1ASN.1 OBJECT IDENTIFIER\s0 encoding (for example no \s-1OID\s0 currently
 245 exists for a particular algorithm). As a result they \fBcannot\fR be encoded or
 246 decoded as part of \s-1ASN.1\s0 structures. Applications can determine if there
 247 is a corresponding \s-1OBJECT IDENTIFIER\s0 by checking \fIOBJ_length()\fR is not zero.
 248 .PP
 249 These functions cannot return \fBconst\fR because an \fB\s-1ASN1_OBJECT\s0\fR can
 250 represent both an internal, constant, \s-1OID\s0 and a dynamically-created one.
 251 The latter cannot be constant because it needs to be freed after use.
 252 .SH "EXAMPLES"
 253 .IX Header "EXAMPLES"
 254 Create an object for \fBcommonName\fR:
 255 .PP
 256 .Vb 2
 257 \& ASN1_OBJECT *o;
 258 \& o = OBJ_nid2obj(NID_commonName);
 259 .Ve
 260 .PP
 261 Check if an object is \fBcommonName\fR
 262 .PP
 263 .Vb 2
 264 \& if (OBJ_obj2nid(obj) == NID_commonName)
 265 \&        /* Do something */
 266 .Ve
 267 .PP
 268 Create a new \s-1NID\s0 and initialize an object from it:
 269 .PP
 270 .Vb 2
 271 \& int new_nid;
 272 \& ASN1_OBJECT *obj;
 273 \&
 274 \& new_nid = OBJ_create("1.2.3.4", "NewOID", "New Object Identifier");
 275 \&
 276 \& obj = OBJ_nid2obj(new_nid);
 277 .Ve
 278 .PP
 279 Create a new object directly:
 280 .PP
 281 .Vb 1
 282 \& obj = OBJ_txt2obj("1.2.3.4", 1);
 283 .Ve
 284 .SH "BUGS"
 285 .IX Header "BUGS"
 286 \&\fIOBJ_obj2txt()\fR is awkward and messy to use: it doesn't follow the
 287 convention of other OpenSSL functions where the buffer can be set
 288 to \fB\s-1NULL\s0\fR to determine the amount of data that should be written.
 289 Instead \fBbuf\fR must point to a valid buffer and \fBbuf_len\fR should
 290 be set to a positive value. A buffer length of 80 should be more
 291 than enough to handle any \s-1OID\s0 encountered in practice.
 292 .SH "RETURN VALUES"
 293 .IX Header "RETURN VALUES"
 294 \&\fIOBJ_nid2obj()\fR returns an \fB\s-1ASN1_OBJECT\s0\fR structure or \fB\s-1NULL\s0\fR is an
 295 error occurred.
 296 It returns a pointer to an internal table and does not
 297 allocate memory; \fIASN1_OBJECT_free()\fR will have no effect.
 298 .PP
 299 \&\fIOBJ_nid2ln()\fR and \fIOBJ_nid2sn()\fR returns a valid string or \fB\s-1NULL\s0\fR
 300 on error.
 301 .PP
 302 \&\fIOBJ_obj2nid()\fR, \fIOBJ_ln2nid()\fR, \fIOBJ_sn2nid()\fR and \fIOBJ_txt2nid()\fR return
 303 a \s-1NID\s0 or \fBNID_undef\fR on error.
 304 .SH "SEE ALSO"
 305 .IX Header "SEE ALSO"
 306 \&\fIERR_get_error\fR\|(3)
 307 .SH "HISTORY"
 308 .IX Header "HISTORY"
 309 \&\s-1TBA\s0