2
0

OPENSSL_config.pod 2.2 KB

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