Reorganize repository as Arduino library

Author: fhessel

.gitignore

@@ -49,5 +49,5 @@ Release/
 .scala_dependencies
 .worksheet
 
-data/wifi/wifi.h
-data/cert/*.h
+examples/wifi/wifi.h
+examples/cert/*.h

data/favicon.h renamed to examples/favicon.h

@@ -55,6 +55,6 @@ openssl rsa -in example.key -outform DER -out example.key.DER
 openssl x509 -in example.crt -outform DER -out example.crt.DER
 
 # create header files
-mkdir ../../data/cert
-xxd -i example.crt.DER > ../../data/cert/cert.h
-xxd -i example.key.DER > ../../data/cert/private_key.h
+mkdir ../examples/cert
+xxd -i example.crt.DER > ../examples/cert/cert.h
+xxd -i example.key.DER > ../examples/cert/private_key.h

data/wifi/wifi.example.h renamed to examples/wifi/wifi.example.h

@@ -32,11 +32,11 @@
 #include "data/favicon.h"
 
 // Inlcudes for setting up the server
-#include "https/HTTPSServer.hpp"
+#include "src/HTTPSServer.hpp"
 
 // Includes to define request handler callbacks
-#include "https/HTTPRequest.hpp"
-#include "https/HTTPResponse.hpp"
+#include "src/HTTPRequest.hpp"
+#include "src/HTTPResponse.hpp"
 
 // The server loop will be configured as a separate task, so the server will run
 // independently from all other code.

tools/cert/create_cert.sh renamed to extras/create_cert.sh

@@ -0,0 +1,16 @@
+ConnectionContext      KEYWORD1
+HTTPConnection         KEYWORD1
+HTTPHeader             KEYWORD1
+HTTPHeaders            KEYWORD1
+HTTPMiddlewareFunction KEYWORD1
+HTTPRequest            KEYWORD1
+HTTPResponse           KEYWORD1
+HTTPSCallbackFunction  KEYWORD1
+HTTPSConnection        KEYWORD1
+HTTPServer             KEYWORD1
+HTTPSServer            KEYWORD1
+ResolvedResource       KEYWORD1
+ResourceNode           KEYWORD1
+ResourceParameters     KEYWORD1
+ResourceResolver       KEYWORD1
+SSLCert                KEYWORD1

https_server.h

@@ -0,0 +1,10 @@
+name=ESP32 HTTP(S) Webserver
+version=0.1.0
+author=Frank Hessel <[email protected]>
+maintainer=Frank Hessel <[email protected]>
+sentence=SSL/TLS-enabled HTTPS server library for the ESP32.
+paragraph=The library allows to define handler functions for specific request URLs, provides some help with the HTTP protocol. It can handle unencrypted HTTP traffic as well.
+category=Communication
+url=https://github.com/fhessel/esp32_https_server
+architectures=esp32
+includes=HTTPSServer.hpp,HTTPRequest.hpp,HTTPResponse.hpp

keywords.txt

@@ -5,7 +5,7 @@
  *      Author: frank
  */
 
-#include "ConnectionContext.hpp"
+#include "../src/ConnectionContext.hpp"
 
 namespace httpsserver {
 

library.properties

@@ -5,8 +5,8 @@
  *      Author: frank
  */
 
-#ifndef HTTPS_CONNECTIONCONTEXT_HPP_
-#define HTTPS_CONNECTIONCONTEXT_HPP_
+#ifndef SRC_CONNECTIONCONTEXT_HPP_
+#define SRC_CONNECTIONCONTEXT_HPP_
 
 #include <Arduino.h>
 
@@ -35,4 +35,4 @@ class ConnectionContext {
 
 } /* namespace httpsserver */
 
-#endif /* HTTPS_CONNECTIONCONTEXT_HPP_ */
+#endif /* SRC_CONNECTIONCONTEXT_HPP_ */

https/ConnectionContext.cpp renamed to src/ConnectionContext.cpp

@@ -1,4 +1,4 @@
-#include "HTTPConnection.hpp"
+#include "../src/HTTPConnection.hpp"
 
 namespace httpsserver {
 

https/ConnectionContext.hpp renamed to src/ConnectionContext.hpp

@@ -1,5 +1,5 @@
-#ifndef HTTPS_HTTPCONNECTION_HPP_
-#define HTTPS_HTTPCONNECTION_HPP_
+#ifndef SRC_HTTPCONNECTION_HPP_
+#define SRC_HTTPCONNECTION_HPP_
 
 #include <Arduino.h>
 
@@ -11,14 +11,14 @@
 #undef read
 #include "lwip/sockets.h"
 
-#include "HTTPSServerConstants.hpp"
-#include "HTTPHeaders.hpp"
-#include "HTTPHeader.hpp"
-#include "ResourceResolver.hpp"
-#include "ResolvedResource.hpp"
-#include "ResourceNode.hpp"
-#include "HTTPRequest.hpp"
-#include "HTTPResponse.hpp"
+#include "../src/HTTPSServerConstants.hpp"
+#include "../src/HTTPHeaders.hpp"
+#include "../src/HTTPHeader.hpp"
+#include "../src/ResourceResolver.hpp"
+#include "../src/ResolvedResource.hpp"
+#include "../src/ResourceNode.hpp"
+#include "../src/HTTPRequest.hpp"
+#include "../src/HTTPResponse.hpp"
 
 namespace httpsserver {
 
@@ -147,4 +147,4 @@ class HTTPConnection : private ConnectionContext {
 
 } /* namespace httpsserver */
 
-#endif /* HTTPS_HTTPCONNECTION_HPP_ */
+#endif /* SRC_HTTPCONNECTION_HPP_ */

https/HTTPConnection.cpp renamed to src/HTTPConnection.cpp

@@ -5,7 +5,7 @@
  *      Author: frank
  */
 
-#include "HTTPHeader.hpp"
+#include "../src/HTTPHeader.hpp"
 
 namespace httpsserver {
 

https/HTTPConnection.hpp renamed to src/HTTPConnection.hpp

@@ -5,8 +5,8 @@
  *      Author: frank
  */
 
-#ifndef HTTPS_HTTPHEADER_HPP_
-#define HTTPS_HTTPHEADER_HPP_
+#ifndef SRC_HTTPHEADER_HPP_
+#define SRC_HTTPHEADER_HPP_
 
 #include <string>
 
@@ -23,4 +23,4 @@ class HTTPHeader {
 
 } /* namespace httpsserver */
 
-#endif /* HTTPS_HTTPHEADER_HPP_ */
+#endif /* SRC_HTTPHEADER_HPP_ */

https/HTTPHeader.cpp renamed to src/HTTPHeader.cpp

@@ -5,7 +5,7 @@
  *      Author: frank
  */
 
-#include "HTTPHeaders.hpp"
+#include "../src/HTTPHeaders.hpp"
 
 namespace httpsserver {
 

https/HTTPHeader.hpp renamed to src/HTTPHeader.hpp

@@ -5,17 +5,17 @@
  *      Author: frank
  */
 
-#ifndef HTTPS_HTTPHEADERS_HPP_
-#define HTTPS_HTTPHEADERS_HPP_
+#ifndef SRC_HTTPHEADERS_HPP_
+#define SRC_HTTPHEADERS_HPP_
 
 #include <string>
 // Arduino declares it's own min max, incompatible with the stl...
 #undef min
 #undef max
 #include <vector>
 
-#include "HTTPSServerConstants.hpp"
-#include "HTTPHeader.hpp"
+#include "../src/HTTPSServerConstants.hpp"
+#include "../src/HTTPHeader.hpp"
 
 namespace httpsserver {
 
@@ -37,4 +37,4 @@ class HTTPHeaders {
 
 } /* namespace httpsserver */
 
-#endif /* HTTPS_HTTPHEADERS_HPP_ */
+#endif /* SRC_HTTPHEADERS_HPP_ */

https/HTTPHeaders.cpp renamed to src/HTTPHeaders.cpp

@@ -1,11 +1,11 @@
-#ifndef HTTPS_HTTPMIDDLEWAREFUNCTION_HPP_
-#define HTTPS_HTTPMIDDLEWAREFUNCTION_HPP_
+#ifndef SRC_HTTPMIDDLEWAREFUNCTION_HPP_
+#define SRC_HTTPMIDDLEWAREFUNCTION_HPP_
 
 #include <functional>
 
-#include "HTTPRequest.hpp"
-#include "HTTPResponse.hpp"
-#include "HTTPSCallbackFunction.hpp"
+#include "../src/HTTPRequest.hpp"
+#include "../src/HTTPResponse.hpp"
+#include "../src/HTTPSCallbackFunction.hpp"
 
 namespace httpsserver {
 	/**
@@ -22,4 +22,4 @@ namespace httpsserver {
 	 */
 	typedef void (HTTPSMiddlewareFunction)(HTTPRequest * req, HTTPResponse * res, std::function<void()> next);
 }
- #endif /* HTTPS_HTTPMIDDLEWAREFUNCTION_HPP_ */
+ #endif /* SRC_HTTPMIDDLEWAREFUNCTION_HPP_ */

https/HTTPHeaders.hpp renamed to src/HTTPHeaders.hpp

@@ -5,7 +5,7 @@
  *      Author: frank
  */
 
-#include "HTTPRequest.hpp"
+#include "../src/HTTPRequest.hpp"
 
 namespace httpsserver {
 

https/HTTPMiddlewareFunction.hpp renamed to src/HTTPMiddlewareFunction.hpp

@@ -5,20 +5,19 @@
  *      Author: frank
  */
 
-#ifndef HTTPS_HTTPREQUEST_HPP_
-#define HTTPS_HTTPREQUEST_HPP_
+#ifndef SRC_HTTPREQUEST_HPP_
+#define SRC_HTTPREQUEST_HPP_
 
 #include <Arduino.h>
 #include <string>
 
 #include <mbedtls/base64.h>
 
-#include "util.hpp"
-
-#include "ConnectionContext.hpp"
-#include "ResourceParameters.hpp"
-#include "HTTPHeaders.hpp"
-#include "HTTPHeader.hpp"
+#include "../src/ConnectionContext.hpp"
+#include "../src/HTTPHeader.hpp"
+#include "../src/HTTPHeaders.hpp"
+#include "../src/ResourceParameters.hpp"
+#include "../src/util.hpp"
 
 namespace httpsserver {
 
@@ -59,4 +58,4 @@ class HTTPRequest {
 
 } /* namespace httpsserver */
 
-#endif /* HTTPS_HTTPREQUEST_HPP_ */
+#endif /* SRC_HTTPREQUEST_HPP_ */

https/HTTPRequest.cpp renamed to src/HTTPRequest.cpp

@@ -6,10 +6,11 @@
  */
 
 // needed for HTTP sockets
+#include "../src/HTTPResponse.hpp"
+
 #include <Arduino.h>
 #include "lwip/sockets.h"
 
-#include "HTTPResponse.hpp"
 
 namespace httpsserver {
 

https/HTTPRequest.hpp renamed to src/HTTPRequest.hpp

@@ -5,8 +5,8 @@
  *      Author: frank
  */
 
-#ifndef HTTPS_HTTPRESPONSE_HPP_
-#define HTTPS_HTTPRESPONSE_HPP_
+#ifndef SRC_HTTPRESPONSE_HPP_
+#define SRC_HTTPRESPONSE_HPP_
 
 #include <Arduino.h>
 #include <string>
@@ -18,11 +18,11 @@
 
 #include <openssl/ssl.h>
 
-#include "util.hpp"
+#include "../src/util.hpp"
 
-#include "ConnectionContext.hpp"
-#include "HTTPHeaders.hpp"
-#include "HTTPHeader.hpp"
+#include "../src/ConnectionContext.hpp"
+#include "../src/HTTPHeaders.hpp"
+#include "../src/HTTPHeader.hpp"
 
 namespace httpsserver {
 
@@ -71,4 +71,4 @@ class HTTPResponse : public Print {
 
 } /* namespace httpsserver */
 
-#endif /* HTTPS_HTTPRESPONSE_HPP_ */
+#endif /* SRC_HTTPRESPONSE_HPP_ */

https/HTTPResponse.cpp renamed to src/HTTPResponse.cpp

@@ -5,14 +5,14 @@
  *      Author: frank
  */
 
-#ifndef HTTPS_HTTPSCALLBACKFUNCTION_HPP_
-#define HTTPS_HTTPSCALLBACKFUNCTION_HPP_
+#ifndef SRC_HTTPSCALLBACKFUNCTION_HPP_
+#define SRC_HTTPSCALLBACKFUNCTION_HPP_
 
-#include "HTTPRequest.hpp"
-#include "HTTPResponse.hpp"
+#include "../src/HTTPRequest.hpp"
+#include "../src/HTTPResponse.hpp"
 
 namespace httpsserver {
 	typedef void (HTTPSCallbackFunction)(HTTPRequest * req, HTTPResponse * res);
 }
 
-#endif /* HTTPS_HTTPSCALLBACKFUNCTION_HPP_ */
+#endif /* SRC_HTTPSCALLBACKFUNCTION_HPP_ */

https/HTTPResponse.hpp renamed to src/HTTPResponse.hpp

@@ -5,7 +5,7 @@
  *      Author: frank
  */
 
-#include "HTTPSConnection.hpp"
+#include "../src/HTTPSConnection.hpp"
 
 namespace httpsserver {
 

https/HTTPSCallbackFunction.hpp renamed to src/HTTPSCallbackFunction.hpp

@@ -5,8 +5,8 @@
  *      Author: frank
  */
 
-#ifndef HTTPS_HTTPSCONNECTION_HPP_
-#define HTTPS_HTTPSCONNECTION_HPP_
+#ifndef SRC_HTTPSCONNECTION_HPP_
+#define SRC_HTTPSCONNECTION_HPP_
 
 #include <Arduino.h>
 
@@ -21,15 +21,15 @@
 #undef read
 #include "lwip/sockets.h"
 
-#include "HTTPSServerConstants.hpp"
-#include "HTTPConnection.hpp"
-#include "HTTPHeaders.hpp"
-#include "HTTPHeader.hpp"
-#include "ResourceResolver.hpp"
-#include "ResolvedResource.hpp"
-#include "ResourceNode.hpp"
-#include "HTTPRequest.hpp"
-#include "HTTPResponse.hpp"
+#include "../src/HTTPSServerConstants.hpp"
+#include "../src/HTTPConnection.hpp"
+#include "../src/HTTPHeaders.hpp"
+#include "../src/HTTPHeader.hpp"
+#include "../src/ResourceResolver.hpp"
+#include "../src/ResolvedResource.hpp"
+#include "../src/ResourceNode.hpp"
+#include "../src/HTTPRequest.hpp"
+#include "../src/HTTPResponse.hpp"
 
 namespace httpsserver {
 
@@ -59,4 +59,4 @@ class HTTPSConnection : public HTTPConnection {
 
 } /* namespace httpsserver */
 
-#endif /* HTTPS_HTTPSCONNECTION_HPP_ */
+#endif /* SRC_HTTPSCONNECTION_HPP_ */

https/HTTPSConnection.cpp renamed to src/HTTPSConnection.cpp

@@ -5,7 +5,7 @@
  *      Author: frank
  */
 
-#include "HTTPSServer.hpp"
+#include "../src/HTTPSServer.hpp"
 
 namespace httpsserver {