crypto/openssl/doc/crypto/ASN1_generate_nconf.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 ASN1_generate_nconf, ASN1_generate_v3 - ASN1 generation functions
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/asn1.h>
  10
  11  ASN1_TYPE *ASN1_generate_nconf(char *str, CONF *nconf);
  12  ASN1_TYPE *ASN1_generate_v3(char *str, X509V3_CTX *cnf);
  13
  14 =head1 DESCRIPTION
  15
  16 These functions generate the ASN1 encoding of a string
  17 in an B<ASN1_TYPE> structure.
  18
  19 B<str> contains the string to encode B<nconf> or B<cnf> contains
  20 the optional configuration information where additional strings
  21 will be read from. B<nconf> will typically come from a config
  22 file wherease B<cnf> is obtained from an B<X509V3_CTX> structure
  23 which will typically be used by X509 v3 certificate extension
  24 functions. B<cnf> or B<nconf> can be set to B<NULL> if no additional
  25 configuration will be used.
  26
  27 =head1 GENERATION STRING FORMAT
  28
  29 The actual data encoded is determined by the string B<str> and
  30 the configuration information. The general format of the string
  31 is:
  32
  33 =over 2
  34
  35 =item B<[modifier,]type[:value]>
  36
  37 =back
  38
  39 That is zero or more comma separated modifiers followed by a type
  40 followed by an optional colon and a value. The formats of B<type>,
  41 B<value> and B<modifier> are explained below.
  42
  43 =head2 SUPPORTED TYPES
  44
  45 The supported types are listed below. Unless otherwise specified
  46 only the B<ASCII> format is permissible.
  47
  48 =over 2
  49
  50 =item B<BOOLEAN>, B<BOOL>
  51
  52 This encodes a boolean type. The B<value> string is mandatory and
  53 should be B<TRUE> or B<FALSE>. Additionally B<TRUE>, B<true>, B<Y>,
  54 B<y>, B<YES>, B<yes>, B<FALSE>, B<false>, B<N>, B<n>, B<NO> and B<no>
  55 are acceptable.
  56
  57 =item B<NULL>
  58
  59 Encode the B<NULL> type, the B<value> string must not be present.
  60
  61 =item B<INTEGER>, B<INT>
  62
  63 Encodes an ASN1 B<INTEGER> type. The B<value> string represents
  64 the value of the integer, it can be preceeded by a minus sign and
  65 is normally interpreted as a decimal value unless the prefix B<0x>
  66 is included.
  67
  68 =item B<ENUMERATED>, B<ENUM>
  69
  70 Encodes the ASN1 B<ENUMERATED> type, it is otherwise identical to
  71 B<INTEGER>.
  72
  73 =item B<OBJECT>, B<OID>
  74
  75 Encodes an ASN1 B<OBJECT IDENTIFIER>, the B<value> string can be
  76 a short name, a long name or numerical format.
  77
  78 =item B<UTCTIME>, B<UTC>
  79
  80 Encodes an ASN1 B<UTCTime> structure, the value should be in
  81 the format B<YYMMDDHHMMSSZ>.
  82
  83 =item B<GENERALIZEDTIME>, B<GENTIME>
  84
  85 Encodes an ASN1 B<GeneralizedTime> structure, the value should be in
  86 the format B<YYYYMMDDHHMMSSZ>.
  87
  88 =item B<OCTETSTRING>, B<OCT>
  89
  90 Encodes an ASN1 B<OCTET STRING>. B<value> represents the contents
  91 of this structure, the format strings B<ASCII> and B<HEX> can be
  92 used to specify the format of B<value>.
  93
  94 =item B<BITSTRING>, B<BITSTR>
  95
  96 Encodes an ASN1 B<BIT STRING>. B<value> represents the contents
  97 of this structure, the format strings B<ASCII>, B<HEX> and B<BITLIST>
  98 can be used to specify the format of B<value>.
  99
 100 If the format is anything other than B<BITLIST> the number of unused
 101 bits is set to zero.
 102
 103 =item B<UNIVERSALSTRING>, B<UNIV>, B<IA5>, B<IA5STRING>, B<UTF8>,
 104 B<UTF8String>, B<BMP>, B<BMPSTRING>, B<VISIBLESTRING>,
 105 B<VISIBLE>, B<PRINTABLESTRING>, B<PRINTABLE>, B<T61>,
 106 B<T61STRING>, B<TELETEXSTRING>, B<GeneralString>
 107
 108 These encode the corresponding string types. B<value> represents the
 109 contents of this structure. The format can be B<ASCII> or B<UTF8>.
 110
 111 =item B<SEQUENCE>, B<SEQ>, B<SET>
 112
 113 Formats the result as an ASN1 B<SEQUENCE> or B<SET> type. B<value>
 114 should be a section name which will contain the contents. The
 115 field names in the section are ignored and the values are in the
 116 generated string format. If B<value> is absent then an empty SEQUENCE
 117 will be encoded.
 118
 119 =back
 120
 121 =head2 MODIFIERS
 122
 123 Modifiers affect the following structure, they can be used to
 124 add EXPLICIT or IMPLICIT tagging, add wrappers or to change
 125 the string format of the final type and value. The supported
 126 formats are documented below.
 127
 128 =over 2
 129
 130 =item B<EXPLICIT>, B<EXP>
 131
 132 Add an explicit tag to the following structure. This string
 133 should be followed by a colon and the tag value to use as a
 134 decimal value.
 135
 136 By following the number with B<U>, B<A>, B<P> or B<C> UNIVERSAL,
 137 APPLICATION, PRIVATE or CONTEXT SPECIFIC tagging can be used,
 138 the default is CONTEXT SPECIFIC.
 139
 140 =item B<IMPLICIT>, B<IMP>
 141
 142 This is the same as B<EXPLICIT> except IMPLICIT tagging is used
 143 instead.
 144
 145 =item B<OCTWRAP>, B<SEQWRAP>, B<SETWRAP>, B<BITWRAP>
 146
 147 The following structure is surrounded by an OCTET STRING, a SEQUENCE,
 148 a SET or a BIT STRING respectively. For a BIT STRING the number of unused
 149 bits is set to zero.
 150
 151 =item B<FORMAT>
 152
 153 This specifies the format of the ultimate value. It should be followed
 154 by a colon and one of the strings B<ASCII>, B<UTF8>, B<HEX> or B<BITLIST>.
 155
 156 If no format specifier is included then B<ASCII> is used. If B<UTF8> is
 157 specified then the value string must be a valid B<UTF8> string. For B<HEX> the
 158 output must be a set of hex digits. B<BITLIST> (which is only valid for a BIT
 159 STRING) is a comma separated list of the indices of the set bits, all other
 160 bits are zero.
 161
 162 =back
 163
 164 =head1 EXAMPLES
 165
 166 A simple IA5String:
 167
 168  IA5STRING:Hello World
 169
 170 An IA5String explicitly tagged:
 171
 172  EXPLICIT:0,IA5STRING:Hello World
 173
 174 An IA5String explicitly tagged using APPLICATION tagging:
 175
 176  EXPLICIT:0A,IA5STRING:Hello World
 177
 178 A BITSTRING with bits 1 and 5 set and all others zero:
 179
 180  FORMAT:BITLIST,BITSTRING:1,5
 181
 182 A more complex example using a config file to produce a
 183 SEQUENCE consiting of a BOOL an OID and a UTF8String:
 184
 185  asn1 = SEQUENCE:seq_section
 186
 187  [seq_section]
 188
 189  field1 = BOOLEAN:TRUE
 190  field2 = OID:commonName
 191  field3 = UTF8:Third field
 192
 193 This example produces an RSAPrivateKey structure, this is the
 194 key contained in the file client.pem in all OpenSSL distributions
 195 (note: the field names such as 'coeff' are ignored and are present just
 196 for clarity):
 197
 198  asn1=SEQUENCE:private_key
 199  [private_key]
 200  version=INTEGER:0
 201
 202  n=INTEGER:0xBB6FE79432CC6EA2D8F970675A5A87BFBE1AFF0BE63E879F2AFFB93644\
 203  D4D2C6D000430DEC66ABF47829E74B8C5108623A1C0EE8BE217B3AD8D36D5EB4FCA1D9
 204
 205  e=INTEGER:0x010001
 206
 207  d=INTEGER:0x6F05EAD2F27FFAEC84BEC360C4B928FD5F3A9865D0FCAAD291E2A52F4A\
 208  F810DC6373278C006A0ABBA27DC8C63BF97F7E666E27C5284D7D3B1FFFE16B7A87B51D
 209
 210  p=INTEGER:0xF3929B9435608F8A22C208D86795271D54EBDFB09DDEF539AB083DA912\
 211  D4BD57
 212
 213  q=INTEGER:0xC50016F89DFF2561347ED1186A46E150E28BF2D0F539A1594BBD7FE467\
 214  46EC4F
 215
 216  exp1=INTEGER:0x9E7D4326C924AFC1DEA40B45650134966D6F9DFA3A7F9D698CD4ABEA\
 217  9C0A39B9
 218
 219  exp2=INTEGER:0xBA84003BB95355AFB7C50DF140C60513D0BA51D637272E355E397779\
 220  E7B2458F
 221
 222  coeff=INTEGER:0x30B9E4F2AFA5AC679F920FC83F1F2DF1BAF1779CF989447FABC2F5\
 223  628657053A
 224
 225 This example is the corresponding public key in a SubjectPublicKeyInfo
 226 structure:
 227
 228  # Start with a SEQUENCE
 229  asn1=SEQUENCE:pubkeyinfo
 230
 231  # pubkeyinfo contains an algorithm identifier and the public key wrapped
 232  # in a BIT STRING
 233  [pubkeyinfo]
 234  algorithm=SEQUENCE:rsa_alg
 235  pubkey=BITWRAP,SEQUENCE:rsapubkey
 236
 237  # algorithm ID for RSA is just an OID and a NULL
 238  [rsa_alg]
 239  algorithm=OID:rsaEncryption
 240  parameter=NULL
 241
 242  # Actual public key: modulus and exponent
 243  [rsapubkey]
 244  n=INTEGER:0xBB6FE79432CC6EA2D8F970675A5A87BFBE1AFF0BE63E879F2AFFB93644\
 245  D4D2C6D000430DEC66ABF47829E74B8C5108623A1C0EE8BE217B3AD8D36D5EB4FCA1D9
 246
 247  e=INTEGER:0x010001
 248
 249 =head1 RETURN VALUES
 250
 251 ASN1_generate_nconf() and ASN1_generate_v3() return the encoded
 252 data as an B<ASN1_TYPE> structure or B<NULL> if an error occurred.
 253
 254 The error codes that can be obtained by L<ERR_get_error(3)|ERR_get_error(3)>.
 255
 256 =head1 SEE ALSO
 257
 258 L<ERR_get_error(3)|ERR_get_error(3)>
 259
 260 =head1 HISTORY
 261
 262 ASN1_generate_nconf() and ASN1_generate_v3() were added to OpenSSL 0.9.8
 263
 264 =cut