pkcs7.pod 2.6 KB
Newer Older
1 2 3 4 5 6 7 8 9
=pod

=head1 NAME

pkcs7 - PKCS#7 utility

=head1 SYNOPSIS

B<openssl> B<pkcs7>
10
[B<-help>]
11 12 13 14 15
[B<-inform PEM|DER>]
[B<-outform PEM|DER>]
[B<-in filename>]
[B<-out filename>]
[B<-print_certs>]
16 17
[B<-text>]
[B<-noout>]
18
[B<-engine id>]
19 20 21 22 23

=head1 DESCRIPTION

The B<pkcs7> command processes PKCS#7 files in DER or PEM format.

R
Rich Salz 已提交
24
=head1 OPTIONS
25 26 27

=over 4

28 29 30 31
=item B<-help>

Print out a usage message.

32 33 34 35 36 37 38 39
=item B<-inform DER|PEM>

This specifies the input format. B<DER> format is DER encoded PKCS#7
v1.5 structure.B<PEM> (the default) is a base64 encoded version of
the DER form with header and footer lines.

=item B<-outform DER|PEM>

R
Rich Salz 已提交
40
This specifies the output format, the options have the same meaning as the
41 42 43 44 45 46 47 48 49
B<-inform> option.

=item B<-in filename>

This specifies the input filename to read from or standard input if this
option is not specified.

=item B<-out filename>

P
Pauli 已提交
50
Specifies the output filename to write to or standard output by
51 52 53 54
default.

=item B<-print_certs>

P
Pauli 已提交
55
Prints out any certificates or CRLs contained in the file. They are
56 57
preceded by their subject and issuer names in one line format.

D
 
Dr. Stephen Henson 已提交
58 59
=item B<-text>

P
Pauli 已提交
60
Prints out certificates details in full rather than just subject and
D
 
Dr. Stephen Henson 已提交
61 62 63 64
issuer names.

=item B<-noout>

P
Pauli 已提交
65
Don't output the encoded version of the PKCS#7 structure (or certificates
D
 
Dr. Stephen Henson 已提交
66 67
is B<-print_certs> is set).

68 69
=item B<-engine id>

P
Pauli 已提交
70
Specifying an engine (by its unique B<id> string) will cause B<pkcs7>
71 72 73 74
to attempt to obtain a functional reference to the specified engine,
thus initialising it if needed. The engine will then be set as the default
for all available algorithms.

75 76 77 78 79 80 81 82 83 84 85 86
=back

=head1 EXAMPLES

Convert a PKCS#7 file from PEM to DER:

 openssl pkcs7 -in file.pem -outform DER -out file.der

Output all certificates in a file:

 openssl pkcs7 -in file.pem -print_certs -out certs.pem

D
 
Dr. Stephen Henson 已提交
87 88 89 90 91 92 93
=head1 NOTES

The PEM PKCS#7 format uses the header and footer lines:

 -----BEGIN PKCS7-----
 -----END PKCS7-----

U
ispell  
Ulf Möller 已提交
94
For compatibility with some CAs it will also accept:
D
 
Dr. Stephen Henson 已提交
95 96 97 98

 -----BEGIN CERTIFICATE-----
 -----END CERTIFICATE-----

99 100 101 102
=head1 RESTRICTIONS

There is no option to print out all the fields of a PKCS#7 file.

R
Rich Salz 已提交
103
This PKCS#7 routines only understand PKCS#7 v 1.5 as specified in RFC2315 they
104
cannot currently parse, for example, the new CMS as described in RFC2630.
105 106 107

=head1 SEE ALSO

R
Rich Salz 已提交
108
L<crl2pkcs7(1)>
109

R
Rich Salz 已提交
110 111
=head1 COPYRIGHT

P
Pauli 已提交
112
Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
R
Rich Salz 已提交
113 114 115 116 117 118 119

Licensed under the OpenSSL license (the "License").  You may not use
this file except in compliance with the License.  You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.

=cut