OSSL_CMP_ITAV_SET0(3ossl)

📦
version 3.5.9 · 8 versions
, in fedora 43, fedora 44

✨ OSSL_CMP_ITAV_SET0 ✨

okay bestie, pull up a chair 🫶 this is the <openssl/cmp.h> page for the OSSL_CMP_ITAV utility functions — literally a whole little friend group of functions that handle InfoTypeAndValue stuff in CMP. no cap, it's giving "small but mighty." 💅

🌸 SYNOPSIS 🌸

#include <openssl/cmp.h>

OSSL_CMP_ITAV *OSSL_CMP_ITAV_create(ASN1_OBJECT *type, ASN1_TYPE *value);
void OSSL_CMP_ITAV_set0(OSSL_CMP_ITAV *itav, ASN1_OBJECT *type,
                        ASN1_TYPE *value);
ASN1_OBJECT *OSSL_CMP_ITAV_get0_type(const OSSL_CMP_ITAV *itav);
ASN1_TYPE *OSSL_CMP_ITAV_get0_value(const OSSL_CMP_ITAV *itav);
int OSSL_CMP_ITAV_push0_stack_item(STACK_OF(OSSL_CMP_ITAV) **itav_sk_p,
                                   OSSL_CMP_ITAV *itav);
OSSL_CMP_ITAV
*OSSL_CMP_ITAV_new0_certProfile(STACK_OF(ASN1_UTF8STRING) *certProfile);
int OSSL_CMP_ITAV_get0_certProfile(const OSSL_CMP_ITAV *itav,
                                   STACK_OF(ASN1_UTF8STRING) **out);

💖 DESCRIPTION 💖

so ITAV is short for InfoTypeAndValue, and this type is defined in RFC 9810 section 5.3.19 and Appendix F. it pops up all over the place in CMP messages — like in the generalInfo PKIHeader field — just chilling there holding a key-value pair. iconic behavior honestly. 🔑

  • OSSL_CMP_ITAV_create() — makes a brand new OSSL_CMP_ITAV structure and fills it in. it's literally OSSL_CMP_ITAV_new() and OSSL_CMP_ITAV_set0() combined into one slay. ✨
  • OSSL_CMP_ITAV_set0() — sets the itav with an infoType of type and an infoValue of value. ⚠️ big important thing: this function uses the pointers type and value internally, so you must NOT free them up after the call. like, don't do it. they're not yours anymore bestie.
  • OSSL_CMP_ITAV_get0_type() — hands you a direct pointer to the infoType in the itav.
  • OSSL_CMP_ITAV_get0_value() — hands you a direct pointer to the infoValue in the itav, as a generic ASN1_TYPE pointer.
  • OSSL_CMP_ITAV_push0_stack_item() — pushes itav onto the stack pointed to by *itav_sk_p. and if *itav_sk_p points to NULL? it just makes a whole new stack for you. so generous. 🎀
  • OSSL_CMP_ITAV_new0_certProfile() — creates a new OSSL_CMP_ITAV structure of type certProfile that includes the optionally given list of profile names. on success, ownership of the list belongs to the new OSSL_CMP_ITAV structure. 👑
  • OSSL_CMP_ITAV_get0_certProfile() — on success, assigns to *out an internal pointer to the list of certificate profile names contained in the infoValue field of itav. that pointer may be NULL if no profile name is included. and it is an error if the infoType of itav is not certProfile. 🚨

📝 NOTES 📝

CMP is defined in RFC 9810.

the OIDs you'd use as types in OSSL_CMP_ITAV live at <https://datatracker.ietf.org/doc/html/rfc9480#section-4.2.2>. and the respective OpenSSL NIDs — like NID_id_it_certProfile — are defined in the <openssl/obj_mac.h> header file. iykyk 🦋

🫶 RETURN VALUES 🫶

  • OSSL_CMP_ITAV_create() and OSSL_CMP_ITAV_new0_certProfile() return a pointer to an ITAV structure on success, or NULL on error. 😭
  • OSSL_CMP_ITAV_set0() does not return a value. it's a vibe-only function. no output, just work. 💅
  • OSSL_CMP_ITAV_get0_type() and OSSL_CMP_ITAV_get0_value() return the respective pointer, or NULL if their input is NULL.
  • OSSL_CMP_ITAV_push0_stack_item() and OSSL_CMP_ITAV_get0_certProfile() return 1 on success, 0 on error.

🌈 EXAMPLES 🌈

okay so here's the moment. the following code creates and sets a structure representing a generic InfoTypeAndValue sequence, using an OID created from text as type, and an integer as value. afterwards, it gets pushed to the OSSL_CMP_CTX so it can be included later in the requests' PKIHeader's genInfo field. periodt. 💖

ASN1_OBJECT *type = OBJ_txt2obj("1.2.3.4.5", 1);
if (type == NULL) ...

ASN1_INTEGER *asn1int = ASN1_INTEGER_new();
if (asn1int == NULL || !ASN1_INTEGER_set(asn1int, 12345)) ...

ASN1_TYPE *val = ASN1_TYPE_new();
if (val == NULL) ...
ASN1_TYPE_set(val, V_ASN1_INTEGER, asn1int);

OSSL_CMP_ITAV *itav = OSSL_CMP_ITAV_create(type, val);
if (itav == NULL) ...

if (!OSSL_CMP_CTX_push0_geninfo_ITAV(ctx, itav)) {
    OSSL_CMP_ITAV_free(itav); /* also frees type and val */
    ...
}

...

OSSL_CMP_CTX_free(ctx); /* also frees itav */

👀 SEE ALSO 👀

OSSL_CMP_CTX_new(3), OSSL_CMP_CTX_free(3), ASN1_TYPE_set(3)

🎀 HISTORY 🎀

the OpenSSL CMP support was added in OpenSSL 3.0.

OSSL_CMP_ITAV_new0_certProfile() and OSSL_CMP_ITAV_get0_certProfile() were added in OpenSSL 3.3. glow up fr fr. ✨

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

okay that's the whole page bestie, you're officially certified in ITAV 🏆💅 this was OpenSSL 3.5.9, dated 2026-09-29, and the page is OSSL_CMP_ITAV_SET0(3ossl) — go forth and hold your key-value pairs responsibly, mwah 💖🌸

📦 where this page comes from