Update docs.
[openssl.git] / doc / crypto / X509_NAME_get_index_by_NID.pod
1 =pod
2
3 X509_NAME_get_index_by_NID, X509_NAME_get_index_by_OBJ, X509_NAME_get_entry,
4 X509_NAME_entry_count, X509_NAME_get_text_by_NID, X509_NAME_get_text_by_OBJ -
5 X509_NAME lookup and enumeration functions
6
7 =head1 NAME
8
9 =head1 SYNOPSIS
10
11 int X509_NAME_get_index_by_NID(X509_NAME *name,int nid,int lastpos);
12 int X509_NAME_get_index_by_OBJ(X509_NAME *name,ASN1_OBJECT *obj, int lastpos);
13
14 int X509_NAME_entry_count(X509_NAME *name);
15 X509_NAME_ENTRY *X509_NAME_get_entry(X509_NAME *name, int loc);
16
17 int X509_NAME_get_text_by_NID(X509_NAME *name, int nid, char *buf,int len);
18 int X509_NAME_get_text_by_OBJ(X509_NAME *name, ASN1_OBJECT *obj, char *buf,int len);
19
20 =head1 DESCRIPTION
21
22 These functions allow an B<X509_NAME> structure to be examined. The
23 B<X509_NAME> structure is the same as the B<Name> type defined in
24 RFC2459 (and elsewhere) and used for example in certificate subject
25 and issuer names.
26
27 X509_NAME_get_index_by_NID() and X509_NAME_get_index_by_OBJ() retrieve
28 the next index matching B<nid> or B<obj> after B<lastpos>. B<lastpos>
29 should initially be set to -1. If there are no more entries -1 is returned.
30
31 X509_NAME_entry_count() returns the total number of entries in B<name>.
32
33 X509_NAME_get_entry() retrieves the B<X509_NAME_ENTRY> from B<name>
34 corresponding to index B<loc>. Acceptable values for B<loc> run from
35 0 to (X509_NAME_entry_count(name) - 1). The value returned is an
36 internal pointer which must not be freed.
37
38 X509_NAME_get_text_by_NID(), X509_NAME_get_text_by_OBJ() retrieve
39 the "text" from the first entry in B<name> which matches B<nid> or
40 B<obj>, if no such entry exists -1 is returned. At most B<len> bytes
41 will be written and the text written to B<buf> will be null
42 terminated. The length of the output string written is returned
43 excluding the terminating null. If B<buf> is <NULL> then the amount
44 of space needed in B<buf> (excluding the final null) is returned. 
45
46 =head1 NOTES
47
48 X509_NAME_get_text_by_NID() and X509_NAME_get_text_by_OBJ() are
49 legacy functions which have various limitations which make them
50 of minimal use in practice. They can only find the first matching
51 entry and will copy the contents of the field verbatim: this can
52 be highly confusing if the target is a muticharacter string type
53 like a BMPString or a UTF8String.
54
55 For a more general solution X509_NAME_get_index_by_NID() or
56 X509_NAME_get_index_by_OBJ() should be used followed by
57 X509_NAME_get_entry() on any matching indices and then the
58 various B<X509_NAME_ENTRY> utility functions on the result.
59
60 =head1 EXAMPLES
61
62 Process all entries:
63
64  int i;
65  X509_NAME_ENTRY *e;
66
67  for (i = 0; i < X509_NAME_entry_count(nm); i++)
68         {
69         e = X509_NAME_get_entry(nm, i);
70         /* Do something with e */
71         }
72
73 Process all commonName entries:
74
75  int loc;
76  X509_NAME_ENTRY *e;
77
78  loc = -1;
79  for (;;)
80         {
81         lastpos = X509_NAME_get_index_by_NID(nm, NID_commonName, lastpos);
82         if (lastpos == -1)
83                 break;
84         e = X509_NAME_get_entry(nm, lastpos);
85         /* Do something with e */
86         }
87
88 =head1 RETURN VALUES
89
90 X509_NAME_get_index_by_NID() and X509_NAME_get_index_by_OBJ()
91 return the index of the next matching entry or -1 if not found.
92
93 X509_NAME_entry_count() returns the total number of entries.
94
95 X509_NAME_get_entry() returns an B<X509_NAME> pointer to the
96 requested entry or B<NULL> if the index is invalid.
97
98 =head1 SEE ALSO
99
100 L<ERR_get_error(3)|ERR_get_error(3)>, L<d2i_X509_NAME(3)|d2i_X509_NAME(3)>
101
102 =head1 HISTORY
103
104 TBA
105
106 =cut