From daed2b5b6e05e6b84d56a712ffb035d7728ab383 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcel=20St=C3=B6r?= Date: Wed, 1 Jun 2016 21:34:02 +0200 Subject: [PATCH] Add SSL/TLS remarks (#1333) --- docs/en/modules/http.md | 4 ++++ docs/en/modules/mqtt.md | 2 +- docs/en/modules/net.md | 11 +++++++++++ 3 files changed, 16 insertions(+), 1 deletion(-) diff --git a/docs/en/modules/http.md b/docs/en/modules/http.md index a0c106c3..b688b915 100644 --- a/docs/en/modules/http.md +++ b/docs/en/modules/http.md @@ -19,6 +19,10 @@ For each operation it is also possible to include custom headers. Note that foll The `Host` header is taken from the URL itself, the `Connection` is always set to `close`, and the `User-Agent` is `ESP8266`. +**SSL/TLS support** + +Take note of constraints documented in the [net module](net.md). + ## http.delete() Executes a HTTP DELETE request. Note that concurrent requests are not supported. diff --git a/docs/en/modules/mqtt.md b/docs/en/modules/mqtt.md index 7446839d..403777fd 100644 --- a/docs/en/modules/mqtt.md +++ b/docs/en/modules/mqtt.md @@ -88,7 +88,7 @@ Connects to the broker specified by the given host, port, and secure options. #### Parameters - `host` host, domain or IP (string) - `port` broker port (number), default 1883 -- `secure` 0/1 for `false`/`true`, default 0. [As per #996](https://github.com/nodemcu/nodemcu-firmware/issues/996#issuecomment-178053308) secure connections use **TLS 1.1** with the following cipher suites: `TLS_RSA_WITH_AES_128_CBC_SHA`, `TLS_RSA_WITH_AES_256_CBC_SHA`, `TLS_RSA_WITH_RC4_128_SHA`, and `TLS_RSA_WITH_RC4_128_MD5`. +- `secure` 0/1 for `false`/`true`, default 0. Take note of constraints documented in the [net module](net.md). - `autoreconnect` 0/1 for `false`/`true`, default 0 - `function(client)` callback function for when the connection was established - `function(client, reason)` callback function for when the connection could not be established diff --git a/docs/en/modules/net.md b/docs/en/modules/net.md index fcd872c1..5580cba8 100644 --- a/docs/en/modules/net.md +++ b/docs/en/modules/net.md @@ -3,6 +3,17 @@ | :----- | :-------------------- | :---------- | :------ | | 2014-12-22 | [Zeroday](https://github.com/funshine) | [Zeroday](https://github.com/funshine) | [net.c](../../../app/modules/net.c)| +**SSL/TLS support** + +Secure connections use **TLS 1.1** with the following cipher suites: + +- `TLS_RSA_WITH_AES_128_CBC_SHA` +- `TLS_RSA_WITH_AES_256_CBC_SHA` +- `TLS_RSA_WITH_RC4_128_SHA` +- `TLS_RSA_WITH_RC4_128_MD5` + +This specification is imposed by the [axTLS library](http://axtls.sourceforge.net/specifications.htm) used by the SDK. + ## Constants Constants to be used in other functions: `net.TCP`, `net.UDP`