secure/lib/libcrypto/man/man3/OBJ_nid2obj.3

   1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
   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 .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 "2022-05-03" "1.1.1o" "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 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
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/objects.h>
 147 \&
 148 \& ASN1_OBJECT *OBJ_nid2obj(int n);
 149 \& const char *OBJ_nid2ln(int n);
 150 \& const char *OBJ_nid2sn(int n);
 151 \&
 152 \& int OBJ_obj2nid(const ASN1_OBJECT *o);
 153 \& int OBJ_ln2nid(const char *ln);
 154 \& int OBJ_sn2nid(const char *sn);
 155 \&
 156 \& int OBJ_txt2nid(const char *s);
 157 \&
 158 \& ASN1_OBJECT *OBJ_txt2obj(const char *s, int no_name);
 159 \& int OBJ_obj2txt(char *buf, int buf_len, const ASN1_OBJECT *a, int no_name);
 160 \&
 161 \& int i2t_ASN1_OBJECT(char *buf, int buf_len, const ASN1_OBJECT *a);
 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 \&
 168 \& size_t OBJ_length(const ASN1_OBJECT *obj);
 169 \& const unsigned char *OBJ_get0_data(const ASN1_OBJECT *obj);
 170 .Ve
 171 .PP
 172 Deprecated:
 173 .PP
 174 .Vb 3
 175 \& #if OPENSSL_API_COMPAT < 0x10100000L
 176 \& void OBJ_cleanup(void)
 177 \& #endif
 178 .Ve
 179 .SH "DESCRIPTION"
 180 .IX Header "DESCRIPTION"
 181 The \s-1ASN1\s0 object utility functions process \s-1ASN1_OBJECT\s0 structures which are
 182 a representation of the \s-1ASN1 OBJECT IDENTIFIER\s0 (\s-1OID\s0) type.
 183 For convenience, OIDs are usually represented in source code as numeric
 184 identifiers, or \fI\s-1NID\s0\fRs.  OpenSSL has an internal table of OIDs that
 185 are generated when the library is built, and their corresponding NIDs
 186 are available as defined constants.  For the functions below, application
 187 code should treat all returned values \*(-- OIDs, NIDs, or names \*(-- as
 188 constants.
 189 .PP
 190 \&\fBOBJ_nid2obj()\fR, \fBOBJ_nid2ln()\fR and \fBOBJ_nid2sn()\fR convert the \s-1NID\s0 \fIn\fR to
 191 an \s-1ASN1_OBJECT\s0 structure, its long name and its short name respectively,
 192 or \fB\s-1NULL\s0\fR if an error occurred.
 193 .PP
 194 \&\fBOBJ_obj2nid()\fR, \fBOBJ_ln2nid()\fR, \fBOBJ_sn2nid()\fR return the corresponding \s-1NID\s0
 195 for the object \fIo\fR, the long name <ln> or the short name <sn> respectively
 196 or NID_undef if an error occurred.
 197 .PP
 198 \&\fBOBJ_txt2nid()\fR returns \s-1NID\s0 corresponding to text string \fIs\fR. \fIs\fR can be
 199 a long name, a short name or the numerical representation of an object.
 200 .PP
 201 \&\fBOBJ_txt2obj()\fR converts the text string \fIs\fR into an \s-1ASN1_OBJECT\s0 structure.
 202 If \fIno_name\fR is 0 then long names and short names will be interpreted
 203 as well as numerical forms. If \fIno_name\fR is 1 only the numerical form
 204 is acceptable.
 205 .PP
 206 \&\fBOBJ_obj2txt()\fR converts the \fB\s-1ASN1_OBJECT\s0\fR \fIa\fR into a textual representation.
 207 Unless \fIbuf\fR is \s-1NULL,\s0
 208 the representation is written as a NUL-terminated string to \fIbuf\fR, where
 209 at most \fIbuf_len\fR bytes are written, truncating the result if necessary.
 210 In any case it returns the total string length, excluding the \s-1NUL\s0 character,
 211 required for non-truncated representation, or \-1 on error.
 212 If \fIno_name\fR is 0 then if the object has a long or short name
 213 then that will be used, otherwise the numerical form will be used.
 214 If \fIno_name\fR is 1 then the numerical form will always be used.
 215 .PP
 216 \&\fBi2t_ASN1_OBJECT()\fR is the same as \fBOBJ_obj2txt()\fR with the \fIno_name\fR set to zero.
 217 .PP
 218 \&\fBOBJ_cmp()\fR compares \fIa\fR to \fIb\fR. If the two are identical 0 is returned.
 219 .PP
 220 \&\fBOBJ_dup()\fR returns a copy of \fIo\fR.
 221 .PP
 222 \&\fBOBJ_create()\fR adds a new object to the internal table. \fIoid\fR is the
 223 numerical form of the object, \fIsn\fR the short name and \fIln\fR the
 224 long name. A new \s-1NID\s0 is returned for the created object in case of
 225 success and NID_undef in case of failure.
 226 .PP
 227 \&\fBOBJ_length()\fR returns the size of the content octets of \fIobj\fR.
 228 .PP
 229 \&\fBOBJ_get0_data()\fR returns a pointer to the content octets of \fIobj\fR.
 230 The returned pointer is an internal pointer which \fBmust not\fR be freed.
 231 .PP
 232 \&\fBOBJ_cleanup()\fR releases any resources allocated by creating new objects.
 233 .SH "NOTES"
 234 .IX Header "NOTES"
 235 Objects in OpenSSL can have a short name, a long name and a numerical
 236 identifier (\s-1NID\s0) associated with them. A standard set of objects is
 237 represented in an internal table. The appropriate values are defined
 238 in the header file \fBobjects.h\fR.
 239 .PP
 240 For example the \s-1OID\s0 for commonName has the following definitions:
 241 .PP
 242 .Vb 3
 243 \& #define SN_commonName                   "CN"
 244 \& #define LN_commonName                   "commonName"
 245 \& #define NID_commonName                  13
 246 .Ve
 247 .PP
 248 New objects can be added by calling \fBOBJ_create()\fR.
 249 .PP
 250 Table objects have certain advantages over other objects: for example
 251 their NIDs can be used in a C language switch statement. They are
 252 also static constant structures which are shared: that is there
 253 is only a single constant structure for each table object.
 254 .PP
 255 Objects which are not in the table have the \s-1NID\s0 value NID_undef.
 256 .PP
 257 Objects do not need to be in the internal tables to be processed,
 258 the functions \fBOBJ_txt2obj()\fR and \fBOBJ_obj2txt()\fR can process the numerical
 259 form of an \s-1OID.\s0
 260 .PP
 261 Some objects are used to represent algorithms which do not have a
 262 corresponding \s-1ASN.1 OBJECT IDENTIFIER\s0 encoding (for example no \s-1OID\s0 currently
 263 exists for a particular algorithm). As a result they \fBcannot\fR be encoded or
 264 decoded as part of \s-1ASN.1\s0 structures. Applications can determine if there
 265 is a corresponding \s-1OBJECT IDENTIFIER\s0 by checking \fBOBJ_length()\fR is not zero.
 266 .PP
 267 These functions cannot return \fBconst\fR because an \fB\s-1ASN1_OBJECT\s0\fR can
 268 represent both an internal, constant, \s-1OID\s0 and a dynamically-created one.
 269 The latter cannot be constant because it needs to be freed after use.
 270 .SH "RETURN VALUES"
 271 .IX Header "RETURN VALUES"
 272 \&\fBOBJ_nid2obj()\fR returns an \fB\s-1ASN1_OBJECT\s0\fR structure or \fB\s-1NULL\s0\fR is an
 273 error occurred.
 274 .PP
 275 \&\fBOBJ_nid2ln()\fR and \fBOBJ_nid2sn()\fR returns a valid string or \fB\s-1NULL\s0\fR
 276 on error.
 277 .PP
 278 \&\fBOBJ_obj2nid()\fR, \fBOBJ_ln2nid()\fR, \fBOBJ_sn2nid()\fR and \fBOBJ_txt2nid()\fR return
 279 a \s-1NID\s0 or \fBNID_undef\fR on error.
 280 .PP
 281 \&\fBOBJ_add_sigid()\fR returns 1 on success or 0 on error.
 282 .PP
 283 \&\fBi2t_ASN1_OBJECT()\fR an \fBOBJ_obj2txt()\fR return \-1 on error.
 284 On success, they return the length of the string written to \fIbuf\fR if \fIbuf\fR is
 285 not \s-1NULL\s0 and \fIbuf_len\fR is big enough, otherwise the total string length.
 286 Note that this does not count the trailing \s-1NUL\s0 character.
 287 .SH "EXAMPLES"
 288 .IX Header "EXAMPLES"
 289 Create an object for \fBcommonName\fR:
 290 .PP
 291 .Vb 1
 292 \& ASN1_OBJECT *o = OBJ_nid2obj(NID_commonName);
 293 .Ve
 294 .PP
 295 Check if an object is \fBcommonName\fR
 296 .PP
 297 .Vb 2
 298 \& if (OBJ_obj2nid(obj) == NID_commonName)
 299 \&     /* Do something */
 300 .Ve
 301 .PP
 302 Create a new \s-1NID\s0 and initialize an object from it:
 303 .PP
 304 .Vb 2
 305 \& int new_nid = OBJ_create("1.2.3.4", "NewOID", "New Object Identifier");
 306 \& ASN1_OBJECT *obj = OBJ_nid2obj(new_nid);
 307 .Ve
 308 .PP
 309 Create a new object directly:
 310 .PP
 311 .Vb 1
 312 \& obj = OBJ_txt2obj("1.2.3.4", 1);
 313 .Ve
 314 .SH "SEE ALSO"
 315 .IX Header "SEE ALSO"
 316 \&\fBERR_get_error\fR\|(3)
 317 .SH "HISTORY"
 318 .IX Header "HISTORY"
 319 \&\fBOBJ_cleanup()\fR was deprecated in OpenSSL 1.1.0 by \fBOPENSSL_init_crypto\fR\|(3)
 320 and should not be used.
 321 .SH "COPYRIGHT"
 322 .IX Header "COPYRIGHT"
 323 Copyright 2002\-2022 The OpenSSL Project Authors. All Rights Reserved.
 324 .PP
 325 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 326 this file except in compliance with the License.  You can obtain a copy
 327 in the file \s-1LICENSE\s0 in the source distribution or at
 328 <https://www.openssl.org/source/license.html>.