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