CMS_GET1_RECEIPTREQUEST(3)

CMS_GET1_RECEIPTREQUEST(3) 💅

✨ NAME ✨

okay so bestie, this is the CMS_GET1_RECEIPTREQUEST(3) page from the Library Functions Manual, and it's all about the CMS signed receipt request functions: CMS_ReceiptRequest_create0, CMS_add1_ReceiptRequest, CMS_get1_ReceiptRequest, and CMS_ReceiptRequest_get0_values. we are so in the right place 💖

🌸 SYNOPSIS 🌸

the library is libcrypto, and the header is <openssl/cms.h> — here's the whole cast, exactly as written, no edits:

library “libcrypto” #include <openssl/cms.h>

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()

okay so CMS_ReceiptRequest_create0() creates a brand-new ReceiptRequest structure. the signedContentIdentifier field gets set using id and idlen, or — if id is NULL — it gets set to 32 bytes of pseudo random data. if receiptList is NULL, the allOrFirstTier option in the receiptsFrom field is set to the value of the allorfirst argument. if receiptList is not NULL, the receiptList option in the receiptsFrom field is used instead. and the receiptsTo argument specifies the value of the receiptsTo field. slay. ✨

🧚 CMS_add1_ReceiptRequest()

CMS_add1_ReceiptRequest() adds a BER-encoded copy of rr to si. that's it, that's the whole vibe. 💅

🦋 CMS_get1_ReceiptRequest()

CMS_get1_ReceiptRequest() looks for a signed receipt request in si. if any is found, it gets decoded and written to prr. iconic. 🔥

🍓 CMS_ReceiptRequest_get0_values()

CMS_ReceiptRequest_get0_values() retrieves the values of a receipt request. the signedContentIdentifier is copied to pcid. if the allOrFirstTier option is used in the receiptsFrom field, its value is copied to pallorfirst; otherwise the receiptList field is copied to plist. the receiptsTo field is copied to prto. got it? good, because we're keeping all of it. 🫶

💀 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(3). no cap, don't skip the verify step.

👑 RETURN VALUES 👑

• CMS_ReceiptRequest_create0() — returns the new signed receipt request structure, or NULL if an error occurred. 😭
• CMS_add1_ReceiptRequest() — returns 1 for success or 0 if an error occurred. periodt.
• CMS_get1_ReceiptRequest() — returns 1 if a signed receipt request is found and decoded. returns 0 if a signed receipt request is not present, or -1 if it is present but malformed. yes, three whole outcomes, bestie. 💅

🌈 SEE ALSO 🌈

CMS_ContentInfo_new(3), CMS_sign(3), CMS_sign_receipt(3), CMS_verify(3), CMS_verify_receipt(3), ERR_get_error(3) — go read these too, iykyk. 💖

⭐ STANDARDS ⭐

RFC 2634: Enhanced Security Services for S/MIME, section 2.7: Receipt Request Syntax — that's the standard, exact and everything. 🎀

💜 HISTORY 💜

CMS_ReceiptRequest_create0(), CMS_add1_ReceiptRequest(), CMS_get1_ReceiptRequest(), and CMS_ReceiptRequest_get0_values() first appeared in OpenSSL 0.9.8h and have been available since OpenBSD 6.7. history lesson, but make it cute. ✨

---

💖 and that's the whole page, bestie — Debian, June 8, 2025, CMS_GET1_RECEIPTREQUEST(3), signing off. byeee! 💅