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