Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add interface to save and resume SSL sessions (PR390) #234

Open
wants to merge 1 commit into
base: publish
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 21 additions & 3 deletions content/firmwareapi/micropython/ussl.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ This module provides access to Transport Layer Security (often known as "Secure

## Methods

#### ssl.wrap\_socket(sock, keyfile=None, certfile=None, server\_side=False, cert\_reqs=CERT\_NONE, ca\_certs=None\, timeout=10sec)
#### ssl.wrap\_socket(sock, keyfile=None, certfile=None, server\_side=False, cert\_reqs=CERT\_NONE, ssl\_version=0, ca\_certs=None, server\_hostname=None, saved_session=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:
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

Expand All @@ -38,13 +38,31 @@ ss.connect(socket.getaddrinfo('cloud.blynk.cc', 8441)[0][-1])

SSL sockets inherit all methods and from the standard sockets, see the `usocket` module.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1st: SSL sockets inherit all methods from the standard sockets, see the usocket module.


`saved_session` : Takes a saved session instance of `ssl.SSLSocket`, and retrieve an already established TLS connection.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2nd: : Takes a saved session instance of ssl.SSLSocket, and retrieves an already established TLS connection.


`timeout` : specify a Timeout in Seconds for the SSL handshake operation between client and server, default is 10 seconds
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

3rd: specifies a Timeout in Seconds for the SSL handshake operation between client and server. The default is 10 seconds.


#### ssl.save\_session(ssl_sock)

Takes an instance `ssl_sock` of `ssl.SSLSocket`, and returns an instance of `ssl.SSLSession`. Saved session can be resumed later, thereby reducing mobile data and time required. Example:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

4th: Takes an instance ssl_sock of ssl.SSLSocket, and returns an instance of ssl.SSLSession. A saved session can be resumed later, thereby reducing mobile data and time required.


```python

import socket
import ssl
s = socket.socket()
ss = ssl.wrap_socket(s)
ss.connect(socket.getaddrinfo('www.google.com', 443)[0][-1])
ses = ssl.save_session(ss)
ss.close()
ss = ssl.wrap_socket(s, saved_session=ses)
ss.connect(socket.getaddrinfo('www.google.com', 443)[0][-1])
```

## Exceptions

* `ssl.SSLError`

## Constants

* `ssl.CERT_NONE`, `ssl.CERT_OPTIONAL`, `ssl.CERT_REQUIRED`: Supported values in `cert_reqs`