summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorCheeseCrustery <45769434+CheeseCrustery@users.noreply.github.com>2021-08-23 02:04:42 +0200
committerGitHub <noreply@github.com>2021-08-23 00:04:42 +0000
commit56a28a7cd8f00e87c37a73c5c10da2a43f74bf8d (patch)
treef51874e71cda9bd2f8da2b296823e04c90606071 /docs
parent5f32b3c0cfb836c016ad2a5f6caeff2978a6a16f (diff)
downloadwebsocket-client-56a28a7cd8f00e87c37a73c5c10da2a43f74bf8d.tar.gz
added sslopt documentation (#732)
Diffstat (limited to 'docs')
-rw-r--r--docs/source/faq.rst15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/source/faq.rst b/docs/source/faq.rst
index 81ee3fa..2376426 100644
--- a/docs/source/faq.rst
+++ b/docs/source/faq.rst
@@ -175,6 +175,21 @@ Please set sslopt to ``{"check_hostname": False}``. (since v0.18.0)
ws = websocket.WebSocket(sslopt={"check_hostname": False})
ws.connect("wss://echo.websocket.org")
+
+What else can I do with sslopts?
+============================================================================
+
+The ``sslopt`` parameter is a dictionary to which the following keys can be assigned:
+
+* ``certfile``, ``keyfile``, ``password`` (see `SSLContext.load_cert_chain <https://docs.python.org/3/library/ssl.html#ssl.SSLContext.load_cert_chain>`_)
+* ``ecdh_curve`` (see `SSLContext.set_ecdh_curve <https://docs.python.org/3/library/ssl.html#ssl.SSLContext.set_ecdh_curve>`_)
+* ``ciphers`` (see `SSLContext.set_ciphers <https://docs.python.org/3/library/ssl.html#ssl.SSLContext.set_ciphers>`_)
+* ``cert_reqs`` (see `SSLContext.verify_mode <https://docs.python.org/3/library/ssl.html#ssl.SSLContext.verify_mode>`_)
+* ``ssl_version`` (see `SSLContext.protocol <https://docs.python.org/3/library/ssl.html#ssl.SSLContext.protocol>`_)
+* ``ca_certs``, ``ca_cert_path`` (see `SSLContext.load_verify_locations <https://docs.python.org/3/library/ssl.html#ssl.SSLContext.load_verify_locations>`_)
+* ``check_hostname`` (see `SSLContext.check_hostname <https://docs.python.org/3/library/ssl.html#ssl.SSLContext.check_hostname>`_)
+* ``server_hostname``, ``do_handshake_on_connect``, ``suppress_ragged_eofs`` (see `SSLContext.wrap_socket <https://docs.python.org/3/library/ssl.html#ssl.SSLContext.wrap_socket>`_)
+
How to enable `SNI <http://en.wikipedia.org/wiki/Server_Name_Indication>`_?
============================================================================