OSSL_CMP_ATAV_SET0(3ossl)

📦 version 3.5.0, in opensuse-leap 16.0

💅 OSSL_CMP_ATAV — like, the whole ATAV situation (from openssl/cmp.h, manual page OSSL_CMP_ATAV_SET0(3ossl))

okay so bestie, welcome to the ATAV corner of OpenSSL's CMP world. this page is the whole glow-up: OSSL_CMP_ATAV, OSSL_CMP_ATAV_create, OSSL_CMP_ATAV_set0, OSSL_CMP_ATAV_get0_type, OSSL_CMP_ATAV_get0_value, OSSL_CMP_ATAV_new_algId, OSSL_CMP_ATAV_get0_algId, OSSL_CMP_ATAV_new_rsaKeyLen, OSSL_CMP_ATAV_get_rsaKeyLen, OSSL_CMP_ATAVS, OSSL_CMP_ATAV_push1, and OSSL_CMP_ATAV_free — all the ATAV utility functions, together, in one group chat. 🎀

✨ SYNOPSIS ✨

#include <openssl/cmp.h>

typedef OSSL_CRMF_ATTRIBUTETYPEANDVALUE OSSL_CMP_ATAV;
OSSL_CMP_ATAV *OSSL_CMP_ATAV_create(ASN1_OBJECT *type, ASN1_TYPE *value);
void OSSL_CMP_ATAV_set0(OSSL_CMP_ATAV *atav, ASN1_OBJECT *type,
                        ASN1_TYPE *value);
ASN1_OBJECT *OSSL_CMP_ATAV_get0_type(const OSSL_CMP_ATAV *atav);
ASN1_TYPE *OSSL_CMP_ATAV_get0_value(const OSSL_CMP_ATAV *atav);

OSSL_CMP_ATAV *OSSL_CMP_ATAV_new_algId(const X509_ALGOR *alg);
X509_ALGOR *OSSL_CMP_ATAV_get0_algId(const OSSL_CMP_ATAV *atav);
OSSL_CMP_ATAV *OSSL_CMP_ATAV_new_rsaKeyLen(int len);
int OSSL_CMP_ATAV_get_rsaKeyLen(const OSSL_CMP_ATAV *atav);

typedef STACK_OF(OSSL_CRMF_ATTRIBUTETYPEANDVALUE) OSSL_CMP_ATAVS;
int OSSL_CMP_ATAV_push1(OSSL_CMP_ATAVS **sk_p, const OSSL_CMP_ATAV *atav);
void OSSL_CMP_ATAV_free(OSSL_CMP_ATAV *atav);

🦋 DESCRIPTION 🦋

OSSL_CMP_ATAV is literally just shorthand for OSSL_CRMF_ATTRIBUTETYPEANDVALUE, which is defined in RFC 4211 Appendix B. it usually shows up in CertRequest structures, but it also pops up in CertReqTemplateContent structures for key specs. main character energy in two different structs, honestly. 👑

🌸 the constructor / setter girlies 🌸

  • OSSL_CMP_ATAV_create() — makes a shiny new OSSL_CMP_ATAV structure and fills it in. it's basically OSSL_CMP_ATAV_new() and OSSL_CMP_ATAV_set0() combined, like a two-in-one. slay.
  • OSSL_CMP_ATAV_set0() — sets the atav with an infoType of type and an infoValue of value. the type and value pointers may be NULL; if they're not, do not free them after the call, because ownership gets transferred to atav. also the itav pointer must not be NULL. 🫶
ngl the ownership transfer is the whole vibe check here — you hand over the pointer, it's not yours anymore. periodt.

🔍 the getters 🔍

  • OSSL_CMP_ATAV_get0_type() — hands you a direct pointer to the infoType in the atav, unless it's NULL.
  • OSSL_CMP_ATAV_get0_value() — hands you a direct pointer to the infoValue in the atav as a generic ASN1_TYPE pointer, unless atav is NULL.

🎀 the algId girlies 🎀

  • OSSL_CMP_ATAV_new_algId() — creates a new OSSL_CMP_ATAV structure of type algId and fills it with a copy of the given alg. (a copy, bestie. we're not sharing.)
  • OSSL_CMP_ATAV_get0_algId() — returns a direct pointer to the algId infoValue in the atav, of type X509_ALGOR, or NULL if atav is NULL or doesn't contain an algId.

🔥 the rsaKeyLen girlies 🔥

  • OSSL_CMP_ATAV_new_rsaKeyLen() — creates a new OSSL_CMP_ATAV structure of type rsaKeyLen and fills it with the given len, which must be positive.
  • OSSL_CMP_ATAV_get_rsaKeyLen() — returns the RSA key length from the rsaKeyLen infoValue in the atav. and now the lil exception menu, memorize it:
    • -1 if atav is NULL, or doesn't contain an rsaKeyLen, or it can't be parsed
    • -2 if the value is less than 1 or greater than INT_MAX 💀

🌈 stack stuff 🌈

  • OSSL_CMP_ATAV_push1() — pushes a copy of atav onto the stack of OSSL_CMP_ATAV pointed to by *sk_p. if *sk_p points to NULL, it creates a new stack for you. generous queen.
  • OSSL_CMP_ATAV_free() — deallocates atav. it's defined as a macro, iykyk.

📝 NOTES 📝

CMP is defined in RFC 4210. CRMF is defined in RFC 4211. that's the lore. 📚

⭐ RETURN VALUES ⭐

  • OSSL_CMP_ATAV_create(), OSSL_CMP_ATAV_new_algId(), and OSSL_CMP_ATAV_new_rsaKeyLen() — return a pointer to the ATAV structure on success, or NULL on error.
  • OSSL_CMP_ATAV_set0() and OSSL_CMP_ATAV_free() — do not return a value. they simply do not participate in the return-value economy.
  • OSSL_CMP_ATAV_get0_type(), OSSL_CMP_ATAV_get0_value(), and OSSL_CMP_ATAV_get0_algId() — return the respective pointer, or NULL if their input is NULL.
  • OSSL_CMP_ATAV_get_rsaKeyLen() — returns a key length in bits, or < 0 on error.
  • OSSL_CMP_ATAV_push1() — returns 1 on success, 0 on error.

👀 SEE ALSO 👀

OSSL_CMP_ITAV_new0_certReqTemplate(3), ASN1_TYPE_set(3)

🧚 HISTORY 🧚

the OSSL_CMP_ATAV type and its related functions were added in OpenSSL 3.4. so they're new-new, but not that new-new. ✨

Copyright 2022-2024 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, bestie 🫶 — brought to you by OpenSSL 3.5.0, dated 2026-09-25, filed under OSSL_CMP_ATAV_SET0(3ossl). go forth and set your ATAVs responsibly. 💅🎀

📦 where this page comes from