Dr. Stephen Henson | 43d9e9d | 2008-04-10 11:00:47 +0000 | [diff] [blame] | 1 | =pod |
| 2 | |
| 3 | =head1 NAME |
| 4 | |
Rich Salz | 1bc7451 | 2016-05-20 08:11:46 -0400 | [diff] [blame] | 5 | CMS_sign_receipt - create a CMS signed receipt |
Dr. Stephen Henson | 43d9e9d | 2008-04-10 11:00:47 +0000 | [diff] [blame] | 6 | |
| 7 | =head1 SYNOPSIS |
| 8 | |
| 9 | #include <openssl/cms.h> |
| 10 | |
Beat Bolli | e9b7724 | 2017-01-20 19:58:49 +0100 | [diff] [blame] | 11 | CMS_ContentInfo *CMS_sign_receipt(CMS_SignerInfo *si, X509 *signcert, |
| 12 | EVP_PKEY *pkey, STACK_OF(X509) *certs, |
| 13 | unsigned int flags); |
Dr. Stephen Henson | 43d9e9d | 2008-04-10 11:00:47 +0000 | [diff] [blame] | 14 | |
| 15 | =head1 DESCRIPTION |
| 16 | |
| 17 | CMS_sign_receipt() creates and returns a CMS signed receipt structure. B<si> is |
| 18 | the B<CMS_SignerInfo> structure containing the signed receipt request. |
| 19 | B<signcert> is the certificate to sign with, B<pkey> is the corresponding |
| 20 | private key. B<certs> is an optional additional set of certificates to include |
| 21 | in the CMS structure (for example any intermediate CAs in the chain). |
| 22 | |
| 23 | B<flags> is an optional set of flags. |
| 24 | |
| 25 | =head1 NOTES |
| 26 | |
| 27 | This functions behaves in a similar way to CMS_sign() except the flag values |
| 28 | B<CMS_DETACHED>, B<CMS_BINARY>, B<CMS_NOATTR>, B<CMS_TEXT> and B<CMS_STREAM> |
| 29 | are not supported since they do not make sense in the context of signed |
| 30 | receipts. |
| 31 | |
| 32 | =head1 RETURN VALUES |
| 33 | |
| 34 | CMS_sign_receipt() returns either a valid CMS_ContentInfo structure or NULL if |
| 35 | an error occurred. The error can be obtained from ERR_get_error(3). |
| 36 | |
| 37 | =head1 SEE ALSO |
| 38 | |
Rich Salz | 9b86974 | 2015-08-17 15:21:33 -0400 | [diff] [blame] | 39 | L<ERR_get_error(3)>, |
| 40 | L<CMS_verify_receipt(3)>, |
| 41 | L<CMS_sign(3)> |
Dr. Stephen Henson | 43d9e9d | 2008-04-10 11:00:47 +0000 | [diff] [blame] | 42 | |
Rich Salz | e2f9261 | 2016-05-18 11:44:05 -0400 | [diff] [blame] | 43 | =head1 COPYRIGHT |
| 44 | |
| 45 | Copyright 2008-2016 The OpenSSL Project Authors. All Rights Reserved. |
| 46 | |
| 47 | Licensed under the OpenSSL license (the "License"). You may not use |
| 48 | this file except in compliance with the License. You can obtain a copy |
| 49 | in the file LICENSE in the source distribution or at |
| 50 | L<https://www.openssl.org/source/license.html>. |
| 51 | |
| 52 | =cut |