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