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