doc/crypto/OBJ_nid2obj.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 OBJ_nid2obj, OBJ_nid2ln, OBJ_nid2sn, OBJ_obj2nid, OBJ_txt2nid, OBJ_ln2nid, OBJ_sn2nid,
   6 OBJ_cmp, OBJ_dup, OBJ_txt2obj, OBJ_obj2txt, OBJ_create, OBJ_cleanup - ASN1 object utility
   7 functions
   8
   9 =head1 SYNOPSIS
  10
  11  #include <openssl/objects.h>
  12
  13  ASN1_OBJECT * OBJ_nid2obj(int n);
  14  const char *  OBJ_nid2ln(int n);
  15  const char *  OBJ_nid2sn(int n);
  16
  17  int OBJ_obj2nid(const ASN1_OBJECT *o);
  18  int OBJ_ln2nid(const char *ln);
  19  int OBJ_sn2nid(const char *sn);
  20
  21  int OBJ_txt2nid(const char *s);
  22
  23  ASN1_OBJECT * OBJ_txt2obj(const char *s, int no_name);
  24  int OBJ_obj2txt(char *buf, int buf_len, const ASN1_OBJECT *a, int no_name);
  25
  26  int OBJ_cmp(const ASN1_OBJECT *a,const ASN1_OBJECT *b);
  27  ASN1_OBJECT * OBJ_dup(const ASN1_OBJECT *o);
  28
  29  int OBJ_create(const char *oid,const char *sn,const char *ln);
  30  void OBJ_cleanup(void);
  31
  32 =head1 DESCRIPTION
  33
  34 The ASN1 object utility functions process ASN1_OBJECT structures which are
  35 a representation of the ASN1 OBJECT IDENTIFIER (OID) type.
  36 For convenience, OID's are usually represented in source code as numeric
  37 identifiers, or B<NID>'s.  OpenSSL has an internal table of OID's that
  38 are generated when the library is built, and their corresponding NID's
  39 are available as define'd constants.  For the functions below, application
  40 code should treat all returned values -- OID's, NID's, or names -- as
  41 constants.
  42
  43 OBJ_nid2obj(), OBJ_nid2ln() and OBJ_nid2sn() convert the NID B<n> to
  44 an ASN1_OBJECT structure, its long name and its short name respectively,
  45 or B<NULL> is an error occurred.
  46
  47 OBJ_obj2nid(), OBJ_ln2nid(), OBJ_sn2nid() return the corresponding NID
  48 for the object B<o>, the long name <ln> or the short name <sn> respectively
  49 or NID_undef if an error occurred.
  50
  51 OBJ_txt2nid() returns NID corresponding to text string <s>. B<s> can be
  52 a long name, a short name or the numerical respresentation of an object.
  53
  54 OBJ_txt2obj() converts the text string B<s> into an ASN1_OBJECT structure.
  55 If B<no_name> is 0 then long names and short names will be interpreted
  56 as well as numerical forms. If B<no_name> is 1 only the numerical form
  57 is acceptable.
  58
  59 OBJ_obj2txt() converts the B<ASN1_OBJECT> B<a> into a textual representation.
  60 The representation is written as a null terminated string to B<buf>
  61 at most B<buf_len> bytes are written, truncating the result if necessary.
  62 The total amount of space required is returned. If B<no_name> is 0 then
  63 if the object has a long or short name then that will be used, otherwise
  64 the numerical form will be used. If B<no_name> is 1 then the numerical
  65 form will always be used.
  66
  67 OBJ_cmp() compares B<a> to B<b>. If the two are identical 0 is returned.
  68
  69 OBJ_dup() returns a copy of B<o>.
  70
  71 OBJ_create() adds a new object to the internal table. B<oid> is the
  72 numerical form of the object, B<sn> the short name and B<ln> the
  73 long name. A new NID is returned for the created object.
  74
  75 OBJ_cleanup() cleans up OpenSSLs internal object table: this should
  76 be called before an application exits if any new objects were added
  77 using OBJ_create().
  78
  79 =head1 NOTES
  80
  81 Objects in OpenSSL can have a short name, a long name and a numerical
  82 identifier (NID) associated with them. A standard set of objects is
  83 represented in an internal table. The appropriate values are defined
  84 in the header file B<objects.h>.
  85
  86 For example the OID for commonName has the following definitions:
  87
  88  #define SN_commonName                   "CN"
  89  #define LN_commonName                   "commonName"
  90  #define NID_commonName                  13
  91
  92 New objects can be added by calling OBJ_create().
  93
  94 Table objects have certain advantages over other objects: for example
  95 their NIDs can be used in a C language switch statement. They are
  96 also static constant structures which are shared: that is there
  97 is only a single constant structure for each table object.
  98
  99 Objects which are not in the table have the NID value NID_undef.
 100
 101 Objects do not need to be in the internal tables to be processed,
 102 the functions OBJ_txt2obj() and OBJ_obj2txt() can process the numerical
 103 form of an OID.
 104
 105 =head1 EXAMPLES
 106
 107 Create an object for B<commonName>:
 108
 109  ASN1_OBJECT *o;
 110  o = OBJ_nid2obj(NID_commonName);
 111
 112 Check if an object is B<commonName>
 113
 114  if (OBJ_obj2nid(obj) == NID_commonName)
 115         /* Do something */
 116
 117 Create a new NID and initialize an object from it:
 118
 119  int new_nid;
 120  ASN1_OBJECT *obj;
 121
 122  new_nid = OBJ_create("1.2.3.4", "NewOID", "New Object Identifier");
 123
 124  obj = OBJ_nid2obj(new_nid);
 125
 126 Create a new object directly:
 127
 128  obj = OBJ_txt2obj("1.2.3.4", 1);
 129
 130 =head1 BUGS
 131
 132 OBJ_obj2txt() is awkward and messy to use: it doesn't follow the
 133 convention of other OpenSSL functions where the buffer can be set
 134 to B<NULL> to determine the amount of data that should be written.
 135 Instead B<buf> must point to a valid buffer and B<buf_len> should
 136 be set to a positive value. A buffer length of 80 should be more
 137 than enough to handle any OID encountered in practice.
 138
 139 Many of the functions here should probably be changed to return B<const>
 140 pointers. But the lack of consistency makes that too awkward to do.
 141
 142 =head1 RETURN VALUES
 143
 144 OBJ_nid2obj() returns an B<ASN1_OBJECT> structure or B<NULL> is an
 145 error occurred.
 146
 147 OBJ_nid2ln() and OBJ_nid2sn() returns a valid string or B<NULL>
 148 on error.
 149
 150 OBJ_obj2nid(), OBJ_ln2nid(), OBJ_sn2nid() and OBJ_txt2nid() return
 151 a NID or B<NID_undef> on error.
 152
 153 =head1 SEE ALSO
 154
 155 L<ERR_get_error(3)|ERR_get_error(3)>
 156
 157 =head1 HISTORY
 158
 159 TBA
 160
 161 =cut