Apply suggestions from code review

Co-authored-by: Jan Procházka <[email protected]>

Author: lucasssvaz

Diff for: libraries/WiFiClientSecure/examples/WiFiClientSecureProtocolUpgradeSTARTT/WiFIClientSecureProtocolUpgradeSTARTTLS.ino

@@ -48,9 +48,9 @@
 #define SMTP_PORT (587) // Standard (plaintext) submission port
 #endif
 
-const char* ssid     = WIFI_NETWORK;     // your network SSID (name of wifi network)
-const char* password = WIFI_PASSWD; // your network password
-const char*  server = SMTP_HOST;  // Server URL
+const char* ssid = WIFI_NETWORK;       // your network SSID (name of wifi network)
+const char* password = WIFI_PASSWD;    // your network password
+const char* server = SMTP_HOST;        // Server URL
 const int submission_port = SMTP_PORT; // submission port.
 
 WiFiClientSecure client;
@@ -82,7 +82,6 @@ void setup() {
 
   // skip verification for this demo. In production one should at the very least
   // enable TOFU; or ideally hardcode a (CA) certificate that is trusted.
-  //
   client.setInsecure();
 
   // Enable a plain-test start.
@@ -134,15 +133,13 @@ err:
 
 // SMTP command repsponse start with three digits and a space;
 // or, for continuation, with three digits and a '-'.
-//
 static bool readAllSMTPLines() {
   String s = "";
   int i;
 
   // blocking read; we cannot rely on a timeout
   // of a WiFiClientSecure read; as it is non
   // blocking.
-  //
   const unsigned long timeout = 15 * 1000;
   unsigned long start = millis(); // the timeout is for the entire CMD block response; not per character/line.
   while (1) {

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

@@ -173,7 +173,7 @@ int WiFiClientSecure::startTLS()
         };
         _stillinPlainStart = false;
     } else 
-        log_e("startTLS: ignoring StartTLS - as we should be secure already");
+        log_i("startTLS: ignoring StartTLS - as we should be secure already");
     return 1;
 }
 
@@ -285,7 +285,7 @@ int WiFiClientSecure::read(uint8_t *buf, size_t size)
         res = get_ssl_receive(sslclient, buf, size);
 
     if (res < 0) {
-        log_d("Closing connection on failed read");
+        log_e("Closing connection on failed read");
         stop();
         return peeked?peeked:res;
     }
@@ -304,7 +304,7 @@ int WiFiClientSecure::available()
     res = data_to_read(sslclient);
 
     if (res < 0 && !_stillinPlainStart) {
-        log_e("Closing connection on failed avail check");
+        log_e("Closing connection on failed available check");
         stop();
         return peeked?peeked:res;
     }
@@ -339,7 +339,7 @@ void WiFiClientSecure::setCACert (const char *rootCA)
  {
     if (bundle != NULL)
     {
-        esp_crt_bundle_set(bundle,sizeof(bundle));
+        esp_crt_bundle_set(bundle, sizeof(bundle));
         _use_ca_bundle = true;
     } else {
         esp_crt_bundle_detach(NULL);

Diff for: libraries/WiFiClientSecure/src/WiFiClientSecure.h

@@ -82,10 +82,10 @@ class WiFiClientSecure : public WiFiClient
 
     // Certain protocols start in plain-text; and then have the client
     // give some STARTSSL command to `upgrade' the connection to TLS
-    // or SSL. setting PlainStart to true (the default is false) enables
+    // or SSL. Setting PlainStart to true (the default is false) enables
     // this. It is up to the application code to then call 'startTLS()'
     // at the right point to initialise the SSL or TLS upgrade.
-    //
+    
     void setPlainStart() { _stillinPlainStart = true; };
     bool stillInPlainStart() { return _stillinPlainStart; };
     int startTLS();

Diff for: libraries/WiFiClientSecure/src/ssl_client.cpp

@@ -227,7 +227,7 @@ int start_ssl_client(sslclient_context *ssl_client, const IPAddress& ip, uint32_
 
     // Note - this check for BOTH key and cert is relied on
     // later during cleanup.
-    //
+    
     if (!insecure && cli_cert != NULL && cli_key != NULL) {
         mbedtls_x509_crt_init(&ssl_client->client_cert);
         mbedtls_pk_init(&ssl_client->client_key);
@@ -313,9 +313,9 @@ int ssl_starttls_handshake(sslclient_context *ssl_client)
         mbedtls_x509_crt_free(&ssl_client->ca_cert);
     }
 
-    // we know that we always have a client cert/key pair -- and we
-    // cannot look into the prviate client_key pk struct for newer
-    //versions of mbedtls. So rely on a public field of the cert
+    // We know that we always have a client cert/key pair -- and we
+    // cannot look into the private client_key pk struct for newer
+    // versions of mbedtls. So rely on a public field of the cert
     // and infer that there is a key too.
     if (ssl_client->client_cert.version) {
         mbedtls_x509_crt_free(&ssl_client->client_cert);