Merge pull request #76 from govorox/v1.2.0

V1.2.0

Author: RobertByrnes

.github/workflows/ci_master.yml

@@ -4,6 +4,7 @@ on:
   pull_request:
     branches:
       - master
+      - 'v[0-9]+.[0-9]+.[0-9]+'
 
 jobs:
   test:

README.md

@@ -1,31 +1,35 @@
-# SSLClient Arduino Library (Version 1.1.10)
+# SSLClient Arduino Library (Version 1.2.0)
+
+#### Available on PlatformIO registry as digitaldragon/[email protected]
 [![PlatformIO Registry](https://badges.registry.platformio.org/packages/digitaldragon/library/SSLClient.svg)](https://registry.platformio.org/libraries/digitaldragon/SSLClient)
 
-![arduino-library-badge](https://www.ardu-badge.com/badge/GovoroxSSLClient.svg)
+#### Available on Arduino Libraries registry to digitaldragon/[email protected]
+[![arduino-library-badge](https://www.ardu-badge.com/badge/GovoroxSSLClient.svg)](https://www.ardu-badge.com/badge/GovoroxSSLClient.svg)
 
-#### Available on PlatformIO registry as digitaldragon/[email protected]
-#### Available on Arduino Libraries registry to digitaldragon/[email protected]
+## 🚀 Overview
+SSLClient extends the ESP32/Arduino ecosystem to secure communication via TLS, providing a transparent SSL/TLS layer over any **Client** class instance. Leverages *mbedtls* for robust, efficient cryptographic operations, initially tailored for ESP32 but adaptable across platforms.
 
-## Overview - SSLClient Arduino library using *mbedtls* functions
-The SSLClient class implements support for secure connections using TLS (SSL). It Provides a transparent SSL wrapper over existing transport object of a **Client** class.
 Based on the [WiFiClientSecure](https://github.com/espressif/arduino-esp32/tree/master/libraries/WiFiClientSecure) for Arduino/ESP32.
-Designed and tested on ESP32, but should be portable to other platforms.
 
-The SSLClient library offers a simple way to add SSL/TLS encryption to your Arduino/ESP32 projects. Utilizing mbedtls functions, it provides a transparent SSL wrapper for the Client class. Originally designed for ESP32, it's adaptable for other platforms.
+## 🌟 What's New in 1.2.0
+**ALPN Support**: Application Layer Protocol Negotiation for efficient server communication.  
+**Cert Bundles**: Simplifies management and use of multiple CA certificates.  
+**Bug Fix**: Corrects byte calculation for record expansion post-handshake.
+**More Examples**: Examples for the ESP32 PlatformIO for ALPN protocols, AWS, and using certificate bundles.
 
-## Features
-Secure TLS communication.
-Based on mbedtls.
-Compatible with Arduino/ESP32 and potentially other platforms.
-Suitable for IoT applications, including AWS IoT.
+## ✨ Features
+- Secure TLS communication.
+- Based on mbedtls.
+- Compatible with Arduino/ESP32 and potentially other platforms.
+- Suitable for IoT applications, including AWS IoT.
 
-## Installation
+## 🔧 Installation
 Install via the Arduino Library Manager or PlatformIO:
 
 Arduino IDE: Search for "SSLClient".
-PlatformIO: Add `digitaldragon/SSLClient@^1.1.10` to platformio.ini.
+PlatformIO: Add `digitaldragon/SSLClient@^1.2.0` to platformio.ini.
 
-## Usage
+## 🛠 Usage
 ### Basic Connection
 ```cpp
 #include <SSLClient.h>
@@ -53,7 +57,7 @@ secure.setPrivateKey(AWS_CERT_PRIVATE);
 MQTTClient mqtt = MQTTClient(256);
 mqtt.begin(AWS_IOT_ENDPOINT, 8883, secure);
 ```
-### Application Notes
+### 📚 Application Notes
 The `SSLClient.cpp` file provides a comprehensive suite of functions for handling SSL/TLS connections in an Arduino environment, particularly for the ESP32. These functions can be categorized into several key areas of functionality, which are essential for understanding the library's capabilities. Here's a user guide to the functionality based on the documentation blocks of these functions:
 
 ### Error Handling
@@ -101,5 +105,19 @@ The `SSLClient.cpp` file provides a comprehensive suite of functions for handlin
 
 This user guide provides a comprehensive overview of each function, offering insights into how to use the SSLClient library effectively for secure communication in Arduino-based projects. Each function is designed to handle specific aspects of SSL/TLS communication, from establishing connections and handling data transmission to managing certificates and ensuring security.
 
-## License
-The library is released under GNU General Public Licence. See the LICENSE file for more details.
+## 📄 License
+The library is released under GNU General Public Licence. See the LICENSE file for more details.
+
+## 📶 Handy CSQ / RSSI / Signal Strength Mapping
+| CSQ Value | RSSI (dBm)          | Description      |
+|-----------|---------------------|------------------|
+| 0         | -113 dBm or less    | No signal        |
+| 1-2       | -111 dBm to -109 dBm| Very poor signal |
+| 3-9       | -107 dBm to -93 dBm | Poor signal      |
+| 10-14     | -91 dBm to -83 dBm  | Fair signal      |
+| 15-19     | -81 dBm to -73 dBm  | Good signal      |
+| 20-30     | -71 dBm to -53 dBm  | Very good signal |
+| 31        | -51 dBm or more     | Excellent signal |
+
+## 🖥 Contributing
+Contributions are welcome! Please fork the repository and submit pull requests with your enhancements.

examples/Esp32/https_eth_LilyGo-T-ETH-POE/ca_cert.h renamed to examples/Esp32-Arduino-IDE/https_eth_LilyGo-T-ETH-POE/ca_cert.h

@@ -1,41 +1,41 @@
-//Azure Baltimore Certificate
-const char root_ca[] PROGMEM =
-"-----BEGIN CERTIFICATE-----\r\n"
-"MIIDdzCCAl+gAwIBAgIEAgAAuTANBgkqhkiG9w0BAQUFADBaMQswCQYDVQQGEwJJ\r\n"
-"RTESMBAGA1UEChMJQmFsdGltb3JlMRMwEQYDVQQLEwpDeWJlclRydXN0MSIwIAYD\r\n"
-"VQQDExlCYWx0aW1vcmUgQ3liZXJUcnVzdCBSb290MB4XDTAwMDUxMjE4NDYwMFoX\r\n"
-"DTI1MDUxMjIzNTkwMFowWjELMAkGA1UEBhMCSUUxEjAQBgNVBAoTCUJhbHRpbW9y\r\n"
-"ZTETMBEGA1UECxMKQ3liZXJUcnVzdDEiMCAGA1UEAxMZQmFsdGltb3JlIEN5YmVy\r\n"
-"VHJ1c3QgUm9vdDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKMEuyKr\r\n"
-"mD1X6CZymrV51Cni4eiVgLGw41uOKymaZN+hXe2wCQVt2yguzmKiYv60iNoS6zjr\r\n"
-"IZ3AQSsBUnuId9Mcj8e6uYi1agnnc+gRQKfRzMpijS3ljwumUNKoUMMo6vWrJYeK\r\n"
-"mpYcqWe4PwzV9/lSEy/CG9VwcPCPwBLKBsua4dnKM3p31vjsufFoREJIE9LAwqSu\r\n"
-"XmD+tqYF/LTdB1kC1FkYmGP1pWPgkAx9XbIGevOF6uvUA65ehD5f/xXtabz5OTZy\r\n"
-"dc93Uk3zyZAsuT3lySNTPx8kmCFcB5kpvcY67Oduhjprl3RjM71oGDHweI12v/ye\r\n"
-"jl0qhqdNkNwnGjkCAwEAAaNFMEMwHQYDVR0OBBYEFOWdWTCCR1jMrPoIVDaGezq1\r\n"
-"BE3wMBIGA1UdEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgEGMA0GCSqGSIb3\r\n"
-"DQEBBQUAA4IBAQCFDF2O5G9RaEIFoN27TyclhAO992T9Ldcw46QQF+vaKSm2eT92\r\n"
-"9hkTI7gQCvlYpNRhcL0EYWoSihfVCr3FvDB81ukMJY2GQE/szKN+OMY3EU/t3Wgx\r\n"
-"jkzSswF07r51XgdIGn9w/xZchMB5hbgF/X++ZRGjD8ACtPhSNzkE1akxehi/oCr0\r\n"
-"Epn3o0WC4zxe9Z2etciefC7IpJ5OCBRLbf1wbWsaY71k5h+3zvDyny67G7fyUIhz\r\n"
-"ksLi4xaNmjICq44Y3ekQEe5+NauQrz4wlHrQMz2nZQ/1/I6eYs9HRCwBXbsdtTLS\r\n"
-"R9I4LtD+gdwyah617jzV/OeBHRnDJELqYzmp\r\n"
-"-----END CERTIFICATE-----\r\n";
-
-
-
-//Client Certificate (from Azure Iot Hub Device) - Get your own
-const char client_cert_pem_start[] =
-"-----BEGIN CERTIFICATE-----""\n"
-"MIIFfDCCA2SgAwIBAgIBAzANBgkqhkiG9w0BAQsFADAqMSgwJgYDVQQDDB9BenVy""\n"
-...
-"+sDPud5VrLd8jOWCAKcuZA==""\n"
-"-----END CERTIFICATE-----";
-
-//Client Key (from Azure Iot Hub Device) - Get your own
-const char client_key_pem_start[] =
-"-----BEGIN RSA PRIVATE KEY-----""\n"
-"MIIJKAIBAAKCAgEAwUG+ZPQp4ZRlvI7xPQYDHkLs5dTX0LTB0tUr3O7LSwc4PPf3""\n"
-...
-"63IPOMRIsakwx3hdRv9gh30bh6LVS6pn9UyHM65pNVsCu4OHB/B4dSiiceM=""\n"
-"-----END RSA PRIVATE KEY-----";
+//Azure Baltimore Certificate
+const char root_ca[] PROGMEM =
+"-----BEGIN CERTIFICATE-----\r\n"
+"MIIDdzCCAl+gAwIBAgIEAgAAuTANBgkqhkiG9w0BAQUFADBaMQswCQYDVQQGEwJJ\r\n"
+"RTESMBAGA1UEChMJQmFsdGltb3JlMRMwEQYDVQQLEwpDeWJlclRydXN0MSIwIAYD\r\n"
+"VQQDExlCYWx0aW1vcmUgQ3liZXJUcnVzdCBSb290MB4XDTAwMDUxMjE4NDYwMFoX\r\n"
+"DTI1MDUxMjIzNTkwMFowWjELMAkGA1UEBhMCSUUxEjAQBgNVBAoTCUJhbHRpbW9y\r\n"
+"ZTETMBEGA1UECxMKQ3liZXJUcnVzdDEiMCAGA1UEAxMZQmFsdGltb3JlIEN5YmVy\r\n"
+"VHJ1c3QgUm9vdDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKMEuyKr\r\n"
+"mD1X6CZymrV51Cni4eiVgLGw41uOKymaZN+hXe2wCQVt2yguzmKiYv60iNoS6zjr\r\n"
+"IZ3AQSsBUnuId9Mcj8e6uYi1agnnc+gRQKfRzMpijS3ljwumUNKoUMMo6vWrJYeK\r\n"
+"mpYcqWe4PwzV9/lSEy/CG9VwcPCPwBLKBsua4dnKM3p31vjsufFoREJIE9LAwqSu\r\n"
+"XmD+tqYF/LTdB1kC1FkYmGP1pWPgkAx9XbIGevOF6uvUA65ehD5f/xXtabz5OTZy\r\n"
+"dc93Uk3zyZAsuT3lySNTPx8kmCFcB5kpvcY67Oduhjprl3RjM71oGDHweI12v/ye\r\n"
+"jl0qhqdNkNwnGjkCAwEAAaNFMEMwHQYDVR0OBBYEFOWdWTCCR1jMrPoIVDaGezq1\r\n"
+"BE3wMBIGA1UdEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgEGMA0GCSqGSIb3\r\n"
+"DQEBBQUAA4IBAQCFDF2O5G9RaEIFoN27TyclhAO992T9Ldcw46QQF+vaKSm2eT92\r\n"
+"9hkTI7gQCvlYpNRhcL0EYWoSihfVCr3FvDB81ukMJY2GQE/szKN+OMY3EU/t3Wgx\r\n"
+"jkzSswF07r51XgdIGn9w/xZchMB5hbgF/X++ZRGjD8ACtPhSNzkE1akxehi/oCr0\r\n"
+"Epn3o0WC4zxe9Z2etciefC7IpJ5OCBRLbf1wbWsaY71k5h+3zvDyny67G7fyUIhz\r\n"
+"ksLi4xaNmjICq44Y3ekQEe5+NauQrz4wlHrQMz2nZQ/1/I6eYs9HRCwBXbsdtTLS\r\n"
+"R9I4LtD+gdwyah617jzV/OeBHRnDJELqYzmp\r\n"
+"-----END CERTIFICATE-----\r\n";
+
+
+
+//Client Certificate (from Azure Iot Hub Device) - Get your own
+const char client_cert_pem_start[] =
+"-----BEGIN CERTIFICATE-----""\n"
+"MIIFfDCCA2SgAwIBAgIBAzANBgkqhkiG9w0BAQsFADAqMSgwJgYDVQQDDB9BenVy""\n"
+...
+"+sDPud5VrLd8jOWCAKcuZA==""\n"
+"-----END CERTIFICATE-----";
+
+//Client Key (from Azure Iot Hub Device) - Get your own
+const char client_key_pem_start[] =
+"-----BEGIN RSA PRIVATE KEY-----""\n"
+"MIIJKAIBAAKCAgEAwUG+ZPQp4ZRlvI7xPQYDHkLs5dTX0LTB0tUr3O7LSwc4PPf3""\n"
+...
+"63IPOMRIsakwx3hdRv9gh30bh6LVS6pn9UyHM65pNVsCu4OHB/B4dSiiceM=""\n"
+"-----END RSA PRIVATE KEY-----";