5 ASN1_generate_nconf, ASN1_generate_v3 - ASN1 generation functions
9 ASN1_TYPE *ASN1_generate_nconf(char *str, CONF *nconf);
10 ASN1_TYPE *ASN1_generate_v3(char *str, X509V3_CTX *cnf);
14 These functions generate the ASN1 encoding of a string
15 in an B<ASN1_TYPE> structure.
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.
25 =head1 GENERATION STRING FORMAT
27 The actual data encoded is determined by the string B<str> and
28 the configuration information. The general format of the string
33 =item B<[modifier,]type[:value]>
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.
41 =head2 SUPPORTED TYPES
43 The supported types are listed below. Unless otherwise specified
44 only the B<ASCII> format is permissible.
48 =item B<BOOLEAN>, B<BOOL>
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>
57 Encode the B<NULL> type, the B<value> string must not be present.
59 =item B<INTEGER>, B<INT>
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>
66 =item B<ENUMERATED>, B<ENUM>
68 Encodes the ASN1 B<ENUMERATED> type, it is otherwise identical to
71 =item B<OBJECT>, B<OID>
73 Encodes an ASN1 B<OBJECT IDENTIFIER>, the B<value> string can be
74 a short name, a long name or numerical format.
76 =item B<UTCTIME>, B<UTC>
78 Encodes an ASN1 B<UTCTime> structure, the value should be in
79 the format B<YYMMDDHHMMSSZ>.
81 =item B<GENERALIZEDTIME>, B<GENTIME>
83 Encodes an ASN1 B<GeneralizedTime> structure, the value should be in
84 the format B<YYYYMMDDHHMMSSZ>.
86 =item B<OCTETSTRING>, B<OCT>
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>.
92 =item B<BITSTRING>, B<BITSTR>
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>.
98 If the format is anything other than B<BITLIST> the number of unused
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>
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>.
109 =item B<SEQUENCE>, B<SEQ>, B<SET>
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
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.
128 =item B<EXPLICIT>, B<EXP>
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
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.
138 =item B<IMPLICIT>, B<IMP>
140 This is the same as B<EXPLICIT> except IMPLICIT tagging is used
143 =item B<OCTWRAP>, B<SEQWRAP>, B<SETWRAP>, B<BITWRAP>
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
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>.
154 If no format specifier is included then B<ASCII> is used. If B<UTF8> is specified
155 then the value string must be a valid B<UTF8> string. For B<HEX> the output must
156 be a set of hex digits. B<BITLIST> (which is only valid for a BIT STRING) is a
157 comma separated list of set bits.
165 IA5STRING:Hello World
167 An IA5String explicitly tagged:
169 EXPLICIT:0,IA5STRING:Hello World
171 An IA5String explicitly tagged using APPLICATION tagging:
173 EXPLICIT:0A,IA5STRING:Hello World
175 A more complex example using a config file to produce a
176 SEQUENCE consiting of a BOOL an OID and a UTF8String:
178 asn1 = SEQUENCE:seq_section
182 field1 = BOOLEAN:TRUE
183 field2 = OID:commonName
184 field3 = UTF8:Third field
186 This example produces an RSAPrivateKey structure, this is the
187 key contained in the file client.pem in all OpenSSL distributions
188 (note: the field names such as 'coeff' are ignored and are present just
191 asn1=SEQUENCE:private_key
195 n=INTEGER:0xBB6FE79432CC6EA2D8F970675A5A87BFBE1AFF0BE63E879F2AFFB93644\
196 D4D2C6D000430DEC66ABF47829E74B8C5108623A1C0EE8BE217B3AD8D36D5EB4FCA1D9
200 d=INTEGER:0x6F05EAD2F27FFAEC84BEC360C4B928FD5F3A9865D0FCAAD291E2A52F4A\
201 F810DC6373278C006A0ABBA27DC8C63BF97F7E666E27C5284D7D3B1FFFE16B7A87B51D
203 p=INTEGER:0xF3929B9435608F8A22C208D86795271D54EBDFB09DDEF539AB083DA912\
206 q=INTEGER:0xC50016F89DFF2561347ED1186A46E150E28BF2D0F539A1594BBD7FE467\
209 exp1=INTEGER:0x9E7D4326C924AFC1DEA40B45650134966D6F9DFA3A7F9D698CD4ABEA\
212 exp2=INTEGER:0xBA84003BB95355AFB7C50DF140C60513D0BA51D637272E355E397779\
215 coeff=INTEGER:0x30B9E4F2AFA5AC679F920FC83F1F2DF1BAF1779CF989447FABC2F5\
218 This example is the corresponding public key in a SubjectPublicKeyInfo
221 # Start with a SEQUENCE
222 asn1=SEQUENCE:pubkeyinfo
224 # pubkeyinfo contains an algorithm identifier and the public key wrapped
227 algorithm=SEQUENCE:rsa_alg
228 pubkey=BITWRAP,SEQUENCE:rsapubkey
230 # algorithm ID for RSA is just an OID and a NULL
232 algorithm=OID:rsaEncryption
235 # Actual public key: modulus and exponent
237 n=INTEGER:0xBB6FE79432CC6EA2D8F970675A5A87BFBE1AFF0BE63E879F2AFFB93644\
238 D4D2C6D000430DEC66ABF47829E74B8C5108623A1C0EE8BE217B3AD8D36D5EB4FCA1D9
244 ASN1_generate_nconf() and ASN1_generate_v3() return the encoded
245 data as an B<ASN1_TYPE> structure or B<NULL> if an error occurred.
247 The error codes that can be obtained by L<ERR_get_error(3)|ERR_get_error(3)>.
251 L<ERR_get_error(3)|ERR_get_error(3)>
255 ASN1_generate_nconf() and ASN1_generate_v3() were added to OpenSSL 0.9.8