Use Mbed TLS as default engine for ESP32 JWT

Author: mobizt

README.md

@@ -2,9 +2,9 @@
 
 ![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/mobizt/FirebaseClient/.github%2Fworkflows%2Fcompile_library.yml?logo=github&label=compile) [![Github Stars](https://img.shields.io/github/stars/mobizt/FirebaseClient?logo=github)](https://github.com/mobizt/FirebaseClient/stargazers) ![Github Issues](https://img.shields.io/github/issues/mobizt/FirebaseClient?logo=github)
 
-![GitHub Release](https://img.shields.io/github/v/release/mobizt/FirebaseClient) ![Arduino](https://img.shields.io/badge/Arduino-v2.1.0-57C207?logo=arduino) ![PlatformIO](https://badges.registry.platformio.org/packages/mobizt/library/FirebaseClient.svg) ![GitHub Release Date](https://img.shields.io/github/release-date/mobizt/FirebaseClient)
+![GitHub Release](https://img.shields.io/github/v/release/mobizt/FirebaseClient) ![Arduino](https://img.shields.io/badge/Arduino-v2.1.1-57C207?logo=arduino) ![PlatformIO](https://badges.registry.platformio.org/packages/mobizt/library/FirebaseClient.svg) ![GitHub Release Date](https://img.shields.io/github/release-date/mobizt/FirebaseClient)
 
-Revision `2025-05-24`
+Revision `2025-05-25`
 
 ## Introduction
 

examples/App/AppInitialization/CustomAuth/CustomAuth.ino

@@ -1,85 +1,11 @@
 /**
- * ABOUT:
- *
  * The bare minimum example for using user authentication with custom UID and claims.
  *
  * This example requires the service account credentials that obtains from the JSON key file.
  *
  * The complete usage guidelines, please read README.md or visit https://github.com/mobizt/FirebaseClient
- *
- * SYNTAX:
- *
- * 1.------------------------
- *
- * CustomAuth::CustomAuth(<api_key>, <client_email>, <project_id>, <private_key>, <user_id>, <scope>, <claims>, <expire>);
- *
- * <api_key> - The web API key of project.
- * <client_email> - The service account client Email.
- * <project_id> - The service account project ID.
- * <private_key> - The service account private key.
- * <user_id> - The unique identifier of the signed-in user must be a string, between 1-128 characters long, inclusive. Shorter uids offer better performance.
- * <claims> - Optional custom claims to include in the Security Rules auth / request.auth variables.
- * <expire> - The expiry period in seconds (less than 3600), 3300 is the default value.
- *
- * 2.------------------------
- *
- * CustomAuth::CustomAuth(<TimeStatusCallback>, <api_key>, <client_email>, <project_id>, <private_key>, <user_id>, <scope>, <claims>, <expire>);
- *
- * <TimeStatusCallback> - The time status callback that provide the UNIX timestamp value used for JWT token signing.
- * <api_key> - The web API key of project.
- * <client_email> - The service account client Email.
- * <project_id> - The service account project ID.
- * <private_key> - The service account private key.
- * <user_id> - The user ID.
- * <scope> - The OAuth scopes.
- * <claims> - The OAuth claims. For more details about claims, please visit https://firebase.google.com/docs/auth/admin/custom-claims.
- * <expire> - The expiry period in seconds (less than 3600), 3300 is the default value.
- *
- * See examples/RealtimeDatabase/AccessControl/AccessControl.ino for how it can work with security rules for database access control.
- *
- * 3.------------------------
- *
- * initializeApp(<AsyncClient>, <FirebaseApp>, <user_auth_data>, <AsyncResultCallback>, <uid>);
- *
- * <AsyncClient> - The async client.
- * <FirebaseApp> - The authentication and access token handler.
- * <user_auth_data> - The user auth data (user_auth_data struct) that holds the user input sign-in credentials and token.
- *
- * The <user_auth_data> can be obtained from the following sign-in credentials, access key, auth token providers classs via getAuth function i.e.
- * CustomAuth, ServiceAuth, UserAuth, NoAuth, CustomToken, AccessToken, IDToken, LegacyToken.
- *
- * <AsyncResultCallback> - The AsyncResultCallback function for debugging.
- * <uid> - Optional The user defined task UID for debugging.
- *
- * 4.------------------------
- *
- * initializeApp(<AsyncClient>, <FirebaseApp>, <user_auth_data>, <timeoutMs>, <AsyncResultCallback>);
- *
- * <AsyncClient> - The async client.
- * <FirebaseApp> - The authentication and access token handler.
- * <user_auth_data> - The user auth data (user_auth_data struct) that holds the user input sign-in credentials and token.
- *
- * The <user_auth_data> can be obtained from the following sign-in credentials, access key, auth token providers classs via getAuth function i.e.
- * CustomAuth, ServiceAuth, UserAuth, NoAuth, CustomToken, AccessToken, IDToken, LegacyToken.
- *
- * <timeoutMs> - Optional. The await timeout in milliseconds.
- * <AsyncResultCallback> - Optional. The async result callback (AsyncResultCallback) for debugging.
- *
- * NOTE:
- *
- * The valid time is required for private key signing process in JWT token generation.
- * In case TimeStatusCallback was not assigned in the CustomAuth class constructor,
- * use FirebaseApp::setTime before calling initializeApp.
- *
- * The timeoutMs is the timeout for waiting the authentication process to be done.
- *
- * By providing AsyncResultCallback in the initializeApp function, the debug information will be collected and send to AsyncResultCallback
- * function immediately.
  */
 
-
-// To define build options in your sketch,
-// adding the following macros before FirebaseClient.h
 #define ENABLE_CUSTOM_AUTH
 
 #include <FirebaseClient.h>

examples/App/AppInitialization/CustomAuthFile/CustomAuthFile.ino

@@ -1,85 +1,11 @@
 /**
- * ABOUT:
- *
  * The bare minimum example for using user authentication with custom UID and claims.
  *
  * The service account JSON key file will be used in this example.
  *
  * The complete usage guidelines, please read README.md or visit https://github.com/mobizt/FirebaseClient
- *
- * SYNTAX:
- *
- * 1.------------------------
- *
- * CustomAuth::CustomAuth(<file_config_data>, <api_key>, <user_id>, <scope>, <claims>, <expire>);
- *
- * <file_config_data> -  The filesystem data (file_config_data) obtained from FileConfig class object of service account key file.
- * <api_key> - The web API key of project.
- * <client_email> - The service account client Email.
- * <project_id> - The service account project ID.
- * <private_key> - The service account private key.
- * <user_id> - The unique identifier of the signed-in user must be a string, between 1-128 characters long, inclusive. Shorter uids offer better performance.
- * <claims> - Optional custom claims to include in the Security Rules auth / request.auth variables.
- * <expire> - The expiry period in seconds (less than 3600), 3300 is the default value.
- *
- * 2.------------------------
- *
- * CustomAuth::CustomAuth(<TimeStatusCallback>, <file_config_data>, <api_key>, <user_id>, <scope>, <claims>, <expire>);
- *
- * <TimeStatusCallback> - The time status callback that provide the UNIX timestamp value used for JWT token signing.
- * <file_config_data> -  The filesystem data (file_config_data) obtained from FileConfig class object of service account key file.
- * <api_key> - The web API key of project.
- * <client_email> - The service account client Email.
- * <project_id> - The service account project ID.
- * <private_key> - The service account private key.
- * <user_id> - The unique identifier of the signed-in user must be a string, between 1-128 characters long, inclusive. Shorter uids offer better performance.
- * <claims> - Optional custom claims to include in the Security Rules auth / request.auth variables.
- * <expire> - The expiry period in seconds (less than 3600), 3300 is the default value.
- *
- * See examples/RealtimeDatabase/AccessControl/AccessControl.ino for how it can work with security rules for database access control.
- *
- * 3.------------------------
- *
- * initializeApp(<AsyncClient>, <FirebaseApp>, <user_auth_data>, <AsyncResultCallback>, <uid>);
- *
- * <AsyncClient> - The async client.
- * <FirebaseApp> - The authentication and access token handler.
- * <user_auth_data> - The user auth data (user_auth_data struct) that holds the user input sign-in credentials and token.
- *
- * The <user_auth_data> can be obtained from the following sign-in credentials, access key, auth token providers classs via getAuth function i.e.
- * CustomAuth, ServiceAuth, UserAuth, NoAuth, CustomToken, AccessToken, IDToken, LegacyToken.
- *
- * <AsyncResultCallback> - The AsyncResultCallback function for debugging.
- * <uid> - Optional The user defined task UID for debugging.
- *
- * 4.------------------------
- *
- * initializeApp(<AsyncClient>, <FirebaseApp>, <user_auth_data>, <timeoutMs>, <AsyncResultCallback>);
- *
- * <AsyncClient> - The async client.
- * <FirebaseApp> - The authentication and access token handler.
- * <user_auth_data> - The user auth data (user_auth_data struct) that holds the user input sign-in credentials and token.
- *
- * The <user_auth_data> can be obtained from the following sign-in credentials, access key, auth token providers classs via getAuth function i.e.
- * CustomAuth, ServiceAuth, UserAuth, NoAuth, CustomToken, AccessToken, IDToken, LegacyToken.
- *
- * <timeoutMs> - Optional. The await timeout in milliseconds.
- * <AsyncResultCallback> - Optional. The async result callback (AsyncResultCallback) for debugging.
- *
- * NOTE:
- *
- * The valid time is required for private key signing process in JWT token generation.
- * In case TimeStatusCallback was not assigned in the CustomAuth class constructor,
- * use FirebaseApp::setTime before calling initializeApp.
- *
- * The timeoutMs is the timeout for waiting the authentication process to be done.
- *
- * By providing AsyncResultCallback in the initializeApp function, the debug information will be collected and send to AsyncResultCallback
- * function immediately.
  */
 
-// To define build options in your sketch,
-// adding the following macros before FirebaseClient.h
 #define ENABLE_CUSTOM_AUTH
 #define ENABLE_FS
 

examples/App/AppInitialization/NoAuth/NoAuth.ino

@@ -1,53 +1,10 @@
 /**
- * ABOUT:
- *
  * The bare minimum example for using non-authentication.
  *
  * The read and write conditions in the security rules should be true for all conditions.
  *
  * The complete usage guidelines, please read README.md or visit https://github.com/mobizt/FirebaseClient
  *
- * SYNTAX:
- *
- * 1.------------------------
- *
- * NoAuth::NoAuth();
- *
- * 2.------------------------
- *
- * initializeApp(<AsyncClient>, <FirebaseApp>, <user_auth_data>, <AsyncResultCallback>, <uid>);
- *
- * <AsyncClient> - The async client.
- * <FirebaseApp> - The authentication and access token handler.
- * <user_auth_data> - The user auth data (user_auth_data struct) that holds the user input sign-in credentials and token.
- *
- * The <user_auth_data> can be obtained from the following sign-in credentials, access key, auth token providers classs via getAuth function i.e.
- * CustomAuth, ServiceAuth, UserAuth, NoAuth, CustomToken, AccessToken, IDToken, LegacyToken.
- *
- * <AsyncResultCallback> - The AsyncResultCallback function for debugging.
- * <uid> - Optional The user defined task UID for debugging.
- *
- * 3.------------------------
- *
- * initializeApp(<AsyncClient>, <FirebaseApp>, <user_auth_data>, <timeoutMs>, <AsyncResultCallback>);
- *
- * <AsyncClient> - The async client.
- * <FirebaseApp> - The authentication and access token handler.
- * <user_auth_data> - The user auth data (user_auth_data struct) that holds the user input sign-in credentials and token.
- *
- * The <user_auth_data> can be obtained from the following sign-in credentials, access key, auth token providers classs via getAuth function i.e.
- * CustomAuth, ServiceAuth, UserAuth, NoAuth, CustomToken, AccessToken, IDToken, LegacyToken.
- *
- * <timeoutMs> - Optional. The await timeout in milliseconds.
- * <AsyncResultCallback> - Optional. The async result callback (AsyncResultCallback) for debugging.
- *
- * NOTE:
- *
- * The timeoutMs is the timeout for waiting the authentication process to be done.
- *
- * By providing AsyncResultCallback in the initializeApp function, the debug information will be collected and send to AsyncResultCallback
- * function immediately.
- *
  */
 
 #include <FirebaseClient.h>

examples/App/AppInitialization/ReAuthenticate/ReAuthenticate.ino

@@ -1,27 +1,9 @@
 /**
- * ABOUT:
- *
  * This is example for how to disable the re-authentication and force the authentication processes.
  *
  * The complete usage guidelines, please read README.md or visit https://github.com/mobizt/FirebaseClient
- *
- * SYNTAX:
- *
- * 1.------------------------
- *
- * FirebaseApp::autoRefresh(<enable>);
- *
- * <enable> - Set to true to enable auto-refresh and false for disable auto-refresh.
- *
- * 2.------------------------
- *
- * FirebaseApp::refreshToken();
- *
- * The complete usage guidelines, please visit https://github.com/mobizt/FirebaseClient
  */
 
-// To define build options in your sketch,
-// adding the following macros before FirebaseClient.h
 #define ENABLE_USER_AUTH
 
 #include <FirebaseClient.h>

examples/App/AppInitialization/SaveAndLoad/SaveAndLoad.ino

@@ -1,13 +1,9 @@
 /**
- * ABOUT:
- *
  * The example for storing the authentication credentials to file and loading it for later use.
  *
  * The complete usage guidelines, please read README.md or visit https://github.com/mobizt/FirebaseClient
  */
 
-// To define build options in your sketch,
-// adding the following macros before FirebaseClient.h
 #define ENABLE_USER_AUTH
 #define ENABLE_FS
 

examples/App/AppInitialization/ServiceAuth/ServiceAuth.ino

@@ -1,75 +1,11 @@
 /**
- * ABOUT:
- *
  * The bare minimum example for using Firebase OAuth2.0 authentication.
  *
  * This example requires the service account credentials that obtains from the JSON key file.
  *
  * The complete usage guidelines, please read README.md or visit https://github.com/mobizt/FirebaseClient
- *
- * SYNTAX:
- *
- * 1.------------------------
- *
- * ServiceAuth::ServiceAuth(<client_email>, <project_id>, <private_key>, <expire>);
- *
- * <timestamp> - The current UNiX timestamp (seonds since Jan 1, 1970 midnight).
- * <client_email> - The service account client Email.
- * <project_id> - The service account project ID.
- * <private_key> - The service account private key.
- * <expire> - The expiry period in seconds (less than 3600), 3300 is the default value.
- *
- * 2.------------------------
- *
- * ServiceAuth::ServiceAuth(<TimeStatusCallback>, <client_email>, <project_id>, <private_key>, <expire>);
- *
- * <TimeStatusCallback> - The time status callback that provide the UNIX timestamp value used for JWT token signing.
- * <client_email> - The service account client Email.
- * <project_id> - The service account project ID.
- * <private_key> - The service account private key.
- * <expire> - The expiry period in seconds (less than 3600), 3300 is the default value.
- *
- * 3.------------------------
- *
- * initializeApp(<AsyncClient>, <FirebaseApp>, <user_auth_data>, <AsyncResultCallback>, <uid>);
- *
- * <AsyncClient> - The async client.
- * <FirebaseApp> - The authentication and access token handler.
- * <user_auth_data> - The user auth data (user_auth_data struct) that holds the user input sign-in credentials and token.
- *
- * The <user_auth_data> can be obtained from the following sign-in credentials, access key, auth token providers classs via getAuth function i.e.
- * CustomAuth, ServiceAuth, UserAuth, NoAuth, CustomToken, AccessToken, IDToken, LegacyToken.
- *
- * <AsyncResultCallback> - The AsyncResultCallback function for debugging.
- * <uid> - Optional The user defined task UID for debugging.
- *
- * 4.------------------------
- *
- * initializeApp(<AsyncClient>, <FirebaseApp>, <user_auth_data>, <timeoutMs>, <AsyncResultCallback>);
- *
- * <AsyncClient> - The async client.
- * <FirebaseApp> - The authentication and access token handler.
- * <user_auth_data> - The user auth data (user_auth_data struct) that holds the user input sign-in credentials and token.
- *
- * The <user_auth_data> can be obtained from the following sign-in credentials, access key, auth token providers classs via getAuth function i.e.
- * CustomAuth, ServiceAuth, UserAuth, NoAuth, CustomToken, AccessToken, IDToken, LegacyToken.
- *
- * <timeoutMs> - Optional. The await timeout in milliseconds.
- * <AsyncResultCallback> - Optional. The async result callback (AsyncResultCallback) for debugging.
- *
- * NOTE:
- *
- * The valid time is required for private key signing process in JWT token generation.
- * In case TimeStatusCallback was not assigned in the CustomAuth class constructor,
- * use FirebaseApp::setTime before calling initializeApp.
- *
- * The timeoutMs is the timeout for waiting the authentication process to be done.
- *
- * By providing AsyncResultCallback in the initializeApp function, the debug information will be collected and send to AsyncResultCallback
- * function immediately.
  */
 
-// To define build options in your sketch
 #define ENABLE_SERVICE_AUTH
 
 #include <FirebaseClient.h>