5 CMS_ReceiptRequest_create0_ex, CMS_ReceiptRequest_create0,
6 CMS_add1_ReceiptRequest, CMS_get1_ReceiptRequest, CMS_ReceiptRequest_get0_values
7 - CMS signed receipt request functions
11 #include <openssl/cms.h>
13 CMS_ReceiptRequest *CMS_ReceiptRequest_create0_ex(
14 unsigned char *id, int idlen, int allorfirst,
15 STACK_OF(GENERAL_NAMES) *receiptList, STACK_OF(GENERAL_NAMES) *receiptsTo,
16 OSSL_LIB_CTX *libctx, const char *propq);
17 CMS_ReceiptRequest *CMS_ReceiptRequest_create0(
18 unsigned char *id, int idlen, int allorfirst,
19 STACK_OF(GENERAL_NAMES) *receiptList, STACK_OF(GENERAL_NAMES) *receiptsTo);
20 int CMS_add1_ReceiptRequest(CMS_SignerInfo *si, CMS_ReceiptRequest *rr);
21 int CMS_get1_ReceiptRequest(CMS_SignerInfo *si, CMS_ReceiptRequest **prr);
22 void CMS_ReceiptRequest_get0_values(CMS_ReceiptRequest *rr, ASN1_STRING **pcid,
24 STACK_OF(GENERAL_NAMES) **plist,
25 STACK_OF(GENERAL_NAMES) **prto);
29 CMS_ReceiptRequest_create0_ex() creates a signed receipt request
30 structure. The B<signedContentIdentifier> field is set using I<id> and I<idlen>,
31 or it is set to 32 bytes of pseudo random data if I<id> is NULL.
32 If I<receiptList> is NULL the allOrFirstTier option in I<receiptsFrom> is used
33 and set to the value of the I<allorfirst> parameter. If I<receiptList> is not
34 NULL the I<receiptList> option in I<receiptsFrom> is used. The I<receiptsTo>
35 parameter specifies the I<receiptsTo> field value. The library context I<libctx>
36 and the property query I<propq> are used when retrieving algorithms from providers.
38 CMS_ReceiptRequest_create0() is similar to
39 CMS_ReceiptRequest_create0_ex() but uses default values of NULL for the
40 library context I<libctx> and the property query I<propq>.
42 The CMS_add1_ReceiptRequest() function adds a signed receipt request B<rr>
43 to SignerInfo structure B<si>.
45 int CMS_get1_ReceiptRequest() looks for a signed receipt request in B<si>, if
46 any is found it is decoded and written to B<prr>.
48 CMS_ReceiptRequest_get0_values() retrieves the values of a receipt request.
49 The signedContentIdentifier is copied to B<pcid>. If the B<allOrFirstTier>
50 option of B<receiptsFrom> is used its value is copied to B<pallorfirst>
51 otherwise the B<receiptList> field is copied to B<plist>. The B<receiptsTo>
52 parameter is copied to B<prto>.
56 For more details of the meaning of the fields see RFC2634.
58 The contents of a signed receipt should only be considered meaningful if the
59 corresponding CMS_ContentInfo structure can be successfully verified using
64 CMS_ReceiptRequest_create0_ex() and CMS_ReceiptRequest_create0() return
65 a signed receipt request structure or NULL if an error occurred.
67 CMS_add1_ReceiptRequest() returns 1 for success or 0 if an error occurred.
69 CMS_get1_ReceiptRequest() returns 1 is a signed receipt request is found and
70 decoded. It returns 0 if a signed receipt request is not present and -1 if
71 it is present but malformed.
75 L<ERR_get_error(3)>, L<CMS_sign(3)>,
76 L<CMS_sign_receipt(3)>, L<CMS_verify(3)>
77 L<CMS_verify_receipt(3)>
81 The function CMS_ReceiptRequest_create0_ex() was added in OpenSSL 3.0.
85 Copyright 2008-2020 The OpenSSL Project Authors. All Rights Reserved.
87 Licensed under the Apache License 2.0 (the "License"). You may not use
88 this file except in compliance with the License. You can obtain a copy
89 in the file LICENSE in the source distribution or at
90 L<https://www.openssl.org/source/license.html>.