feature: fix build error of basic authorization.

Author: QuickSander

platformio.ini

@@ -1,37 +1,28 @@
-# Created by Sander van Woensel on 29-01-16.
-# Copyright (c) 2016 Sander van Woensel. All rights reserved.
-#
-# Project Configuration File
-#
-# A detailed documentation with the EXAMPLES is located here:
-# http://docs.platformio.org/en/latest/projectconf.html
-#
+; PlatformIO Project Configuration File
+;
+;   Build options: build flags, source filter
+;   Upload options: custom upload port, speed and extra flags
+;   Library options: dependencies, extra library storages
+;   Advanced options: extra scripting
+;
+; Please visit documentation for the other options and examples
+; https://docs.platformio.org/page/projectconf.html
 
 [platformio]
-# Since we desire to integrate with Arduino (and the way it likes its directory
-# structure), point source directory to the directory containing an example with
-# loop() and setup() and the lib directory to the directory Arduino stores its
-# libraries in. This way, PlatformIO will find this very library via the Arduino
-# library directory.
 src_dir = examples/HelloHttp
 lib_dir = ../
 
 [env:esp01]
 platform = espressif8266
 framework = arduino
 board = esp01
-# Custom upload tool to force use of esptool.py instead of default esptool.
-# See: http://arduino.stackexchange.com/questions/20219/upload-with-esptool-fails-with-espcomm-send-command-cant-receive-slip-payload
 extra_scripts = ../../Tools/platformio_esptool.py
+lib_deps = agdl/Base64@^1.0.0
 
 [env:uno]
 platform = atmelavr
 framework = arduino
 board = uno
-lib_deps = WiFi
-
-# TODO Work in progress
-#[env:native]
-#platform = native
-# Relative to src_dir ("examples/")
-#src_filter = +<../../test/*>
+lib_deps = 
+	WiFi
+	agdl/Base64@^1.0.0

src/internals/FixString.hpp

@@ -41,6 +41,7 @@ class FixString
    // Assignment
    FixString<MAX_SIZE>& operator=(const char* pCStr);
    FixString<MAX_SIZE>& operator=(const __FlashStringHelper * str);
+   FixString<MAX_SIZE>& operator=(const String& arduinostr);
    template<size_t RHS_SIZE> FixString<MAX_SIZE>& operator=(const FixString<RHS_SIZE>& fixStr);
    // We need this since move constructor implicitely declares assignment operators private.
    FixString<MAX_SIZE>& operator=(const FixString<MAX_SIZE>& fixStr) = default;
@@ -161,6 +162,15 @@ ArduinoHttpServer::FixString<MAX_SIZE>& ArduinoHttpServer::FixString<MAX_SIZE>::
    return (*this = FixString<MAX_SIZE>(pFlashStr));
 }
 
+//------------------------------------------------------------------------------
+//! \brief Assignment operator for Arduino Strings.
+template <size_t MAX_SIZE>
+ArduinoHttpServer::FixString<MAX_SIZE>& ArduinoHttpServer::FixString<MAX_SIZE>::operator=(const String& arduinostr)
+{
+   return (*this = FixString<MAX_SIZE>(arduinostr));
+}
+
+
 //------------------------------------------------------------------------------
 //! \brief Assignment operator
 template <size_t MAX_SIZE>

src/internals/HttpField.cpp

@@ -11,6 +11,7 @@
 #include "ArduinoHttpServerDebug.h"
 
 const char* ArduinoHttpServer::HttpField::SEPERATOR = ": ";
+const char* ArduinoHttpServer::HttpField::SUB_VALUE_SEPERATOR = " ";
 const char* ArduinoHttpServer::HttpField::CONTENT_TYPE_STR = "Content-Type";
 const char* ArduinoHttpServer::HttpField::CONTENT_LENGTH_TYPE_STR = "Content-Length";
 const char* ArduinoHttpServer::HttpField::USER_AGENT_TYPE_STR = "User-Agent";
@@ -78,3 +79,32 @@ const ArduinoHttpServer::HttpField::Type ArduinoHttpServer::HttpField::getType()
 {
    return m_type;
 }
+
+//! \brief Retrieve part of a value indicated by a zero based index.
+//! \details Retrieve "username:password" from "Basic username:password": call with subValueIndex 1.
+const ArduinoHttpServer::HttpField::SubValueString ArduinoHttpServer::HttpField::getSubValueString(size_t subValueIndex) const
+{
+   SubValueString subValue;
+   auto startIndex(0);
+   auto endIndex(0);
+
+   for(auto currentSubValueIndex=0U; currentSubValueIndex < subValueIndex; currentSubValueIndex++)
+   {
+      endIndex = m_value.indexOf(SUB_VALUE_SEPERATOR, startIndex);
+
+      // If separator has been found.
+      if(endIndex >=0)
+      {
+         subValue = m_value.substring(startIndex + strlen(SUB_VALUE_SEPERATOR), endIndex);
+         startIndex = endIndex;
+      }
+      else
+      {
+         subValue = m_value.substring(startIndex);
+      }
+   }
+      
+
+   return subValue;
+}
+

src/internals/HttpField.hpp

@@ -10,6 +10,8 @@
 #ifndef __ArduinoHttpServer__HttpField__
 #define __ArduinoHttpServer__HttpField__
 
+#include "FixString.hpp"
+
 #include "Arduino.h"
 
 namespace ArduinoHttpServer
@@ -21,6 +23,8 @@ class HttpField
 
 public:
 
+   using SubValueString = FixString<128>;
+
    enum class Type: char
    {
       NOT_SUPPORTED,
@@ -41,12 +45,14 @@ class HttpField
    const Type getType() const;
 
    inline const String& getValueAsString() const {return m_value; };
+   const SubValueString getSubValueString(size_t subValueIndex) const;
    inline const int getValueAsInt() const {return m_value.toInt(); };
 
 private:
    void determineType(const String& typeStr);
 
    static const char *SEPERATOR;
+   static const char* SUB_VALUE_SEPERATOR;
    static const char* CONTENT_TYPE_STR;
    static const char* CONTENT_LENGTH_TYPE_STR;
    static const char* USER_AGENT_TYPE_STR;

src/internals/StreamHttpReply.cpp

@@ -26,23 +26,17 @@ void ArduinoHttpServer::AbstractStreamHttpReply::send(const String& data, const
    // Read away remaining bytes.
    while(getStream().read()>=0);
 
-   String httpErrorReply;
-   httpErrorReply += AHS_F("HTTP/1.1 ");
-   httpErrorReply += getCode() + " ";
-   httpErrorReply += title + "\r\n";
-   httpErrorReply += AHS_F("Connection: close\r\n");
-   httpErrorReply += AHS_F("Content-Length: ");
-   httpErrorReply += data.length();
-   httpErrorReply += AHS_F("\r\n");
-   httpErrorReply += AHS_F("Content-Type: ");
-   httpErrorReply += m_contentType;
-   httpErrorReply += AHS_F("\r\n");
-   httpErrorReply += AHS_F("\r\n");
-   httpErrorReply += data;
-   httpErrorReply += AHS_F("\r\n");
-
    DEBUG_ARDUINO_HTTP_SERVER_PRINT("Printing Reply ... ");
-   getStream().print(httpErrorReply);
+
+   getStream().print( AHS_F("HTTP/1.1 ") );
+   getStream().print( getCode() + " ");
+   getStream().print( title + "\r\n" );
+   getStream().print( AHS_F("Connection: close\r\n") );
+   getStream().print( AHS_F("Content-Length: ") ); getStream().print( data.length()); getStream().print( AHS_F("\r\n") );
+   getStream().print( AHS_F("Content-Type: ") ); getStream().print( m_contentType ); getStream().print( AHS_F("\r\n") );
+   getStream().print( AHS_F("\r\n") );
+   getStream().print( data ); getStream().print( AHS_F("\r\n") );
+
    DEBUG_ARDUINO_HTTP_SERVER_PRINTLN("done.");
 }
 
@@ -151,12 +145,12 @@ void ArduinoHttpServer::StreamHttpAuthenticateReply::send()
    // Read away remaining bytes.
    while(getStream().read()>=0);
 
-   DEBUG_ARDUINO_HTTP_SERVER_PRINT("Printing Reply ... ");
+   DEBUG_ARDUINO_HTTP_SERVER_PRINT("Printing authenticate reply ... ");
    getStream().println(AHS_F("HTTP/1.1 401 Unauthorized"));
    getStream().println(AHS_F("WWW-Authenticate: Basic realm=\"Login Required\""));
    getStream().println(AHS_F("Connection: close"));
    getStream().println(AHS_F(""));
-   getStream().println(AHS_F("<HTML><HEAD><TITLE>401 Unauthorized</TITLE></HEAD><BODY BGCOLOR=\"#cc9999\"><H4>401 Unauthorized</H4>Authorization required.</BODY></HTML>"));
+   getStream().println(AHS_F("<html><head><title>401 Unauthorized</title></head><body><h4>401 Unauthorized</h4>Authorization required.</body></html>"));
    getStream().println(AHS_F(""));
    getStream().println(AHS_F(""));
    DEBUG_ARDUINO_HTTP_SERVER_PRINTLN("done.");

src/internals/StreamHttpRequest.hpp

@@ -85,6 +85,8 @@ class StreamHttpRequest
    static const long LINE_READ_TIMEOUT_MS = 10000L; //!< [ms] Wait 10s for reception of a complete line.
    static const int MAX_RETRIES_WAIT_DATA_AVAILABLE = 255;
 
+   constexpr static const char* BASIC_AUTH_TYPE_STR = "Basic";
+
    void parseRequest(char lineBuffer[MAX_LINE_SIZE]);
    void parseMethod(char lineBuffer[MAX_LINE_SIZE]);
    void parseResource();
@@ -380,34 +382,30 @@ const ArduinoHttpServer::ErrorString ArduinoHttpServer::StreamHttpRequest<MAX_BO
 }
 
 template <size_t MAX_BODY_SIZE>
-bool ArduinoHttpServer::StreamHttpRequest<MAX_BODY_SIZE>::authenticate(const char * username, const char * password) const
+bool ArduinoHttpServer::StreamHttpRequest<MAX_BODY_SIZE>::authenticate(const char *username, const char *password) const
 {
    if (m_authorizationField.getType() == HttpField::Type::NOT_SUPPORTED)
    {
       return false;
    }
 
-   if (!m_authorizationField.getValueAsString().startsWith("Basic"))
+   // HTTP value: "<Type> <Base 64 encoded credentials>"
+   // Retrieve type and verify wether it is basic authorization.
+   if(!(m_authorizationField.getSubValueString(0) == BASIC_AUTH_TYPE_STR))
    {
-      DEBUG_ARDUINO_HTTP_SERVER_PRINTLN("Unsupported auth header");
+      DEBUG_ARDUINO_HTTP_SERVER_PRINT("Unsupported authentication header: ");
+      DEBUG_ARDUINO_HTTP_SERVER_PRINTLN(m_authorizationField);
       return false;
    }
 
-   String combinedInput;
-   if (!combinedInput.reserve(strlen(username) + strlen(password) + 2))
-   {
-      DEBUG_ARDUINO_HTTP_SERVER_PRINTLN("Not enough memory");
-      return false;
-   }
-   combinedInput += username;
-   combinedInput += AHS_F(":");
-   combinedInput += password;
+   FixString<128U> combinedInput;
+   combinedInput += username; combinedInput += AHS_F(":"); combinedInput += password;
 
-   int encodedLength = Base64.encodedLength(combinedInput.length());
-   char encodedString[encodedLength];
-   Base64.encode(encodedString, combinedInput.c_str(), combinedInput.length());
+   const int encodedLength = Base64.encodedLength(combinedInput.length());
+   char encodedString[encodedLength] = {0};
+   Base64.encode(encodedString, combinedInput.cStr(), combinedInput.length());
 
-   if (strcmp(m_authorizationField.getValueAsString().c_str()+6,encodedString) == 0)
+   if ( m_authorizationField.getSubValueString(1) == encodedString )
    {
       return true;
    }