CMS_GET1_RECEIPTREQUEST(3SSL)

📦
version 4.0.3 · 14 versions
, in ubuntu stonking

💖 CMS_GET1_RECEIPTREQUEST 💖

okay bestie so this is the OpenSSL page for the signed receipt request girlies — full manual name CMS_GET1_RECEIPTREQUEST(3SSL), no cap. we're doing CMS signed receipts today and honestly? it's giving ✨cryptographic receipts✨. let's GO 🦋

🌸 NAME 🌸

CMS_ReceiptRequest_create0_ex, CMS_ReceiptRequest_create0, CMS_add1_ReceiptRequest, CMS_get1_ReceiptRequest, CMS_ReceiptRequest_get0_values — the whole CMS signed receipt request functions squad 💅

✨ 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() makes a signed receipt request structure. iconic behaviour, truly.

  • the signedContentIdentifier field gets set using id and idlen — OR it gets set to 32 bytes of pseudo random data if id is NULL. free randomness, we love that for us 🎀
  • if receiptList is NULL, the allOrFirstTier option in receiptsFrom is used and set to the value of the allorfirst parameter.
  • if receiptList is not NULL, then the receiptList option in receiptsFrom is used instead.
  • the receiptsTo parameter specifies the receiptsTo field value.
  • the library context libctx is what's used to find the public random generator 🔮

CMS_ReceiptRequest_create0() is literally the same vibe as CMS_ReceiptRequest_create0_ex() except it uses default values of NULL for the library context libctx. lowkey convenient 🫶

CMS_add1_ReceiptRequest() — this one adds a signed receipt request rr to the SignerInfo structure si. putting it in its place, respectfully 💅

int CMS_get1_ReceiptRequest() goes looking for a signed receipt request inside si. if it finds any, it is decoded and written to prr. detective work ✨

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 deets on what all these fields actually mean, go read RFC2634. iykyk, bestie 📖

important bestie moment: 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 verify, 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's 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 the whole friend group 🌈

🕰️ HISTORY 🕰️

the function CMS_ReceiptRequest_create0_ex() was added in OpenSSL 3.0. glow-up era ✨

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>.

that's the whole thing bestie, you ate that 🍓💖

mwah 💋 this was OpenSSL 4.0.3, dated 2026-09-29 — go forth and verify your receipts, queen 👑

📦 where this page comes from