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