OBJ_nid2ln (3)
Leading comments
Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32) Standard preamble: ========================================================================
NAME
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 functionsSYNOPSIS
#include <openssl/objects.h> ASN1_OBJECT * OBJ_nid2obj(int n); const char * OBJ_nid2ln(int n); const char * OBJ_nid2sn(int n); int OBJ_obj2nid(const ASN1_OBJECT *o); int OBJ_ln2nid(const char *ln); int OBJ_sn2nid(const char *sn); int OBJ_txt2nid(const char *s); ASN1_OBJECT * OBJ_txt2obj(const char *s, int no_name); int OBJ_obj2txt(char *buf, int buf_len, const ASN1_OBJECT *a, int no_name); int OBJ_cmp(const ASN1_OBJECT *a,const ASN1_OBJECT *b); ASN1_OBJECT * OBJ_dup(const ASN1_OBJECT *o); int OBJ_create(const char *oid,const char *sn,const char *ln); void OBJ_cleanup(void);
DESCRIPTION
TheOBJ_nid2obj(), OBJ_nid2ln() and OBJ_nid2sn() convert the
OBJ_obj2nid(), OBJ_ln2nid(), OBJ_sn2nid() return the corresponding
OBJ_txt2nid() returns
OBJ_txt2obj() converts the text string s into an
OBJ_obj2txt() converts the
OBJ_cmp() compares a to b. If the two are identical 0 is returned.
OBJ_dup() returns a copy of o.
OBJ_create() adds a new object to the internal table. oid is the numerical form of the object, sn the short name and ln the long name. A new
OBJ_cleanup() cleans up OpenSSLs internal object table: this should be called before an application exits if any new objects were added using OBJ_create().
NOTES
Objects in OpenSSL can have a short name, a long name and a numerical identifier (For example the
#define SN_commonName "CN" #define LN_commonName "commonName" #define NID_commonName 13
New objects can be added by calling OBJ_create().
Table objects have certain advantages over other objects: for example their NIDs can be used in a C language switch statement. They are also static constant structures which are shared: that is there is only a single constant structure for each table object.
Objects which are not in the table have the
Objects do not need to be in the internal tables to be processed, the functions OBJ_txt2obj() and OBJ_obj2txt() can process the numerical form of an
EXAMPLES
Create an object for commonName:
ASN1_OBJECT *o; o = OBJ_nid2obj(NID_commonName);
Check if an object is commonName
if (OBJ_obj2nid(obj) == NID_commonName) /* Do something */
Create a new
int new_nid; ASN1_OBJECT *obj; new_nid = OBJ_create("1.2.3.4", "NewOID", "New Object Identifier"); obj = OBJ_nid2obj(new_nid);
Create a new object directly:
obj = OBJ_txt2obj("1.2.3.4", 1);
BUGS
OBJ_obj2txt() is awkward and messy to use: it doesn't follow the convention of other OpenSSL functions where the buffer can be set toRETURN VALUES
OBJ_nid2obj() returns anOBJ_nid2ln() and OBJ_nid2sn() returns a valid string or
OBJ_obj2nid(), OBJ_ln2nid(), OBJ_sn2nid() and OBJ_txt2nid() return a