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