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

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