crypto/openssl/doc/apps/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<-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 COMMAND OPTIONS
  25
  26 =over 4
  27
  28 =item B<-inform DER|PEM>
  29
  30 This specifies the input format. B<DER> format is DER encoded PKCS#7
  31 v1.5 structure.B<PEM> (the default) is a base64 encoded version of
  32 the DER form with header and footer lines.
  33
  34 =item B<-outform DER|PEM>
  35
  36 This specifies the output format, the options have the same meaning as the
  37 B<-inform> option.
  38
  39 =item B<-in filename>
  40
  41 This specifies the input filename to read from or standard input if this
  42 option is not specified.
  43
  44 =item B<-out filename>
  45
  46 specifies the output filename to write to or standard output by
  47 default.
  48
  49 =item B<-print_certs>
  50
  51 prints out any certificates or CRLs contained in the file. They are
  52 preceded by their subject and issuer names in one line format.
  53
  54 =item B<-text>
  55
  56 prints out certificates details in full rather than just subject and
  57 issuer names.
  58
  59 =item B<-noout>
  60
  61 don't output the encoded version of the PKCS#7 structure (or certificates
  62 is B<-print_certs> is set).
  63
  64 =item B<-engine id>
  65
  66 specifying an engine (by its unique B<id> string) will cause B<pkcs7>
  67 to attempt to obtain a functional reference to the specified engine,
  68 thus initialising it if needed. The engine will then be set as the default
  69 for all available algorithms.
  70
  71 =back
  72
  73 =head1 EXAMPLES
  74
  75 Convert a PKCS#7 file from PEM to DER:
  76
  77  openssl pkcs7 -in file.pem -outform DER -out file.der
  78
  79 Output all certificates in a file:
  80
  81  openssl pkcs7 -in file.pem -print_certs -out certs.pem
  82
  83 =head1 NOTES
  84
  85 The PEM PKCS#7 format uses the header and footer lines:
  86
  87  -----BEGIN PKCS7-----
  88  -----END PKCS7-----
  89
  90 For compatibility with some CAs it will also accept:
  91
  92  -----BEGIN CERTIFICATE-----
  93  -----END CERTIFICATE-----
  94
  95 =head1 RESTRICTIONS
  96
  97 There is no option to print out all the fields of a PKCS#7 file.
  98
  99 This PKCS#7 routines only understand PKCS#7 v 1.5 as specified in RFC2315 they
 100 cannot currently parse, for example, the new CMS as described in RFC2630.
 101
 102 =head1 SEE ALSO
 103
 104 L<crl2pkcs7(1)|crl2pkcs7(1)>
 105
 106 =cut