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