Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

OPENSSL_config (3openssl)

Name

OPENSSL_config - simple OpenSSL configuration functions

Synopsis

#include <openssl/conf.h>

void OPENSSL_config(const char *appname);
void OPENSSL_no_config(void);

Description

OPENSSL_config(3openssl)            OpenSSL           OPENSSL_config(3openssl)



NAME
       OPENSSL_config, OPENSSL_no_config - simple OpenSSL configuration
       functions

SYNOPSIS
        #include <openssl/conf.h>

        void OPENSSL_config(const char *appname);
        void OPENSSL_no_config(void);

DESCRIPTION
       OPENSSL_config() configures OpenSSL using the standard openssl.cnf and
       reads from the application section appname. If appname is NULL then the
       default section, openssl_conf, will be used.  Errors are silently
       ignored.  Multiple calls have no effect.

       OPENSSL_no_config() disables configuration. If called before
       OPENSSL_config() no configuration takes place.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+--------------------------+
       |ATTRIBUTE TYPE |     ATTRIBUTE VALUE      |
       +---------------+--------------------------+
       |Availability   | library/security/openssl |
       +---------------+--------------------------+
       |Stability      | Pass-through uncommitted |
       +---------------+--------------------------+

NOTES
       The OPENSSL_config() function is designed to be a very simple "call it
       and forget it" function.  It is however much better than nothing.
       Applications which need finer control over their configuration
       functionality should use the configuration functions such as
       CONF_modules_load() directly. This function is deprecated and its use
       should be avoided.  Applications should instead call
       CONF_modules_load() during initialization (that is before starting any
       threads).

       There are several reasons why calling the OpenSSL configuration
       routines is advisable. For example new ENGINE functionality was added
       to OpenSSL 0.9.7.  In OpenSSL 0.9.7 control functions can be supported
       by ENGINEs, this can be used (among other things) to load dynamic
       ENGINEs from shared libraries (DSOs).  However very few applications
       currently support the control interface and so very few can load and
       use dynamic ENGINEs. Equally in future more sophisticated ENGINEs will
       require certain control operations to customize them. If an application
       calls OPENSSL_config() it doesn't need to know or care about ENGINE
       control operations because they can be performed by editing a
       configuration file.

       Applications should free up configuration at application closedown by
       calling CONF_modules_free().

       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       https://www.openssl.org/source/openssl-1.0.2ze.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.openssl.org/.

RETURN VALUES
       Neither OPENSSL_config() nor OPENSSL_no_config() return a value.

SEE ALSO
       conf(5), CONF_load_modules_file(3), CONF_modules_free(3)

HISTORY
       OPENSSL_config() and OPENSSL_no_config() first appeared in OpenSSL
       0.9.7




1.0.2ze                           2022-05-03          OPENSSL_config(3openssl)