CMS_GET1_RECEIPTREQUEST(3ossl)

๐Ÿ“ฆ version 3.5.0, in opensuse-leap 16.0

๐Ÿ’Œ CMS_GET1_RECEIPTREQUEST(3ossl) โ€” the receipt-request glow-up

okay bestie, so this is the CMS_GET1_RECEIPTREQUEST(3ossl) manual page, and it's literally all about CMS signed receipt requests โ€” the "yes i got your message, here's proof ๐Ÿ’…" of the crypto world. Six functions, zero fluff, let's go ๐ŸŽ€


โœจ NAME โœจ

CMS_ReceiptRequest_create0_ex, CMS_ReceiptRequest_create0, CMS_add1_ReceiptRequest, CMS_get1_ReceiptRequest, CMS_ReceiptRequest_get0_values โ€” the 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 ๐Ÿ’–

So CMS_ReceiptRequest_create0_ex() is the main character here โ€” it creates a signed receipt request structure. ๐Ÿซถ

  • The signedContentIdentifier field gets set using id and idlenโ€ฆ unless id is NULL, in which case it gets set to 32 bytes of pseudo random data instead. iconic behavior ngl โœจ
  • If receiptList is NULL, the allOrFirstTier option in receiptsFrom is used, and it's set to the value of the allorfirst parameter. ๐ŸŽฏ
  • If receiptList is not NULL, the receiptList option in receiptsFrom is used instead. slay, choose your fighter ๐Ÿ’…
  • The receiptsTo parameter specifies the receiptsTo field value. ๐Ÿ“ฌ
  • The library context libctx is used to find the public random generator. ๐ŸŽฒ

CMS_ReceiptRequest_create0() is basically the same vibe as CMS_ReceiptRequest_create0_ex() โ€” literally similar โ€” except it uses default values of NULL for the library context libctx. no ctx, no problem ๐Ÿ™ˆ

CMS_add1_ReceiptRequest() adds a signed receipt request rr to the SignerInfo structure si. it's giving "attach the receipt to the signerinfo, periodt" ๐Ÿ‘‘

int CMS_get1_ReceiptRequest() looks for a signed receipt request in si, and if any is found, it gets decoded and written to prr. ๐Ÿ‘€

CMS_ReceiptRequest_get0_values() retrieves the values of a receipt request, bestie:

  • 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 more deets on what all these fields actually mean, see RFC2634. iykyk ๐Ÿ“–

โš ๏ธ The contents of a signed receipt should only be considered meaningful if the corresponding CMS_ContentInfo structure can be successfully verified using CMS_verify(). like, don't trust a receipt you can't verify, fr fr ๐Ÿ’€

๐Ÿ”ฅ 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. three whole moods ๐Ÿ’€

๐ŸŒˆ SEE ALSO ๐ŸŒˆ

ERR_get_error(3), CMS_sign(3), CMS_sign_receipt(3), CMS_verify(3), CMS_verify_receipt(3) โ€” go read those too, bestie, they're all linked in the group chat ๐Ÿซถ


โญ HISTORY โญ

The function CMS_ReceiptRequest_create0_ex() was added in OpenSSL 3.0. new-ish but already iconic ๐Ÿ’…


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, no cap ๐ŸŽ€ this was OpenSSL 3.5.0, dated 2026-09-25, and the manual page is CMS_GET1_RECEIPTREQUEST(3ossl) โ€” receipts have never looked this cute ๐Ÿ’–โœจ๐Ÿ“

๐Ÿ“ฆ where this page comes from