X-Git-Url: https://git.openssl.org/?p=openssl.git;a=blobdiff_plain;f=doc%2Fcrypto%2FASN1_generate_nconf.pod;h=5dc1091c881bd5077fe14a7538a9d239130871de;hp=724ccfe04030b51d6a0057f875d5d4462b94d4ac;hb=a8e4ac6a2fe67c19672ecf0c6aeafa15801ce3a5;hpb=c264592d690b0957e6ad2d25cd3c842383a5538e diff --git a/doc/crypto/ASN1_generate_nconf.pod b/doc/crypto/ASN1_generate_nconf.pod index 724ccfe040..5dc1091c88 100644 --- a/doc/crypto/ASN1_generate_nconf.pod +++ b/doc/crypto/ASN1_generate_nconf.pod @@ -19,7 +19,7 @@ in an B structure. B contains the string to encode B or B contains the optional configuration information where additional strings will be read from. B will typically come from a config -file wherease B is obtained from an B structure +file whereas B is obtained from an B structure which will typically be used by X509 v3 certificate extension functions. B or B can be set to B if no additional configuration will be used. @@ -30,7 +30,11 @@ The actual data encoded is determined by the string B and the configuration information. The general format of the string is: - B<[modifier,]type[:value]> +=over 2 + +=item B<[modifier,]type[:value]> + +=back That is zero or more comma separated modifiers followed by a type followed by an optional colon and a value. The formats of B, @@ -57,7 +61,7 @@ Encode the B type, the B string must not be present. =item B, B Encodes an ASN1 B type. The B string represents -the value of the integer, it can be preceeded by a minus sign and +the value of the integer, it can be prefaced by a minus sign and is normally interpreted as a decimal value unless the prefix B<0x> is included. @@ -83,13 +87,13 @@ the format B. =item B, B -Emcodes an ASN1 B. B represents the contents +Encodes an ASN1 B. B represents the contents of this structure, the format strings B and B can be used to specify the format of B. -=item B, B +=item B, B -Emcodes an ASN1 B. B represents the contents +Encodes an ASN1 B. B represents the contents of this structure, the format strings B, B and B can be used to specify the format of B. @@ -150,10 +154,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 B, B, B or B. -If no format specifier is included then B is used. If B is specified -then the value string must be a valid B string. For B the output must -be a set of hex digits. B (which is only valid for a BIT STRING) is a -comma separated list of set bits. +If no format specifier is included then B is used. If B is +specified then the value string must be a valid B string. For B the +output must be a set of hex digits. B (which is only valid for a BIT +STRING) is a comma separated list of the indices of the set bits, all other +bits are zero. =back @@ -171,16 +176,20 @@ An IA5String explicitly tagged using APPLICATION tagging: EXPLICIT:0A,IA5STRING:Hello World +A BITSTRING with bits 1 and 5 set and all others zero: + + FORMAT:BITLIST,BITSTRING:1,5 + A more complex example using a config file to produce a -SEQUENCE consiting of a BOOL an OID and a UTF8String: +SEQUENCE consisting of a BOOL an OID and a UTF8String: -asn1 = SEQUENCE:seq_section + asn1 = SEQUENCE:seq_section -[seq_section] + [seq_section] -field1 = BOOLEAN:TRUE -field2 = OID:commonName -field3 = UTF8:Third field + field1 = BOOLEAN:TRUE + field2 = OID:commonName + field3 = UTF8:Third field This example produces an RSAPrivateKey structure, this is the key contained in the file client.pem in all OpenSSL distributions