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