freebsd-skq/crypto/openssl/doc/man1/pkcs7.pod

121 lines
2.6 KiB
Plaintext
Raw Normal View History

2000-04-13 06:33:22 +00:00
=pod
=head1 NAME
2017-11-02 17:35:19 +00:00
openssl-pkcs7,
2000-04-13 06:33:22 +00:00
pkcs7 - PKCS#7 utility
=head1 SYNOPSIS
B<openssl> B<pkcs7>
2018-09-13 19:18:07 +00:00
[B<-help>]
2000-04-13 06:33:22 +00:00
[B<-inform PEM|DER>]
[B<-outform PEM|DER>]
[B<-in filename>]
[B<-out filename>]
[B<-print_certs>]
[B<-text>]
[B<-noout>]
2003-02-19 23:17:42 +00:00
[B<-engine id>]
2000-04-13 06:33:22 +00:00
=head1 DESCRIPTION
The B<pkcs7> command processes PKCS#7 files in DER or PEM format.
2018-09-13 19:18:07 +00:00
=head1 OPTIONS
2000-04-13 06:33:22 +00:00
=over 4
2018-09-13 19:18:07 +00:00
=item B<-help>
Print out a usage message.
2000-04-13 06:33:22 +00:00
=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>
2018-09-13 19:18:07 +00:00
This specifies the output format, the options have the same meaning and default
as the B<-inform> option.
2000-04-13 06:33:22 +00:00
=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>
2018-09-13 19:18:07 +00:00
Specifies the output filename to write to or standard output by
2000-04-13 06:33:22 +00:00
default.
=item B<-print_certs>
2018-09-13 19:18:07 +00:00
Prints out any certificates or CRLs contained in the file. They are
2000-04-13 06:33:22 +00:00
preceded by their subject and issuer names in one line format.
=item B<-text>
2018-09-13 19:18:07 +00:00
Prints out certificates details in full rather than just subject and
2000-04-13 06:33:22 +00:00
issuer names.
=item B<-noout>
2018-09-13 19:18:07 +00:00
Don't output the encoded version of the PKCS#7 structure (or certificates
2000-04-13 06:33:22 +00:00
is B<-print_certs> is set).
2003-02-19 23:17:42 +00:00
=item B<-engine id>
2018-09-13 19:18:07 +00:00
Specifying an engine (by its unique B<id> string) will cause B<pkcs7>
2003-02-19 23:17:42 +00:00
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.
2000-04-13 06:33:22 +00:00
=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
=head1 NOTES
The PEM PKCS#7 format uses the header and footer lines:
-----BEGIN PKCS7-----
-----END PKCS7-----
For compatibility with some CAs it will also accept:
2000-04-13 06:33:22 +00:00
-----BEGIN CERTIFICATE-----
-----END CERTIFICATE-----
=head1 RESTRICTIONS
There is no option to print out all the fields of a PKCS#7 file.
2018-09-13 19:18:07 +00:00
This PKCS#7 routines only understand PKCS#7 v 1.5 as specified in RFC2315 they
2000-04-13 06:33:22 +00:00
cannot currently parse, for example, the new CMS as described in RFC2630.
=head1 SEE ALSO
2018-09-13 19:18:07 +00:00
L<crl2pkcs7(1)>
=head1 COPYRIGHT
Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
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>.
2000-04-13 06:33:22 +00:00
=cut