SSL_CONF_CTX_set_flags.pod 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
  1. =pod
  2. =head1 NAME
  3. SSL_CONF_CTX_set_flags, SSL_CONF_CTX_clear_flags - Set or clear SSL configuration context flags
  4. =head1 SYNOPSIS
  5. #include <openssl/ssl.h>
  6. unsigned int SSL_CONF_CTX_set_flags(SSL_CONF_CTX *cctx, unsigned int flags);
  7. unsigned int SSL_CONF_CTX_clear_flags(SSL_CONF_CTX *cctx, unsigned int flags);
  8. =head1 DESCRIPTION
  9. The function SSL_CONF_CTX_set_flags() sets B<flags> in the context B<cctx>.
  10. The function SSL_CONF_CTX_clear_flags() clears B<flags> in the context B<cctx>.
  11. =head1 NOTES
  12. The flags set affect how subsequent calls to SSL_CONF_cmd() or
  13. SSL_CONF_argv() behave.
  14. Currently the following B<flags> values are recognised:
  15. =over 4
  16. =item SSL_CONF_FLAG_CMDLINE, SSL_CONF_FLAG_FILE
  17. recognise options intended for command line or configuration file use. At
  18. least one of these flags must be set.
  19. =item SSL_CONF_FLAG_CLIENT, SSL_CONF_FLAG_SERVER
  20. recognise options intended for use in SSL/TLS clients or servers. One or
  21. both of these flags must be set.
  22. =item SSL_CONF_FLAG_CERTIFICATE
  23. recognise certificate and private key options.
  24. =item SSL_CONF_FLAG_REQUIRE_PRIVATE
  25. If this option is set then if a private key is not specified for a certificate
  26. it will attempt to load a private key from the certificate file when
  27. SSL_CONF_CTX_finish() is called. If a key cannot be loaded from the certificate
  28. file an error occurs.
  29. =item SSL_CONF_FLAG_SHOW_ERRORS
  30. indicate errors relating to unrecognised options or missing arguments in
  31. the error queue. If this option isn't set such errors are only reflected
  32. in the return values of SSL_CONF_set_cmd() or SSL_CONF_set_argv()
  33. =back
  34. =head1 RETURN VALUES
  35. SSL_CONF_CTX_set_flags() and SSL_CONF_CTX_clear_flags() returns the new flags
  36. value after setting or clearing flags.
  37. =head1 SEE ALSO
  38. L<SSL_CONF_CTX_new(3)>,
  39. L<SSL_CONF_CTX_set_ssl_ctx(3)>,
  40. L<SSL_CONF_CTX_set1_prefix(3)>,
  41. L<SSL_CONF_cmd(3)>,
  42. L<SSL_CONF_cmd_argv(3)>
  43. =head1 HISTORY
  44. These functions were added in OpenSSL 1.0.2.
  45. =head1 COPYRIGHT
  46. Copyright 2012-2016 The OpenSSL Project Authors. All Rights Reserved.
  47. Licensed under the Apache License 2.0 (the "License"). You may not use
  48. this file except in compliance with the License. You can obtain a copy
  49. in the file LICENSE in the source distribution or at
  50. L<https://www.openssl.org/source/license.html>.
  51. =cut