1=pod
2
3=head1 NAME
4
5CMS_ReceiptRequest_create0, CMS_add1_ReceiptRequest, CMS_get1_ReceiptRequest, CMS_ReceiptRequest_get0_values - CMS signed receipt request functions
6
7=head1 SYNOPSIS
8
9 #include <openssl/cms.h>
10
11 CMS_ReceiptRequest *CMS_ReceiptRequest_create0(unsigned char *id, int idlen,
12                                                int allorfirst,
13                                                STACK_OF(GENERAL_NAMES) *receiptList,
14                                                STACK_OF(GENERAL_NAMES) *receiptsTo);
15 int CMS_add1_ReceiptRequest(CMS_SignerInfo *si, CMS_ReceiptRequest *rr);
16 int CMS_get1_ReceiptRequest(CMS_SignerInfo *si, CMS_ReceiptRequest **prr);
17 void CMS_ReceiptRequest_get0_values(CMS_ReceiptRequest *rr, ASN1_STRING **pcid,
18                                     int *pallorfirst,
19                                     STACK_OF(GENERAL_NAMES) **plist,
20                                     STACK_OF(GENERAL_NAMES) **prto);
21
22=head1 DESCRIPTION
23
24CMS_ReceiptRequest_create0() creates a signed receipt request structure. The
25B<signedContentIdentifier> field is set using B<id> and B<idlen>, or it is set
26to 32 bytes of pseudo random data if B<id> is NULL. If B<receiptList> is NULL
27the allOrFirstTier option in B<receiptsFrom> is used and set to the value of
28the B<allorfirst> parameter. If B<receiptList> is not NULL the B<receiptList>
29option in B<receiptsFrom> is used. The B<receiptsTo> parameter specifies the
30B<receiptsTo> field value.
31
32The CMS_add1_ReceiptRequest() function adds a signed receipt request B<rr>
33to SignerInfo structure B<si>.
34
35int CMS_get1_ReceiptRequest() looks for a signed receipt request in B<si>, if
36any is found it is decoded and written to B<prr>.
37
38CMS_ReceiptRequest_get0_values() retrieves the values of a receipt request.
39The signedContentIdentifier is copied to B<pcid>. If the B<allOrFirstTier>
40option of B<receiptsFrom> is used its value is copied to B<pallorfirst>
41otherwise the B<receiptList> field is copied to B<plist>. The B<receiptsTo>
42parameter is copied to B<prto>.
43
44=head1 NOTES
45
46For more details of the meaning of the fields see RFC2634.
47
48The contents of a signed receipt should only be considered meaningful if the
49corresponding CMS_ContentInfo structure can be successfully verified using
50CMS_verify().
51
52=head1 RETURN VALUES
53
54CMS_ReceiptRequest_create0() returns a signed receipt request structure or
55NULL if an error occurred.
56
57CMS_add1_ReceiptRequest() returns 1 for success or 0 if an error occurred.
58
59CMS_get1_ReceiptRequest() returns 1 is a signed receipt request is found and
60decoded. It returns 0 if a signed receipt request is not present and -1 if
61it is present but malformed.
62
63=head1 SEE ALSO
64
65L<ERR_get_error(3)>, L<CMS_sign(3)>,
66L<CMS_sign_receipt(3)>, L<CMS_verify(3)>
67L<CMS_verify_receipt(3)>
68
69=head1 COPYRIGHT
70
71Copyright 2008-2018 The OpenSSL Project Authors. All Rights Reserved.
72
73Licensed under the OpenSSL license (the "License").  You may not use
74this file except in compliance with the License.  You can obtain a copy
75in the file LICENSE in the source distribution or at
76L<https://www.openssl.org/source/license.html>.
77
78=cut
79