Formatting improvements

Author: lucasssvaz

Diff for: libraries/ESP32/examples/HEXBuilder/HEXBuilder.ino

@@ -6,7 +6,6 @@ void setup() {
   Serial.println("\n\n\nStart.");
 
   // Convert a HEX string like 6c6c6f20576f726c64 to a binary buffer
-  //
   {
     const char * out = "Hello World";
     const char * hexin = "48656c6c6f20576f726c6400"; // As the string above is \0 terminated too
@@ -21,7 +20,6 @@ void setup() {
       Serial.println("Odd - decode 1 went wrong");
 
     // Safe to print this binary buffer -- as we've included a \0 in the hex sequence.
-    //
     Serial.printf("IN: <%s>\nOUT <%s\\0>\n", hexin, buff);
   };
 
@@ -49,7 +47,6 @@ void setup() {
       Serial.println("Odd - length 3 is wrong");
 
     // we need to ignore case - as a hex string can be spelled in uppercase and lowercase
-    //
     if (!out.equalsIgnoreCase(helloHEX)) {
       Serial.println("Odd - decode 3 went wrong");
     }
@@ -65,7 +62,6 @@ void setup() {
       Serial.println("Odd - length 4 is wrong");
 
     // we need to ignore case - as a hex string can be spelled in uppercase and lowercase
-    //
     if (strcasecmp(buff, helloHex))
       Serial.println("Odd - decode 4 went wrong");
   }

Diff for: libraries/ESP32/examples/MD5Builder/MD5Builder.ino

@@ -9,7 +9,7 @@
 // has been phased out as insecure eons ago) by letting you create an
 // MD5 of the data the user entered; and then compare this to an MD5
 // string that you have put in your code.
-//
+
 void setup() {
   Serial.begin(115200);
   while (!Serial) { delay(10); }
@@ -19,7 +19,6 @@ void setup() {
   // matches the original string.
   //
   // echo -n "Hello World" | openssl md5
-  //
   {
     String md5 = "b10a8db164e0754105b7a99be72e3fe5";
     String password = "Hello World";
@@ -37,6 +36,7 @@ void setup() {
     else
       Serial.println("OK!");
   }
+
   // Check that this also work if we add the password not as
   // a normal string - but as a string with the HEX values.
   {
@@ -60,6 +60,7 @@ void setup() {
       Serial.println("OK!");
 
   }
+
   // Check that this also work if we add the password as
   // an unsigned byte array.
   {
@@ -79,7 +80,6 @@ void setup() {
       Serial.println("OK!");
 
     // And also check that we can compare this as pure, raw, bytes
-    //
     uint8_t raw[16] = {   0xb1, 0x0a, 0x8d, 0xb1, 0x64, 0xe0, 0x75, 0x41,
                           0x05, 0xb7, 0xa9, 0x9b, 0xe7, 0x2e, 0x3f, 0xe5
                       };

Diff for: libraries/WebServer/examples/HttpBasicAuthSHA1/HttpBasicAuthSHA1.ino

@@ -15,24 +15,20 @@ WebServer server(80);
 
 // Passwords as plaintext - human readable and easily visible in
 // the sourcecode and in the firmware/binary.
-//
 const char* www_username = "admin";
 const char* www_password = "esp32";
 
 // The sha1 of 'esp32' (without the trailing \0) expressed as 20
 // bytes of hex. Created by for example 'echo -n esp32 | openssl sha1'
 // or http://www.sha1-online.com.
-//
 const char* www_username_hex = "hexadmin";
 const char* www_password_hex = "8cb124f8c277c16ec0b2ee00569fd151a08e342b";
 
 // The same; but now expressed as a base64 string (e.g. as commonly used
 // by webservers). Created by ` echo -n esp32 | openssl sha1 -binary | openssl base64`
-//
 const char* www_username_base64 = "base64admin";
 const char* www_password_base64 = "jLEk+MJ3wW7Asu4AVp/RUaCONCs=";
 
-
 void setup() {
   Serial.begin(115200);
   while (!Serial) { delay(10); }

Diff for: libraries/WebServer/examples/HttpBasicAuthSHA1orBearerToken/HttpBasicAuthSHA1orBearerToken.ino

@@ -4,8 +4,7 @@
 #include <WebServer.h>
 #include "mbedtls/sha1.h"
 
-
-/// We have two options - we either come in with a bearer
+// We have two options - we either come in with a bearer
 // token - i.e. a special header or API token; or we
 // get a normal HTTP style basic auth prompt.
 //
@@ -18,11 +17,11 @@
 
 // Create the secet token SHA1 with:
 //        echo -n SecritToken | openssl sha1
-//
+
 String secret_token_hex = "d2cce6b472959484a21c3194080c609b8a2c910b";
 
 // Wifi credentials
-//
+
 const char* ssid = "........";
 const char* password = "........";
 
@@ -36,20 +35,17 @@ WebServer server(80);
 // The sha1 of 'esp32' (without the trailing \0) expressed as 20
 // bytes of hex. Created by for example 'echo -n esp32 | openssl sha1'
 // or http://www.sha1-online.com.
-//
 const char* www_username_hex = "hexadmin";
 const char* www_password_hex = "8cb124f8c277c16ec0b2ee00569fd151a08e342b";
 
 // The same; but now expressed as a base64 string (e.g. as commonly used
 // by webservers). Created by ` echo -n esp32 | openssl sha1 -binary | openssl base64`
-//
 const char* www_username_base64 = "base64admin";
 const char* www_password_base64 = "jLEk+MJ3wW7Asu4AVp/RUaCONCs=";
 
 static unsigned char _bearer[20];
 String * check_bearer_or_auth(HTTPAuthMethod mode, String authReq, String params[]) {
   // we expect authReq to be "bearer some-secret"
-  //
   String lcAuthReq = authReq;
   lcAuthReq.toLowerCase();
   if (mode == OTHER_AUTH && (lcAuthReq.startsWith("bearer "))) {
@@ -64,7 +60,6 @@ String * check_bearer_or_auth(HTTPAuthMethod mode, String authReq, String params
   };
 
 // that failed - so do a normal auth
-//
 return server.authenticateBasicSHA1(www_username_hex, www_password_hex) ?
          new String(params[0]) : NULL;
 };
@@ -82,9 +77,8 @@ void setup() {
   ArduinoOTA.begin();
 
   // Convert token to a convenient binary representation.
-  //
   size_t len = HEXBuilder::hex2bytes(_bearer,sizeof(_bearer),secret_token_hex);
-  if (len != 20) 
+  if (len != 20)
     Serial.println("Bearer token does not look like a valid SHA1 hex string ?!");
 
   server.on("/", []() {

Diff for: libraries/WebServer/src/WebServer.cpp

@@ -43,7 +43,6 @@ static const char WWW_Authenticate[] = "WWW-Authenticate";
 static const char Content_Length[] = "Content-Length";
 static const char ETAG_HEADER[] = "If-None-Match";
 
-
 WebServer::WebServer(IPAddress addr, int port)
 : _corsEnabled(false)
 , _server(addr, port)
@@ -151,7 +150,6 @@ bool WebServer::authenticateBasicSHA1(const char * _username, const char * _sha1
             // we can either decode _sha1base64orHex and then compare the 20 bytes;
             // or encode the sha we calculated. We pick the latter as encoding of a
             // fixed array of 20 bytes s safer than operating on something external.
-            //
             #define _H2D(x) (((x)>='0' && ((x) <='9')) ? ((x)-'0') : (((x)>='a' && (x)<='f') ? ((x)-'a'+10) : 0))
             #define H2D(x) (_H2D(tolower((x))))
             if (strlen(_sha1Base64orHex) == 20 * 2) {
@@ -216,7 +214,6 @@ bool WebServer::authenticate(THandlerFunctionAuthCheck fn) {
     log_v("%s", authReq.c_str());
 
     // extracting required parameters for RFC 2069 simpler Digest
-    //
     String _username = _extractParam(authReq,F("username=\""),'\"');
     String _realm    = _extractParam(authReq, F("realm=\""),'\"');
     String _uri      = _extractParam(authReq, F("uri=\""),'\"');
@@ -239,14 +236,13 @@ bool WebServer::authenticate(THandlerFunctionAuthCheck fn) {
     String _response = _extractParam(authReq, F("response=\""),'\"');
     String _opaque   = _extractParam(authReq, F("opaque=\""),'\"');
 
-    if((!_realm.length()) || (!_nonce.length()) || (!_uri.length()) || (!_response.length()) || (!_opaque.length())) 
+    if((!_realm.length()) || (!_nonce.length()) || (!_uri.length()) || (!_response.length()) || (!_opaque.length()))
       goto exf;
 
-    if((_opaque != _sopaque) || (_nonce != _snonce) || (_realm != _srealm)) 
+    if((_opaque != _sopaque) || (_nonce != _snonce) || (_realm != _srealm))
       goto exf;
 
     // parameters for the RFC 2617 newer Digest
-    //
     String _nc,_cnonce;
     if(authReq.indexOf(FPSTR(qop_auth)) != -1 || authReq.indexOf(FPSTR(qop_auth_quoted)) != -1) {
       _nc = _extractParam(authReq, F("nc="), ',');