doc/crypto/OPENSSL_config.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 OPENSSL_config, OPENSSL_no_config - simple OpenSSL configuration functions
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/conf.h>
  10
  11  void OPENSSL_config(const char *appname);
  12  void OPENSSL_no_config(void);
  13
  14 =head1 DESCRIPTION
  15
  16 OPENSSL_config() configures OpenSSL using the standard B<openssl.cnf> and
  17 reads from the application section B<appname>. If B<appname> is NULL then
  18 the default section, B<openssl_conf>, will be used.
  19 Errors are silently ignored.
  20 Multiple calls have no effect.
  21
  22 OPENSSL_no_config() disables configuration. If called before OPENSSL_config()
  23 no configuration takes place.
  24
  25 =head1 NOTES
  26
  27 The OPENSSL_config() function is designed to be a very simple "call it and
  28 forget it" function.
  29 It is however B<much> better than nothing. Applications which need finer
  30 control over their configuration functionality should use the configuration
  31 functions such as CONF_modules_load() directly. This function is deprecated
  32 and its use should be avoided.
  33 Applications should instead call CONF_modules_load() during
  34 initialization (that is before starting any threads).
  35
  36 There are several reasons why calling the OpenSSL configuration routines is
  37 advisable. For example new ENGINE functionality was added to OpenSSL 0.9.7.
  38 In OpenSSL 0.9.7 control functions can be supported by ENGINEs, this can be
  39 used (among other things) to load dynamic ENGINEs from shared libraries (DSOs).
  40 However very few applications currently support the control interface and so
  41 very few can load and use dynamic ENGINEs. Equally in future more sophisticated
  42 ENGINEs will require certain control operations to customize them. If an
  43 application calls OPENSSL_config() it doesn't need to know or care about
  44 ENGINE control operations because they can be performed by editing a
  45 configuration file.
  46
  47 Applications should free up configuration at application closedown by calling
  48 CONF_modules_free().
  49
  50 =head1 RETURN VALUES
  51
  52 Neither OPENSSL_config() nor OPENSSL_no_config() return a value.
  53
  54 =head1 SEE ALSO
  55
  56 L<conf(5)|conf(5)>, L<CONF_load_modules_file(3)|CONF_load_modules_file(3)>,
  57 L<CONF_modules_free(3)|CONF_modules_free(3)>
  58
  59 =head1 HISTORY
  60
  61 OPENSSL_config() and OPENSSL_no_config() first appeared in OpenSSL 0.9.7
  62
  63 =cut