OPENSSL_config.pod 2.5 KB

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