Keenan Johnson
aa25a4ec27
Add support for TLS-PSK (pre-shared key) cipher suites to the mbedtls bindings, via new SSLContext attributes: - psk_identity / psk_key: the identity and key a client presents. - server_psk_keys: a mapping (e.g. dict) the server uses to look up the key for a client's identity; any object with a get() method works. Identities are handled as bytes (an opaque octet string on the wire). When PSK is configured the context is restricted to PSK cipher suites, so a connection cannot silently fall back to a non-PSK suite. PSK is enabled for the bundled mbedtls config and for the esp32 port, and the new attributes are documented in the ssl module reference. Tests cover the PSK attributes and key-length validation; successful handshakes via a dict, via a custom mapping object, and with a non-ASCII identity; and adversarial cases: PSK vs non-PSK peers (both directions), a wrong key, an unknown identity, and a misbehaving server_psk_keys. Signed-off-by: Keenan Johnson <keenan.johnson@gmail.com>
MicroPython Documentation
The MicroPython documentation can be found at: http://docs.micropython.org/en/latest/
The documentation you see there is generated from the files in the docs tree: https://github.com/micropython/micropython/tree/master/docs
Building the documentation locally
If you're making changes to the documentation, you may want to build the documentation locally so that you can preview your changes.
Install Sphinx and sphinx_rtd_theme, preferably in a virtualenv:
pip install sphinx
pip install sphinx_rtd_theme
In micropython/docs, build the docs:
make html
You'll find the index page at micropython/docs/build/html/index.html.
Documentation autobuild
For a more convenient development experience, you can use sphinx-autobuild
to automatically rebuild and serve the documentation when you make changes:
pip install sphinx-autobuild
Then run from the micropython/docs directory:
sphinx-autobuild . build/html
This will start a local web server (typically at http://127.0.0.1:8000)
and automatically rebuild the documentation whenever you save changes to the source files.
Having readthedocs.org build the documentation
If you would like to have docs for forks/branches hosted on GitHub, GitLab or BitBucket an alternative to building the docs locally is to sign up for a free https://readthedocs.org account. The rough steps to follow are:
- sign-up for an account, unless you already have one
- in your account settings: add GitHub as a connected service (assuming you have forked this repo on github)
- in your account projects: import your forked/cloned micropython repository into readthedocs
- in the project's versions: add the branches you are developing on or for which you'd like readthedocs to auto-generate docs whenever you push a change
PDF manual generation
This can be achieved with:
make latexpdf
but requires a rather complete install of LaTeX with various extensions. On Debian/Ubuntu, try (1GB+ download):
apt install texlive-latex-recommended texlive-latex-extra texlive-xetex texlive-fonts-extra cm-super xindy