v1.4.0 to fix base64 encoding of websocket

### Releases v1.4.0

1. Fix base64 encoding of websocket client key and add WebServer progmem support. Check PR [Fix base64 encoding of websocket client key and progmem support for webserver #7](#7)

Author: khoih-prog

CONTRIBUTING.md

@@ -31,7 +31,7 @@ Arduino IDE version: 1.8.16
 STM32 Core Version 2.1.0
 Nucleo-144 STM32F7 NUCLEO_F767ZI
 OS: Ubuntu 20.04 LTS
-Linux xy-Inspiron-3593 5.4.0-86-generic #97-Ubuntu SMP Fri Sep 17 19:19:40 UTC 2021 x86_64 x86_64 x86_64 GNU/Linux
+Linux xy-Inspiron-3593 5.4.0-91-generic #102-Ubuntu SMP Fri Nov 5 16:31:28 UTC 2021 x86_64 x86_64 x86_64 GNU/Linux
 
 Context:
 I encountered an endless loop while trying to connect to Local WiFi.

README.md

@@ -1777,7 +1777,7 @@ Following are debug terminal output and screen shots when running example [Async
 
 ```
 Starting AsyncMultiWebServer_STM32 on NUCLEO_F767ZI with LAN8742A built-in Ethernet
-AsyncWebServer_STM32 v1.3.1
+AsyncWebServer_STM32 v1.4.0
 
 Connected to network. IP = 192.168.2.141
 Initialize multiServer OK, serverIndex = 0, port = 8080
@@ -1810,7 +1810,7 @@ Following is debug terminal output when running example [WebClient](examples/Web
 
 ```
 Starting WebClient on NUCLEO_F767ZI with LAN8742A built-in Ethernet
-AsyncWebServer_STM32 v1.3.1
+AsyncWebServer_STM32 v1.4.0
 You're connected to the network, IP = 192.168.2.71
 
 Starting connection to server...
@@ -1879,7 +1879,7 @@ Following is debug terminal output when running example [MQTTClient_Auth](exampl
 
 ```
 Starting MQTTClient_Auth on NUCLEO_F767ZI with LAN8742A built-in Ethernet
-AsyncWebServer_STM32 v1.3.1
+AsyncWebServer_STM32 v1.4.0
 
 Connected to network. IP = 192.168.2.71
 Attempting MQTT connection to broker.emqx.io...connected
@@ -1897,7 +1897,7 @@ Following is debug terminal output when running example [MQTTClient_Basic](examp
 
 ```
 Starting MQTTClient_Basic on NUCLEO_F767ZI with LAN8742A built-in Ethernet
-AsyncWebServer_STM32 v1.3.1
+AsyncWebServer_STM32 v1.4.0
 
 Connected to network. IP = 192.168.2.71
 Attempting MQTT connection to broker.shiftr.io...connected
@@ -1923,7 +1923,7 @@ Following is debug terminal output when running example [MQTT_ThingStream](examp
 
 ```
 Starting MQTT_ThingStream on NUCLEO_F767ZI with LAN8742A built-in Ethernet
-AsyncWebServer_STM32 v1.3.1
+AsyncWebServer_STM32 v1.4.0
 
 Connected to network. IP = 192.168.2.71
 ***************************************
@@ -1953,7 +1953,7 @@ Following is debug terminal output when running example [MQTTClient_Auth_LAN8720
 
 ```
 Start MQTTClient_Auth_LAN8720 on BLACK_F407VE with LAN8720 Ethernet
-AsyncWebServer_STM32 v1.3.1
+AsyncWebServer_STM32 v1.4.0
 
 Connected to network. IP = 192.168.2.150
 Attempting MQTT connection to broker.emqx.io...connected
@@ -1992,7 +1992,7 @@ Following are debug terminal output and screen shots when running example [Async
 
 ```
 Start AsyncMultiWebServer_STM32_LAN8720 on BLACK_F407VE with LAN8720 Ethernet
-AsyncWebServer_STM32 v1.3.1
+AsyncWebServer_STM32 v1.4.0
 
 Connected to network. IP = 192.168.2.150
 Initialize multiServer OK, serverIndex = 0, port = 8080
@@ -2083,7 +2083,7 @@ Submit issues to: [AsyncWebServer_STM32 issues](https://github.com/khoih-prog/As
 3. Relied on [PhilBowles' STM32 AsyncTCP Library](https://github.com/philbowles/STM32AsyncTCP).
 4. Thanks to good work of [Miguel Wisintainer](https://github.com/tcpipchip) for working with, developing, debugging and testing.
 5. Thanks to [Jean-Claude](https://github.com/jcw) and [chris007de](https://github.com/chris007de) to help locate the dependency issue, discuss solution leading to release v1.2.6. Check [Compilation broken due to error in STM32AsyncTCP dependency](https://github.com/khoih-prog/AsyncWebServer_STM32/issues/4) and [how to run one of the examples?](https://github.com/khoih-prog/AsyncWebServer_STM32/issues/2).
-
+6. Thanks to [tothtechnika](https://github.com/tothtechnika) to create the PR [Fix base64 encoding of websocket client key and progmem support for webserver #7](https://github.com/khoih-prog/AsyncWebServer_STM32/pull/7) leading to new release v1.4.0
 
 <table>
   <tr>
@@ -2093,6 +2093,7 @@ Submit issues to: [AsyncWebServer_STM32 issues](https://github.com/khoih-prog/As
     <td align="center"><a href="https://github.com/tcpipchip"><img src="https://github.com/tcpipchip.png" width="100px;" alt="tcpipchip"/><br /><sub><b>tcpipchip</b></sub></a><br /></td>
     <td align="center"><a href="https://github.com/jcw"><img src="https://github.com/jcw.png" width="100px;" alt="jcw"/><br /><sub><b>Jean-Claude</b></sub></a><br /></td>
     <td align="center"><a href="https://github.com/chris007de"><img src="https://github.com/chris007de.png" width="100px;" alt="chris007de"/><br /><sub><b>chris007de</b></sub></a><br /></td>
+    <td align="center"><a href="https://github.com/tothtechnika"><img src="https://github.com/tothtechnika.png" width="100px;" alt="tothtechnika"/><br /><sub><b>tothtechnika</b></sub></a><br /></td>
   </tr> 
 </table>
 

changelog.md

@@ -13,6 +13,7 @@
 
 * [Table of contents](#table-of-contents)
 * [Changelog](#changelog)
+  * [Releases v1.4.0](#releases-v140)
   * [Releases v1.3.1](#releases-v131)
   * [Releases v1.3.0](#releases-v130)
   * [Releases v1.2.6](#releases-v126)
@@ -25,6 +26,11 @@
 
 ## Changelog
 
+### Releases v1.4.0
+
+1. Fix base64 encoding of websocket client key and add WebServer progmem support. Check PR [Fix base64 encoding of websocket client key and progmem support for webserver #7](https://github.com/khoih-prog/AsyncWebServer_STM32/pull/7)
+
+
 ### Releases v1.3.1
 
 1. Update `platform.ini` and `library.json` to use original `khoih-prog` instead of `khoih.prog` after PIO fix

keywords.txt

@@ -41,6 +41,7 @@ AsyncAbstractResponse	KEYWORD1
 AsyncStreamResponse	KEYWORD1
 AsyncCallbackResponse	KEYWORD1
 AsyncChunkedResponse	KEYWORD1
+AsyncProgmemResponse  KEYWORD1
 AsyncResponseStream	KEYWORD1
 
 AsyncWebLock	KEYWORD1
@@ -348,6 +349,12 @@ _fillBuffer  KEYWORD2
 _sourceValid  KEYWORD2
 _fillBuffer  KEYWORD2
 
+##############################
+# AsyncProgmemResponse
+##############################
+
+_fillBuffer  KEYWORD2
+
 ##############################
 # AsyncResponseStream
 ##############################
@@ -497,6 +504,13 @@ webSocketSendFrameWindow	KEYWORD2
 webSocketSendFrame	KEYWORD2
 generateEventMessage	KEYWORD2
 
+ltrim KEYWORD2
+rtrim KEYWORD2
+trim  KEYWORD2
+b64_encoded_size  KEYWORD2
+b64_encode  KEYWORD2
+
+
 #######################################
 # Constants (LITERAL1)
 #######################################

library.json

@@ -1,6 +1,6 @@
 {
   "name":"AsyncWebServer_STM32",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "description":"Asynchronous HTTP and WebSocket Server Library for STM32F/L/H/G/WB/MP1 using LAN8720 or built-in LAN8742A Ethernet",
   "keywords":"http, async, websocket, webserver, stm32, stm32f, stm32l, stm32h, stm32g, stm32wb, stm32mp1, ethernet, lan8742a, lan8720, bluepill, blackpill, f407ve, f767zi, nucleo, nucleo-144",
   "authors": 
@@ -43,5 +43,6 @@
     }
   ],
   "platforms": ["ststm32"],
-  "examples": "examples/*/*/*.ino"
+  "examples": "examples/*/*/*.ino",
+  "headers": ["AsyncWebServer_STM32.h"]
 }

library.properties

@@ -1,5 +1,5 @@
 name=AsyncWebServer_STM32
-version=1.3.1
+version=1.4.0
 author=Hristo Gochkov,Khoi Hoang
 maintainer=Khoi Hoang <khoih.prog@gmail.com>
 license=MIT

src/AsyncEventSource_STM32.cpp

@@ -9,16 +9,18 @@
   Built by Khoi Hoang https://github.com/khoih-prog/AsyncWebServer_STM32
   Licensed under MIT license
  
-  Version: 1.3.0
-  
+  Version: 1.4.0
+
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
   1.2.3   K Hoang      02/09/2020 Initial coding for STM32 for built-in Ethernet (Nucleo-144, DISCOVERY, etc).
                                   Bump up version to v1.2.3 to sync with ESPAsyncWebServer v1.2.3
   1.2.4   K Hoang      05/09/2020 Add back MD5/SHA1 authentication feature.
   1.2.5   K Hoang      28/12/2020 Suppress all possible compiler warnings. Add examples.
   1.2.6   K Hoang      22/03/2021 Fix dependency on STM32AsyncTCP Library
-  1.3.0   K Hoang      14/04/2021 Add support to LAN8720 using STM32F4 or STM32F7 *****************************************************************************************************************************/
+  1.3.0   K Hoang      14/04/2021 Add support to LAN8720 using STM32F4 or STM32F7
+  1.3.1   K Hoang      09/10/2021 Update `platform.ini` and `library.json`
+  1.4.0   K Hoang      14/12/2021 Fix base64 encoding of websocket client key and add WebServer progmem support *****************************************************************************************************************************/
 
 #define _ASYNCWEBSERVER_STM32_LOGLEVEL_     1
 
@@ -270,7 +272,7 @@ void AsyncEventSourceClient::_queueMessage(AsyncEventSourceMessage *dataMessage)
 
   if (_messageQueue.length() >= SSE_MAX_QUEUED_MESSAGES)
   {
-    Serial.println("ERROR: Too many messages queued");
+    LOGERROR("ERROR: Too many messages queued");
     delete dataMessage;
   }
   else

src/AsyncEventSource_STM32.h

@@ -9,8 +9,8 @@
   Built by Khoi Hoang https://github.com/khoih-prog/AsyncWebServer_STM32
   Licensed under MIT license
  
-  Version: 1.3.0
-  
+  Version: 1.4.0
+
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
   1.2.3   K Hoang      02/09/2020 Initial coding for STM32 for built-in Ethernet (Nucleo-144, DISCOVERY, etc).
@@ -19,6 +19,8 @@
   1.2.5   K Hoang      28/12/2020 Suppress all possible compiler warnings. Add examples.
   1.2.6   K Hoang      22/03/2021 Fix dependency on STM32AsyncTCP Library
   1.3.0   K Hoang      14/04/2021 Add support to LAN8720 using STM32F4 or STM32F7
+  1.3.1   K Hoang      09/10/2021 Update `platform.ini` and `library.json`
+  1.4.0   K Hoang      14/12/2021 Fix base64 encoding of websocket client key and add WebServer progmem support
  *****************************************************************************************************************************/
 
 #pragma once

src/AsyncJson_STM32.h

@@ -9,8 +9,8 @@
   Built by Khoi Hoang https://github.com/khoih-prog/AsyncWebServer_STM32
   Licensed under MIT license
  
-  Version: 1.3.0
-  
+  Version: 1.4.0
+
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
   1.2.3   K Hoang      02/09/2020 Initial coding for STM32 for built-in Ethernet (Nucleo-144, DISCOVERY, etc).
@@ -19,6 +19,8 @@
   1.2.5   K Hoang      28/12/2020 Suppress all possible compiler warnings. Add examples.
   1.2.6   K Hoang      22/03/2021 Fix dependency on STM32AsyncTCP Library
   1.3.0   K Hoang      14/04/2021 Add support to LAN8720 using STM32F4 or STM32F7
+  1.3.1   K Hoang      09/10/2021 Update `platform.ini` and `library.json`
+  1.4.0   K Hoang      14/12/2021 Fix base64 encoding of websocket client key and add WebServer progmem support
  *****************************************************************************************************************************/
 /*
   Async Response to use with ArduinoJson and AsyncWebServer

src/AsyncWebAuthentication_STM32.cpp

@@ -9,8 +9,8 @@
   Built by Khoi Hoang https://github.com/khoih-prog/AsyncWebServer_STM32
   Licensed under MIT license
  
-  Version: 1.3.0
-  
+  Version: 1.4.0
+
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
   1.2.3   K Hoang      02/09/2020 Initial coding for STM32 for built-in Ethernet (Nucleo-144, DISCOVERY, etc).
@@ -19,6 +19,8 @@
   1.2.5   K Hoang      28/12/2020 Suppress all possible compiler warnings. Add examples.
   1.2.6   K Hoang      22/03/2021 Fix dependency on STM32AsyncTCP Library
   1.3.0   K Hoang      14/04/2021 Add support to LAN8720 using STM32F4 or STM32F7
+  1.3.1   K Hoang      09/10/2021 Update `platform.ini` and `library.json`
+  1.4.0   K Hoang      14/12/2021 Fix base64 encoding of websocket client key and add WebServer progmem support
  *****************************************************************************************************************************/
 
 #define _ASYNCWEBSERVER_STM32_LOGLEVEL_     1

src/AsyncWebAuthentication_STM32.h

@@ -9,8 +9,8 @@
   Built by Khoi Hoang https://github.com/khoih-prog/AsyncWebServer_STM32
   Licensed under MIT license
  
-  Version: 1.3.0
-  
+  Version: 1.4.0
+
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
   1.2.3   K Hoang      02/09/2020 Initial coding for STM32 for built-in Ethernet (Nucleo-144, DISCOVERY, etc).
@@ -19,6 +19,8 @@
   1.2.5   K Hoang      28/12/2020 Suppress all possible compiler warnings. Add examples.
   1.2.6   K Hoang      22/03/2021 Fix dependency on STM32AsyncTCP Library
   1.3.0   K Hoang      14/04/2021 Add support to LAN8720 using STM32F4 or STM32F7
+  1.3.1   K Hoang      09/10/2021 Update `platform.ini` and `library.json`
+  1.4.0   K Hoang      14/12/2021 Fix base64 encoding of websocket client key and add WebServer progmem support
  *****************************************************************************************************************************/
 
 #pragma once

src/AsyncWebHandlerImpl_STM32.h

@@ -9,8 +9,8 @@
   Built by Khoi Hoang https://github.com/khoih-prog/AsyncWebServer_STM32
   Licensed under MIT license
  
-  Version: 1.3.0
-  
+  Version: 1.4.0
+
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
   1.2.3   K Hoang      02/09/2020 Initial coding for STM32 for built-in Ethernet (Nucleo-144, DISCOVERY, etc).
@@ -19,6 +19,8 @@
   1.2.5   K Hoang      28/12/2020 Suppress all possible compiler warnings. Add examples.
   1.2.6   K Hoang      22/03/2021 Fix dependency on STM32AsyncTCP Library
   1.3.0   K Hoang      14/04/2021 Add support to LAN8720 using STM32F4 or STM32F7
+  1.3.1   K Hoang      09/10/2021 Update `platform.ini` and `library.json`
+  1.4.0   K Hoang      14/12/2021 Fix base64 encoding of websocket client key and add WebServer progmem support
  *****************************************************************************************************************************/
 
 #pragma once

src/AsyncWebHandlers_STM32.cpp

@@ -9,8 +9,8 @@
   Built by Khoi Hoang https://github.com/khoih-prog/AsyncWebServer_STM32
   Licensed under MIT license
  
-  Version: 1.3.0
-  
+  Version: 1.4.0
+
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
   1.2.3   K Hoang      02/09/2020 Initial coding for STM32 for built-in Ethernet (Nucleo-144, DISCOVERY, etc).
@@ -19,6 +19,8 @@
   1.2.5   K Hoang      28/12/2020 Suppress all possible compiler warnings. Add examples.
   1.2.6   K Hoang      22/03/2021 Fix dependency on STM32AsyncTCP Library
   1.3.0   K Hoang      14/04/2021 Add support to LAN8720 using STM32F4 or STM32F7
+  1.3.1   K Hoang      09/10/2021 Update `platform.ini` and `library.json`
+  1.4.0   K Hoang      14/12/2021 Fix base64 encoding of websocket client key and add WebServer progmem support
  *****************************************************************************************************************************/
 
 #define _ASYNCWEBSERVER_STM32_LOGLEVEL_     1

src/AsyncWebRequest_STM32.cpp

@@ -9,7 +9,7 @@
   Built by Khoi Hoang https://github.com/khoih-prog/AsyncWebServer_STM32
   Licensed under MIT license
 
-  Version: 1.3.0
+  Version: 1.4.0
 
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
@@ -19,6 +19,8 @@
   1.2.5   K Hoang      28/12/2020 Suppress all possible compiler warnings. Add examples.
   1.2.6   K Hoang      22/03/2021 Fix dependency on STM32AsyncTCP Library
   1.3.0   K Hoang      14/04/2021 Add support to LAN8720 using STM32F4 or STM32F7
+  1.3.1   K Hoang      09/10/2021 Update `platform.ini` and `library.json`
+  1.4.0   K Hoang      14/12/2021 Fix base64 encoding of websocket client key and add WebServer progmem support
  *****************************************************************************************************************************/
 
 #define _ASYNCWEBSERVER_STM32_LOGLEVEL_     1
@@ -1007,11 +1009,13 @@ void AsyncWebServerRequest::send(AsyncWebServerResponse *response)
   }
 }
 
-AsyncWebServerResponse * AsyncWebServerRequest::beginResponse_P(int code, const String& contentType, const uint8_t * content, size_t len, AwsTemplateProcessor callback){
+AsyncWebServerResponse * AsyncWebServerRequest::beginResponse_P(int code, const String& contentType, const uint8_t * content, size_t len, AwsTemplateProcessor callback)
+{
   return new AsyncProgmemResponse(code, contentType, content, len, callback);
 }
 
-AsyncWebServerResponse * AsyncWebServerRequest::beginResponse_P(int code, const String& contentType, PGM_P content, AwsTemplateProcessor callback){
+AsyncWebServerResponse * AsyncWebServerRequest::beginResponse_P(int code, const String& contentType, PGM_P content, AwsTemplateProcessor callback)
+{
   return beginResponse_P(code, contentType, (const uint8_t *)content, strlen_P(content), callback);
 }
 

src/AsyncWebResponseImpl_STM32.h

@@ -9,7 +9,7 @@
   Built by Khoi Hoang https://github.com/khoih-prog/AsyncWebServer_STM32
   Licensed under MIT license
 
-  Version: 1.3.0
+  Version: 1.4.0
 
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
@@ -19,6 +19,8 @@
   1.2.5   K Hoang      28/12/2020 Suppress all possible compiler warnings. Add examples.
   1.2.6   K Hoang      22/03/2021 Fix dependency on STM32AsyncTCP Library
   1.3.0   K Hoang      14/04/2021 Add support to LAN8720 using STM32F4 or STM32F7
+  1.3.1   K Hoang      09/10/2021 Update `platform.ini` and `library.json`
+  1.4.0   K Hoang      14/12/2021 Fix base64 encoding of websocket client key and add WebServer progmem support
  *****************************************************************************************************************************/
 
 #pragma once
@@ -141,10 +143,13 @@ class AsyncChunkedResponse: public AsyncAbstractResponse
 };
 
 class cbuf;
-class AsyncProgmemResponse: public AsyncAbstractResponse {
+
+class AsyncProgmemResponse: public AsyncAbstractResponse 
+{
   private:
     const uint8_t * _content;
     size_t _readLength;
+    
   public:
     AsyncProgmemResponse(int code, const String& contentType, const uint8_t * content, size_t len, AwsTemplateProcessor callback=nullptr);
     bool _sourceValid() const { return true; }