crypto/external/bsd/openssl/lib/libcrypto/man/openssl_pkcs7.1

   1 .\"     $NetBSD: libcrypto.pl,v 1.3 2007/11/27 22:16:03 christos Exp $
   2 .\"
   3 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
   4 .\"
   5 .\" Standard preamble:
   6 .\" ========================================================================
   7 .de Sh \" Subsection heading
   8 .br
   9 .if t .Sp
  10 .ne 5
  11 .PP
  12 \fB\\$1\fR
  13 .PP
  14 ..
  15 .de Sp \" Vertical space (when we can't use .PP)
  16 .if t .sp .5v
  17 .if n .sp
  18 ..
  19 .de Vb \" Begin verbatim text
  20 .ft CW
  21 .nf
  22 .ne \\$1
  23 ..
  24 .de Ve \" End verbatim text
  25 .ft R
  26 .fi
  27 ..
  28 .\" Set up some character translations and predefined strings.  \*(-- will
  29 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  30 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  31 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  32 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  33 .\" nothing in troff, for use with C<>.
  34 .tr \(*W-
  35 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  36 .ie n \{\
  37 .    ds -- \(*W-
  38 .    ds PI pi
  39 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  40 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  41 .    ds L" ""
  42 .    ds R" ""
  43 .    ds C` ""
  44 .    ds C' ""
  45 'br\}
  46 .el\{\
  47 .    ds -- \|\(em\|
  48 .    ds PI \(*p
  49 .    ds L" ``
  50 .    ds R" ''
  51 'br\}
  52 .\"
  53 .\" Escape single quotes in literal strings from groff's Unicode transform.
  54 .ie \n(.g .ds Aq \(aq
  55 .el       .ds Aq '
  56 .\"
  57 .\" If the F register is turned on, we'll generate index entries on stderr for
  58 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  59 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  60 .\" output yourself in some meaningful fashion.
  61 .ie \nF \{\
  62 .    de IX
  63 .    tm Index:\\$1\t\\n%\t"\\$2"
  64 ..
  65 .    nr % 0
  66 .    rr F
  67 .\}
  68 .el \{\
  69 .    de IX
  70 ..
  71 .\}
  72 .\"
  73 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  74 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  75 .    \" fudge factors for nroff and troff
  76 .if n \{\
  77 .    ds #H 0
  78 .    ds #V .8m
  79 .    ds #F .3m
  80 .    ds #[ \f1
  81 .    ds #] \fP
  82 .\}
  83 .if t \{\
  84 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  85 .    ds #V .6m
  86 .    ds #F 0
  87 .    ds #[ \&
  88 .    ds #] \&
  89 .\}
  90 .    \" simple accents for nroff and troff
  91 .if n \{\
  92 .    ds ' \&
  93 .    ds ` \&
  94 .    ds ^ \&
  95 .    ds , \&
  96 .    ds ~ ~
  97 .    ds /
  98 .\}
  99 .if t \{\
 100 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 101 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 102 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 103 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 104 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 105 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 106 .\}
 107 .    \" troff and (daisy-wheel) nroff accents
 108 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 109 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 110 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 111 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 112 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 113 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 114 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 115 .ds ae a\h'-(\w'a'u*4/10)'e
 116 .ds Ae A\h'-(\w'A'u*4/10)'E
 117 .    \" corrections for vroff
 118 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 119 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 120 .    \" for low resolution devices (crt and lpr)
 121 .if \n(.H>23 .if \n(.V>19 \
 122 \{\
 123 .    ds : e
 124 .    ds 8 ss
 125 .    ds o a
 126 .    ds d- d\h'-1'\(ga
 127 .    ds D- D\h'-1'\(hy
 128 .    ds th \o'bp'
 129 .    ds Th \o'LP'
 130 .    ds ae ae
 131 .    ds Ae AE
 132 .\}
 133 .rm #[ #] #H #V #F C
 134 .\" ========================================================================
 135 .\"
 136 .IX Title "PKCS7 1"
 137 .TH PKCS7 1 "2009-04-15" "1.1.0-dev" "OpenSSL"
 138 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 139 .\" way too many mistakes in technical documents.
 140 .if n .ad l
 141 .nh
 142 .SH "NAME"
 143 pkcs7 \- PKCS#7 utility
 144 .SH "LIBRARY"
 145 libcrypto, -lcrypto
 146 .SH "SYNOPSIS"
 147 .IX Header "SYNOPSIS"
 148 \&\fBopenssl\fR \fBpkcs7\fR
 149 [\fB\-inform PEM|DER\fR]
 150 [\fB\-outform PEM|DER\fR]
 151 [\fB\-in filename\fR]
 152 [\fB\-out filename\fR]
 153 [\fB\-print_certs\fR]
 154 [\fB\-text\fR]
 155 [\fB\-noout\fR]
 156 [\fB\-engine id\fR]
 157 .SH "DESCRIPTION"
 158 .IX Header "DESCRIPTION"
 159 The \fBpkcs7\fR command processes PKCS#7 files in \s-1DER\s0 or \s-1PEM\s0 format.
 160 .SH "COMMAND OPTIONS"
 161 .IX Header "COMMAND OPTIONS"
 162 .IP "\fB\-inform DER|PEM\fR" 4
 163 .IX Item "-inform DER|PEM"
 164 This specifies the input format. \fB\s-1DER\s0\fR format is \s-1DER\s0 encoded PKCS#7
 165 v1.5 structure.\fB\s-1PEM\s0\fR (the default) is a base64 encoded version of
 166 the \s-1DER\s0 form with header and footer lines.
 167 .IP "\fB\-outform DER|PEM\fR" 4
 168 .IX Item "-outform DER|PEM"
 169 This specifies the output format, the options have the same meaning as the
 170 \&\fB\-inform\fR option.
 171 .IP "\fB\-in filename\fR" 4
 172 .IX Item "-in filename"
 173 This specifies the input filename to read from or standard input if this
 174 option is not specified.
 175 .IP "\fB\-out filename\fR" 4
 176 .IX Item "-out filename"
 177 specifies the output filename to write to or standard output by
 178 default.
 179 .IP "\fB\-print_certs\fR" 4
 180 .IX Item "-print_certs"
 181 prints out any certificates or CRLs contained in the file. They are
 182 preceded by their subject and issuer names in one line format.
 183 .IP "\fB\-text\fR" 4
 184 .IX Item "-text"
 185 prints out certificates details in full rather than just subject and
 186 issuer names.
 187 .IP "\fB\-noout\fR" 4
 188 .IX Item "-noout"
 189 don't output the encoded version of the PKCS#7 structure (or certificates
 190 is \fB\-print_certs\fR is set).
 191 .IP "\fB\-engine id\fR" 4
 192 .IX Item "-engine id"
 193 specifying an engine (by its unique \fBid\fR string) will cause \fBpkcs7\fR
 194 to attempt to obtain a functional reference to the specified engine,
 195 thus initialising it if needed. The engine will then be set as the default
 196 for all available algorithms.
 197 .SH "EXAMPLES"
 198 .IX Header "EXAMPLES"
 199 Convert a PKCS#7 file from \s-1PEM\s0 to \s-1DER:\s0
 200 .PP
 201 .Vb 1
 202 \& openssl pkcs7 \-in file.pem \-outform DER \-out file.der
 203 .Ve
 204 .PP
 205 Output all certificates in a file:
 206 .PP
 207 .Vb 1
 208 \& openssl pkcs7 \-in file.pem \-print_certs \-out certs.pem
 209 .Ve
 210 .SH "NOTES"
 211 .IX Header "NOTES"
 212 The \s-1PEM\s0 PKCS#7 format uses the header and footer lines:
 213 .PP
 214 .Vb 2
 215 \& \-\-\-\-\-BEGIN PKCS7\-\-\-\-\-
 216 \& \-\-\-\-\-END PKCS7\-\-\-\-\-
 217 .Ve
 218 .PP
 219 For compatibility with some CAs it will also accept:
 220 .PP
 221 .Vb 2
 222 \& \-\-\-\-\-BEGIN CERTIFICATE\-\-\-\-\-
 223 \& \-\-\-\-\-END CERTIFICATE\-\-\-\-\-
 224 .Ve
 225 .SH "RESTRICTIONS"
 226 .IX Header "RESTRICTIONS"
 227 There is no option to print out all the fields of a PKCS#7 file.
 228 .PP
 229 This PKCS#7 routines only understand PKCS#7 v 1.5 as specified in \s-1RFC2315\s0 they
 230 cannot currently parse, for example, the new \s-1CMS\s0 as described in \s-1RFC2630\s0.
 231 .SH "SEE ALSO"
 232 .IX Header "SEE ALSO"
 233 \&\fIopenssl_crl2pkcs7\fR\|(1)