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