5 X509_NAME_get_index_by_NID, X509_NAME_get_index_by_OBJ, X509_NAME_get_entry,
6 X509_NAME_entry_count, X509_NAME_get_text_by_NID, X509_NAME_get_text_by_OBJ -
7 X509_NAME lookup and enumeration functions
11 #include <openssl/x509.h>
13 int X509_NAME_get_index_by_NID(X509_NAME *name,int nid,int lastpos);
14 int X509_NAME_get_index_by_OBJ(X509_NAME *name,ASN1_OBJECT *obj, int lastpos);
16 int X509_NAME_entry_count(X509_NAME *name);
17 X509_NAME_ENTRY *X509_NAME_get_entry(X509_NAME *name, int loc);
19 int X509_NAME_get_text_by_NID(X509_NAME *name, int nid, char *buf,int len);
20 int X509_NAME_get_text_by_OBJ(X509_NAME *name, ASN1_OBJECT *obj, char *buf,int len);
24 These functions allow an B<X509_NAME> structure to be examined. The
25 B<X509_NAME> structure is the same as the B<Name> type defined in
26 RFC2459 (and elsewhere) and used for example in certificate subject
29 X509_NAME_get_index_by_NID() and X509_NAME_get_index_by_OBJ() retrieve
30 the next index matching B<nid> or B<obj> after B<lastpos>. B<lastpos>
31 should initially be set to -1. If there are no more entries -1 is returned.
32 If B<nid> is invalid (doesn't correspond to a valid OID) then -2 is returned.
34 X509_NAME_entry_count() returns the total number of entries in B<name>.
36 X509_NAME_get_entry() retrieves the B<X509_NAME_ENTRY> from B<name>
37 corresponding to index B<loc>. Acceptable values for B<loc> run from
38 0 to (X509_NAME_entry_count(name) - 1). The value returned is an
39 internal pointer which must not be freed.
41 X509_NAME_get_text_by_NID(), X509_NAME_get_text_by_OBJ() retrieve
42 the "text" from the first entry in B<name> which matches B<nid> or
43 B<obj>, if no such entry exists -1 is returned. At most B<len> bytes
44 will be written and the text written to B<buf> will be null
45 terminated. The length of the output string written is returned
46 excluding the terminating null. If B<buf> is <NULL> then the amount
47 of space needed in B<buf> (excluding the final null) is returned.
51 X509_NAME_get_text_by_NID() and X509_NAME_get_text_by_OBJ() are
52 legacy functions which have various limitations which make them
53 of minimal use in practice. They can only find the first matching
54 entry and will copy the contents of the field verbatim: this can
55 be highly confusing if the target is a muticharacter string type
56 like a BMPString or a UTF8String.
58 For a more general solution X509_NAME_get_index_by_NID() or
59 X509_NAME_get_index_by_OBJ() should be used followed by
60 X509_NAME_get_entry() on any matching indices and then the
61 various B<X509_NAME_ENTRY> utility functions on the result.
63 Applications which could pass invalid NIDs to X509_NAME_get_index_by_NID()
64 should check for the return value of -2. Alternatively the NID validity
65 can be determined first by checking OBJ_nid2obj(nid) is not NULL.
74 for (i = 0; i < X509_NAME_entry_count(nm); i++)
76 e = X509_NAME_get_entry(nm, i);
77 /* Do something with e */
80 Process all commonName entries:
88 lastpos = X509_NAME_get_index_by_NID(nm, NID_commonName, lastpos);
91 e = X509_NAME_get_entry(nm, lastpos);
92 /* Do something with e */
97 X509_NAME_get_index_by_NID() and X509_NAME_get_index_by_OBJ()
98 return the index of the next matching entry or -1 if not found.
99 X509_NAME_get_index_by_NID() can also return -2 if the supplied
102 X509_NAME_entry_count() returns the total number of entries.
104 X509_NAME_get_entry() returns an B<X509_NAME> pointer to the
105 requested entry or B<NULL> if the index is invalid.
109 L<ERR_get_error(3)|ERR_get_error(3)>, L<d2i_X509_NAME(3)|d2i_X509_NAME(3)>