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