summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMoisés Guimarães de Medeiros <guimaraes@pm.me>2020-11-26 15:40:03 +0100
committerAsif Saif Uddin <auvipy@gmail.com>2020-11-27 19:59:02 +0600
commitc903aaeb581cc60bd1258df823a5a2a2a4ecdbd7 (patch)
treecc2f2331cef3e271b21397920ebb1e8b8adf0b75
parenta46054e5a30ad41f982708f3a6b5e9c02b123067 (diff)
downloadpy-amqp-c903aaeb581cc60bd1258df823a5a2a2a4ecdbd7.tar.gz
Reworks _wrap_soscket_sni doctext
* Normalizes all params descriptions starting with a capitalized letter. * Removes 'client' reference from key and cert, as the server_side param states, this can be used by either side of the conversation. * Enhances cert_reqs description covering all the possible values with a more acurate behaviour explanation. Signed-off-by: Moisés Guimarães de Medeiros <guimaraes@pm.me>
-rw-r--r--amqp/transport.py28
1 files changed, 16 insertions, 12 deletions
diff --git a/amqp/transport.py b/amqp/transport.py
index 7838e6d..2a7c190 100644
--- a/amqp/transport.py
+++ b/amqp/transport.py
@@ -452,45 +452,49 @@ class SSLTransport(_AbstractTransport):
keyfile: str
- path to client private key
+ Path to the private key
certfile: str
- path to client certificate
+ Path to the certificate
server_side: bool
- identifies whether server-side or client-side
+ Identifies whether server-side or client-side
behavior is desired from this socket. See
:attr:`~ssl.SSLContext.wrap_socket` for details.
- cert_reqs: If set, peers certificate is checked. Possible
- values are :attr:`ssl.CERT_OPTIONAL` or
- :attr:`ssl.CERT_REQUIRED`.
+
+ cert_reqs: ssl.VerifyMode
+
+ When set to other than :attr:`ssl.CERT_NONE`, peers certificate
+ is checked. Possible values are :attr:`ssl.CERT_NONE`,
+ :attr:`ssl.CERT_OPTIONAL` and :attr:`ssl.CERT_REQUIRED`.
ca_certs: str
- path to “certification authority” (CA) certificates
+ Path to “certification authority” (CA) certificates
used to validate other peers’ certificates when ``cert_reqs``
is other than :attr:`ssl.CERT_NONE`.
do_handshake_on_connect: bool
- specifies whether to do the SSL
+ Specifies whether to do the SSL
handshake automatically. See
:attr:`~ssl.SSLContext.wrap_socket` for details.
- suppress_ragged_eofs (bool): See
- :attr:`~ssl.SSLContext.wrap_socket` for details.
+ suppress_ragged_eofs (bool):
+
+ See :attr:`~ssl.SSLContext.wrap_socket` for details.
server_hostname: str
- specifies the hostname of the service which
+ Specifies the hostname of the service which
we are connecting to. See :attr:`~ssl.SSLContext.wrap_socket`
for details.
ciphers: str
- available ciphers for sockets created with this
+ Available ciphers for sockets created with this
context. See :attr:`ssl.SSLContext.set_ciphers`
ssl_version: