OSSL_IETF_ATTR_SYNTAX(3ossl)

🌸 OSSL_IETF_ATTR_SYNTAX β€” the 3ossl manual page, bestie edition πŸ’…

okay so welcome to OSSL_IETF_ATTR_SYNTAX(3ossl), the OpenSSL manpage for the accessors and setters that let you poke at an OSSL_IETF_ATTR_SYNTAX object. it's giving certificate-attribute realness, and honestly? we're obsessed. let's get into it 🫢


✨ NAME ✨

OSSL_IETF_ATTR_SYNTAX, OSSL_IETF_ATTR_SYNTAX_get0_policyAuthority, OSSL_IETF_ATTR_SYNTAX_set0_policyAuthority, OSSL_IETF_ATTR_SYNTAX_get_value_num, OSSL_IETF_ATTR_SYNTAX_get0_value, OSSL_IETF_ATTR_SYNTAX_add1_value β€” the accessors and setters for OSSL_IETF_ATTR_SYNTAX. that's the whole squad, no cap πŸŽ€


🌈 SYNOPSIS 🌈

#include <openssl/x509_acert.h>

typedef struct OSSL_IETF_ATTR_SYNTAX_st OSSL_IETF_ATTR_SYNTAX;

const GENERAL_NAMES *
OSSL_IETF_ATTR_SYNTAX_get0_policyAuthority(const OSSL_IETF_ATTR_SYNTAX *a);
void OSSL_IETF_ATTR_SYNTAX_set0_policyAuthority(OSSL_IETF_ATTR_SYNTAX *a,
                                                GENERAL_NAMES *names);

int OSSL_IETF_ATTR_SYNTAX_get_value_num(const OSSL_IETF_ATTR_SYNTAX *a);
void *OSSL_IETF_ATTR_SYNTAX_get0_value(const OSSL_IETF_ATTR_SYNTAX *a,
                                       int ind, int *type);
int OSSL_IETF_ATTR_SYNTAX_add1_value(OSSL_IETF_ATTR_SYNTAX *a, int type,
                                     void *data);

like. look at that include. <openssl/x509_acert.h>. iconic ✨


πŸ’– DESCRIPTION πŸ’–

OSSL_IETF_ATTR_SYNTAX is an opaque structure (so don't go poking at its internals, bestie, it's not that kind of relationship πŸ’€) that represents the IetfAttrSyntax type defined in RFC 5755 (Section 4.4) β€” and you'd use it as an AttributeValue. yes, fr fr, that's the vibe.

πŸŽ€ policyAuthority stuff πŸŽ€

OSSL_IETF_ATTR_SYNTAX_get0_policyAuthority() and OSSL_IETF_ATTR_SYNTAX_set0_policyAuthority() get and set the policyAuthority field of the structure.

⚠️ both routines act on internal pointers of the structure, so the application must NOT free them. do not. I'm serious. put the free() down πŸ™ˆ

πŸ¦‹ the value sequence πŸ¦‹

An OSSL_IETF_ATTR_SYNTAX object also holds a sequence of values. here's the tea:

  • OSSL_IETF_ATTR_SYNTAX_get_value_num() returns the number of values in the sequence.
  • OSSL_IETF_ATTR_SYNTAX_add1_value() adds a copy of data of a specified type to the sequence.
    • and yes, the caller should free the data after use β€” it's a copy, so the original is still yours to clean up πŸ’…
  • OSSL_IETF_ATTR_SYNTAX_get0_value() will return the value at a specific index ind in the sequence, or NULL on error.
    • if type is not NULL, the type of the value gets written to that location. handing you the receipts πŸ“

⭐ the types, the types ⭐

the type of the values stored in the OSSL_IETF_ATTR_SYNTAX value sequence is one of the following:

  • OSSL_IETFAS_OCTETS β€” a pointer to an ASN1_OCTET_STRING
  • OSSL_IETFAS_OID β€” a pointer to an ASN1_OBJECT
  • OSSL_IETFAS_STRING β€” a pointer to an ASN1_UTF8STRING

three types, three moods, all valid 🌸


πŸ‘‘ RETURN VALUES πŸ‘‘

  • OSSL_IETF_ATTR_SYNTAX_get0_policyAuthority() returns a pointer to a GENERAL_NAMES structure, or NULL if the policy authority has not been set. (it's not ghosting you, it's just empty πŸ’œ)
  • OSSL_IETF_ATTR_SYNTAX_get_value_num() returns the number of entries in the value sequence, or -1 on error.
  • OSSL_IETF_ATTR_SYNTAX_get0_value() returns a pointer to the value at the given index, or NULL if the index is out of range.
  • OSSL_IETF_ATTR_SYNTAX_add1_value() returns 1 on success and 0 on failure.

🧚 HISTORY 🧚

these functions all showed up in OpenSSL 3.4, and honestly, glow-up behavior:

  • OSSL_IETF_ATTR_SYNTAX_get0_policyAuthority()
  • OSSL_IETF_ATTR_SYNTAX_set0_policyAuthority()
  • OSSL_IETF_ATTR_SYNTAX_get_value_num()
  • OSSL_IETF_ATTR_SYNTAX_get0_value()
  • OSSL_IETF_ATTR_SYNTAX_add1_value()

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


okay that's the whole page, bestie, you ate that πŸ“ go forth and set your policy authorities responsibly. this was OpenSSL 3.5.9, dated 2026-09-29, and the manual name is OSSL_IETF_ATTR_SYNTAX(3ossl). mwah πŸ’‹βœ¨

πŸ“¦ where this page comes from