250 lines
8.8 KiB
Groff
Executable File
250 lines
8.8 KiB
Groff
Executable File
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
|
|
.\"
|
|
.\" Standard preamble:
|
|
.\" ========================================================================
|
|
.de Sp \" Vertical space (when we can't use .PP)
|
|
.if t .sp .5v
|
|
.if n .sp
|
|
..
|
|
.de Vb \" Begin verbatim text
|
|
.ft CW
|
|
.nf
|
|
.ne \\$1
|
|
..
|
|
.de Ve \" End verbatim text
|
|
.ft R
|
|
.fi
|
|
..
|
|
.\" Set up some character translations and predefined strings. \*(-- will
|
|
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
|
|
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
|
|
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
|
|
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
|
|
.\" nothing in troff, for use with C<>.
|
|
.tr \(*W-
|
|
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
|
.ie n \{\
|
|
. ds -- \(*W-
|
|
. ds PI pi
|
|
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
|
|
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
|
|
. ds L" ""
|
|
. ds R" ""
|
|
. ds C` ""
|
|
. ds C' ""
|
|
'br\}
|
|
.el\{\
|
|
. ds -- \|\(em\|
|
|
. ds PI \(*p
|
|
. ds L" ``
|
|
. ds R" ''
|
|
'br\}
|
|
.\"
|
|
.\" Escape single quotes in literal strings from groff's Unicode transform.
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\"
|
|
.\" If the F register is turned on, we'll generate index entries on stderr for
|
|
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
|
|
.\" entries marked with X<> in POD. Of course, you'll have to process the
|
|
.\" output yourself in some meaningful fashion.
|
|
.ie \nF \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. nr % 0
|
|
. rr F
|
|
.\}
|
|
.el \{\
|
|
. de IX
|
|
..
|
|
.\}
|
|
.\"
|
|
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
|
.\" Fear. Run. Save yourself. No user-serviceable parts.
|
|
. \" fudge factors for nroff and troff
|
|
.if n \{\
|
|
. ds #H 0
|
|
. ds #V .8m
|
|
. ds #F .3m
|
|
. ds #[ \f1
|
|
. ds #] \fP
|
|
.\}
|
|
.if t \{\
|
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
|
. ds #V .6m
|
|
. ds #F 0
|
|
. ds #[ \&
|
|
. ds #] \&
|
|
.\}
|
|
. \" simple accents for nroff and troff
|
|
.if n \{\
|
|
. ds ' \&
|
|
. ds ` \&
|
|
. ds ^ \&
|
|
. ds , \&
|
|
. ds ~ ~
|
|
. ds /
|
|
.\}
|
|
.if t \{\
|
|
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
|
|
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
|
|
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
|
|
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
|
|
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
|
|
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
|
|
.\}
|
|
. \" troff and (daisy-wheel) nroff accents
|
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
|
.ds ae a\h'-(\w'a'u*4/10)'e
|
|
.ds Ae A\h'-(\w'A'u*4/10)'E
|
|
. \" corrections for vroff
|
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
|
. \" for low resolution devices (crt and lpr)
|
|
.if \n(.H>23 .if \n(.V>19 \
|
|
\{\
|
|
. ds : e
|
|
. ds 8 ss
|
|
. ds o a
|
|
. ds d- d\h'-1'\(ga
|
|
. ds D- D\h'-1'\(hy
|
|
. ds th \o'bp'
|
|
. ds Th \o'LP'
|
|
. ds ae ae
|
|
. ds Ae AE
|
|
.\}
|
|
.rm #[ #] #H #V #F C
|
|
.\" ========================================================================
|
|
.\"
|
|
.IX Title "X509_NAME_ADD_ENTRY_BY_TXT 3"
|
|
.TH X509_NAME_ADD_ENTRY_BY_TXT 3 "2020-03-02" "3.0.0-dev" "OpenSSL"
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
|
.\" way too many mistakes in technical documents.
|
|
.if n .ad l
|
|
.nh
|
|
.SH "NAME"
|
|
X509_NAME_add_entry_by_txt, X509_NAME_add_entry_by_OBJ, X509_NAME_add_entry_by_NID,
|
|
X509_NAME_add_entry, X509_NAME_delete_entry \- X509_NAME modification functions
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.Vb 1
|
|
\& #include <openssl/x509.h>
|
|
\&
|
|
\& 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);
|
|
\&
|
|
\& int X509_NAME_add_entry_by_OBJ(X509_NAME *name, const ASN1_OBJECT *obj, int type,
|
|
\& const unsigned char *bytes, int len, int loc, int set);
|
|
\&
|
|
\& int X509_NAME_add_entry_by_NID(X509_NAME *name, int nid, int type,
|
|
\& const unsigned char *bytes, int len, int loc, int set);
|
|
\&
|
|
\& int X509_NAME_add_entry(X509_NAME *name, const X509_NAME_ENTRY *ne, int loc, int set);
|
|
\&
|
|
\& X509_NAME_ENTRY *X509_NAME_delete_entry(X509_NAME *name, int loc);
|
|
.Ve
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
\&\fIX509_NAME_add_entry_by_txt()\fR, \fIX509_NAME_add_entry_by_OBJ()\fR and
|
|
\&\fIX509_NAME_add_entry_by_NID()\fR add a field whose name is defined
|
|
by a string \fBfield\fR, an object \fBobj\fR or a \s-1NID\s0 \fBnid\fR respectively.
|
|
The field value to be added is in \fBbytes\fR of length \fBlen\fR. If
|
|
\&\fBlen\fR is \-1 then the field length is calculated internally using
|
|
strlen(bytes).
|
|
.PP
|
|
The type of field is determined by \fBtype\fR which can either be a
|
|
definition of the type of \fBbytes\fR (such as \fB\s-1MBSTRING_ASC\s0\fR) or a
|
|
standard \s-1ASN1\s0 type (such as \fBV_ASN1_IA5STRING\fR). The new entry is
|
|
added to a position determined by \fBloc\fR and \fBset\fR.
|
|
.PP
|
|
\&\fIX509_NAME_add_entry()\fR adds a copy of \fBX509_NAME_ENTRY\fR structure \fBne\fR
|
|
to \fBname\fR. The new entry is added to a position determined by \fBloc\fR
|
|
and \fBset\fR. Since a copy of \fBne\fR is added \fBne\fR must be freed up after
|
|
the call.
|
|
.PP
|
|
\&\fIX509_NAME_delete_entry()\fR deletes an entry from \fBname\fR at position
|
|
\&\fBloc\fR. The deleted entry is returned and must be freed up.
|
|
.SH "NOTES"
|
|
.IX Header "NOTES"
|
|
The use of string types such as \fB\s-1MBSTRING_ASC\s0\fR or \fB\s-1MBSTRING_UTF8\s0\fR
|
|
is strongly recommended for the \fBtype\fR parameter. This allows the
|
|
internal code to correctly determine the type of the field and to
|
|
apply length checks according to the relevant standards. This is
|
|
done using \fIASN1_STRING_set_by_NID()\fR.
|
|
.PP
|
|
If instead an \s-1ASN1\s0 type is used no checks are performed and the
|
|
supplied data in \fBbytes\fR is used directly.
|
|
.PP
|
|
In \fIX509_NAME_add_entry_by_txt()\fR the \fBfield\fR string represents
|
|
the field name using OBJ_txt2obj(field, 0).
|
|
.PP
|
|
The \fBloc\fR and \fBset\fR parameters determine where a new entry should
|
|
be added. For almost all applications \fBloc\fR can be set to \-1 and \fBset\fR
|
|
to 0. This adds a new entry to the end of \fBname\fR as a single valued
|
|
RelativeDistinguishedName (\s-1RDN\s0).
|
|
.PP
|
|
\&\fBloc\fR actually determines the index where the new entry is inserted:
|
|
if it is \-1 it is appended.
|
|
.PP
|
|
\&\fBset\fR determines how the new type is added. If it is zero a
|
|
new \s-1RDN\s0 is created.
|
|
.PP
|
|
If \fBset\fR is \-1 or 1 it is added to the previous or next \s-1RDN\s0
|
|
structure respectively. This will then be a multivalued \s-1RDN:\s0
|
|
since multivalues RDNs are very seldom used \fBset\fR is almost
|
|
always set to zero.
|
|
.SH "RETURN VALUES"
|
|
.IX Header "RETURN VALUES"
|
|
\&\fIX509_NAME_add_entry_by_txt()\fR, \fIX509_NAME_add_entry_by_OBJ()\fR,
|
|
\&\fIX509_NAME_add_entry_by_NID()\fR and \fIX509_NAME_add_entry()\fR return 1 for
|
|
success of 0 if an error occurred.
|
|
.PP
|
|
\&\fIX509_NAME_delete_entry()\fR returns either the deleted \fBX509_NAME_ENTRY\fR
|
|
structure of \fB\s-1NULL\s0\fR if an error occurred.
|
|
.SH "EXAMPLES"
|
|
.IX Header "EXAMPLES"
|
|
Create an \fBX509_NAME\fR structure:
|
|
.PP
|
|
\&\*(L"C=UK, O=Disorganized Organization, CN=Joe Bloggs\*(R"
|
|
.PP
|
|
.Vb 1
|
|
\& X509_NAME *nm;
|
|
\&
|
|
\& nm = X509_NAME_new();
|
|
\& if (nm == NULL)
|
|
\& /* Some error */
|
|
\& if (!X509_NAME_add_entry_by_txt(nm, "C", MBSTRING_ASC,
|
|
\& "UK", \-1, \-1, 0))
|
|
\& /* Error */
|
|
\& if (!X509_NAME_add_entry_by_txt(nm, "O", MBSTRING_ASC,
|
|
\& "Disorganized Organization", \-1, \-1, 0))
|
|
\& /* Error */
|
|
\& if (!X509_NAME_add_entry_by_txt(nm, "CN", MBSTRING_ASC,
|
|
\& "Joe Bloggs", \-1, \-1, 0))
|
|
\& /* Error */
|
|
.Ve
|
|
.SH "BUGS"
|
|
.IX Header "BUGS"
|
|
\&\fBtype\fR can still be set to \fBV_ASN1_APP_CHOOSE\fR to use a
|
|
different algorithm to determine field types. Since this form does
|
|
not understand multicharacter types, performs no length checks and
|
|
can result in invalid field types its use is strongly discouraged.
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fIERR_get_error\fR\|(3), \fId2i_X509_NAME\fR\|(3)
|
|
.SH "COPYRIGHT"
|
|
.IX Header "COPYRIGHT"
|
|
Copyright 2002\-2016 The OpenSSL Project Authors. All Rights Reserved.
|
|
.PP
|
|
Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
|
|
this file except in compliance with the License. You can obtain a copy
|
|
in the file \s-1LICENSE\s0 in the source distribution or at
|
|
<https://www.openssl.org/source/license.html>.
|