secure/lib/libcrypto/man/X509_NAME_add_entry_by_txt.3

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