xref: /freebsd/secure/lib/libcrypto/man/man3/NCONF_new_ex.3 (revision f5f40dd63bc7acbb5312b26ac1ea1103c12352a6)
Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)

Standard preamble:
========================================================================
..
..
.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "NCONF_NEW_EX 3ossl"
NCONF_NEW_EX 3ossl "2023-09-19" "3.0.11" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
"NAME"
NCONF_new_ex, NCONF_new, NCONF_free, NCONF_default, NCONF_load, NCONF_get0_libctx, NCONF_get_section, NCONF_get_section_names \- functionality to Load and parse configuration files manually
"SYNOPSIS"
Header "SYNOPSIS" .Vb 1 #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); .Ve
"DESCRIPTION"
Header "DESCRIPTION" \fBNCONF_new_ex() creates a new \s-1CONF\s0 object in heap memory and assigns to it a context libctx that can be used during loading. If the method table \fImeth is set to \s-1NULL\s0 then the default value of NCONF_default() is used.

\fBNCONF_new() is similar to NCONF_new_ex() but sets the libctx to \s-1NULL.\s0

\fBNCONF_free() frees the data associated with conf and then frees the conf object.

\fBNCONF_load() parses the file named filename and adds the values found to \fIconf. If an error occurs file and eline list the file and line that the load failed on if they are not \s-1NULL.\s0

\fBNCONF_default() gets the default method table for processing a configuration file.

\fBNCONF_get0_libctx() gets the library context associated with the conf parameter.

\fBNCONF_get_section_names() gets the names of the sections associated with the conf as \s-1STACK_OF\s0(\s-1OPENSSL_CSTRING\s0) 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().

\fBNCONF_get_section() gets the config values associated with the conf from the config section name as \s-1STACK_OF\s0(\s-1CONF_VALUE\s0) 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.

"RETURN VALUES"
Header "RETURN VALUES" \fBNCONF_load() returns 1 on success or 0 on error.

\fBNCONF_new_ex() and NCONF_new() return a newly created \s-1CONF\s0 object or \s-1NULL\s0 if an error occurs.

"SEE ALSO"
Header "SEE ALSO" \fBCONF_modules_load_file\|(3),
"HISTORY"
Header "HISTORY" \fBNCONF_new_ex(), NCONF_get0_libctx(), and NCONF_get_section_names() were added in OpenSSL 3.0.
"COPYRIGHT"
Header "COPYRIGHT" Copyright 2020-2021 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.