OLD | NEW |
1 =pod | 1 =pod |
2 | 2 |
3 =head1 NAME | 3 =head1 NAME |
4 | 4 |
5 PKCS7_sign - create a PKCS#7 signedData structure | 5 PKCS7_sign - create a PKCS#7 signedData structure |
6 | 6 |
7 =head1 SYNOPSIS | 7 =head1 SYNOPSIS |
8 | 8 |
9 #include <openssl/pkcs7.h> | 9 #include <openssl/pkcs7.h> |
10 | 10 |
11 PKCS7 *PKCS7_sign(X509 *signcert, EVP_PKEY *pkey, STACK_OF(X509) *certs, BIO *d
ata, int flags); | 11 PKCS7 *PKCS7_sign(X509 *signcert, EVP_PKEY *pkey, STACK_OF(X509) *certs, BIO *d
ata, int flags); |
12 | 12 |
13 =head1 DESCRIPTION | 13 =head1 DESCRIPTION |
14 | 14 |
15 PKCS7_sign() creates and returns a PKCS#7 signedData structure. B<signcert> | 15 PKCS7_sign() creates and returns a PKCS#7 signedData structure. B<signcert> is |
16 is the certificate to sign with, B<pkey> is the corresponsding private key. | 16 the certificate to sign with, B<pkey> is the corresponsding private key. |
17 B<certs> is an optional additional set of certificates to include in the | 17 B<certs> is an optional additional set of certificates to include in the PKCS#7 |
18 PKCS#7 structure (for example any intermediate CAs in the chain). | 18 structure (for example any intermediate CAs in the chain). |
19 | 19 |
20 The data to be signed is read from BIO B<data>. | 20 The data to be signed is read from BIO B<data>. |
21 | 21 |
22 B<flags> is an optional set of flags. | 22 B<flags> is an optional set of flags. |
23 | 23 |
24 =head1 NOTES | 24 =head1 NOTES |
25 | 25 |
26 Any of the following flags (ored together) can be passed in the B<flags> paramet
er. | 26 Any of the following flags (ored together) can be passed in the B<flags> |
| 27 parameter. |
27 | 28 |
28 Many S/MIME clients expect the signed content to include valid MIME headers. If | 29 Many S/MIME clients expect the signed content to include valid MIME headers. If |
29 the B<PKCS7_TEXT> flag is set MIME headers for type B<text/plain> are prepended | 30 the B<PKCS7_TEXT> flag is set MIME headers for type B<text/plain> are prepended |
30 to the data. | 31 to the data. |
31 | 32 |
32 If B<PKCS7_NOCERTS> is set the signer's certificate will not be included in the | 33 If B<PKCS7_NOCERTS> is set the signer's certificate will not be included in the |
33 PKCS7 structure, the signer's certificate must still be supplied in the B<signce
rt> | 34 PKCS7 structure, the signer's certificate must still be supplied in the |
34 parameter though. This can reduce the size of the signature if the signers certi
ficate | 35 B<signcert> parameter though. This can reduce the size of the signature if the |
35 can be obtained by other means: for example a previously signed message. | 36 signers certificate can be obtained by other means: for example a previously |
| 37 signed message. |
36 | 38 |
37 The data being signed is included in the PKCS7 structure, unless B<PKCS7_DETACHE
D> | 39 The data being signed is included in the PKCS7 structure, unless |
38 is set in which case it is omitted. This is used for PKCS7 detached signatures | 40 B<PKCS7_DETACHED> is set in which case it is omitted. This is used for PKCS7 |
39 which are used in S/MIME plaintext signed messages for example. | 41 detached signatures which are used in S/MIME plaintext signed messages for |
| 42 example. |
40 | 43 |
41 Normally the supplied content is translated into MIME canonical format (as requi
red | 44 Normally the supplied content is translated into MIME canonical format (as |
42 by the S/MIME specifications) if B<PKCS7_BINARY> is set no translation occurs. T
his | 45 required by the S/MIME specifications) if B<PKCS7_BINARY> is set no translation |
43 option should be used if the supplied data is in binary format otherwise the tra
nslation | 46 occurs. This option should be used if the supplied data is in binary format |
44 will corrupt it. | 47 otherwise the translation will corrupt it. |
45 | 48 |
46 The signedData structure includes several PKCS#7 autenticatedAttributes includin
g | 49 The signedData structure includes several PKCS#7 autenticatedAttributes |
47 the signing time, the PKCS#7 content type and the supported list of ciphers in | 50 including the signing time, the PKCS#7 content type and the supported list of |
48 an SMIMECapabilities attribute. If B<PKCS7_NOATTR> is set then no authenticatedA
ttributes | 51 ciphers in an SMIMECapabilities attribute. If B<PKCS7_NOATTR> is set then no |
49 will be used. If B<PKCS7_NOSMIMECAP> is set then just the SMIMECapabilities are | 52 authenticatedAttributes will be used. If B<PKCS7_NOSMIMECAP> is set then just |
50 omitted. | 53 the SMIMECapabilities are omitted. |
51 | 54 |
52 If present the SMIMECapabilities attribute indicates support for the following | 55 If present the SMIMECapabilities attribute indicates support for the following |
53 algorithms: triple DES, 128 bit RC2, 64 bit RC2, DES and 40 bit RC2. If any | 56 algorithms: triple DES, 128 bit RC2, 64 bit RC2, DES and 40 bit RC2. If any of |
54 of these algorithms is disabled then it will not be included. | 57 these algorithms is disabled then it will not be included. |
55 | 58 |
56 If the flags B<PKCS7_PARTSIGN> is set then the returned B<PKCS7> structure | 59 If the flags B<PKCS7_STREAM> is set then the returned B<PKCS7> structure is |
57 is just initialized ready to perform the signing operation. The signing | 60 just initialized ready to perform the signing operation. The signing is however |
58 is however B<not> performed and the data to be signed is not read from | 61 B<not> performed and the data to be signed is not read from the B<data> |
59 the B<data> parameter. Signing is deferred until after the data has been | 62 parameter. Signing is deferred until after the data has been written. In this |
60 written. In this way data can be signed in a single pass. Currently the | 63 way data can be signed in a single pass. |
61 flag B<PKCS7_DETACHED> B<must> also be set. | 64 |
| 65 If the B<PKCS7_PARTIAL> flag is set a partial B<PKCS7> structure is output to |
| 66 which additional signers and capabilities can be added before finalization. |
| 67 |
62 | 68 |
63 =head1 NOTES | 69 =head1 NOTES |
64 | 70 |
65 Currently the flag B<PKCS7_PARTSIGN> is only supported for detached | 71 If the flag B<PKCS7_STREAM> is set the returned B<PKCS7> structure is B<not> |
66 data. If this flag is set the returned B<PKCS7> structure is B<not> | 72 complete and outputting its contents via a function that does not properly |
67 complete and outputting its contents via a function that does not | 73 finalize the B<PKCS7> structure will give unpredictable results. |
68 properly finalize the B<PKCS7> structure will give unpredictable | |
69 results. | |
70 | 74 |
71 At present only the SMIME_write_PKCS7() function properly finalizes the | 75 Several functions including SMIME_write_PKCS7(), i2d_PKCS7_bio_stream(), |
72 structure. | 76 PEM_write_bio_PKCS7_stream() finalize the structure. Alternatively finalization |
| 77 can be performed by obtaining the streaming ASN1 B<BIO> directly using |
| 78 BIO_new_PKCS7(). |
| 79 |
| 80 If a signer is specified it will use the default digest for the signing |
| 81 algorithm. This is B<SHA1> for both RSA and DSA keys. |
| 82 |
| 83 In OpenSSL 1.0.0 the B<certs>, B<signcert> and B<pkey> parameters can all be |
| 84 B<NULL> if the B<PKCS7_PARTIAL> flag is set. One or more signers can be added |
| 85 using the function B<PKCS7_sign_add_signer()>. B<PKCS7_final()> must also be |
| 86 called to finalize the structure if streaming is not enabled. Alternative |
| 87 signing digests can also be specified using this method. |
| 88 |
| 89 In OpenSSL 1.0.0 if B<signcert> and B<pkey> are NULL then a certificates only |
| 90 PKCS#7 structure is output. |
| 91 |
| 92 In versions of OpenSSL before 1.0.0 the B<signcert> and B<pkey> parameters must |
| 93 B<NOT> be NULL. |
73 | 94 |
74 =head1 BUGS | 95 =head1 BUGS |
75 | 96 |
76 PKCS7_sign() is somewhat limited. It does not support multiple signers, some | 97 Some advanced attributes such as counter signatures are not supported. |
77 advanced attributes such as counter signatures are not supported. | |
78 | |
79 The SHA1 digest algorithm is currently always used. | |
80 | |
81 When the signed data is not detached it will be stored in memory within the | |
82 B<PKCS7> structure. This effectively limits the size of messages which can be | |
83 signed due to memory restraints. There should be a way to sign data without | |
84 having to hold it all in memory, this would however require fairly major | |
85 revisions of the OpenSSL ASN1 code. | |
86 | |
87 | 98 |
88 =head1 RETURN VALUES | 99 =head1 RETURN VALUES |
89 | 100 |
90 PKCS7_sign() returns either a valid PKCS7 structure or NULL if an error occurred
. | 101 PKCS7_sign() returns either a valid PKCS7 structure or NULL if an error |
91 The error can be obtained from ERR_get_error(3). | 102 occurred. The error can be obtained from ERR_get_error(3). |
92 | 103 |
93 =head1 SEE ALSO | 104 =head1 SEE ALSO |
94 | 105 |
95 L<ERR_get_error(3)|ERR_get_error(3)>, L<PKCS7_verify(3)|PKCS7_verify(3)> | 106 L<ERR_get_error(3)|ERR_get_error(3)>, L<PKCS7_verify(3)|PKCS7_verify(3)> |
96 | 107 |
97 =head1 HISTORY | 108 =head1 HISTORY |
98 | 109 |
99 PKCS7_sign() was added to OpenSSL 0.9.5 | 110 PKCS7_sign() was added to OpenSSL 0.9.5 |
100 | 111 |
101 The B<PKCS7_PARTSIGN> flag was added in OpenSSL 0.9.8 | 112 The B<PKCS7_PARTIAL> flag was added in OpenSSL 1.0.0 |
| 113 |
| 114 The B<PKCS7_STREAM> flag was added in OpenSSL 1.0.0 |
102 | 115 |
103 =cut | 116 =cut |
OLD | NEW |