blob: d238946b34f9b3e6473cafa92bec1d2afb376172 [file] [log] [blame]
Dr. Stephen Henson5e768071999-11-12 01:04:39 +00001=pod
2
3=head1 NAME
4
5pkcs7 - PKCS#7 utility
6
7=head1 SYNOPSIS
8
9B<openssl> B<pkcs7>
A J Mohan Rao169394d2016-02-05 11:58:45 -050010[B<-help>]
Dr. Stephen Henson5e768071999-11-12 01:04:39 +000011[B<-inform PEM|DER>]
12[B<-outform PEM|DER>]
13[B<-in filename>]
14[B<-out filename>]
15[B<-print_certs>]
Dr. Stephen Henson01aad2c1999-11-12 14:04:41 +000016[B<-text>]
17[B<-noout>]
Richard Levittebfa35552003-01-30 22:02:27 +000018[B<-engine id>]
Dr. Stephen Henson5e768071999-11-12 01:04:39 +000019
20=head1 DESCRIPTION
21
22The B<pkcs7> command processes PKCS#7 files in DER or PEM format.
23
Rich Salz3dfda1a2016-12-12 11:14:40 -050024=head1 OPTIONS
Dr. Stephen Henson5e768071999-11-12 01:04:39 +000025
26=over 4
27
A J Mohan Rao169394d2016-02-05 11:58:45 -050028=item B<-help>
29
30Print out a usage message.
31
Dr. Stephen Henson5e768071999-11-12 01:04:39 +000032=item B<-inform DER|PEM>
33
34This specifies the input format. B<DER> format is DER encoded PKCS#7
35v1.5 structure.B<PEM> (the default) is a base64 encoded version of
36the DER form with header and footer lines.
37
38=item B<-outform DER|PEM>
39
Rich Salz1bc74512016-05-20 08:11:46 -040040This specifies the output format, the options have the same meaning as the
Dr. Stephen Henson5e768071999-11-12 01:04:39 +000041B<-inform> option.
42
43=item B<-in filename>
44
45This specifies the input filename to read from or standard input if this
46option is not specified.
47
48=item B<-out filename>
49
50specifies the output filename to write to or standard output by
51default.
52
53=item B<-print_certs>
54
55prints out any certificates or CRLs contained in the file. They are
56preceded by their subject and issuer names in one line format.
57
Dr. Stephen Henson954ef7e1999-11-12 01:42:25 +000058=item B<-text>
59
60prints out certificates details in full rather than just subject and
61issuer names.
62
63=item B<-noout>
64
65don't output the encoded version of the PKCS#7 structure (or certificates
66is B<-print_certs> is set).
67
Richard Levittebfa35552003-01-30 22:02:27 +000068=item B<-engine id>
69
Dr. Stephen Hensone5fa8642009-04-15 15:27:03 +000070specifying an engine (by its unique B<id> string) will cause B<pkcs7>
Richard Levittebfa35552003-01-30 22:02:27 +000071to attempt to obtain a functional reference to the specified engine,
72thus initialising it if needed. The engine will then be set as the default
73for all available algorithms.
74
Dr. Stephen Henson5e768071999-11-12 01:04:39 +000075=back
76
77=head1 EXAMPLES
78
79Convert a PKCS#7 file from PEM to DER:
80
81 openssl pkcs7 -in file.pem -outform DER -out file.der
82
83Output all certificates in a file:
84
85 openssl pkcs7 -in file.pem -print_certs -out certs.pem
86
Dr. Stephen Henson3142c862000-02-23 01:11:01 +000087=head1 NOTES
88
89The PEM PKCS#7 format uses the header and footer lines:
90
91 -----BEGIN PKCS7-----
92 -----END PKCS7-----
93
Ulf Möller3b80e3a2001-09-07 06:13:40 +000094For compatibility with some CAs it will also accept:
Dr. Stephen Henson3142c862000-02-23 01:11:01 +000095
96 -----BEGIN CERTIFICATE-----
97 -----END CERTIFICATE-----
98
Dr. Stephen Henson5e768071999-11-12 01:04:39 +000099=head1 RESTRICTIONS
100
101There is no option to print out all the fields of a PKCS#7 file.
102
Rich Salz1bc74512016-05-20 08:11:46 -0400103This PKCS#7 routines only understand PKCS#7 v 1.5 as specified in RFC2315 they
Dr. Stephen Hensonc4471291999-11-12 01:07:33 +0000104cannot currently parse, for example, the new CMS as described in RFC2630.
Dr. Stephen Henson5e768071999-11-12 01:04:39 +0000105
106=head1 SEE ALSO
107
Rich Salz9b869742015-08-17 15:21:33 -0400108L<crl2pkcs7(1)>
Dr. Stephen Henson5e768071999-11-12 01:04:39 +0000109
Rich Salze2f92612016-05-18 11:44:05 -0400110=head1 COPYRIGHT
111
112Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
113
114Licensed under the OpenSSL license (the "License"). You may not use
115this file except in compliance with the License. You can obtain a copy
116in the file LICENSE in the source distribution or at
117L<https://www.openssl.org/source/license.html>.
118
119=cut