Fix RT 3193
[openssl.git] / doc / apps / pkcs7.pod
1 =pod
2
3 =head1 NAME
4
5 pkcs7 - PKCS#7 utility
6
7 =head1 SYNOPSIS
8
9 B<openssl> B<pkcs7>
10 [B<-inform PEM|DER>]
11 [B<-outform PEM|DER>]
12 [B<-in filename>]
13 [B<-out filename>]
14 [B<-print_certs>]
15 [B<-text>]
16 [B<-noout>]
17 [B<-engine id>]
18
19 =head1 DESCRIPTION
20
21 The B<pkcs7> command processes PKCS#7 files in DER or PEM format.
22
23 =head1 COMMAND OPTIONS
24
25 =over 4
26
27 =item B<-inform DER|PEM>
28
29 This specifies the input format. B<DER> format is DER encoded PKCS#7
30 v1.5 structure.B<PEM> (the default) is a base64 encoded version of
31 the DER form with header and footer lines.
32
33 =item B<-outform DER|PEM>
34
35 This specifies the output format, the options have the same meaning as the 
36 B<-inform> option.
37
38 =item B<-in filename>
39
40 This specifies the input filename to read from or standard input if this
41 option is not specified.
42
43 =item B<-out filename>
44
45 specifies the output filename to write to or standard output by
46 default.
47
48 =item B<-print_certs>
49
50 prints out any certificates or CRLs contained in the file. They are
51 preceded by their subject and issuer names in one line format.
52
53 =item B<-text>
54
55 prints out certificates details in full rather than just subject and
56 issuer names.
57
58 =item B<-noout>
59
60 don't output the encoded version of the PKCS#7 structure (or certificates
61 is B<-print_certs> is set).
62
63 =item B<-engine id>
64
65 specifying an engine (by its unique B<id> string) will cause B<pkcs7>
66 to attempt to obtain a functional reference to the specified engine,
67 thus initialising it if needed. The engine will then be set as the default
68 for all available algorithms.
69
70 =back
71
72 =head1 EXAMPLES
73
74 Convert a PKCS#7 file from PEM to DER:
75
76  openssl pkcs7 -in file.pem -outform DER -out file.der
77
78 Output all certificates in a file:
79
80  openssl pkcs7 -in file.pem -print_certs -out certs.pem
81
82 =head1 NOTES
83
84 The PEM PKCS#7 format uses the header and footer lines:
85
86  -----BEGIN PKCS7-----
87  -----END PKCS7-----
88
89 For compatibility with some CAs it will also accept:
90
91  -----BEGIN CERTIFICATE-----
92  -----END CERTIFICATE-----
93
94 =head1 RESTRICTIONS
95
96 There is no option to print out all the fields of a PKCS#7 file.
97
98 This PKCS#7 routines only understand PKCS#7 v 1.5 as specified in RFC2315 they 
99 cannot currently parse, for example, the new CMS as described in RFC2630.
100
101 =head1 SEE ALSO
102
103 L<crl2pkcs7(1)|crl2pkcs7(1)>
104
105 =cut