CMS_GET1_RECEIPTREQUEST(3ossl)

πŸ“¦
version 15.1 Β· 2 versions
, in freebsd 15.1

πŸ’Œ CMS_GET1_RECEIPTREQUEST(3ossl) β€” the signed-receipt-request girlies

okay so this is the 3ossl manual page for the CMS signed receipt request functions, bestie. if you've ever wondered "how do I ask someone to send me a signed receipt for a message I sent," this is literally your page. receipts ℒ️ but cryptographically real πŸ’…


✨ NAME ✨

CMS_ReceiptRequest_create0_ex, CMS_ReceiptRequest_create0, CMS_add1_ReceiptRequest, CMS_get1_ReceiptRequest, CMS_ReceiptRequest_get0_values β€” CMS signed receipt request functions πŸŽ€


🌸 SYNOPSIS 🌸

#include <openssl/cms.h>

CMS_ReceiptRequest *CMS_ReceiptRequest_create0_ex(
    unsigned char *id, int idlen, int allorfirst,
    STACK_OF(GENERAL_NAMES) *receiptList, STACK_OF(GENERAL_NAMES) *receiptsTo,
    OSSL_LIB_CTX *libctx);
CMS_ReceiptRequest *CMS_ReceiptRequest_create0(
    unsigned char *id, int idlen, int allorfirst,
    STACK_OF(GENERAL_NAMES) *receiptList, STACK_OF(GENERAL_NAMES) *receiptsTo);
int CMS_add1_ReceiptRequest(CMS_SignerInfo *si, CMS_ReceiptRequest *rr);
int CMS_get1_ReceiptRequest(CMS_SignerInfo *si, CMS_ReceiptRequest **prr);
void CMS_ReceiptRequest_get0_values(CMS_ReceiptRequest *rr, ASN1_STRING **pcid,
                                    int *pallorfirst,
                                    STACK_OF(GENERAL_NAMES) **plist,
                                    STACK_OF(GENERAL_NAMES) **prto);

πŸ¦‹ DESCRIPTION πŸ¦‹

CMS_ReceiptRequest_create0_ex() creates a signed receipt request structure. iconic behavior honestly.

  • the signedContentIdentifier field gets set using id and idlen β€” or, if id is NULL, it's set to 32 bytes of pseudo random data 🎲
  • if receiptList is NULL, the allOrFirstTier option in receiptsFrom is used, set to the value of the allorfirst parameter
  • if receiptList is not NULL, the receiptList option in receiptsFrom is used instead
  • the receiptsTo parameter specifies the value of the receiptsTo field
  • the library context libctx is used to find the public random generator πŸ”‘

CMS_ReceiptRequest_create0() is basically the same bestie as CMS_ReceiptRequest_create0_ex() but it uses default values of NULL for the library context libctx. lowkey the low-effort sibling and we love her for it 🫢

CMS_add1_ReceiptRequest() adds a signed receipt request rr to the SignerInfo structure si. drop it in, slay πŸ’…

int CMS_get1_ReceiptRequest() looks for a signed receipt request in si β€” and if one is found, it gets decoded and written to prr. found her πŸ‘‘

CMS_ReceiptRequest_get0_values() retrieves the values of a receipt request:

  • the signedContentIdentifier is copied to pcid
  • if the allOrFirstTier option of receiptsFrom is used, its value is copied to pallorfirst
  • otherwise the receiptList field is copied to plist
  • the receiptsTo parameter is copied to prto

⭐ NOTES ⭐

for the full deets on what these fields actually mean, see RFC2634 πŸ“œ (iykyk)

⚠️ important vibe check: the contents of a signed receipt should only be considered meaningful if the corresponding CMS_ContentInfo structure can be successfully verified using CMS_verify(). no verification, no trust. periodt πŸ’€

🌈 RETURN VALUES 🌈

  • CMS_ReceiptRequest_create0_ex() and CMS_ReceiptRequest_create0() return a signed receipt request structure β€” or NULL if an error occurred 😭
  • CMS_add1_ReceiptRequest() returns 1 for success or 0 if an error occurred
  • CMS_get1_ReceiptRequest() returns 1 if a signed receipt request is found and decoded. it returns 0 if a signed receipt request is not present, and -1 if it is present but malformed 🩹

🧚 SEE ALSO 🧚

ERR_get_error(3), CMS_sign(3), CMS_sign_receipt(3), CMS_verify(3), CMS_verify_receipt(3) β€” go read those next, bestie, they're literally the whole friend group 🫢


πŸŽ€ HISTORY πŸŽ€

the function CMS_ReceiptRequest_create0_ex() was added in OpenSSL 3.0. she's new-ish, she's fresh, she ate ✨


Copyright 2008-2021 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.


and that's the whole page, babes πŸ’œ this was version 3.5.6, dated 2026-04-07, and yeah β€” we read the whole CMS_GET1_RECEIPTREQUEST(3ossl) page top to bottom. no skimming, no cap. go get those receipts πŸ§ΎπŸ’…

πŸ“¦ where this page comes from