Various doc fixes.

[openssl.git] / doc / apps / asn1parse.pod

diff --git a/doc/apps/asn1parse.pod b/doc/apps/asn1parse.pod
index e76e9813abaf48fca86a1a0850cef0fe5b0cce60..afe94b09d8ce0fc2a14ad3588587d5cf620b2a6f 100644 (file)
--- a/doc/apps/asn1parse.pod
+++ b/doc/apps/asn1parse.pod
@@ -15,7 +15,12 @@ B<openssl> B<asn1parse>
 [B<-length number>]
 [B<-i>]
 [B<-oid filename>]
+[B<-dump>]
+[B<-dlimit num>]
 [B<-strparse offset>]
+[B<-genstr string>]
+[B<-genconf file>]
+[B<-strictpem>]
 
 =head1 DESCRIPTION
 
@@ -62,11 +67,35 @@ indents the output according to the "depth" of the structures.
 a file containing additional OBJECT IDENTIFIERs (OIDs). The format of this
 file is described in the NOTES section below.
 
+=item B<-dump>
+
+dump unknown data in hex format.
+
+=item B<-dlimit num>
+
+like B<-dump>, but only the first B<num> bytes are output.
+
 =item B<-strparse offset>
 
 parse the contents octets of the ASN.1 object starting at B<offset>. This
 option can be used multiple times to "drill down" into a nested structure.
 
+=item B<-genstr string>, B<-genconf file>
+
+generate encoded data based on B<string>, B<file> or both using
+L<ASN1_generate_nconf(3)> format. If B<file> only is
+present then the string is obtained from the default section using the name
+B<asn1>. The encoded data is passed through the ASN1 parser and printed out as
+though it came from a file, the contents can thus be examined and written to a
+file using the B<out> option. 
+
+=item B<-strictpem>
+
+If this option is used then B<-inform> will be ignored. Without this option any
+data in a PEM format input file will be treated as being base64 encoded and
+processed whether it has the normal PEM BEGIN and END markers or not. This
+option will ignore any data prior to the start of the BEGIN marker, or after an
+END marker in a PEM file.
 
 =back
 
@@ -78,7 +107,7 @@ The output will typically contain lines like this:
 
 .....
 
-  229:d=3  hl=3 l= 141 prim: BIT STRING        
+  229:d=3  hl=3 l= 141 prim: BIT STRING
   373:d=2  hl=3 l= 162 cons: cont [ 3 ]        
   376:d=3  hl=3 l= 159 cons: SEQUENCE          
   379:d=4  hl=2 l=  29 cons: SEQUENCE          
@@ -121,9 +150,45 @@ by white space. The final column is the rest of the line and is the
 
 C<1.2.3.4      shortName       A long name>
 
+=head1 EXAMPLES
+
+Parse a file:
+
+ openssl asn1parse -in file.pem
+
+Parse a DER file:
+
+ openssl asn1parse -inform DER -in file.der
+
+Generate a simple UTF8String:
+
+ openssl asn1parse -genstr 'UTF8:Hello World'
+
+Generate and write out a UTF8String, don't print parsed output:
+
+ openssl asn1parse -genstr 'UTF8:Hello World' -noout -out utf8.der
+
+Generate using a config file:
+
+ openssl asn1parse -genconf asn1.cnf -noout -out asn1.der
+
+Example config file:
+
+ asn1=SEQUENCE:seq_sect
+
+ [seq_sect]
+
+ field1=BOOL:TRUE
+ field2=EXP:0, UTF8:some random string
+
+
 =head1 BUGS
 
-There should be options to change the format of input lines. The output of some
+There should be options to change the format of output lines. The output of some
 ASN.1 types is not well handled (if at all).
 
+=head1 SEE ALSO
+
+L<ASN1_generate_nconf(3)>
+
 =cut