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