From 2472e517a5b46080995206eec43577ca928185ef Mon Sep 17 00:00:00 2001 From: Noah Laptop Date: Mon, 15 Jun 2020 09:16:24 -0700 Subject: [PATCH 1/2] add known issues to README --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 922cbe7..2ba4289 100644 --- a/README.md +++ b/README.md @@ -264,3 +264,10 @@ to this: br_ssl_client_init_full(&m_sslctx, &m_x509ctx, m_trust_anchors, m_trust_anchors_num); ``` If for some unfortunate reason you need SSL 3.0 or SSL 2.0, you will need to modify the BearSSL profile to enable support. Check out the [BearSSL profiles documentation](https://bearssl.org/api1.html#profiles) and I wish you the best of luck. + +### Known Issues + * In some drivers (Ethernet), calls to `Client::flush` will hang if internet is available but there is no route to the destination. Unfortunately SSLClient cannot correct for this without modifying the driver itself, and as a result the recommended solution is ensuring you choose a driver with built-in timeouts to prevent freezing. [More information here](https://github.com/OPEnSLab-OSU/SSLClient/issues/13#issuecomment-643855923). + * When using PubSubClient on the ESP32, a stack overflow will occur if the user does not flush the buffer immediately after writing. The cause of this issue is under active investigation. More information in issue https://github.com/OPEnSLab-OSU/SSLClient/issues/9. + * Previous to SSLClient v1.6.7, calls to `SSLClient::stop` would sometimes hang the device. More information in issue https://github.com/OPEnSLab-OSU/SSLClient/issues/13. + * Previous to SSLClient v1.6.6, calls to `SSLClient::connect` would fail if the driver indicated that a socket was already opened (`Client::connected` returned true). This behavior created unintentional permanent failures when `Client::stop` would fail to close the socket, and as a result was downgraded to a warning in v1.6.6. + * Previous to SSLClient v1.6.3, calling `SSLClient::write` with more than 2Kb of total data before flushing the write buffer would cause a buffer overflow. \ No newline at end of file From f250f7f2d2bcb0e4a83f99fb4352092babcca11e Mon Sep 17 00:00:00 2001 From: Noah Laptop Date: Mon, 15 Jun 2020 09:16:50 -0700 Subject: [PATCH 2/2] bump version --- .travis/Doxyfile | 2 +- library.properties | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.travis/Doxyfile b/.travis/Doxyfile index 35933e3..863898d 100644 --- a/.travis/Doxyfile +++ b/.travis/Doxyfile @@ -38,7 +38,7 @@ PROJECT_NAME = SSLClient # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = v1.6.6 +PROJECT_NUMBER = v1.6.7 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/library.properties b/library.properties index bc37339..1dd4b08 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=SSLClient -version=1.6.6 +version=1.6.7 author=Noah Koontz maintainer=OPEnS Lab sentence=Arduino library to add TLS functionality to any Client class