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