diff options
Diffstat (limited to 'doc/man3/CONF_modules_load_file.pod')
| -rw-r--r-- | doc/man3/CONF_modules_load_file.pod | 29 |
1 files changed, 14 insertions, 15 deletions
diff --git a/doc/man3/CONF_modules_load_file.pod b/doc/man3/CONF_modules_load_file.pod index 7e99bb9d5a..07834a6ba5 100644 --- a/doc/man3/CONF_modules_load_file.pod +++ b/doc/man3/CONF_modules_load_file.pod @@ -2,16 +2,15 @@ =head1 NAME -CONF_modules_load_file_with_libctx, CONF_modules_load_file, CONF_modules_load +CONF_modules_load_file_ex, CONF_modules_load_file, CONF_modules_load - OpenSSL configuration functions =head1 SYNOPSIS #include <openssl/conf.h> - int CONF_modules_load_file_with_libctx(OPENSSL_CTX *libctx, - const char *filename, - const char *appname, unsigned long flags); + int CONF_modules_load_file_ex(OPENSSL_CTX *libctx, const char *filename, + const char *appname, unsigned long flags); int CONF_modules_load_file(const char *filename, const char *appname, unsigned long flags); int CONF_modules_load(const CONF *cnf, const char *appname, @@ -19,7 +18,7 @@ CONF_modules_load_file_with_libctx, CONF_modules_load_file, CONF_modules_load =head1 DESCRIPTION -The function CONF_modules_load_file_with_libctx() configures OpenSSL using +The function CONF_modules_load_file_ex() configures OpenSSL using library context B<libctx> file B<filename> and application name B<appname>. If B<filename> is NULL the standard OpenSSL configuration file is used. If B<appname> is NULL the standard OpenSSL application name B<openssl_conf> is @@ -27,7 +26,7 @@ used. The behaviour can be customized using B<flags>. Note that, the error suppressing can be overriden by B<config_diagnostics> as described in L<config(5)>. -CONF_modules_load_file() is the same as CONF_modules_load_file_with_libctx() but +CONF_modules_load_file() is the same as CONF_modules_load_file_ex() but has a NULL library context. CONF_modules_load() is identical to CONF_modules_load_file() except it @@ -49,7 +48,7 @@ returns success. This is used by default in L<OPENSSL_init_crypto(3)> to ignore any errors in the default system-wide configuration file, as having all OpenSSL applications fail to start when there are potentially minor issues in the file is too risky. -Applications calling B<CONF_modules_load_file_with_libctx> explicitly should not +Applications calling B<CONF_modules_load_file_ex> explicitly should not generally set this flag. If B<CONF_MFLAGS_NO_DSO> is set configuration module loading from DSOs is @@ -62,7 +61,7 @@ return an error. B<CONF_MFLAGS_DEFAULT_SECTION> if set and B<appname> is not NULL will use the default section pointed to by B<openssl_conf> if B<appname> does not exist. -By using CONF_modules_load_file_with_libctx() with appropriate flags an +By using CONF_modules_load_file_ex() with appropriate flags an application can customise application configuration to best suit its needs. In some cases the use of a configuration file is optional and its absence is not an error: in this case B<CONF_MFLAGS_IGNORE_MISSING_FILE> would be set. @@ -87,7 +86,7 @@ return value of the failing module (this will always be zero or negative). Load a configuration file and print out any errors and exit (missing file considered fatal): - if (CONF_modules_load_file_with_libctx(libctx, NULL, NULL, 0) <= 0) { + if (CONF_modules_load_file_ex(libctx, NULL, NULL, 0) <= 0) { fprintf(stderr, "FATAL: error loading configuration file\n"); ERR_print_errors_fp(stderr); exit(1); @@ -96,8 +95,8 @@ considered fatal): Load default configuration file using the section indicated by "myapp", tolerate missing files, but exit on other errors: - if (CONF_modules_load_file_with_libctx(NULL, NULL, "myapp", - CONF_MFLAGS_IGNORE_MISSING_FILE) <= 0) { + if (CONF_modules_load_file_ex(NULL, NULL, "myapp", + CONF_MFLAGS_IGNORE_MISSING_FILE) <= 0) { fprintf(stderr, "FATAL: error loading configuration file\n"); ERR_print_errors_fp(stderr); exit(1); @@ -106,8 +105,8 @@ tolerate missing files, but exit on other errors: Load custom configuration file and section, only print warnings on error, missing configuration file ignored: - if (CONF_modules_load_file_with_libctx(NULL, "/something/app.cnf", "myapp", - CONF_MFLAGS_IGNORE_MISSING_FILE) <= 0) { + if (CONF_modules_load_file_ex(NULL, "/something/app.cnf", "myapp", + CONF_MFLAGS_IGNORE_MISSING_FILE) <= 0) { fprintf(stderr, "WARNING: error loading configuration file\n"); ERR_print_errors_fp(stderr); } @@ -123,7 +122,7 @@ Load and parse configuration file manually, custom error handling: fprintf(stderr, "Error opening configuration file\n"); /* Other missing configuration file behaviour */ } else { - cnf = NCONF_new_with_libctx(libctx, NULL); + cnf = NCONF_new_ex(libctx, NULL); if (NCONF_load_fp(cnf, fp, &eline) == 0) { fprintf(stderr, "Error on line %ld of configuration file\n", eline); ERR_print_errors_fp(stderr); @@ -141,7 +140,7 @@ Load and parse configuration file manually, custom error handling: L<config(5)>, L<OPENSSL_config(3)>, -L<NCONF_new_with_libctx(3)> +L<NCONF_new_ex(3)> =head1 COPYRIGHT |