mirrors
/
micropython
mirror of https://github.com/micropython/micropython.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs/ussl: Fix module name refs and use "MicroPython port" term.

This commit is contained in:
Paul Sokolovsky 2017-10-30 18:03:54 +02:00
parent 10b76a9620
commit 6fb093282b
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/library/ussl.rst
View File

@ -13,7 +13,7 @@ facilities for network sockets, both client-side and server-side.
Functions Functions
--------- ---------
.. function:: ssl.wrap_socket(sock, server_side=False, keyfile=None, certfile=None, cert_reqs=CERT_NONE, ca_certs=None) .. function:: ussl.wrap_socket(sock, server_side=False, keyfile=None, certfile=None, cert_reqs=CERT_NONE, ca_certs=None)
Takes a stream *sock* (usually usocket.socket instance of ``SOCK_STREAM`` type), Takes a stream *sock* (usually usocket.socket instance of ``SOCK_STREAM`` type),
and returns an instance of ssl.SSLSocket, which wraps the underlying stream in and returns an instance of ssl.SSLSocket, which wraps the underlying stream in
@ -23,12 +23,12 @@ Functions
server-side SSL socket should be created from a normal socket returned from server-side SSL socket should be created from a normal socket returned from
`accept()` on a non-SSL listening server socket. `accept()` on a non-SSL listening server socket.
Depending on the underlying module implementation for a particular board, Depending on the underlying module implementation in a particular
some or all keyword arguments above may be not supported. `MicroPython port`, some or all keyword arguments above may be not supported.
.. warning:: .. warning::
Some implementations of ``ssl`` module do NOT validate server certificates, Some implementations of ``ussl`` module do NOT validate server certificates,
which makes an SSL connection established prone to man-in-the-middle attacks. which makes an SSL connection established prone to man-in-the-middle attacks.
Exceptions Exceptions
@ -41,8 +41,8 @@ Exceptions
Constants Constants
--------- ---------
.. data:: ssl.CERT_NONE .. data:: ussl.CERT_NONE
ssl.CERT_OPTIONAL ussl.CERT_OPTIONAL
ssl.CERT_REQUIRED ussl.CERT_REQUIRED
Supported values for *cert_reqs* parameter. Supported values for *cert_reqs* parameter.