| blob | d9c29afd3ba0cade85e1b79d82e5494b9ed1f714 |
1 .\" $NetBSD: libcrypto.pl,v 1.3 2007/11/27 22:16:03 christos Exp $
2 .\"
3 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
4 .\"
5 .\" Standard preamble:
6 .\" ========================================================================
7 .de Sh \" Subsection heading
8 .br
9 .if t .Sp
10 .ne 5
11 .PP
12 \fB\\$1\fR
13 .PP
14 ..
15 .de Sp \" Vertical space (when we can't use .PP)
16 .if t .sp .5v
17 .if n .sp
18 ..
19 .de Vb \" Begin verbatim text
20 .ft CW
21 .nf
22 .ne \\$1
23 ..
24 .de Ve \" End verbatim text
25 .ft R
26 .fi
27 ..
28 .\" Set up some character translations and predefined strings. \*(-- will
29 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
30 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
31 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
32 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
33 .\" nothing in troff, for use with C<>.
34 .tr \(*W-
35 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
36 .ie n \{\
37 . ds -- \(*W-
38 . ds PI pi
39 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
40 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
41 . ds L" ""
42 . ds R" ""
43 . ds C` ""
44 . ds C' ""
45 'br\}
46 .el\{\
47 . ds -- \|\(em\|
48 . ds PI \(*p
49 . ds L" ``
50 . ds R" ''
51 'br\}
52 .\"
53 .\" Escape single quotes in literal strings from groff's Unicode transform.
54 .ie \n(.g .ds Aq \(aq
55 .el .ds Aq '
56 .\"
57 .\" If the F register is turned on, we'll generate index entries on stderr for
58 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
59 .\" entries marked with X<> in POD. Of course, you'll have to process the
60 .\" output yourself in some meaningful fashion.
61 .ie \nF \{\
62 . de IX
63 . tm Index:\\$1\t\\n%\t"\\$2"
64 ..
65 . nr % 0
66 . rr F
67 .\}
68 .el \{\
69 . de IX
70 ..
71 .\}
72 .\"
73 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
74 .\" Fear. Run. Save yourself. No user-serviceable parts.
75 . \" fudge factors for nroff and troff
76 .if n \{\
77 . ds #H 0
78 . ds #V .8m
79 . ds #F .3m
80 . ds #[ \f1
81 . ds #] \fP
82 .\}
83 .if t \{\
84 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
85 . ds #V .6m
86 . ds #F 0
87 . ds #[ \&
88 . ds #] \&
89 .\}
90 . \" simple accents for nroff and troff
91 .if n \{\
92 . ds ' \&
93 . ds ` \&
94 . ds ^ \&
95 . ds , \&
96 . ds ~ ~
97 . ds /
98 .\}
99 .if t \{\
100 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
101 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
102 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
103 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
104 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
105 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
106 .\}
107 . \" troff and (daisy-wheel) nroff accents
108 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
109 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
110 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
111 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
112 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
113 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
114 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
115 .ds ae a\h'-(\w'a'u*4/10)'e
116 .ds Ae A\h'-(\w'A'u*4/10)'E
117 . \" corrections for vroff
118 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
119 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
120 . \" for low resolution devices (crt and lpr)
121 .if \n(.H>23 .if \n(.V>19 \
122 \{\
123 . ds : e
124 . ds 8 ss
125 . ds o a
126 . ds d- d\h'-1'\(ga
127 . ds D- D\h'-1'\(hy
128 . ds th \o'bp'
129 . ds Th \o'LP'
130 . ds ae ae
131 . ds Ae AE
132 .\}
133 .rm #[ #] #H #V #F C
134 .\" ========================================================================
135 .\"
136 .IX Title "PKCS7_sign 3"
137 .TH PKCS7_sign 3 "2008-04-08" "1.1.0-dev" "OpenSSL"
138 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
139 .\" way too many mistakes in technical documents.
140 .if n .ad l
141 .nh
142 .SH "NAME"
143 PKCS7_sign \- create a PKCS#7 signedData structure
144 .SH "LIBRARY"
145 libcrypto, -lcrypto
146 .SH "SYNOPSIS"
147 .IX Header "SYNOPSIS"
148 .Vb 1
149 \& #include <openssl/pkcs7.h>
150 \&
151 \& PKCS7 *PKCS7_sign(X509 *signcert, EVP_PKEY *pkey, STACK_OF(X509) *certs, BIO *data, int flags);
152 .Ve
153 .SH "DESCRIPTION"
154 .IX Header "DESCRIPTION"
155 \&\fIPKCS7_sign()\fR creates and returns a PKCS#7 signedData structure. \fBsigncert\fR is
156 the certificate to sign with, \fBpkey\fR is the corresponsding private key.
157 \&\fBcerts\fR is an optional additional set of certificates to include in the PKCS#7
158 structure (for example any intermediate CAs in the chain).
159 .PP
160 The data to be signed is read from \s-1BIO\s0 \fBdata\fR.
161 .PP
162 \&\fBflags\fR is an optional set of flags.
163 .SH "NOTES"
164 .IX Header "NOTES"
165 Any of the following flags (ored together) can be passed in the \fBflags\fR
166 parameter.
167 .PP
168 Many S/MIME clients expect the signed content to include valid \s-1MIME\s0 headers. If
169 the \fB\s-1PKCS7_TEXT\s0\fR flag is set \s-1MIME\s0 headers for type \fBtext/plain\fR are prepended
170 to the data.
171 .PP
172 If \fB\s-1PKCS7_NOCERTS\s0\fR is set the signer's certificate will not be included in the
173 \&\s-1PKCS7\s0 structure, the signer's certificate must still be supplied in the
174 \&\fBsigncert\fR parameter though. This can reduce the size of the signature if the
175 signers certificate can be obtained by other means: for example a previously
176 signed message.
177 .PP
178 The data being signed is included in the \s-1PKCS7\s0 structure, unless
179 \&\fB\s-1PKCS7_DETACHED\s0\fR is set in which case it is omitted. This is used for \s-1PKCS7\s0
180 detached signatures which are used in S/MIME plaintext signed messages for
181 example.
182 .PP
183 Normally the supplied content is translated into \s-1MIME\s0 canonical format (as
184 required by the S/MIME specifications) if \fB\s-1PKCS7_BINARY\s0\fR is set no translation
185 occurs. This option should be used if the supplied data is in binary format
186 otherwise the translation will corrupt it.
187 .PP
188 The signedData structure includes several PKCS#7 autenticatedAttributes
189 including the signing time, the PKCS#7 content type and the supported list of
190 ciphers in an SMIMECapabilities attribute. If \fB\s-1PKCS7_NOATTR\s0\fR is set then no
191 authenticatedAttributes will be used. If \fB\s-1PKCS7_NOSMIMECAP\s0\fR is set then just
192 the SMIMECapabilities are omitted.
193 .PP
194 If present the SMIMECapabilities attribute indicates support for the following
195 algorithms: triple \s-1DES\s0, 128 bit \s-1RC2\s0, 64 bit \s-1RC2\s0, \s-1DES\s0 and 40 bit \s-1RC2\s0. If any of
196 these algorithms is disabled then it will not be included.
197 .PP
198 If the flags \fB\s-1PKCS7_STREAM\s0\fR is set then the returned \fB\s-1PKCS7\s0\fR structure is
199 just initialized ready to perform the signing operation. The signing is however
200 \&\fBnot\fR performed and the data to be signed is not read from the \fBdata\fR
201 parameter. Signing is deferred until after the data has been written. In this
202 way data can be signed in a single pass.
203 .PP
204 If the \fB\s-1PKCS7_PARTIAL\s0\fR flag is set a partial \fB\s-1PKCS7\s0\fR structure is output to
205 which additional signers and capabilities can be added before finalization.
206 .SH "NOTES"
207 .IX Header "NOTES"
208 If the flag \fB\s-1PKCS7_STREAM\s0\fR is set the returned \fB\s-1PKCS7\s0\fR structure is \fBnot\fR
209 complete and outputting its contents via a function that does not properly
210 finalize the \fB\s-1PKCS7\s0\fR structure will give unpredictable results.
211 .PP
212 Several functions including \fISMIME_write_PKCS7()\fR, \fIi2d_PKCS7_bio_stream()\fR,
213 \&\fIPEM_write_bio_PKCS7_stream()\fR finalize the structure. Alternatively finalization
214 can be performed by obtaining the streaming \s-1ASN1\s0 \fB\s-1BIO\s0\fR directly using
215 \&\fIBIO_new_PKCS7()\fR.
216 .PP
217 If a signer is specified it will use the default digest for the signing
218 algorithm. This is \fB\s-1SHA1\s0\fR for both \s-1RSA\s0 and \s-1DSA\s0 keys.
219 .PP
220 In OpenSSL 0.9.9 the \fBcerts\fR, \fBsigncert\fR and \fBpkey\fR parameters can all be
221 \&\fB\s-1NULL\s0\fR if the \fB\s-1PKCS7_PARTIAL\s0\fR flag is set. One or more signers can be added
222 using the function \fB\f(BIPKCS7_sign_add_signer()\fB\fR. \fB\f(BIPKCS7_final()\fB\fR must also be
223 called to finalize the structure if streaming is not enabled. Alternative
224 signing digests can also be specified using this method.
225 .PP
226 In OpenSSL 0.9.9 if \fBsigncert\fR and \fBpkey\fR are \s-1NULL\s0 then a certificates only
227 PKCS#7 structure is output.
228 .PP
229 In versions of OpenSSL before 0.9.9 the \fBsigncert\fR and \fBpkey\fR parameters must
230 \&\fB\s-1NOT\s0\fR be \s-1NULL\s0.
231 .SH "BUGS"
232 .IX Header "BUGS"
233 Some advanced attributes such as counter signatures are not supported.
234 .SH "RETURN VALUES"
235 .IX Header "RETURN VALUES"
236 \&\fIPKCS7_sign()\fR returns either a valid \s-1PKCS7\s0 structure or \s-1NULL\s0 if an error
237 occurred. The error can be obtained from \fIERR_get_error\fR\|(3).
238 .SH "SEE ALSO"
239 .IX Header "SEE ALSO"
240 \&\fIERR_get_error\fR\|(3), \fIPKCS7_verify\fR\|(3)
241 .SH "HISTORY"
242 .IX Header "HISTORY"
243 \&\fIPKCS7_sign()\fR was added to OpenSSL 0.9.5
244 .PP
245 The \fB\s-1PKCS7_PARTIAL\s0\fR flag was added in OpenSSL 0.9.9
246 .PP
247 The \fB\s-1PKCS7_STREAM\s0\fR flag was added in OpenSSL 0.9.9