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