OSSL_CMP_ATAV_SET0(3ossl)

πŸ’– OSSL_CMP_ATAV_SET0(3ossl) πŸ’–

okay bestie, sit down, hydrate, and let me tell you about the OSSL_CMP_ATAV squad β€” that's the OpenSSL CMP utility function family, from the OSSL_CMP_ATAV_SET0(3ossl) manual page, and yes it's giving "niche but iconic" πŸ’…


✨ NAME ✨

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, OSSL_CMP_ATAV_free β€” the OSSL_CMP_ATAV utility functions 🫢


🌸 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 basically the short-hand bestie of OSSL_CRMF_ATTRIBUTETYPEANDVALUE, which is defined in RFC 4211 Appendix B. You'll usually see it chillin' inside CertRequest structures, but it also pops up in CertReqTemplateContent structures for key specifications. versatile queen πŸ’…

  • OSSL_CMP_ATAV_create() β€” makes a brand-new OSSL_CMP_ATAV structure and fills it in. It's literally OSSL_CMP_ATAV_new() and OSSL_CMP_ATAV_set0() combined into one slay move. ✨
  • OSSL_CMP_ATAV_set0() β€” sets the atav with an infoType of type and an infoValue of value. The pointers type and value can be NULL, but otherwise you must not free them up after the call, because their ownership gets transferred to atav. and the itav pointer? that one must not be NULL. no cap.
  • 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.
  • OSSL_CMP_ATAV_new_algId() β€” creates a new OSSL_CMP_ATAV structure of type algId and fills it in with a copy of the given alg.
  • 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 just doesn't contain an algId.
  • OSSL_CMP_ATAV_new_rsaKeyLen() β€” creates a new OSSL_CMP_ATAV structure of type rsaKeyLen and fills it in with the given len, which must be positive. periodt.
  • OSSL_CMP_ATAV_get_rsaKeyLen() β€” returns the RSA key length in the rsaKeyLen infoValue in the atav. It gives you -1 if atav is NULL, or doesn't contain an rsaKeyLen, or it can't be parsed β€” or -2 if the value is less than 1 or is greater than INT_MAX. 😭
  • 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 whole new stack for you. queen behavior πŸ‘‘
  • OSSL_CMP_ATAV_free() β€” deallocates atav. fun fact: it's defined as a macro. πŸ’€

πŸ“ NOTES πŸ“

CMP is defined in RFC 9810. CRMF is defined in RFC 4211. 🌈


πŸŽ€ 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're above returning things, honestly)
  • 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 related functions were added in OpenSSL 3.4. baby of the family fr fr 🍼✨


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!! 🫢 this was OSSL_CMP_ATAV_SET0(3ossl) from OpenSSL 3.5.9, dated 2026-09-29 β€” mwah, go forth and handle your attribute type-and-values responsibly πŸ’–πŸŽ€πŸ¦‹
πŸ“¦ where this page comes from