Make magic number configurable

arduino-libraries · Nov 22, 2023 · 8c724b1 · 8c724b1
1 parent 57b32e4
commit 8c724b1
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 4 deletions.
diff --git a/src/Arduino_ESP32_OTA.cpp b/src/Arduino_ESP32_OTA.cpp
@@ -37,6 +37,7 @@ Arduino_ESP32_OTA::Arduino_ESP32_OTA()
 ,_crc32(0)
 ,_ca_cert{amazon_root_ca}
 ,_ca_cert_bundle{nullptr}
+,_magic(0)
 {
 
 }
@@ -45,14 +46,17 @@ Arduino_ESP32_OTA::Arduino_ESP32_OTA()
    PUBLIC MEMBER FUNCTIONS
  ******************************************************************************/
 
-Arduino_ESP32_OTA::Error Arduino_ESP32_OTA::begin()
+Arduino_ESP32_OTA::Error Arduino_ESP32_OTA::begin(uint32_t magic)
 {
   /* initialize private variables */
   otaInit();
 
   /* ... initialize CRC ... */
   crc32Init();
 
+  /* ... configure board Magic number */
+  setMagic(magic);
+
   if(!isCapable()) {
     DEBUG_ERROR("%s: board is not capable to perform OTA", __FUNCTION__);
     return Error::NoOtaStorage;
@@ -84,6 +88,11 @@ void Arduino_ESP32_OTA::setCACertBundle (const uint8_t * bundle)
   }
 }
 
+void Arduino_ESP32_OTA::setMagic(uint32_t magic)
+{
+  _magic = magic;
+}
+
 uint8_t Arduino_ESP32_OTA::read_byte_from_network()
 {
   bool is_http_data_timeout = false;
@@ -239,7 +248,7 @@ int Arduino_ESP32_OTA::download(const char * ota_url)
   }
 
   /* ... and OTA magic number */
-  if (_ota_header.header.magic_number != ARDUINO_ESP32_OTA_MAGIC)
+  if (_ota_header.header.magic_number != _magic)
   {
     delete _client;
     _client = nullptr;

diff --git a/src/Arduino_ESP32_OTA.h b/src/Arduino_ESP32_OTA.h
@@ -72,8 +72,9 @@ class Arduino_ESP32_OTA
            Arduino_ESP32_OTA();
   virtual ~Arduino_ESP32_OTA() { }
 
-  Arduino_ESP32_OTA::Error begin();
-  void setCACert (const char *rootCA);
+  Arduino_ESP32_OTA::Error begin(uint32_t magic = ARDUINO_ESP32_OTA_MAGIC);
+  void setMagic(uint32_t magic);
+  void setCACert(const char *rootCA);
   void setCACertBundle(const uint8_t * bundle);
   int download(const char * ota_url);
   uint8_t read_byte_from_network();
@@ -97,6 +98,8 @@ class Arduino_ESP32_OTA
   uint32_t _crc32;
   const char * _ca_cert;
   const uint8_t * _ca_cert_bundle;
+  uint32_t _magic;
+
 };
 
 #endif /* ARDUINO_ESP32_OTA_H_ */