diff options
Diffstat (limited to 'doc/man3/NCONF_new_ex.pod')
| -rw-r--r-- | doc/man3/NCONF_new_ex.pod | 28 |
1 files changed, 24 insertions, 4 deletions
diff --git a/doc/man3/NCONF_new_ex.pod b/doc/man3/NCONF_new_ex.pod index e03c801ce5..6861fb198c 100644 --- a/doc/man3/NCONF_new_ex.pod +++ b/doc/man3/NCONF_new_ex.pod @@ -3,19 +3,28 @@ =head1 NAME NCONF_new_ex, NCONF_new, NCONF_free, NCONF_default, NCONF_load, -NCONF_get0_libctx +NCONF_get0_libctx, NCONF_get_section, NCONF_get_section_names - functionality to Load and parse configuration files manually =head1 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(CONF *conf); + 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); =head1 DESCRIPTION @@ -37,6 +46,16 @@ NCONF_default() gets the default method table for processing a configuration fil NCONF_get0_libctx() gets the library context associated with the I<conf> parameter. +NCONF_get_section_names() gets the names of the sections associated with +the I<conf> as B<STACK_OF(OPENSSL_CSTRING)> strings. The individual strings +are associated with the I<conf> and will be invalid after I<conf> is +freed. The returned stack must be freed with sk_OPENSSL_CSTRING_free(). + +NCONF_get_section() gets the config values associated with the I<conf> from +the config section I<name> as B<STACK_OF(CONF_VALUE)> structures. The returned +stack is associated with the I<conf> and will be invalid after I<conf> +is freed. It must not be freed by the caller. + =head1 RETURN VALUES NCONF_load() returns 1 on success or 0 on error. @@ -50,11 +69,12 @@ L<CONF_modules_load_file(3)>, =head1 HISTORY -NCONF_new_ex() was added in OpenSSL 3.0. +NCONF_new_ex(), NCONF_get0_libctx(), and NCONF_get_section_names() were added +in OpenSSL 3.0. =head1 COPYRIGHT -Copyright 2020 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2020-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 |