free NULL cleanup.
[openssl.git] / 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  size_t OBJ_length(const ASN1_OBJECT *obj);
33  const unsigned char *OBJ_get0_data(const ASN1_OBJECT *obj);
34
35 =head1 DESCRIPTION
36
37 The ASN1 object utility functions process ASN1_OBJECT structures which are
38 a representation of the ASN1 OBJECT IDENTIFIER (OID) type.
39
40 OBJ_nid2obj(), OBJ_nid2ln() and OBJ_nid2sn() convert the NID B<n> to 
41 an ASN1_OBJECT structure, its long name and its short name respectively,
42 or B<NULL> is an error occurred.
43
44 OBJ_obj2nid(), OBJ_ln2nid(), OBJ_sn2nid() return the corresponding NID
45 for the object B<o>, the long name <ln> or the short name <sn> respectively
46 or NID_undef if an error occurred.
47
48 OBJ_txt2nid() returns NID corresponding to text string <s>. B<s> can be
49 a long name, a short name or the numerical respresentation of an object.
50
51 OBJ_txt2obj() converts the text string B<s> into an ASN1_OBJECT structure.
52 If B<no_name> is 0 then long names and short names will be interpreted
53 as well as numerical forms. If B<no_name> is 1 only the numerical form
54 is acceptable.
55
56 OBJ_obj2txt() converts the B<ASN1_OBJECT> B<a> into a textual representation.
57 The representation is written as a null terminated string to B<buf>
58 at most B<buf_len> bytes are written, truncating the result if necessary.
59 The total amount of space required is returned. If B<no_name> is 0 then
60 if the object has a long or short name then that will be used, otherwise
61 the numerical form will be used. If B<no_name> is 1 then the numerical
62 form will always be used.
63
64 OBJ_cmp() compares B<a> to B<b>. If the two are identical 0 is returned.
65
66 OBJ_dup() returns a copy of B<o>.
67
68 OBJ_create() adds a new object to the internal table. B<oid> is the 
69 numerical form of the object, B<sn> the short name and B<ln> the
70 long name. A new NID is returned for the created object.
71
72 OBJ_cleanup() cleans up OpenSSLs internal object table: this should
73 be called before an application exits if any new objects were added
74 using OBJ_create().
75
76 OBJ_length() returns the size of the content octets of B<obj>.
77
78 OBJ_get0_data() returns a pointer to the content octets of B<obj>.
79 The returned pointer is an internal pointer which B<must not> be freed.
80
81 =head1 NOTES
82
83 Objects in OpenSSL can have a short name, a long name and a numerical
84 identifier (NID) associated with them. A standard set of objects is
85 represented in an internal table. The appropriate values are defined
86 in the header file B<objects.h>.
87
88 For example the OID for commonName has the following definitions:
89
90  #define SN_commonName                   "CN"
91  #define LN_commonName                   "commonName"
92  #define NID_commonName                  13
93
94 New objects can be added by calling OBJ_create().
95
96 Table objects have certain advantages over other objects: for example
97 their NIDs can be used in a C language switch statement. They are
98 also static constant structures which are shared: that is there
99 is only a single constant structure for each table object.
100
101 Objects which are not in the table have the NID value NID_undef.
102
103 Objects do not need to be in the internal tables to be processed,
104 the functions OBJ_txt2obj() and OBJ_obj2txt() can process the numerical
105 form of an OID.
106
107 Some objects are used to reprsent algorithms which do not have a
108 corresponding ASN.1 OBJECT IDENTIFIER encoding (for example no OID currently
109 exists for a particular algorithm). As a result they B<cannot> be encoded or
110 decoded as part of ASN.1 structures. Applications can determine if there
111 is a corresponding OBJECT IDENTIFIER by checking OBJ_length() is not zero.
112
113 =head1 EXAMPLES
114
115 Create an object for B<commonName>:
116
117  ASN1_OBJECT *o;
118  o = OBJ_nid2obj(NID_commonName);
119
120 Check if an object is B<commonName>
121
122  if (OBJ_obj2nid(obj) == NID_commonName)
123         /* Do something */
124
125 Create a new NID and initialize an object from it:
126
127  int new_nid;
128  ASN1_OBJECT *obj;
129  new_nid = OBJ_create("1.2.3.4", "NewOID", "New Object Identifier");
130
131  obj = OBJ_nid2obj(new_nid);
132  
133 Create a new object directly:
134
135  obj = OBJ_txt2obj("1.2.3.4", 1);
136
137 =head1 BUGS
138
139 OBJ_obj2txt() is awkward and messy to use: it doesn't follow the 
140 convention of other OpenSSL functions where the buffer can be set
141 to B<NULL> to determine the amount of data that should be written.
142 Instead B<buf> must point to a valid buffer and B<buf_len> should
143 be set to a positive value. A buffer length of 80 should be more
144 than enough to handle any OID encountered in practice.
145
146 =head1 RETURN VALUES
147
148 OBJ_nid2obj() returns an B<ASN1_OBJECT> structure or B<NULL> is an
149 error occurred.
150
151 OBJ_nid2ln() and OBJ_nid2sn() returns a valid string or B<NULL>
152 on error.
153
154 OBJ_obj2nid(), OBJ_ln2nid(), OBJ_sn2nid() and OBJ_txt2nid() return
155 a NID or B<NID_undef> on error.
156
157 =head1 SEE ALSO
158
159 L<ERR_get_error(3)|ERR_get_error(3)>
160
161 =head1 HISTORY
162
163 TBA
164
165 =cut