Multiple verifier reference identities.
[openssl.git] / doc / crypto / X509_NAME_add_entry_by_txt.pod
1 =pod
2
3 =head1 NAME
4
5 X509_NAME_add_entry_by_txt, X509_NAME_add_entry_by_OBJ, X509_NAME_add_entry_by_NID,
6 X509_NAME_add_entry, X509_NAME_delete_entry - X509_NAME modification functions
7
8 =head1 SYNOPSIS
9
10  #include <openssl/x509.h>
11
12  int X509_NAME_add_entry_by_txt(X509_NAME *name, const char *field, int type, const unsigned char *bytes, int len, int loc, int set);
13
14  int X509_NAME_add_entry_by_OBJ(X509_NAME *name, ASN1_OBJECT *obj, int type, unsigned char *bytes, int len, int loc, int set);
15
16  int X509_NAME_add_entry_by_NID(X509_NAME *name, int nid, int type, unsigned char *bytes, int len, int loc, int set);
17
18  int X509_NAME_add_entry(X509_NAME *name,X509_NAME_ENTRY *ne, int loc, int set);
19
20  X509_NAME_ENTRY *X509_NAME_delete_entry(X509_NAME *name, int loc);
21
22 =head1 DESCRIPTION
23
24 X509_NAME_add_entry_by_txt(), X509_NAME_add_entry_by_OBJ() and
25 X509_NAME_add_entry_by_NID() add a field whose name is defined
26 by a string B<field>, an object B<obj> or a NID B<nid> respectively.
27 The field value to be added is in B<bytes> of length B<len>. If
28 B<len> is -1 then the field length is calculated internally using
29 strlen(bytes).
30
31 The type of field is determined by B<type> which can either be a
32 definition of the type of B<bytes> (such as B<MBSTRING_ASC>) or a
33 standard ASN1 type (such as B<V_ASN1_IA5STRING>). The new entry is
34 added to a position determined by B<loc> and B<set>.
35
36 X509_NAME_add_entry() adds a copy of B<X509_NAME_ENTRY> structure B<ne>
37 to B<name>. The new entry is added to a position determined by B<loc>
38 and B<set>. Since a copy of B<ne> is added B<ne> must be freed up after
39 the call.
40
41 X509_NAME_delete_entry() deletes an entry from B<name> at position
42 B<loc>. The deleted entry is returned and must be freed up.
43
44 =head1 NOTES
45
46 The use of string types such as B<MBSTRING_ASC> or B<MBSTRING_UTF8>
47 is strongly recommended for the B<type> parameter. This allows the
48 internal code to correctly determine the type of the field and to
49 apply length checks according to the relevant standards. This is
50 done using ASN1_STRING_set_by_NID().
51
52 If instead an ASN1 type is used no checks are performed and the
53 supplied data in B<bytes> is used directly.
54
55 In X509_NAME_add_entry_by_txt() the B<field> string represents
56 the field name using OBJ_txt2obj(field, 0).
57
58 The B<loc> and B<set> parameters determine where a new entry should
59 be added. For almost all applications B<loc> can be set to -1 and B<set>
60 to 0. This adds a new entry to the end of B<name> as a single valued
61 RelativeDistinguishedName (RDN).
62
63 B<loc> actually determines the index where the new entry is inserted:
64 if it is -1 it is appended. 
65
66 B<set> determines how the new type is added. If it is zero a
67 new RDN is created.
68
69 If B<set> is -1 or 1 it is added to the previous or next RDN
70 structure respectively. This will then be a multivalued RDN:
71 since multivalues RDNs are very seldom used B<set> is almost
72 always set to zero.
73
74 =head1 EXAMPLES
75
76 Create an B<X509_NAME> structure:
77
78 "C=UK, O=Disorganized Organization, CN=Joe Bloggs"
79
80  X509_NAME *nm;
81  nm = X509_NAME_new();
82  if (nm == NULL)
83         /* Some error */
84  if (!X509_NAME_add_entry_by_txt(nm, MBSTRING_ASC,
85                         "C", "UK", -1, -1, 0))
86         /* Error */
87  if (!X509_NAME_add_entry_by_txt(nm, MBSTRING_ASC,
88                         "O", "Disorganized Organization", -1, -1, 0))
89         /* Error */
90  if (!X509_NAME_add_entry_by_txt(nm, MBSTRING_ASC,
91                         "CN", "Joe Bloggs", -1, -1, 0))
92         /* Error */
93
94 =head1 RETURN VALUES
95
96 X509_NAME_add_entry_by_txt(), X509_NAME_add_entry_by_OBJ(),
97 X509_NAME_add_entry_by_NID() and X509_NAME_add_entry() return 1 for
98 success of 0 if an error occurred.
99
100 X509_NAME_delete_entry() returns either the deleted B<X509_NAME_ENTRY>
101 structure of B<NULL> if an error occurred.
102
103 =head1 BUGS
104
105 B<type> can still be set to B<V_ASN1_APP_CHOOSE> to use a
106 different algorithm to determine field types. Since this form does
107 not understand multicharacter types, performs no length checks and
108 can result in invalid field types its use is strongly discouraged.
109
110 =head1 SEE ALSO
111
112 L<ERR_get_error(3)|ERR_get_error(3)>, L<d2i_X509_NAME(3)|d2i_X509_NAME(3)>
113
114 =head1 HISTORY
115
116 =cut