SSL_CONF_CTX_set_ssl_ctx.pod 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. =pod
  2. =head1 NAME
  3. SSL_CONF_CTX_finish,
  4. SSL_CONF_CTX_set_ssl_ctx, SSL_CONF_CTX_set_ssl - set context to configure
  5. =head1 SYNOPSIS
  6. #include <openssl/ssl.h>
  7. void SSL_CONF_CTX_set_ssl_ctx(SSL_CONF_CTX *cctx, SSL_CTX *ctx);
  8. void SSL_CONF_CTX_set_ssl(SSL_CONF_CTX *cctx, SSL *ssl);
  9. int SSL_CONF_CTX_finish(SSL_CONF_CTX *cctx);
  10. =head1 DESCRIPTION
  11. SSL_CONF_CTX_set_ssl_ctx() sets the context associated with B<cctx> to the
  12. B<SSL_CTX> structure B<ctx>. Any previous B<SSL> or B<SSL_CTX> associated with
  13. B<cctx> is cleared. Subsequent calls to SSL_CONF_cmd() will be sent to
  14. B<ctx>.
  15. SSL_CONF_CTX_set_ssl() sets the context associated with B<cctx> to the
  16. B<SSL> structure B<ssl>. Any previous B<SSL> or B<SSL_CTX> associated with
  17. B<cctx> is cleared. Subsequent calls to SSL_CONF_cmd() will be sent to
  18. B<ssl>.
  19. The function SSL_CONF_CTX_finish() must be called after all configuration
  20. operations have been completed. It is used to finalise any operations
  21. or to process defaults.
  22. =head1 NOTES
  23. The context need not be set or it can be set to B<NULL> in which case only
  24. syntax checking of commands is performed, where possible.
  25. =head1 RETURN VALUES
  26. SSL_CONF_CTX_set_ssl_ctx() and SSL_CTX_set_ssl() do not return a value.
  27. SSL_CONF_CTX_finish() returns 1 for success and 0 for failure.
  28. =head1 SEE ALSO
  29. L<ssl(7)>,
  30. L<SSL_CONF_CTX_new(3)>,
  31. L<SSL_CONF_CTX_set_flags(3)>,
  32. L<SSL_CONF_CTX_set1_prefix(3)>,
  33. L<SSL_CONF_cmd(3)>,
  34. L<SSL_CONF_cmd_argv(3)>
  35. =head1 HISTORY
  36. These functions were added in OpenSSL 1.0.2.
  37. =head1 COPYRIGHT
  38. Copyright 2012-2023 The OpenSSL Project Authors. All Rights Reserved.
  39. Licensed under the Apache License 2.0 (the "License"). You may not use
  40. this file except in compliance with the License. You can obtain a copy
  41. in the file LICENSE in the source distribution or at
  42. L<https://www.openssl.org/source/license.html>.
  43. =cut