29d151366d6e0b38dc08cc86b90962bd8fc96aae
[openssl.git] / 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>, B<NUMERICSTRING>,
107 B<NUMERIC>
108
109 These encode the corresponding string types. B<value> represents the
110 contents of this structure. The format can be B<ASCII> or B<UTF8>.
111
112 =item B<SEQUENCE>, B<SEQ>, B<SET>
113
114 Formats the result as an ASN1 B<SEQUENCE> or B<SET> type. B<value>
115 should be a section name which will contain the contents. The
116 field names in the section are ignored and the values are in the
117 generated string format. If B<value> is absent then an empty SEQUENCE
118 will be encoded.
119
120 =back
121
122 =head2 MODIFIERS
123
124 Modifiers affect the following structure, they can be used to
125 add EXPLICIT or IMPLICIT tagging, add wrappers or to change
126 the string format of the final type and value. The supported
127 formats are documented below.
128
129 =over 2
130
131 =item B<EXPLICIT>, B<EXP>
132
133 Add an explicit tag to the following structure. This string
134 should be followed by a colon and the tag value to use as a
135 decimal value.
136
137 By following the number with B<U>, B<A>, B<P> or B<C> UNIVERSAL,
138 APPLICATION, PRIVATE or CONTEXT SPECIFIC tagging can be used,
139 the default is CONTEXT SPECIFIC.
140
141 =item B<IMPLICIT>, B<IMP>
142
143 This is the same as B<EXPLICIT> except IMPLICIT tagging is used
144 instead.
145
146 =item B<OCTWRAP>, B<SEQWRAP>, B<SETWRAP>, B<BITWRAP>
147
148 The following structure is surrounded by an OCTET STRING, a SEQUENCE,
149 a SET or a BIT STRING respectively. For a BIT STRING the number of unused
150 bits is set to zero.
151
152 =item B<FORMAT>
153
154 This specifies the format of the ultimate value. It should be followed
155 by a colon and one of the strings B<ASCII>, B<UTF8>, B<HEX> or B<BITLIST>.
156
157 If no format specifier is included then B<ASCII> is used. If B<UTF8> is specified
158 then the value string must be a valid B<UTF8> string. For B<HEX> the output must
159 be a set of hex digits. B<BITLIST> (which is only valid for a BIT STRING) is a
160 comma separated list of set bits.
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 more complex example using a config file to produce a
179 SEQUENCE consiting of a BOOL an OID and a UTF8String:
180
181  asn1 = SEQUENCE:seq_section
182
183  [seq_section]
184
185  field1 = BOOLEAN:TRUE
186  field2 = OID:commonName
187  field3 = UTF8:Third field
188
189 This example produces an RSAPrivateKey structure, this is the
190 key contained in the file client.pem in all OpenSSL distributions
191 (note: the field names such as 'coeff' are ignored and are present just
192 for clarity):
193
194  asn1=SEQUENCE:private_key
195  [private_key]
196  version=INTEGER:0
197
198  n=INTEGER:0xBB6FE79432CC6EA2D8F970675A5A87BFBE1AFF0BE63E879F2AFFB93644\
199  D4D2C6D000430DEC66ABF47829E74B8C5108623A1C0EE8BE217B3AD8D36D5EB4FCA1D9
200
201  e=INTEGER:0x010001
202
203  d=INTEGER:0x6F05EAD2F27FFAEC84BEC360C4B928FD5F3A9865D0FCAAD291E2A52F4A\
204  F810DC6373278C006A0ABBA27DC8C63BF97F7E666E27C5284D7D3B1FFFE16B7A87B51D
205
206  p=INTEGER:0xF3929B9435608F8A22C208D86795271D54EBDFB09DDEF539AB083DA912\
207  D4BD57
208
209  q=INTEGER:0xC50016F89DFF2561347ED1186A46E150E28BF2D0F539A1594BBD7FE467\
210  46EC4F
211
212  exp1=INTEGER:0x9E7D4326C924AFC1DEA40B45650134966D6F9DFA3A7F9D698CD4ABEA\
213  9C0A39B9
214
215  exp2=INTEGER:0xBA84003BB95355AFB7C50DF140C60513D0BA51D637272E355E397779\
216  E7B2458F
217
218  coeff=INTEGER:0x30B9E4F2AFA5AC679F920FC83F1F2DF1BAF1779CF989447FABC2F5\
219  628657053A
220
221 This example is the corresponding public key in a SubjectPublicKeyInfo
222 structure:
223
224  # Start with a SEQUENCE
225  asn1=SEQUENCE:pubkeyinfo
226
227  # pubkeyinfo contains an algorithm identifier and the public key wrapped
228  # in a BIT STRING
229  [pubkeyinfo]
230  algorithm=SEQUENCE:rsa_alg
231  pubkey=BITWRAP,SEQUENCE:rsapubkey
232
233  # algorithm ID for RSA is just an OID and a NULL
234  [rsa_alg]
235  algorithm=OID:rsaEncryption
236  parameter=NULL
237
238  # Actual public key: modulus and exponent
239  [rsapubkey]
240  n=INTEGER:0xBB6FE79432CC6EA2D8F970675A5A87BFBE1AFF0BE63E879F2AFFB93644\
241  D4D2C6D000430DEC66ABF47829E74B8C5108623A1C0EE8BE217B3AD8D36D5EB4FCA1D9
242
243  e=INTEGER:0x010001
244
245 =head1 RETURN VALUES
246
247 ASN1_generate_nconf() and ASN1_generate_v3() return the encoded
248 data as an B<ASN1_TYPE> structure or B<NULL> if an error occurred.
249
250 The error codes that can be obtained by L<ERR_get_error(3)|ERR_get_error(3)>.
251
252 =head1 SEE ALSO
253
254 L<ERR_get_error(3)|ERR_get_error(3)>
255
256 =head1 HISTORY
257
258 ASN1_generate_nconf() and ASN1_generate_v3() were added to OpenSSL 0.9.8
259
260 =cut