NCONF_NEW_EX(3ossl)

📦 version 3.5.0, in opensuse-leap 16.0

💅 NCONF_NEW_EX (3ossl) — the OpenSSL config-file glow-up

okay bestie, this is the 3ossl manual page for the NCONF_new_ex crew, and it's literally all about loading and parsing configuration files manually — like, you're the one driving, no autopilot. buckle up 🎀

✨ SYNOPSIS ✨

#include <openssl/conf.h>

typedef struct {
    char *section;
    char *name;
    char *value;
} CONF_VALUE;

CONF *NCONF_new_ex(OSSL_LIB_CTX *libctx, CONF_METHOD *meth);
CONF *NCONF_new(CONF_METHOD *meth);
void NCONF_free(CONF *conf);
CONF_METHOD *NCONF_default(void);
int NCONF_load(CONF *conf, const char *file, long *eline);
OSSL_LIB_CTX *NCONF_get0_libctx(const CONF *conf);

STACK_OF(CONF_VALUE) *NCONF_get_section(const CONF *conf, const char *name);
STACK_OF(OPENSSL_CSTRING) *NCONF_get_section_names(const CONF *conf);

that CONF_VALUE struct is giving main character energy btw — section, name, value, all three char *, iconic 💜

🌸 DESCRIPTION 🌸

  • NCONF_new_ex() — makes a brand-new CONF object in heap memory 🫶 and assigns to it a context libctx that can be used during loading. if the method table meth is set to NULL, then the default value of NCONF_default() is used. no cap.
  • NCONF_new() — basically NCONF_new_ex()'s sibling, except it sets the libctx to NULL. same vibe, less context 💀
  • NCONF_free() — frees the data associated with conf and then frees the conf object itself. and if the argument is NULL? nothing is done. it just... sits there. respectfully 🙈
  • NCONF_load() — parses the file named filename and adds the values found to conf. if an error occurs, file and eline list the file and line that the load failed on — but only if they are not NULL. lowkey the most useful debug info ever ⭐
  • NCONF_default() — gets the default method table for processing a configuration file. the blueprint, the moment, the whole thing 👑
  • NCONF_get0_libctx() — gets the library context associated with the conf parameter. simple. clean. slay.
  • NCONF_get_section_names() — gets the names of the sections associated with the conf as STACK_OF(OPENSSL_CSTRING) strings. the individual strings are associated with the conf and will be invalid after conf is freed. the returned stack must be freed with sk_OPENSSL_CSTRING_free(). ok that part is important, don't skip it 🫶
  • NCONF_get_section() — gets the config values associated with the conf from the config section name as STACK_OF(CONF_VALUE) structures. the returned stack is associated with the conf and will be invalid after conf is freed. it must not be freed by the caller. so like... look, don't touch 💅
🚨 bestie warning, fr fr: those two get functions hand you stacks that are borrowed, not yours. NCONF_get_section_names()'s stack you free with sk_OPENSSL_CSTRING_free(), but NCONF_get_section()'s stack you do not free. and both go poof the second conf is freed. remember that and you'll be fine 😭

🦋 RETURN VALUES 🦋

  • NCONF_load() returns 1 on success or 0 on error. that's it. binary. no nuance 💀
  • NCONF_new_ex() and NCONF_new() return a newly created CONF object or NULL if an error occurs. so always vibe check that pointer ✨

🌈 SEE ALSO 🌈

🎀 HISTORY 🎀

NCONF_new_ex(), NCONF_get0_libctx(), and NCONF_get_section_names() were added in OpenSSL 3.0. so if you're on something older... 😬 not me telling you to upgrade, but like, upgrade 🧚

Copyright 2020-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, periodt 🍓 this was version 3.5.0, dated 2026-09-25, and it's the NCONF_NEW_EX(3ossl) page — go forth and parse those config files manually, you absolute icon 👑💅✨

📦 where this page comes from