mirror of
https://github.com/sascha-hemi/pycom-documentation.git
synced 2026-03-23 02:05:55 +01:00
ae646e65f9
Commit from development-publish: 0eb35cfb85bc401e5fe1a7322da274794dd4aa22 Current stable FW release: 1.20.1.r2, commit: 06dfad0554d5b8793862b6e0803f1f1cc5cd5d16
51 lines
1.8 KiB
Markdown
51 lines
1.8 KiB
Markdown
---
|
|
title: "ussl"
|
|
aliases:
|
|
- firmwareapi/micropython/ussl.html
|
|
- firmwareapi/micropython/ussl.md
|
|
- chapter/firmwareapi/micropython/ussl
|
|
---
|
|
|
|
This module provides access to Transport Layer Security (often known as "Secure Sockets Layer") encryption and peer authentication facilities for network sockets, both client-side and server-side.
|
|
|
|
## Methods
|
|
|
|
#### ssl.wrap\_socket(sock, keyfile=None, certfile=None, server\_side=False, cert\_reqs=CERT\_NONE, ssl\_version=0, ca\_certs=None, server\_hostname=None, timeout=10sec)
|
|
|
|
Takes an instance `sock` of `socket.socket`, and returns an instance of `ssl.SSLSocket`, a subtype of `socket.socket`, which wraps the underlying socket in an SSL context. Example:
|
|
|
|
```python
|
|
|
|
import socket
|
|
import ssl
|
|
s = socket.socket()
|
|
ss = ssl.wrap_socket(s)
|
|
ss.connect(socket.getaddrinfo('www.google.com', 443)[0][-1])
|
|
```
|
|
|
|
Certificates must be used in order to validate the other side of the connection, and also to authenticate ourselves with the other end. Such certificates must be stored as files using the FTP server, and they must be placed in specific paths with specific names.
|
|
|
|
For instance, to connect to the Blynk servers using certificates, take the file `ca.pem` located in the `blynk` examples folder and put it in `/flash/cert/`. Then do:
|
|
|
|
```python
|
|
|
|
import socket
|
|
import ssl
|
|
s = socket.socket()
|
|
ss = ssl.wrap_socket(s, cert_reqs=ssl.CERT_REQUIRED, ca_certs='/flash/cert/ca.pem')
|
|
ss.connect(socket.getaddrinfo('cloud.blynk.cc', 8441)[0][-1])
|
|
```
|
|
|
|
SSL sockets inherit all methods and from the standard sockets, see the `usocket` module.
|
|
|
|
`timeout` : specify a Timeout in Seconds for the SSL handshake operation between client and server, default is 10 seconds
|
|
|
|
## Exceptions
|
|
|
|
* `ssl.SSLError`
|
|
|
|
## Constants
|
|
|
|
* `ssl.CERT_NONE`, `ssl.CERT_OPTIONAL`, `ssl.CERT_REQUIRED`: Supported values in `cert_reqs`
|
|
|