Update build for OpenSSL-0.9.8j upgrade.
[dragonfly.git] / secure / lib / libcrypto / man / ASN1_generate_nconf.3
index aecacce..0c47946 100644 (file)
@@ -1,4 +1,4 @@
-.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
+.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
 .\"
 .\" Standard preamble:
 .\" ========================================================================
 ..
 .\" Set up some character translations and predefined strings.  \*(-- will
 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
-.\" double quote, and \*(R" will give a right double quote.  | will give a
-.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
-.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
-.\" expand to `' in nroff, nothing in troff, for use with C<>.
-.tr \(*W-|\(bv\*(Tr
+.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
+.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
+.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
+.\" nothing in troff, for use with C<>.
+.tr \(*W-
 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
 .ie n \{\
 .    ds -- \(*W-
 .    ds R" ''
 'br\}
 .\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\"
 .\" If the F register is turned on, we'll generate index entries on stderr for
 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
 .\" entries marked with X<> in POD.  Of course, you'll have to process the
 .\" output yourself in some meaningful fashion.
-.if \nF \{\
+.ie \nF \{\
 .    de IX
 .    tm Index:\\$1\t\\n%\t"\\$2"
 ..
 .    nr % 0
 .    rr F
 .\}
-.\"
-.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
-.\" way too many mistakes in technical documents.
-.hy 0
-.if n .na
+.el \{\
+.    de IX
+..
+.\}
 .\"
 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
 .\" ========================================================================
 .\"
 .IX Title "ASN1_generate_nconf 3"
-.TH ASN1_generate_nconf 3 "2006-11-19" "0.9.8d" "OpenSSL"
+.TH ASN1_generate_nconf 3 "2009-01-11" "0.9.8j" "OpenSSL"
+.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
 .SH "NAME"
 ASN1_generate_nconf, ASN1_generate_v3 \- ASN1 generation functions
 .SH "SYNOPSIS"
@@ -155,10 +162,8 @@ configuration will be used.
 The actual data encoded is determined by the string \fBstr\fR and
 the configuration information. The general format of the string
 is:
-.PP
-.Vb 1
-\& B<[modifier,]type[:value]>
-.Ve
+.IP "\fB[modifier,]type[:value]\fR" 2
+.IX Item "[modifier,]type[:value]"
 .PP
 That is zero or more comma separated modifiers followed by a type
 followed by an optional colon and a value. The formats of \fBtype\fR,
@@ -172,7 +177,7 @@ only the \fB\s-1ASCII\s0\fR format is permissible.
 This encodes a boolean type. The \fBvalue\fR string is mandatory and
 should be \fB\s-1TRUE\s0\fR or \fB\s-1FALSE\s0\fR. Additionally \fB\s-1TRUE\s0\fR, \fBtrue\fR, \fBY\fR,
 \&\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
-are acceptable. 
+are acceptable.
 .IP "\fB\s-1NULL\s0\fR" 2
 .IX Item "NULL"
 Encode the \fB\s-1NULL\s0\fR type, the \fBvalue\fR string must not be present.
@@ -193,19 +198,19 @@ a short name, a long name or numerical format.
 .IP "\fB\s-1UTCTIME\s0\fR, \fB\s-1UTC\s0\fR" 2
 .IX Item "UTCTIME, UTC"
 Encodes an \s-1ASN1\s0 \fBUTCTime\fR structure, the value should be in
-the format \fB\s-1YYMMDDHHMMSSZ\s0\fR. 
+the format \fB\s-1YYMMDDHHMMSSZ\s0\fR.
 .IP "\fB\s-1GENERALIZEDTIME\s0\fR, \fB\s-1GENTIME\s0\fR" 2
 .IX Item "GENERALIZEDTIME, GENTIME"
 Encodes an \s-1ASN1\s0 \fBGeneralizedTime\fR structure, the value should be in
-the format \fB\s-1YYYYMMDDHHMMSSZ\s0\fR. 
+the format \fB\s-1YYYYMMDDHHMMSSZ\s0\fR.
 .IP "\fB\s-1OCTETSTRING\s0\fR, \fB\s-1OCT\s0\fR" 2
 .IX Item "OCTETSTRING, OCT"
-Emcodes an \s-1ASN1\s0 \fB\s-1OCTET\s0 \s-1STRING\s0\fR. \fBvalue\fR represents the contents
+Encodes an \s-1ASN1\s0 \fB\s-1OCTET\s0 \s-1STRING\s0\fR. \fBvalue\fR represents the contents
 of this structure, the format strings \fB\s-1ASCII\s0\fR and \fB\s-1HEX\s0\fR can be
 used to specify the format of \fBvalue\fR.
-.IP "\fB\s-1BITSRING\s0\fR, \fB\s-1BITSTR\s0\fR" 2
-.IX Item "BITSRING, BITSTR"
-Emcodes an \s-1ASN1\s0 \fB\s-1BIT\s0 \s-1STRING\s0\fR. \fBvalue\fR represents the contents
+.IP "\fB\s-1BITSTRING\s0\fR, \fB\s-1BITSTR\s0\fR" 2
+.IX Item "BITSTRING, BITSTR"
+Encodes an \s-1ASN1\s0 \fB\s-1BIT\s0 \s-1STRING\s0\fR. \fBvalue\fR represents the contents
 of this structure, the format strings \fB\s-1ASCII\s0\fR, \fB\s-1HEX\s0\fR and \fB\s-1BITLIST\s0\fR
 can be used to specify the format of \fBvalue\fR.
 .Sp
@@ -251,10 +256,11 @@ bits is set to zero.
 This specifies the format of the ultimate value. It should be followed
 by a colon and one of the strings \fB\s-1ASCII\s0\fR, \fB\s-1UTF8\s0\fR, \fB\s-1HEX\s0\fR or \fB\s-1BITLIST\s0\fR.
 .Sp
-If no format specifier is included then \fB\s-1ASCII\s0\fR is used. If \fB\s-1UTF8\s0\fR is specified
-then the value string must be a valid \fB\s-1UTF8\s0\fR string. For \fB\s-1HEX\s0\fR the output must
-be a set of hex digits. \fB\s-1BITLIST\s0\fR (which is only valid for a \s-1BIT\s0 \s-1STRING\s0) is a
-comma separated list of set bits.
+If no format specifier is included then \fB\s-1ASCII\s0\fR is used. If \fB\s-1UTF8\s0\fR is
+specified then the value string must be a valid \fB\s-1UTF8\s0\fR string. For \fB\s-1HEX\s0\fR the
+output must be a set of hex digits. \fB\s-1BITLIST\s0\fR (which is only valid for a \s-1BIT\s0
+\&\s-1STRING\s0) is a comma separated list of the indices of the set bits, all other
+bits are zero.
 .SH "EXAMPLES"
 .IX Header "EXAMPLES"
 A simple IA5String:
@@ -275,16 +281,24 @@ An IA5String explicitly tagged using \s-1APPLICATION\s0 tagging:
 \& EXPLICIT:0A,IA5STRING:Hello World
 .Ve
 .PP
-A more complex example using a config file to produce a
-\&\s-1SEQUENCE\s0 consiting of a \s-1BOOL\s0 an \s-1OID\s0 and a UTF8String:
+A \s-1BITSTRING\s0 with bits 1 and 5 set and all others zero:
 .PP
-asn1 = SEQUENCE:seq_section
+.Vb 1
+\& FORMAT=BITLIST,BITSTRING:1,5
+.Ve
 .PP
-[seq_section]
+A more complex example using a config file to produce a
+\&\s-1SEQUENCE\s0 consiting of a \s-1BOOL\s0 an \s-1OID\s0 and a UTF8String:
 .PP
-field1 = \s-1BOOLEAN:TRUE\s0
-field2 = OID:commonName
-field3 = UTF8:Third field
+.Vb 1
+\& asn1 = SEQUENCE:seq_section
+\&
+\& [seq_section]
+\&
+\& field1 = BOOLEAN:TRUE
+\& field2 = OID:commonName
+\& field3 = UTF8:Third field
+.Ve
 .PP
 This example produces an RSAPrivateKey structure, this is the
 key contained in the file client.pem in all OpenSSL distributions
@@ -295,43 +309,27 @@ for clarity):
 \& asn1=SEQUENCE:private_key
 \& [private_key]
 \& version=INTEGER:0
-.Ve
-.PP
-.Vb 2
+\&
 \& n=INTEGER:0xBB6FE79432CC6EA2D8F970675A5A87BFBE1AFF0BE63E879F2AFFB93644\e
 \& D4D2C6D000430DEC66ABF47829E74B8C5108623A1C0EE8BE217B3AD8D36D5EB4FCA1D9
-.Ve
-.PP
-.Vb 1
+\&
 \& e=INTEGER:0x010001
-.Ve
-.PP
-.Vb 2
+\&
 \& d=INTEGER:0x6F05EAD2F27FFAEC84BEC360C4B928FD5F3A9865D0FCAAD291E2A52F4A\e
 \& F810DC6373278C006A0ABBA27DC8C63BF97F7E666E27C5284D7D3B1FFFE16B7A87B51D
-.Ve
-.PP
-.Vb 2
+\&
 \& p=INTEGER:0xF3929B9435608F8A22C208D86795271D54EBDFB09DDEF539AB083DA912\e
 \& D4BD57
-.Ve
-.PP
-.Vb 2
+\&
 \& q=INTEGER:0xC50016F89DFF2561347ED1186A46E150E28BF2D0F539A1594BBD7FE467\e
 \& 46EC4F
-.Ve
-.PP
-.Vb 2
+\&
 \& exp1=INTEGER:0x9E7D4326C924AFC1DEA40B45650134966D6F9DFA3A7F9D698CD4ABEA\e
 \& 9C0A39B9
-.Ve
-.PP
-.Vb 2
+\&
 \& exp2=INTEGER:0xBA84003BB95355AFB7C50DF140C60513D0BA51D637272E355E397779\e
 \& E7B2458F
-.Ve
-.PP
-.Vb 2
+\&
 \& coeff=INTEGER:0x30B9E4F2AFA5AC679F920FC83F1F2DF1BAF1779CF989447FABC2F5\e
 \& 628657053A
 .Ve
@@ -342,31 +340,23 @@ structure:
 .Vb 2
 \& # Start with a SEQUENCE
 \& asn1=SEQUENCE:pubkeyinfo
-.Ve
-.PP
-.Vb 5
+\&
 \& # pubkeyinfo contains an algorithm identifier and the public key wrapped
 \& # in a BIT STRING
 \& [pubkeyinfo]
 \& algorithm=SEQUENCE:rsa_alg
 \& pubkey=BITWRAP,SEQUENCE:rsapubkey
-.Ve
-.PP
-.Vb 4
+\&
 \& # algorithm ID for RSA is just an OID and a NULL
 \& [rsa_alg]
 \& algorithm=OID:rsaEncryption
 \& parameter=NULL
-.Ve
-.PP
-.Vb 4
+\&
 \& # Actual public key: modulus and exponent
 \& [rsapubkey]
 \& n=INTEGER:0xBB6FE79432CC6EA2D8F970675A5A87BFBE1AFF0BE63E879F2AFFB93644\e
 \& D4D2C6D000430DEC66ABF47829E74B8C5108623A1C0EE8BE217B3AD8D36D5EB4FCA1D9
-.Ve
-.PP
-.Vb 1
+\&
 \& e=INTEGER:0x010001
 .Ve
 .SH "RETURN VALUES"