secure/lib/libcrypto/man/OBJ_nid2obj.3

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   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 >0, 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 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  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
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  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'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 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
 112 .    \" corrections for vroff
 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'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 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
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "OBJ_NID2OBJ 3"
 132 .TH OBJ_NID2OBJ 3 "2018-09-11" "1.1.1" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 i2t_ASN1_OBJECT, OBJ_length, OBJ_get0_data, OBJ_nid2obj, OBJ_nid2ln, OBJ_nid2sn, OBJ_obj2nid, OBJ_txt2nid, OBJ_ln2nid, OBJ_sn2nid, OBJ_cmp, OBJ_dup, OBJ_txt2obj, OBJ_obj2txt, OBJ_create, OBJ_cleanup \&\- ASN1 object utility functions
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/objects.h>
 143 \&
 144 \& ASN1_OBJECT *OBJ_nid2obj(int n);
 145 \& const char *OBJ_nid2ln(int n);
 146 \& const char *OBJ_nid2sn(int n);
 147 \&
 148 \& int OBJ_obj2nid(const ASN1_OBJECT *o);
 149 \& int OBJ_ln2nid(const char *ln);
 150 \& int OBJ_sn2nid(const char *sn);
 151 \&
 152 \& int OBJ_txt2nid(const char *s);
 153 \&
 154 \& ASN1_OBJECT *OBJ_txt2obj(const char *s, int no_name);
 155 \& int OBJ_obj2txt(char *buf, int buf_len, const ASN1_OBJECT *a, int no_name);
 156 \&
 157 \& int i2t_ASN1_OBJECT(char *buf, int buf_len, const ASN1_OBJECT *a);
 158 \&
 159 \& int OBJ_cmp(const ASN1_OBJECT *a, const ASN1_OBJECT *b);
 160 \& ASN1_OBJECT *OBJ_dup(const ASN1_OBJECT *o);
 161 \&
 162 \& int OBJ_create(const char *oid, const char *sn, const char *ln);
 163 \&
 164 \& size_t OBJ_length(const ASN1_OBJECT *obj);
 165 \& const unsigned char *OBJ_get0_data(const ASN1_OBJECT *obj);
 166 .Ve
 167 .PP
 168 Deprecated:
 169 .PP
 170 .Vb 3
 171 \& #if OPENSSL_API_COMPAT < 0x10100000L
 172 \& void OBJ_cleanup(void)
 173 \& #endif
 174 .Ve
 175 .SH "DESCRIPTION"
 176 .IX Header "DESCRIPTION"
 177 The \s-1ASN1\s0 object utility functions process \s-1ASN1_OBJECT\s0 structures which are
 178 a representation of the \s-1ASN1 OBJECT IDENTIFIER\s0 (\s-1OID\s0) type.
 179 For convenience, OIDs are usually represented in source code as numeric
 180 identifiers, or \fB\s-1NID\s0\fRs.  OpenSSL has an internal table of OIDs that
 181 are generated when the library is built, and their corresponding NIDs
 182 are available as defined constants.  For the functions below, application
 183 code should treat all returned values \*(-- OIDs, NIDs, or names \*(-- as
 184 constants.
 185 .PP
 186 \&\fIOBJ_nid2obj()\fR, \fIOBJ_nid2ln()\fR and \fIOBJ_nid2sn()\fR convert the \s-1NID\s0 \fBn\fR to
 187 an \s-1ASN1_OBJECT\s0 structure, its long name and its short name respectively,
 188 or \fB\s-1NULL\s0\fR if an error occurred.
 189 .PP
 190 \&\fIOBJ_obj2nid()\fR, \fIOBJ_ln2nid()\fR, \fIOBJ_sn2nid()\fR return the corresponding \s-1NID\s0
 191 for the object \fBo\fR, the long name <ln> or the short name <sn> respectively
 192 or NID_undef if an error occurred.
 193 .PP
 194 \&\fIOBJ_txt2nid()\fR returns \s-1NID\s0 corresponding to text string <s>. \fBs\fR can be
 195 a long name, a short name or the numerical representation of an object.
 196 .PP
 197 \&\fIOBJ_txt2obj()\fR converts the text string \fBs\fR into an \s-1ASN1_OBJECT\s0 structure.
 198 If \fBno_name\fR is 0 then long names and short names will be interpreted
 199 as well as numerical forms. If \fBno_name\fR is 1 only the numerical form
 200 is acceptable.
 201 .PP
 202 \&\fIOBJ_obj2txt()\fR converts the \fB\s-1ASN1_OBJECT\s0\fR \fBa\fR into a textual representation.
 203 The representation is written as a null terminated string to \fBbuf\fR
 204 at most \fBbuf_len\fR bytes are written, truncating the result if necessary.
 205 The total amount of space required is returned. If \fBno_name\fR is 0 then
 206 if the object has a long or short name then that will be used, otherwise
 207 the numerical form will be used. If \fBno_name\fR is 1 then the numerical
 208 form will always be used.
 209 .PP
 210 \&\fIi2t_ASN1_OBJECT()\fR is the same as \fIOBJ_obj2txt()\fR with the \fBno_name\fR set to zero.
 211 .PP
 212 \&\fIOBJ_cmp()\fR compares \fBa\fR to \fBb\fR. If the two are identical 0 is returned.
 213 .PP
 214 \&\fIOBJ_dup()\fR returns a copy of \fBo\fR.
 215 .PP
 216 \&\fIOBJ_create()\fR adds a new object to the internal table. \fBoid\fR is the
 217 numerical form of the object, \fBsn\fR the short name and \fBln\fR the
 218 long name. A new \s-1NID\s0 is returned for the created object in case of
 219 success and NID_undef in case of failure.
 220 .PP
 221 \&\fIOBJ_length()\fR returns the size of the content octets of \fBobj\fR.
 222 .PP
 223 \&\fIOBJ_get0_data()\fR returns a pointer to the content octets of \fBobj\fR.
 224 The returned pointer is an internal pointer which \fBmust not\fR be freed.
 225 .PP
 226 \&\fIOBJ_cleanup()\fR releases any resources allocated by creating new objects.
 227 .SH "NOTES"
 228 .IX Header "NOTES"
 229 Objects in OpenSSL can have a short name, a long name and a numerical
 230 identifier (\s-1NID\s0) associated with them. A standard set of objects is
 231 represented in an internal table. The appropriate values are defined
 232 in the header file \fBobjects.h\fR.
 233 .PP
 234 For example the \s-1OID\s0 for commonName has the following definitions:
 235 .PP
 236 .Vb 3
 237 \& #define SN_commonName                   "CN"
 238 \& #define LN_commonName                   "commonName"
 239 \& #define NID_commonName                  13
 240 .Ve
 241 .PP
 242 New objects can be added by calling \fIOBJ_create()\fR.
 243 .PP
 244 Table objects have certain advantages over other objects: for example
 245 their NIDs can be used in a C language switch statement. They are
 246 also static constant structures which are shared: that is there
 247 is only a single constant structure for each table object.
 248 .PP
 249 Objects which are not in the table have the \s-1NID\s0 value NID_undef.
 250 .PP
 251 Objects do not need to be in the internal tables to be processed,
 252 the functions \fIOBJ_txt2obj()\fR and \fIOBJ_obj2txt()\fR can process the numerical
 253 form of an \s-1OID.\s0
 254 .PP
 255 Some objects are used to represent algorithms which do not have a
 256 corresponding \s-1ASN.1 OBJECT IDENTIFIER\s0 encoding (for example no \s-1OID\s0 currently
 257 exists for a particular algorithm). As a result they \fBcannot\fR be encoded or
 258 decoded as part of \s-1ASN.1\s0 structures. Applications can determine if there
 259 is a corresponding \s-1OBJECT IDENTIFIER\s0 by checking \fIOBJ_length()\fR is not zero.
 260 .PP
 261 These functions cannot return \fBconst\fR because an \fB\s-1ASN1_OBJECT\s0\fR can
 262 represent both an internal, constant, \s-1OID\s0 and a dynamically-created one.
 263 The latter cannot be constant because it needs to be freed after use.
 264 .SH "EXAMPLES"
 265 .IX Header "EXAMPLES"
 266 Create an object for \fBcommonName\fR:
 267 .PP
 268 .Vb 1
 269 \& ASN1_OBJECT *o = OBJ_nid2obj(NID_commonName);
 270 .Ve
 271 .PP
 272 Check if an object is \fBcommonName\fR
 273 .PP
 274 .Vb 2
 275 \& if (OBJ_obj2nid(obj) == NID_commonName)
 276 \&     /* Do something */
 277 .Ve
 278 .PP
 279 Create a new \s-1NID\s0 and initialize an object from it:
 280 .PP
 281 .Vb 2
 282 \& int new_nid = OBJ_create("1.2.3.4", "NewOID", "New Object Identifier");
 283 \& ASN1_OBJECT *obj = OBJ_nid2obj(new_nid);
 284 .Ve
 285 .PP
 286 Create a new object directly:
 287 .PP
 288 .Vb 1
 289 \& obj = OBJ_txt2obj("1.2.3.4", 1);
 290 .Ve
 291 .SH "BUGS"
 292 .IX Header "BUGS"
 293 \&\fIOBJ_obj2txt()\fR is awkward and messy to use: it doesn't follow the
 294 convention of other OpenSSL functions where the buffer can be set
 295 to \fB\s-1NULL\s0\fR to determine the amount of data that should be written.
 296 Instead \fBbuf\fR must point to a valid buffer and \fBbuf_len\fR should
 297 be set to a positive value. A buffer length of 80 should be more
 298 than enough to handle any \s-1OID\s0 encountered in practice.
 299 .SH "RETURN VALUES"
 300 .IX Header "RETURN VALUES"
 301 \&\fIOBJ_nid2obj()\fR returns an \fB\s-1ASN1_OBJECT\s0\fR structure or \fB\s-1NULL\s0\fR is an
 302 error occurred.
 303 .PP
 304 \&\fIOBJ_nid2ln()\fR and \fIOBJ_nid2sn()\fR returns a valid string or \fB\s-1NULL\s0\fR
 305 on error.
 306 .PP
 307 \&\fIOBJ_obj2nid()\fR, \fIOBJ_ln2nid()\fR, \fIOBJ_sn2nid()\fR and \fIOBJ_txt2nid()\fR return
 308 a \s-1NID\s0 or \fBNID_undef\fR on error.
 309 .SH "SEE ALSO"
 310 .IX Header "SEE ALSO"
 311 \&\fIERR_get_error\fR\|(3)
 312 .SH "HISTORY"
 313 .IX Header "HISTORY"
 314 \&\fIOBJ_cleanup()\fR was deprecated in OpenSSL 1.1.0 by \fIOPENSSL_init_crypto\fR\|(3)
 315 and should not be used.
 316 .SH "COPYRIGHT"
 317 .IX Header "COPYRIGHT"
 318 Copyright 2002\-2018 The OpenSSL Project Authors. All Rights Reserved.
 319 .PP
 320 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 321 this file except in compliance with the License.  You can obtain a copy
 322 in the file \s-1LICENSE\s0 in the source distribution or at
 323 <https://www.openssl.org/source/license.html>.