Deleted Added
sdiff udiff text old ( 206048 ) new ( 215698 )
full compact
1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.37
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
13.de Sp \" Vertical space (when we can't use .PP)
14.if t .sp .5v
15.if n .sp
16..
17.de Vb \" Begin verbatim text
18.ft CW
19.nf
20.ne \\$1
21..
22.de Ve \" End verbatim text
23.ft R
24.fi
25..
26.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28.\" double quote, and \*(R" will give a right double quote. | will give a
29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31.\" expand to `' in nroff, nothing in troff, for use with C<>.
32.tr \(*W-|\(bv\*(Tr
33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34.ie n \{\
35. ds -- \(*W-
36. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39. ds L" ""
40. ds R" ""
41. ds C` ""
42. ds C' ""
43'br\}
44.el\{\
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
49'br\}
50.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for
52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53.\" entries marked with X<> in POD. Of course, you'll have to process the
54.\" output yourself in some meaningful fashion.
55.if \nF \{\
56. de IX
57. tm Index:\\$1\t\\n%\t"\\$2"
58..
59. nr % 0
60. rr F
61.\}
62.\"
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64.\" way too many mistakes in technical documents.
65.hy 0
66.if n .na
67.\"
68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69.\" Fear. Run. Save yourself. No user-serviceable parts.
70. \" fudge factors for nroff and troff
71.if n \{\
72. ds #H 0
73. ds #V .8m
74. ds #F .3m
75. ds #[ \f1

--- 48 unchanged lines hidden (view full) ---

124. ds Th \o'LP'
125. ds ae ae
126. ds Ae AE
127.\}
128.rm #[ #] #H #V #F C
129.\" ========================================================================
130.\"
131.IX Title "ASN1_generate_nconf 3"
132.TH ASN1_generate_nconf 3 "2010-03-24" "0.9.8n" "OpenSSL"
133.SH "NAME"
134ASN1_generate_nconf, ASN1_generate_v3 \- ASN1 generation functions
135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS"
137.Vb 2
138\& ASN1_TYPE *ASN1_generate_nconf(char *str, CONF *nconf);
139\& ASN1_TYPE *ASN1_generate_v3(char *str, X509V3_CTX *cnf);
140.Ve
141.SH "DESCRIPTION"
142.IX Header "DESCRIPTION"
143These functions generate the \s-1ASN1\s0 encoding of a string
144in an \fB\s-1ASN1_TYPE\s0\fR structure.
145.PP

--- 10 unchanged lines hidden (view full) ---

156the configuration information. The general format of the string
157is:
158.IP "\fB[modifier,]type[:value]\fR" 2
159.IX Item "[modifier,]type[:value]"
160.PP
161That is zero or more comma separated modifiers followed by a type
162followed by an optional colon and a value. The formats of \fBtype\fR,
163\&\fBvalue\fR and \fBmodifier\fR are explained below.
164.Sh "\s-1SUPPORTED\s0 \s-1TYPES\s0"
165.IX Subsection "SUPPORTED TYPES"
166The supported types are listed below. Unless otherwise specified
167only the \fB\s-1ASCII\s0\fR format is permissible.
168.IP "\fB\s-1BOOLEAN\s0\fR, \fB\s-1BOOL\s0\fR" 2
169.IX Item "BOOLEAN, BOOL"
170This encodes a boolean type. The \fBvalue\fR string is mandatory and
171should be \fB\s-1TRUE\s0\fR or \fB\s-1FALSE\s0\fR. Additionally \fB\s-1TRUE\s0\fR, \fBtrue\fR, \fBY\fR,
172\&\fBy\fR, \fB\s-1YES\s0\fR, \fByes\fR, \fB\s-1FALSE\s0\fR, \fBfalse\fR, \fBN\fR, \fBn\fR, \fB\s-1NO\s0\fR and \fBno\fR
173are acceptable.
174.IP "\fB\s-1NULL\s0\fR" 2
175.IX Item "NULL"
176Encode the \fB\s-1NULL\s0\fR type, the \fBvalue\fR string must not be present.
177.IP "\fB\s-1INTEGER\s0\fR, \fB\s-1INT\s0\fR" 2
178.IX Item "INTEGER, INT"
179Encodes an \s-1ASN1\s0 \fB\s-1INTEGER\s0\fR type. The \fBvalue\fR string represents
180the value of the integer, it can be preceeded by a minus sign and
181is normally interpreted as a decimal value unless the prefix \fB0x\fR

--- 4 unchanged lines hidden (view full) ---

186\&\fB\s-1INTEGER\s0\fR.
187.IP "\fB\s-1OBJECT\s0\fR, \fB\s-1OID\s0\fR" 2
188.IX Item "OBJECT, OID"
189Encodes an \s-1ASN1\s0 \fB\s-1OBJECT\s0 \s-1IDENTIFIER\s0\fR, the \fBvalue\fR string can be
190a short name, a long name or numerical format.
191.IP "\fB\s-1UTCTIME\s0\fR, \fB\s-1UTC\s0\fR" 2
192.IX Item "UTCTIME, UTC"
193Encodes an \s-1ASN1\s0 \fBUTCTime\fR structure, the value should be in
194the format \fB\s-1YYMMDDHHMMSSZ\s0\fR.
195.IP "\fB\s-1GENERALIZEDTIME\s0\fR, \fB\s-1GENTIME\s0\fR" 2
196.IX Item "GENERALIZEDTIME, GENTIME"
197Encodes an \s-1ASN1\s0 \fBGeneralizedTime\fR structure, the value should be in
198the format \fB\s-1YYYYMMDDHHMMSSZ\s0\fR.
199.IP "\fB\s-1OCTETSTRING\s0\fR, \fB\s-1OCT\s0\fR" 2
200.IX Item "OCTETSTRING, OCT"
201Encodes an \s-1ASN1\s0 \fB\s-1OCTET\s0 \s-1STRING\s0\fR. \fBvalue\fR represents the contents
202of this structure, the format strings \fB\s-1ASCII\s0\fR and \fB\s-1HEX\s0\fR can be
203used to specify the format of \fBvalue\fR.
204.IP "\fB\s-1BITSTRING\s0\fR, \fB\s-1BITSTR\s0\fR" 2
205.IX Item "BITSTRING, BITSTR"
206Encodes an \s-1ASN1\s0 \fB\s-1BIT\s0 \s-1STRING\s0\fR. \fBvalue\fR represents the contents

--- 8 unchanged lines hidden (view full) ---

215contents of this structure. The format can be \fB\s-1ASCII\s0\fR or \fB\s-1UTF8\s0\fR.
216.IP "\fB\s-1SEQUENCE\s0\fR, \fB\s-1SEQ\s0\fR, \fB\s-1SET\s0\fR" 2
217.IX Item "SEQUENCE, SEQ, SET"
218Formats the result as an \s-1ASN1\s0 \fB\s-1SEQUENCE\s0\fR or \fB\s-1SET\s0\fR type. \fBvalue\fR
219should be a section name which will contain the contents. The
220field names in the section are ignored and the values are in the
221generated string format. If \fBvalue\fR is absent then an empty \s-1SEQUENCE\s0
222will be encoded.
223.Sh "\s-1MODIFIERS\s0"
224.IX Subsection "MODIFIERS"
225Modifiers affect the following structure, they can be used to
226add \s-1EXPLICIT\s0 or \s-1IMPLICIT\s0 tagging, add wrappers or to change
227the string format of the final type and value. The supported
228formats are documented below.
229.IP "\fB\s-1EXPLICIT\s0\fR, \fB\s-1EXP\s0\fR" 2
230.IX Item "EXPLICIT, EXP"
231Add an explicit tag to the following structure. This string

--- 48 unchanged lines hidden (view full) ---

280\& FORMAT:BITLIST,BITSTRING:1,5
281.Ve
282.PP
283A more complex example using a config file to produce a
284\&\s-1SEQUENCE\s0 consiting of a \s-1BOOL\s0 an \s-1OID\s0 and a UTF8String:
285.PP
286.Vb 1
287\& asn1 = SEQUENCE:seq_section
288.Ve
289.PP
290.Vb 1
291\& [seq_section]
292.Ve
293.PP
294.Vb 3
295\& field1 = BOOLEAN:TRUE
296\& field2 = OID:commonName
297\& field3 = UTF8:Third field
298.Ve
299.PP
300This example produces an RSAPrivateKey structure, this is the
301key contained in the file client.pem in all OpenSSL distributions
302(note: the field names such as 'coeff' are ignored and are present just
303for clarity):
304.PP
305.Vb 3
306\& asn1=SEQUENCE:private_key
307\& [private_key]
308\& version=INTEGER:0
309.Ve
310.PP
311.Vb 2
312\& n=INTEGER:0xBB6FE79432CC6EA2D8F970675A5A87BFBE1AFF0BE63E879F2AFFB93644\e
313\& D4D2C6D000430DEC66ABF47829E74B8C5108623A1C0EE8BE217B3AD8D36D5EB4FCA1D9
314.Ve
315.PP
316.Vb 1
317\& e=INTEGER:0x010001
318.Ve
319.PP
320.Vb 2
321\& d=INTEGER:0x6F05EAD2F27FFAEC84BEC360C4B928FD5F3A9865D0FCAAD291E2A52F4A\e
322\& F810DC6373278C006A0ABBA27DC8C63BF97F7E666E27C5284D7D3B1FFFE16B7A87B51D
323.Ve
324.PP
325.Vb 2
326\& p=INTEGER:0xF3929B9435608F8A22C208D86795271D54EBDFB09DDEF539AB083DA912\e
327\& D4BD57
328.Ve
329.PP
330.Vb 2
331\& q=INTEGER:0xC50016F89DFF2561347ED1186A46E150E28BF2D0F539A1594BBD7FE467\e
332\& 46EC4F
333.Ve
334.PP
335.Vb 2
336\& exp1=INTEGER:0x9E7D4326C924AFC1DEA40B45650134966D6F9DFA3A7F9D698CD4ABEA\e
337\& 9C0A39B9
338.Ve
339.PP
340.Vb 2
341\& exp2=INTEGER:0xBA84003BB95355AFB7C50DF140C60513D0BA51D637272E355E397779\e
342\& E7B2458F
343.Ve
344.PP
345.Vb 2
346\& coeff=INTEGER:0x30B9E4F2AFA5AC679F920FC83F1F2DF1BAF1779CF989447FABC2F5\e
347\& 628657053A
348.Ve
349.PP
350This example is the corresponding public key in a SubjectPublicKeyInfo
351structure:
352.PP
353.Vb 2
354\& # Start with a SEQUENCE
355\& asn1=SEQUENCE:pubkeyinfo
356.Ve
357.PP
358.Vb 5
359\& # pubkeyinfo contains an algorithm identifier and the public key wrapped
360\& # in a BIT STRING
361\& [pubkeyinfo]
362\& algorithm=SEQUENCE:rsa_alg
363\& pubkey=BITWRAP,SEQUENCE:rsapubkey
364.Ve
365.PP
366.Vb 4
367\& # algorithm ID for RSA is just an OID and a NULL
368\& [rsa_alg]
369\& algorithm=OID:rsaEncryption
370\& parameter=NULL
371.Ve
372.PP
373.Vb 4
374\& # Actual public key: modulus and exponent
375\& [rsapubkey]
376\& n=INTEGER:0xBB6FE79432CC6EA2D8F970675A5A87BFBE1AFF0BE63E879F2AFFB93644\e
377\& D4D2C6D000430DEC66ABF47829E74B8C5108623A1C0EE8BE217B3AD8D36D5EB4FCA1D9
378.Ve
379.PP
380.Vb 1
381\& e=INTEGER:0x010001
382.Ve
383.SH "RETURN VALUES"
384.IX Header "RETURN VALUES"
385\&\fIASN1_generate_nconf()\fR and \fIASN1_generate_v3()\fR return the encoded
386data as an \fB\s-1ASN1_TYPE\s0\fR structure or \fB\s-1NULL\s0\fR if an error occurred.
387.PP
388The error codes that can be obtained by \fIERR_get_error\fR\|(3).
389.SH "SEE ALSO"
390.IX Header "SEE ALSO"
391\&\fIERR_get_error\fR\|(3)
392.SH "HISTORY"
393.IX Header "HISTORY"
394\&\fIASN1_generate_nconf()\fR and \fIASN1_generate_v3()\fR were added to OpenSSL 0.9.8