Merge from vendor branch WPA_SUPPLICANT:
[dragonfly.git] / secure / lib / libcrypto / man / X509_NAME_add_entry_by_txt.3
1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sh \" Subsection heading
6 .br
7 .if t .Sp
8 .ne 5
9 .PP
10 \fB\\$1\fR
11 .PP
12 ..
13 .de Sp \" Vertical space (when we can't use .PP)
14 .if t .sp .5v
15 .if n .sp
16 ..
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
21 ..
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
25 ..
26 .\" Set up some character translations and predefined strings.  \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote.  | will give a
29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
32 .tr \(*W-|\(bv\*(Tr
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
35 .    ds -- \(*W-
36 .    ds PI pi
37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
39 .    ds L" ""
40 .    ds R" ""
41 .    ds C` ""
42 .    ds C' ""
43 'br\}
44 .el\{\
45 .    ds -- \|\(em\|
46 .    ds PI \(*p
47 .    ds L" ``
48 .    ds R" ''
49 'br\}
50 .\"
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
55 .if \nF \{\
56 .    de IX
57 .    tm Index:\\$1\t\\n%\t"\\$2"
58 ..
59 .    nr % 0
60 .    rr F
61 .\}
62 .\"
63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
65 .hy 0
66 .if n .na
67 .\"
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
70 .    \" fudge factors for nroff and troff
71 .if n \{\
72 .    ds #H 0
73 .    ds #V .8m
74 .    ds #F .3m
75 .    ds #[ \f1
76 .    ds #] \fP
77 .\}
78 .if t \{\
79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 .    ds #V .6m
81 .    ds #F 0
82 .    ds #[ \&
83 .    ds #] \&
84 .\}
85 .    \" simple accents for nroff and troff
86 .if n \{\
87 .    ds ' \&
88 .    ds ` \&
89 .    ds ^ \&
90 .    ds , \&
91 .    ds ~ ~
92 .    ds /
93 .\}
94 .if t \{\
95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101 .\}
102 .    \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 .    \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 .    \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
117 \{\
118 .    ds : e
119 .    ds 8 ss
120 .    ds o a
121 .    ds d- d\h'-1'\(ga
122 .    ds D- D\h'-1'\(hy
123 .    ds th \o'bp'
124 .    ds Th \o'LP'
125 .    ds ae ae
126 .    ds Ae AE
127 .\}
128 .rm #[ #] #H #V #F C
129 .\" ========================================================================
130 .\"
131 .IX Title "X509_NAME_add_entry_by_txt 3"
132 .TH X509_NAME_add_entry_by_txt 3 "2007-03-28" "0.9.8e" "OpenSSL"
133 .SH "NAME"
134 X509_NAME_add_entry_by_txt, X509_NAME_add_entry_by_OBJ, X509_NAME_add_entry_by_NID,
135 X509_NAME_add_entry, X509_NAME_delete_entry \- X509_NAME modification functions
136 .SH "SYNOPSIS"
137 .IX Header "SYNOPSIS"
138 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);
139 .PP
140 int X509_NAME_add_entry_by_OBJ(X509_NAME *name, \s-1ASN1_OBJECT\s0 *obj, int type, unsigned char *bytes, int len, int loc, int set);
141 .PP
142 int X509_NAME_add_entry_by_NID(X509_NAME *name, int nid, int type, unsigned char *bytes, int len, int loc, int set);
143 .PP
144 int X509_NAME_add_entry(X509_NAME *name,X509_NAME_ENTRY *ne, int loc, int set);
145 .PP
146 X509_NAME_ENTRY *X509_NAME_delete_entry(X509_NAME *name, int loc);
147 .SH "DESCRIPTION"
148 .IX Header "DESCRIPTION"
149 \&\fIX509_NAME_add_entry_by_txt()\fR, \fIX509_NAME_add_entry_by_OBJ()\fR and
150 \&\fIX509_NAME_add_entry_by_NID()\fR add a field whose name is defined
151 by a string \fBfield\fR, an object \fBobj\fR or a \s-1NID\s0 \fBnid\fR respectively.
152 The field value to be added is in \fBbytes\fR of length \fBlen\fR. If
153 \&\fBlen\fR is \-1 then the field length is calculated internally using
154 strlen(bytes).
155 .PP
156 The type of field is determined by \fBtype\fR which can either be a
157 definition of the type of \fBbytes\fR (such as \fB\s-1MBSTRING_ASC\s0\fR) or a
158 standard \s-1ASN1\s0 type (such as \fBV_ASN1_IA5STRING\fR). The new entry is
159 added to a position determined by \fBloc\fR and \fBset\fR.
160 .PP
161 \&\fIX509_NAME_add_entry()\fR adds a copy of \fBX509_NAME_ENTRY\fR structure \fBne\fR
162 to \fBname\fR. The new entry is added to a position determined by \fBloc\fR
163 and \fBset\fR. Since a copy of \fBne\fR is added \fBne\fR must be freed up after
164 the call.
165 .PP
166 \&\fIX509_NAME_delete_entry()\fR deletes an entry from \fBname\fR at position
167 \&\fBloc\fR. The deleted entry is returned and must be freed up.
168 .SH "NOTES"
169 .IX Header "NOTES"
170 The use of string types such as \fB\s-1MBSTRING_ASC\s0\fR or \fB\s-1MBSTRING_UTF8\s0\fR
171 is strongly recommened for the \fBtype\fR parameter. This allows the
172 internal code to correctly determine the type of the field and to
173 apply length checks according to the relevant standards. This is
174 done using \fIASN1_STRING_set_by_NID()\fR.
175 .PP
176 If instead an \s-1ASN1\s0 type is used no checks are performed and the
177 supplied data in \fBbytes\fR is used directly.
178 .PP
179 In \fIX509_NAME_add_entry_by_txt()\fR the \fBfield\fR string represents
180 the field name using OBJ_txt2obj(field, 0).
181 .PP
182 The \fBloc\fR and \fBset\fR parameters determine where a new entry should
183 be added. For almost all applications \fBloc\fR can be set to \-1 and \fBset\fR
184 to 0. This adds a new entry to the end of \fBname\fR as a single valued
185 RelativeDistinguishedName (\s-1RDN\s0).
186 .PP
187 \&\fBloc\fR actually determines the index where the new entry is inserted:
188 if it is \-1 it is appended. 
189 .PP
190 \&\fBset\fR determines how the new type is added. If it is zero a
191 new \s-1RDN\s0 is created.
192 .PP
193 If \fBset\fR is \-1 or 1 it is added to the previous or next \s-1RDN\s0
194 structure respectively. This will then be a multivalued \s-1RDN:\s0
195 since multivalues RDNs are very seldom used \fBset\fR is almost
196 always set to zero.
197 .SH "EXAMPLES"
198 .IX Header "EXAMPLES"
199 Create an \fBX509_NAME\fR structure:
200 .PP
201 \&\*(L"C=UK, O=Disorganized Organization, CN=Joe Bloggs\*(R"
202 .PP
203 .Vb 13
204 \& X509_NAME *nm;
205 \& nm = X509_NAME_new();
206 \& if (nm == NULL)
207 \&        /* Some error */
208 \& if (!X509_NAME_add_entry_by_txt(nm, MBSTRING_ASC,
209 \&                        "C", "UK", -1, -1, 0))
210 \&        /* Error */
211 \& if (!X509_NAME_add_entry_by_txt(nm, MBSTRING_ASC,
212 \&                        "O", "Disorganized Organization", -1, -1, 0))
213 \&        /* Error */
214 \& if (!X509_NAME_add_entry_by_txt(nm, MBSTRING_ASC,
215 \&                        "CN", "Joe Bloggs", -1, -1, 0))
216 \&        /* Error */
217 .Ve
218 .SH "RETURN VALUES"
219 .IX Header "RETURN VALUES"
220 \&\fIX509_NAME_add_entry_by_txt()\fR, \fIX509_NAME_add_entry_by_OBJ()\fR,
221 \&\fIX509_NAME_add_entry_by_NID()\fR and \fIX509_NAME_add_entry()\fR return 1 for
222 success of 0 if an error occurred.
223 .PP
224 \&\fIX509_NAME_delete_entry()\fR returns either the deleted \fBX509_NAME_ENTRY\fR
225 structure of \fB\s-1NULL\s0\fR if an error occurred.
226 .SH "BUGS"
227 .IX Header "BUGS"
228 \&\fBtype\fR can still be set to \fBV_ASN1_APP_CHOOSE\fR to use a
229 different algorithm to determine field types. Since this form does
230 not understand multicharacter types, performs no length checks and
231 can result in invalid field types its use is strongly discouraged.
232 .SH "SEE ALSO"
233 .IX Header "SEE ALSO"
234 \&\fIERR_get_error\fR\|(3), \fId2i_X509_NAME\fR\|(3)
235 .SH "HISTORY"
236 .IX Header "HISTORY"