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