1=pod
2
3=head1 NAME
4
5X509_NAME_add_entry_by_txt, X509_NAME_add_entry_by_OBJ, X509_NAME_add_entry_by_NID,
6X509_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,
13                                const unsigned char *bytes, int len, int loc, int set);
14
15 int X509_NAME_add_entry_by_OBJ(X509_NAME *name, const ASN1_OBJECT *obj, int type,
16                                const unsigned char *bytes, int len, int loc, int set);
17
18 int X509_NAME_add_entry_by_NID(X509_NAME *name, int nid, int type,
19                                const unsigned char *bytes, int len, int loc, int set);
20
21 int X509_NAME_add_entry(X509_NAME *name, const X509_NAME_ENTRY *ne, int loc, int set);
22
23 X509_NAME_ENTRY *X509_NAME_delete_entry(X509_NAME *name, int loc);
24
25=head1 DESCRIPTION
26
27X509_NAME_add_entry_by_txt(), X509_NAME_add_entry_by_OBJ() and
28X509_NAME_add_entry_by_NID() add a field whose name is defined
29by a string B<field>, an object B<obj> or a NID B<nid> respectively.
30The field value to be added is in B<bytes> of length B<len>. If
31B<len> is -1 then the field length is calculated internally using
32strlen(bytes).
33
34The type of field is determined by B<type> which can either be a
35definition of the type of B<bytes> (such as B<MBSTRING_ASC>) or a
36standard ASN1 type (such as B<V_ASN1_IA5STRING>). The new entry is
37added to a position determined by B<loc> and B<set>.
38
39X509_NAME_add_entry() adds a copy of B<X509_NAME_ENTRY> structure B<ne>
40to B<name>. The new entry is added to a position determined by B<loc>
41and B<set>. Since a copy of B<ne> is added B<ne> must be freed up after
42the call.
43
44X509_NAME_delete_entry() deletes an entry from B<name> at position
45B<loc>. The deleted entry is returned and must be freed up.
46
47=head1 NOTES
48
49The use of string types such as B<MBSTRING_ASC> or B<MBSTRING_UTF8>
50is strongly recommended for the B<type> parameter. This allows the
51internal code to correctly determine the type of the field and to
52apply length checks according to the relevant standards. This is
53done using ASN1_STRING_set_by_NID().
54
55If instead an ASN1 type is used no checks are performed and the
56supplied data in B<bytes> is used directly.
57
58In X509_NAME_add_entry_by_txt() the B<field> string represents
59the field name using OBJ_txt2obj(field, 0).
60
61The B<loc> and B<set> parameters determine where a new entry should
62be added. For almost all applications B<loc> can be set to -1 and B<set>
63to 0. This adds a new entry to the end of B<name> as a single valued
64RelativeDistinguishedName (RDN).
65
66B<loc> actually determines the index where the new entry is inserted:
67if it is -1 it is appended.
68
69B<set> determines how the new type is added.
70If it is zero a new RDN is created.
71
72If B<set> is -1 or 1 it is added as a new set member
73to the previous or next RDN structure, respectively.
74This will then become part of a multi-valued RDN (containing a set of AVAs).
75Since multi-valued RDNs are very rarely used B<set> typically will be zero.
76
77=head1 RETURN VALUES
78
79X509_NAME_add_entry_by_txt(), X509_NAME_add_entry_by_OBJ(),
80X509_NAME_add_entry_by_NID() and X509_NAME_add_entry() return 1 for
81success of 0 if an error occurred.
82
83X509_NAME_delete_entry() returns either the deleted B<X509_NAME_ENTRY>
84structure or B<NULL> if an error occurred.
85
86=head1 EXAMPLES
87
88Create an B<X509_NAME> structure:
89
90"C=UK, O=Disorganized Organization, CN=Joe Bloggs"
91
92 X509_NAME *nm;
93
94 nm = X509_NAME_new();
95 if (nm == NULL)
96     /* Some error */
97 if (!X509_NAME_add_entry_by_txt(nm, "C", MBSTRING_ASC,
98                                 "UK", -1, -1, 0))
99     /* Error */
100 if (!X509_NAME_add_entry_by_txt(nm, "O", MBSTRING_ASC,
101                                 "Disorganized Organization", -1, -1, 0))
102     /* Error */
103 if (!X509_NAME_add_entry_by_txt(nm, "CN", MBSTRING_ASC,
104                                 "Joe Bloggs", -1, -1, 0))
105     /* Error */
106
107=head1 BUGS
108
109B<type> can still be set to B<V_ASN1_APP_CHOOSE> to use a
110different algorithm to determine field types. Since this form does
111not understand multicharacter types, performs no length checks and
112can result in invalid field types its use is strongly discouraged.
113
114=head1 SEE ALSO
115
116L<ERR_get_error(3)>, L<d2i_X509_NAME(3)>
117
118=head1 COPYRIGHT
119
120Copyright 2002-2020 The OpenSSL Project Authors. All Rights Reserved.
121
122Licensed under the Apache License 2.0 (the "License").  You may not use
123this file except in compliance with the License.  You can obtain a copy
124in the file LICENSE in the source distribution or at
125L<https://www.openssl.org/source/license.html>.
126
127=cut
128