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 *config_name);
  12  void OPENSSL_no_config(void);
  13
  14 =head1 DESCRIPTION
  15
  16 OPENSSL_config() configures OpenSSL using the standard B<openssl.cnf>
  17 configuration file name using B<config_name>. If B<config_name> is NULL then
  18 the file specified in the environment variable B<OPENSSL_CONF> will be used,
  19 and if that is not set then a system default location is used.
  20 Errors are silently ignored.
  21 Multiple calls have no effect.
  22
  23 OPENSSL_no_config() disables configuration. If called before OPENSSL_config()
  24 no configuration takes place.
  25
  26 If the application is built with B<OPENSSL_LOAD_CONF> defined, then a
  27 call to OpenSSL_add_all_algorithms() will implicitly call OPENSSL_config()
  28 first.
  29
  30 =head1 NOTES
  31
  32 The OPENSSL_config() function is designed to be a very simple "call it and
  33 forget it" function.
  34 It is however B<much> better than nothing. Applications which need finer
  35 control over their configuration functionality should use the configuration
  36 functions such as CONF_modules_load() directly. This function is deprecated
  37 and its use should be avoided.
  38 Applications should instead call CONF_modules_load() during
  39 initialization (that is before starting any threads).
  40
  41 There are several reasons why calling the OpenSSL configuration routines is
  42 advisable. For example, to load dynamic ENGINEs from shared libraries (DSOs).
  43 However very few applications currently support the control interface and so
  44 very few can load and use dynamic ENGINEs. Equally in future more sophisticated
  45 ENGINEs will require certain control operations to customize them. If an
  46 application calls OPENSSL_config() it doesn't need to know or care about
  47 ENGINE control operations because they can be performed by editing a
  48 configuration file.
  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)>,
  57 L<CONF_modules_load_file(3)>
  58
  59 =head1 HISTORY
  60
  61 The OPENSSL_no_config() and OPENSSL_config() functions were
  62 deprecated in OpenSSL 1.1.0 by OPENSSL_init_crypto().
  63
  64 =head1 COPYRIGHT
  65
  66 Copyright 2004-2016 The OpenSSL Project Authors. All Rights Reserved.
  67
  68 Licensed under the OpenSSL license (the "License").  You may not use
  69 this file except in compliance with the License.  You can obtain a copy
  70 in the file LICENSE in the source distribution or at
  71 L<https://www.openssl.org/source/license.html>.
  72
  73 =cut