]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - secure/usr.bin/openssl/man/pkcs7.1
MFC: r312825
[FreeBSD/FreeBSD.git] / secure / usr.bin / openssl / man / pkcs7.1
1 .\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.35)
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 .    ds C`
42 .    ds C'
43 'br\}
44 .\"
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
46 .ie \n(.g .ds Aq \(aq
47 .el       .ds Aq '
48 .\"
49 .\" If the F register is >0, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
53 .\"
54 .\" Avoid warning from groff about undefined register 'F'.
55 .de IX
56 ..
57 .if !\nF .nr F 0
58 .if \nF>0 \{\
59 .    de IX
60 .    tm Index:\\$1\t\\n%\t"\\$2"
61 ..
62 .    if !\nF==2 \{\
63 .        nr % 0
64 .        nr F 2
65 .    \}
66 .\}
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 "2017-01-26" "1.0.2k" "OpenSSL"
133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
134 .\" way too many mistakes in technical documents.
135 .if n .ad l
136 .nh
137 .SH "NAME"
138 pkcs7 \- PKCS#7 utility
139 .SH "SYNOPSIS"
140 .IX Header "SYNOPSIS"
141 \&\fBopenssl\fR \fBpkcs7\fR
142 [\fB\-inform PEM|DER\fR]
143 [\fB\-outform PEM|DER\fR]
144 [\fB\-in filename\fR]
145 [\fB\-out filename\fR]
146 [\fB\-print_certs\fR]
147 [\fB\-text\fR]
148 [\fB\-noout\fR]
149 [\fB\-engine id\fR]
150 .SH "DESCRIPTION"
151 .IX Header "DESCRIPTION"
152 The \fBpkcs7\fR command processes PKCS#7 files in \s-1DER\s0 or \s-1PEM\s0 format.
153 .SH "COMMAND OPTIONS"
154 .IX Header "COMMAND OPTIONS"
155 .IP "\fB\-inform DER|PEM\fR" 4
156 .IX Item "-inform DER|PEM"
157 This specifies the input format. \fB\s-1DER\s0\fR format is \s-1DER\s0 encoded PKCS#7
158 v1.5 structure.\fB\s-1PEM\s0\fR (the default) is a base64 encoded version of
159 the \s-1DER\s0 form with header and footer lines.
160 .IP "\fB\-outform DER|PEM\fR" 4
161 .IX Item "-outform DER|PEM"
162 This specifies the output format, the options have the same meaning as the 
163 \&\fB\-inform\fR option.
164 .IP "\fB\-in filename\fR" 4
165 .IX Item "-in filename"
166 This specifies the input filename to read from or standard input if this
167 option is not specified.
168 .IP "\fB\-out filename\fR" 4
169 .IX Item "-out filename"
170 specifies the output filename to write to or standard output by
171 default.
172 .IP "\fB\-print_certs\fR" 4
173 .IX Item "-print_certs"
174 prints out any certificates or CRLs contained in the file. They are
175 preceded by their subject and issuer names in one line format.
176 .IP "\fB\-text\fR" 4
177 .IX Item "-text"
178 prints out certificates details in full rather than just subject and
179 issuer names.
180 .IP "\fB\-noout\fR" 4
181 .IX Item "-noout"
182 don't output the encoded version of the PKCS#7 structure (or certificates
183 is \fB\-print_certs\fR is set).
184 .IP "\fB\-engine id\fR" 4
185 .IX Item "-engine id"
186 specifying an engine (by its unique \fBid\fR string) will cause \fBpkcs7\fR
187 to attempt to obtain a functional reference to the specified engine,
188 thus initialising it if needed. The engine will then be set as the default
189 for all available algorithms.
190 .SH "EXAMPLES"
191 .IX Header "EXAMPLES"
192 Convert a PKCS#7 file from \s-1PEM\s0 to \s-1DER:\s0
193 .PP
194 .Vb 1
195 \& openssl pkcs7 \-in file.pem \-outform DER \-out file.der
196 .Ve
197 .PP
198 Output all certificates in a file:
199 .PP
200 .Vb 1
201 \& openssl pkcs7 \-in file.pem \-print_certs \-out certs.pem
202 .Ve
203 .SH "NOTES"
204 .IX Header "NOTES"
205 The \s-1PEM\s0 PKCS#7 format uses the header and footer lines:
206 .PP
207 .Vb 2
208 \& \-\-\-\-\-BEGIN PKCS7\-\-\-\-\-
209 \& \-\-\-\-\-END PKCS7\-\-\-\-\-
210 .Ve
211 .PP
212 For compatibility with some CAs it will also accept:
213 .PP
214 .Vb 2
215 \& \-\-\-\-\-BEGIN CERTIFICATE\-\-\-\-\-
216 \& \-\-\-\-\-END CERTIFICATE\-\-\-\-\-
217 .Ve
218 .SH "RESTRICTIONS"
219 .IX Header "RESTRICTIONS"
220 There is no option to print out all the fields of a PKCS#7 file.
221 .PP
222 This PKCS#7 routines only understand PKCS#7 v 1.5 as specified in \s-1RFC2315\s0 they 
223 cannot currently parse, for example, the new \s-1CMS\s0 as described in \s-1RFC2630.\s0
224 .SH "SEE ALSO"
225 .IX Header "SEE ALSO"
226 \&\fIcrl2pkcs7\fR\|(1)