OPENSSL_config.pod 2.6 KB

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