Regenerate the manual pages after the OpenSSL update to 0.9.7e.
[dragonfly.git] / secure / lib / libcrypto / man / X509_NAME_add_entry_by_txt.3
CommitLineData
8b0cefbb
JR
1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
984263bc
MD
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
8b0cefbb 13.de Sp \" Vertical space (when we can't use .PP)
984263bc
MD
14.if t .sp .5v
15.if n .sp
16..
8b0cefbb 17.de Vb \" Begin verbatim text
984263bc
MD
18.ft CW
19.nf
20.ne \\$1
21..
8b0cefbb 22.de Ve \" End verbatim text
984263bc 23.ft R
984263bc
MD
24.fi
25..
8b0cefbb
JR
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<>.
984263bc 32.tr \(*W-|\(bv\*(Tr
8b0cefbb 33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
984263bc 34.ie n \{\
8b0cefbb
JR
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' ""
984263bc
MD
43'br\}
44.el\{\
8b0cefbb
JR
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
984263bc 49'br\}
8b0cefbb
JR
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"
984263bc 58..
8b0cefbb
JR
59. nr % 0
60. rr F
984263bc 61.\}
8b0cefbb
JR
62.\"
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64.\" way too many mistakes in technical documents.
65.hy 0
984263bc 66.if n .na
8b0cefbb
JR
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
984263bc 71.if n \{\
8b0cefbb
JR
72. ds #H 0
73. ds #V .8m
74. ds #F .3m
75. ds #[ \f1
76. ds #] \fP
984263bc
MD
77.\}
78.if t \{\
8b0cefbb
JR
79. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80. ds #V .6m
81. ds #F 0
82. ds #[ \&
83. ds #] \&
984263bc 84.\}
8b0cefbb 85. \" simple accents for nroff and troff
984263bc 86.if n \{\
8b0cefbb
JR
87. ds ' \&
88. ds ` \&
89. ds ^ \&
90. ds , \&
91. ds ~ ~
92. ds /
984263bc
MD
93.\}
94.if t \{\
8b0cefbb
JR
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'
984263bc 101.\}
8b0cefbb 102. \" troff and (daisy-wheel) nroff accents
984263bc
MD
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
8b0cefbb 112. \" corrections for vroff
984263bc
MD
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'
8b0cefbb 115. \" for low resolution devices (crt and lpr)
984263bc
MD
116.if \n(.H>23 .if \n(.V>19 \
117\{\
8b0cefbb
JR
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
984263bc
MD
127.\}
128.rm #[ #] #H #V #F C
8b0cefbb
JR
129.\" ========================================================================
130.\"
131.IX Title "X509_NAME_add_entry_by_txt 3"
132.TH X509_NAME_add_entry_by_txt 3 "2004-12-18" "0.9.7e" "OpenSSL"
984263bc
MD
133.SH "NAME"
134X509_NAME_add_entry_by_txt, X509_NAME_add_entry_by_OBJ, X509_NAME_add_entry_by_NID,
135X509_NAME_add_entry, X509_NAME_delete_entry \- X509_NAME modification functions
136.SH "SYNOPSIS"
8b0cefbb
JR
137.IX Header "SYNOPSIS"
138int X509_NAME_add_entry_by_txt(X509_NAME *name, char *field, int type, unsigned char *bytes, int len, int loc, int set);
139int 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);
140int X509_NAME_add_entry_by_NID(X509_NAME *name, int nid, int type, unsigned char *bytes, int len, int loc, int set);
141int X509_NAME_add_entry(X509_NAME *name,X509_NAME_ENTRY *ne, int loc, int set);
142X509_NAME_ENTRY *X509_NAME_delete_entry(X509_NAME *name, int loc);
984263bc 143.SH "DESCRIPTION"
8b0cefbb
JR
144.IX Header "DESCRIPTION"
145\&\fIX509_NAME_add_entry_by_txt()\fR, \fIX509_NAME_add_entry_by_OBJ()\fR and
146\&\fIX509_NAME_add_entry_by_NID()\fR add a field whose name is defined
147by a string \fBfield\fR, an object \fBobj\fR or a \s-1NID\s0 \fBnid\fR respectively.
984263bc 148The field value to be added is in \fBbytes\fR of length \fBlen\fR. If
8b0cefbb
JR
149\&\fBlen\fR is \-1 then the field length is calculated internally using
150strlen(bytes).
984263bc
MD
151.PP
152The type of field is determined by \fBtype\fR which can either be a
8b0cefbb
JR
153definition of the type of \fBbytes\fR (such as \fB\s-1MBSTRING_ASC\s0\fR) or a
154standard \s-1ASN1\s0 type (such as \fBV_ASN1_IA5STRING\fR). The new entry is
984263bc
MD
155added to a position determined by \fBloc\fR and \fBset\fR.
156.PP
8b0cefbb 157\&\fIX509_NAME_add_entry()\fR adds a copy of \fBX509_NAME_ENTRY\fR structure \fBne\fR
984263bc
MD
158to \fBname\fR. The new entry is added to a position determined by \fBloc\fR
159and \fBset\fR. Since a copy of \fBne\fR is added \fBne\fR must be freed up after
160the call.
161.PP
8b0cefbb
JR
162\&\fIX509_NAME_delete_entry()\fR deletes an entry from \fBname\fR at position
163\&\fBloc\fR. The deleted entry is returned and must be freed up.
984263bc 164.SH "NOTES"
8b0cefbb
JR
165.IX Header "NOTES"
166The use of string types such as \fB\s-1MBSTRING_ASC\s0\fR or \fB\s-1MBSTRING_UTF8\s0\fR
984263bc
MD
167is strongly recommened for the \fBtype\fR parameter. This allows the
168internal code to correctly determine the type of the field and to
169apply length checks according to the relevant standards. This is
170done using \fIASN1_STRING_set_by_NID()\fR.
171.PP
8b0cefbb 172If instead an \s-1ASN1\s0 type is used no checks are performed and the
984263bc
MD
173supplied data in \fBbytes\fR is used directly.
174.PP
175In \fIX509_NAME_add_entry_by_txt()\fR the \fBfield\fR string represents
8b0cefbb 176the field name using OBJ_txt2obj(field, 0).
984263bc
MD
177.PP
178The \fBloc\fR and \fBset\fR parameters determine where a new entry should
179be added. For almost all applications \fBloc\fR can be set to \-1 and \fBset\fR
180to 0. This adds a new entry to the end of \fBname\fR as a single valued
8b0cefbb 181RelativeDistinguishedName (\s-1RDN\s0).
984263bc 182.PP
8b0cefbb 183\&\fBloc\fR actually determines the index where the new entry is inserted:
984263bc
MD
184if it is \-1 it is appended.
185.PP
8b0cefbb
JR
186\&\fBset\fR determines how the new type is added. If it is zero a
187new \s-1RDN\s0 is created.
984263bc 188.PP
8b0cefbb
JR
189If \fBset\fR is \-1 or 1 it is added to the previous or next \s-1RDN\s0
190structure respectively. This will then be a multivalued \s-1RDN:\s0
984263bc
MD
191since multivalues RDNs are very seldom used \fBset\fR is almost
192always set to zero.
193.SH "EXAMPLES"
8b0cefbb 194.IX Header "EXAMPLES"
984263bc
MD
195Create an \fBX509_NAME\fR structure:
196.PP
8b0cefbb 197\&\*(L"C=UK, O=Disorganized Organization, CN=Joe Bloggs\*(R"
984263bc
MD
198.PP
199.Vb 13
200\& X509_NAME *nm;
201\& nm = X509_NAME_new();
202\& if (nm == NULL)
203\& /* Some error */
204\& if (!X509_NAME_add_entry_by_txt(nm, MBSTRING_ASC,
205\& "C", "UK", -1, -1, 0))
206\& /* Error */
207\& if (!X509_NAME_add_entry_by_txt(nm, MBSTRING_ASC,
208\& "O", "Disorganized Organization", -1, -1, 0))
209\& /* Error */
210\& if (!X509_NAME_add_entry_by_txt(nm, MBSTRING_ASC,
211\& "CN", "Joe Bloggs", -1, -1, 0))
212\& /* Error */
213.Ve
214.SH "RETURN VALUES"
8b0cefbb
JR
215.IX Header "RETURN VALUES"
216\&\fIX509_NAME_add_entry_by_txt()\fR, \fIX509_NAME_add_entry_by_OBJ()\fR,
217\&\fIX509_NAME_add_entry_by_NID()\fR and \fIX509_NAME_add_entry()\fR return 1 for
984263bc
MD
218success of 0 if an error occurred.
219.PP
8b0cefbb
JR
220\&\fIX509_NAME_delete_entry()\fR returns either the deleted \fBX509_NAME_ENTRY\fR
221structure of \fB\s-1NULL\s0\fR if an error occurred.
984263bc 222.SH "BUGS"
8b0cefbb
JR
223.IX Header "BUGS"
224\&\fBtype\fR can still be set to \fBV_ASN1_APP_CHOOSE\fR to use a
984263bc
MD
225different algorithm to determine field types. Since this form does
226not understand multicharacter types, performs no length checks and
227can result in invalid field types its use is strongly discouraged.
228.SH "SEE ALSO"
74dab6c2 229.IX Header "SEE ALSO"
8b0cefbb
JR
230\&\fIERR_get_error\fR\|(3), \fId2i_X509_NAME\fR\|(3)
231.SH "HISTORY"
984263bc 232.IX Header "HISTORY"