MirrorSave
/
nodemcu-firmware
mirror of https://github.com/nodemcu/nodemcu-firmware.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add SSL/TLS remarks (#1333)

This commit is contained in:
Marcel Stör 2016-06-01 21:34:02 +02:00 committed by Arnim Läuger
parent bd17b295ba
commit daed2b5b6e
3 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/en/modules/http.md
View File

@ -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`. 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() ## http.delete()
Executes a HTTP DELETE request. Note that concurrent requests are not supported. Executes a HTTP DELETE request. Note that concurrent requests are not supported.

2
docs/en/modules/mqtt.md
View File

@ -88,7 +88,7 @@ Connects to the broker specified by the given host, port, and secure options.
#### Parameters #### Parameters
- `host` host, domain or IP (string) - `host` host, domain or IP (string)
- `port` broker port (number), default 1883 - `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 - `autoreconnect` 0/1 for `false`/`true`, default 0
- `function(client)` callback function for when the connection was established - `function(client)` callback function for when the connection was established
- `function(client, reason)` callback function for when the connection could not be established - `function(client, reason)` callback function for when the connection could not be established

11
docs/en/modules/net.md
View File

@ -3,6 +3,17 @@
| :----- | :-------------------- | :---------- | :------ | | :----- | :-------------------- | :---------- | :------ |
| 2014-12-22 | [Zeroday](https://github.com/funshine) | [Zeroday](https://github.com/funshine) | [net.c](../../../app/modules/net.c)| | 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
Constants to be used in other functions: `net.TCP`, `net.UDP` Constants to be used in other functions: `net.TCP`, `net.UDP`