Upgrade to OpenSSL 0.9.8h.
[dragonfly.git] / secure / usr.bin / openssl / man / pkcs7.1
CommitLineData
aac4ff6f 1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
8b0cefbb
JR
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
984263bc
MD
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
8b0cefbb 13.de Sp \" Vertical space (when we can't use .PP)
984263bc
MD
14.if t .sp .5v
15.if n .sp
16..
8b0cefbb 17.de Vb \" Begin verbatim text
984263bc
MD
18.ft CW
19.nf
20.ne \\$1
21..
8b0cefbb 22.de Ve \" End verbatim text
984263bc 23.ft R
984263bc
MD
24.fi
25..
8b0cefbb
JR
26.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
aac4ff6f
PA
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
8b0cefbb 33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
984263bc 34.ie n \{\
8b0cefbb
JR
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' ""
984263bc
MD
43'br\}
44.el\{\
8b0cefbb
JR
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
984263bc 49'br\}
8b0cefbb
JR
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"
984263bc 58..
8b0cefbb
JR
59. nr % 0
60. rr F
984263bc 61.\}
8b0cefbb 62.\"
aac4ff6f
PA
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.\"
8b0cefbb
JR
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
984263bc 71.if n \{\
8b0cefbb
JR
72. ds #H 0
73. ds #V .8m
74. ds #F .3m
75. ds #[ \f1
76. ds #] \fP
984263bc
MD
77.\}
78.if t \{\
8b0cefbb
JR
79. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80. ds #V .6m
81. ds #F 0
82. ds #[ \&
83. ds #] \&
984263bc 84.\}
8b0cefbb 85. \" simple accents for nroff and troff
984263bc 86.if n \{\
8b0cefbb
JR
87. ds ' \&
88. ds ` \&
89. ds ^ \&
90. ds , \&
91. ds ~ ~
92. ds /
984263bc
MD
93.\}
94.if t \{\
8b0cefbb
JR
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'
984263bc 101.\}
8b0cefbb 102. \" troff and (daisy-wheel) nroff accents
984263bc
MD
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
8b0cefbb 112. \" corrections for vroff
984263bc
MD
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'
8b0cefbb 115. \" for low resolution devices (crt and lpr)
984263bc
MD
116.if \n(.H>23 .if \n(.V>19 \
117\{\
8b0cefbb
JR
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
984263bc
MD
127.\}
128.rm #[ #] #H #V #F C
8b0cefbb
JR
129.\" ========================================================================
130.\"
131.IX Title "PKCS7 1"
aac4ff6f 132.TH PKCS7 1 "2008-09-06" "0.9.8h" "OpenSSL"
984263bc
MD
133.SH "NAME"
134pkcs7 \- PKCS#7 utility
135.SH "SYNOPSIS"
8b0cefbb
JR
136.IX Header "SYNOPSIS"
137\&\fBopenssl\fR \fBpkcs7\fR
984263bc
MD
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"
8b0cefbb
JR
147.IX Header "DESCRIPTION"
148The \fBpkcs7\fR command processes PKCS#7 files in \s-1DER\s0 or \s-1PEM\s0 format.
984263bc 149.SH "COMMAND OPTIONS"
8b0cefbb
JR
150.IX Header "COMMAND OPTIONS"
151.IP "\fB\-inform DER|PEM\fR" 4
152.IX Item "-inform DER|PEM"
153This specifies the input format. \fB\s-1DER\s0\fR format is \s-1DER\s0 encoded PKCS#7
984263bc
MD
154v1.5 structure.\fB\s-1PEM\s0\fR (the default) is a base64 encoded version of
155the \s-1DER\s0 form with header and footer lines.
8b0cefbb
JR
156.IP "\fB\-outform DER|PEM\fR" 4
157.IX Item "-outform DER|PEM"
984263bc 158This specifies the output format, the options have the same meaning as the
8b0cefbb
JR
159\&\fB\-inform\fR option.
160.IP "\fB\-in filename\fR" 4
161.IX Item "-in filename"
984263bc
MD
162This specifies the input filename to read from or standard input if this
163option is not specified.
8b0cefbb
JR
164.IP "\fB\-out filename\fR" 4
165.IX Item "-out filename"
984263bc
MD
166specifies the output filename to write to or standard output by
167default.
8b0cefbb
JR
168.IP "\fB\-print_certs\fR" 4
169.IX Item "-print_certs"
984263bc
MD
170prints out any certificates or CRLs contained in the file. They are
171preceded by their subject and issuer names in one line format.
8b0cefbb
JR
172.IP "\fB\-text\fR" 4
173.IX Item "-text"
984263bc
MD
174prints out certificates details in full rather than just subject and
175issuer names.
8b0cefbb
JR
176.IP "\fB\-noout\fR" 4
177.IX Item "-noout"
178don't output the encoded version of the PKCS#7 structure (or certificates
984263bc 179is \fB\-print_certs\fR is set).
8b0cefbb
JR
180.IP "\fB\-engine id\fR" 4
181.IX Item "-engine id"
984263bc
MD
182specifying an engine (by it's unique \fBid\fR string) will cause \fBreq\fR
183to attempt to obtain a functional reference to the specified engine,
184thus initialising it if needed. The engine will then be set as the default
185for all available algorithms.
186.SH "EXAMPLES"
8b0cefbb
JR
187.IX Header "EXAMPLES"
188Convert a PKCS#7 file from \s-1PEM\s0 to \s-1DER:\s0
984263bc
MD
189.PP
190.Vb 1
aac4ff6f 191\& openssl pkcs7 -in file.pem -outform DER -out file.der
984263bc 192.Ve
8b0cefbb 193.PP
984263bc
MD
194Output all certificates in a file:
195.PP
196.Vb 1
aac4ff6f 197\& openssl pkcs7 -in file.pem -print_certs -out certs.pem
984263bc
MD
198.Ve
199.SH "NOTES"
8b0cefbb
JR
200.IX Header "NOTES"
201The \s-1PEM\s0 PKCS#7 format uses the header and footer lines:
984263bc
MD
202.PP
203.Vb 2
aac4ff6f
PA
204\& -----BEGIN PKCS7-----
205\& -----END PKCS7-----
984263bc 206.Ve
8b0cefbb 207.PP
984263bc
MD
208For compatibility with some CAs it will also accept:
209.PP
210.Vb 2
aac4ff6f
PA
211\& -----BEGIN CERTIFICATE-----
212\& -----END CERTIFICATE-----
984263bc
MD
213.Ve
214.SH "RESTRICTIONS"
8b0cefbb 215.IX Header "RESTRICTIONS"
984263bc
MD
216There is no option to print out all the fields of a PKCS#7 file.
217.PP
8b0cefbb
JR
218This PKCS#7 routines only understand PKCS#7 v 1.5 as specified in \s-1RFC2315\s0 they
219cannot currently parse, for example, the new \s-1CMS\s0 as described in \s-1RFC2630\s0.
984263bc 220.SH "SEE ALSO"
e3cdf75b 221.IX Header "SEE ALSO"
8b0cefbb 222\&\fIcrl2pkcs7\fR\|(1)