generic-library/openssl
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Tidy up docs, remove warning.

Browse Source
This commit is contained in:
Dr. Stephen Henson 2007-05-10 17:35:37 +00:00
parent f8492ffeaa
commit ee7ca0941a
1 changed files with 21 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
crypto/conf/README
View File

@ -1,8 +1,3 @@
WARNING WARNING WARNING!!!
This stuff is experimental, may change radically or be deleted altogether
before OpenSSL 0.9.7 release. You have been warned!
Configuration modules. These are a set of modules which can perform
various configuration functions.
@ -13,7 +8,7 @@ The routines read a configuration file set up like this:
-----
#default section
openssl_init=init_section
openssl_conf=init_section
[init_section]
@ -30,29 +25,27 @@ path=/some/path/to/some/dso.so
other_stuff=other_value
----
When this file is loaded a configuration module with the specified
string (module* in the above example) is looked up and its init
function called as:
When this file is loaded a configuration module with the specified string
(module* in the above example) is looked up and its init function called as:
int conf_init_func(CONF_IMODULE *md, CONF *cnf);
The function can then take whatever action is appropriate, for example
further lookups based on the value. Multiple instances of the same
config module can be loaded.
The function can then take whatever action is appropriate, for example further
lookups based on the value. Multiple instances of the same config module can be
loaded.
When the application closes down the modules are cleaned up by calling
an optional finish function:
When the application closes down the modules are cleaned up by calling an
optional finish function:
void conf_finish_func(CONF_IMODULE *md);
The finish functions are called in reverse order: that is the last module
loaded is the first one cleaned up.
If no module exists with a given name then an attempt is made to load
a DSO with the supplied name. This might mean that "module3" attempts
to load a DSO called libmodule3.so or module3.dll for example. An explicit
DSO name can be given by including a separate section as in the module4 example
above.
If no module exists with a given name then an attempt is made to load a DSO
with the supplied name. This might mean that "module3" attempts to load a DSO
called libmodule3.so or module3.dll for example. An explicit DSO name can be
given by including a separate section as in the module4 example above.
The DSO is expected to at least contain an initialization function:
@ -64,15 +57,17 @@ void OPENSSL_finish(CONF_IMODULE *md);
Static modules can also be added using,
int CONF_module_add(char *name, dso_mod_init_func *ifunc, dso_mod_finish_func *ffunc);
int CONF_module_add(char *name, dso_mod_init_func *ifunc, dso_mod_finish_func
*ffunc);
where "name" is the name in the configuration file this function corresponds to.
where "name" is the name in the configuration file this function corresponds
to.
A set of builtin modules (currently only an ASN1 non functional test module) can be
added by calling OPENSSL_load_builtin_modules().
A set of builtin modules (currently only an ASN1 non functional test module)
can be added by calling OPENSSL_load_builtin_modules().
The function OPENSSL_config() is intended as a simple configuration function that
any application can call to perform various default configuration tasks. It uses the
file openssl.cnf in the usual locations.
The function OPENSSL_config() is intended as a simple configuration function
that any application can call to perform various default configuration tasks.
It uses the file openssl.cnf in the usual locations.