1X509_NAME_get_index_by_NID(3)       OpenSSL      X509_NAME_get_index_by_NID(3)
2
3
4

NAME

6       X509_NAME_get_index_by_NID, X509_NAME_get_index_by_OBJ,
7       X509_NAME_get_entry, X509_NAME_entry_count, X509_NAME_get_text_by_NID,
8       X509_NAME_get_text_by_OBJ - X509_NAME lookup and enumeration functions
9

SYNOPSIS

11        #include <openssl/x509.h>
12
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);
15
16        int X509_NAME_entry_count(X509_NAME *name);
17        X509_NAME_ENTRY *X509_NAME_get_entry(X509_NAME *name, int loc);
18
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);
21

DESCRIPTION

23       These functions allow an X509_NAME structure to be examined. The
24       X509_NAME structure is the same as the Name type defined in RFC2459
25       (and elsewhere) and used for example in certificate subject and issuer
26       names.
27
28       X509_NAME_get_index_by_NID() and X509_NAME_get_index_by_OBJ() retrieve
29       the next index matching nid or obj after lastpos. lastpos should
30       initially be set to -1. If there are no more entries -1 is returned.
31       If nid is invalid (doesn't correspond to a valid OID) then -2 is
32       returned.
33
34       X509_NAME_entry_count() returns the total number of entries in name.
35
36       X509_NAME_get_entry() retrieves the X509_NAME_ENTRY from name
37       corresponding to index loc. Acceptable values for loc run from 0 to
38       (X509_NAME_entry_count(name) - 1). The value returned is an internal
39       pointer which must not be freed.
40
41       X509_NAME_get_text_by_NID(), X509_NAME_get_text_by_OBJ() retrieve the
42       "text" from the first entry in name which matches nid or obj, if no
43       such entry exists -1 is returned. At most len bytes will be written and
44       the text written to buf will be null terminated. The length of the
45       output string written is returned excluding the terminating null. If
46       buf is <NULL> then the amount of space needed in buf (excluding the
47       final null) is returned.
48

NOTES

50       X509_NAME_get_text_by_NID() and X509_NAME_get_text_by_OBJ() are legacy
51       functions which have various limitations which make them of minimal use
52       in practice. They can only find the first matching entry and will copy
53       the contents of the field verbatim: this can be highly confusing if the
54       target is a muticharacter string type like a BMPString or a UTF8String.
55
56       For a more general solution X509_NAME_get_index_by_NID() or
57       X509_NAME_get_index_by_OBJ() should be used followed by
58       X509_NAME_get_entry() on any matching indices and then the various
59       X509_NAME_ENTRY utility functions on the result.
60
61       The list of all relevant NID_* and OBJ_* codes can be found in the
62       source code header files <openssl/obj_mac.h> and/or
63       <openssl/objects.h>.
64
65       Applications which could pass invalid NIDs to
66       X509_NAME_get_index_by_NID() should check for the return value of -2.
67       Alternatively the NID validity can be determined first by checking
68       OBJ_nid2obj(nid) is not NULL.
69

EXAMPLES

71       Process all entries:
72
73        int i;
74        X509_NAME_ENTRY *e;
75
76        for (i = 0; i < X509_NAME_entry_count(nm); i++)
77               {
78               e = X509_NAME_get_entry(nm, i);
79               /* Do something with e */
80               }
81
82       Process all commonName entries:
83
84        int lastpos = -1;
85        X509_NAME_ENTRY *e;
86
87        for (;;)
88               {
89               lastpos = X509_NAME_get_index_by_NID(nm, NID_commonName, lastpos);
90               if (lastpos == -1)
91                       break;
92               e = X509_NAME_get_entry(nm, lastpos);
93               /* Do something with e */
94               }
95

RETURN VALUES

97       X509_NAME_get_index_by_NID() and X509_NAME_get_index_by_OBJ() return
98       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 NID is
100       invalid.
101
102       X509_NAME_entry_count() returns the total number of entries.
103
104       X509_NAME_get_entry() returns an X509_NAME pointer to the requested
105       entry or NULL if the index is invalid.
106

SEE ALSO

108       ERR_get_error(3), d2i_X509_NAME(3)
109

HISTORY

111       TBA
112
113
114
1151.0.2o                            2020-01-28     X509_NAME_get_index_by_NID(3)
Impressum