Update lib - User can choose if calc MD5 from encrypted or decrypted file (espressif#10510)

zinkett · lucasssvaz · pre-commit-ci-lite[bot] · web-flow · commit 330beb40a501 · 2024-10-24T14:31:54.000+03:00
* User can choose if calc MD5 from decrypted file

At the present moment, if user want use OTA, the function calculate MD5 of the decrypted file, but if file is encrypted from source, could be more useful to know the MD5 of the encrypted file.

* md5

* Update Updater.cpp

* Update libraries/Update/src/Update.h

Co-authored-by: Lucas Saavedra Vaz &lt;32426024+lucasssvaz@users.noreply.github.com&gt;

* Update libraries/Update/src/Update.h

Co-authored-by: Lucas Saavedra Vaz &lt;32426024+lucasssvaz@users.noreply.github.com&gt;

* Update libraries/Update/src/Updater.cpp

Co-authored-by: Lucas Saavedra Vaz &lt;32426024+lucasssvaz@users.noreply.github.com&gt;

* Update libraries/Update/src/Updater.cpp

Co-authored-by: Lucas Saavedra Vaz &lt;32426024+lucasssvaz@users.noreply.github.com&gt;

* ci(pre-commit): Apply automatic fixes

---------

Co-authored-by: Lucas Saavedra Vaz &lt;32426024+lucasssvaz@users.noreply.github.com&gt;
Co-authored-by: pre-commit-ci-lite[bot] &lt;117423508+pre-commit-ci-lite[bot]@users.noreply.github.com&gt;
diff --git a/libraries/Update/src/Update.h b/libraries/Update/src/Update.h
@@ -137,8 +137,9 @@ class UpdateClass {
 
   /*
       sets the expected MD5 for the firmware (hexString)
+      If calc_post_decryption is true, the update library will calculate the MD5 after the decryption, if false the calculation occurs before the decryption
     */
-  bool setMD5(const char *expected_md5);
+  bool setMD5(const char *expected_md5, bool calc_post_decryption = true);
 
   /*
       returns the MD5 String of the successfully ended firmware
@@ -257,6 +258,7 @@ class UpdateClass {
   const esp_partition_t *_partition;
 
   String _target_md5;
+  bool _target_md5_decrypted = true;
   MD5Builder _md5;
 
   int _ledPin;
diff --git a/libraries/Update/src/Updater.cpp b/libraries/Update/src/Updater.cpp
@@ -348,6 +348,11 @@ bool UpdateClass::_writeBuffer() {
       log_d("Decrypting OTA Image");
     }
   }
+
+  if (!_target_md5_decrypted) {
+    _md5.add(_buffer, _bufferLen);
+  }
+
   //check if data in buffer needs decrypting
   if (_cryptMode & U_AES_IMAGE_DECRYPTING_BIT) {
     if (!_decryptBuffer()) {
@@ -404,7 +409,9 @@ bool UpdateClass::_writeBuffer() {
   if (!_progress && _command == U_FLASH) {
     _buffer[0] = ESP_IMAGE_HEADER_MAGIC;
   }
-  _md5.add(_buffer, _bufferLen);
+  if (_target_md5_decrypted) {
+    _md5.add(_buffer, _bufferLen);
+  }
   _progress += _bufferLen;
   _bufferLen = 0;
   if (_progress_callback) {
@@ -446,12 +453,13 @@ bool UpdateClass::_verifyEnd() {
   return false;
 }
 
-bool UpdateClass::setMD5(const char *expected_md5) {
+bool UpdateClass::setMD5(const char *expected_md5, bool calc_post_decryption) {
   if (strlen(expected_md5) != 32) {
     return false;
   }
   _target_md5 = expected_md5;
   _target_md5.toLowerCase();
+  _target_md5_decrypted = calc_post_decryption;
   return true;
 }
 

Original file line number	Diff line number	Diff line change
`@@ -348,6 +348,11 @@ bool UpdateClass::_writeBuffer() {`
`348`	`348`	`log_d("Decrypting OTA Image");`
`349`	`349`	`}`
`350`	`350`	`}`
	`351`	`+`
	`352`	`+ if (!_target_md5_decrypted) {`
	`353`	`+ _md5.add(_buffer, _bufferLen);`
	`354`	`+ }`
	`355`	`+`
`351`	`356`	`//check if data in buffer needs decrypting`
`352`	`357`	`if (_cryptMode & U_AES_IMAGE_DECRYPTING_BIT) {`
`353`	`358`	`if (!_decryptBuffer()) {`
`@@ -404,7 +409,9 @@ bool UpdateClass::_writeBuffer() {`
`404`	`409`	`if (!_progress && _command == U_FLASH) {`
`405`	`410`	`_buffer[0] = ESP_IMAGE_HEADER_MAGIC;`
`406`	`411`	`}`
`407`		`- _md5.add(_buffer, _bufferLen);`
	`412`	`+ if (_target_md5_decrypted) {`
	`413`	`+ _md5.add(_buffer, _bufferLen);`
	`414`	`+ }`
`408`	`415`	`_progress += _bufferLen;`
`409`	`416`	`_bufferLen = 0;`
`410`	`417`	`if (_progress_callback) {`
`@@ -446,12 +453,13 @@ bool UpdateClass::_verifyEnd() {`
`446`	`453`	`return false;`
`447`	`454`	`}`
`448`	`455`
`449`		`-bool UpdateClass::setMD5(const char *expected_md5) {`
	`456`	`+bool UpdateClass::setMD5(const char *expected_md5, bool calc_post_decryption) {`
`450`	`457`	`if (strlen(expected_md5) != 32) {`
`451`	`458`	`return false;`
`452`	`459`	`}`
`453`	`460`	`_target_md5 = expected_md5;`
`454`	`461`	`_target_md5.toLowerCase();`
	`462`	`+ _target_md5_decrypted = calc_post_decryption;`
`455`	`463`	`return true;`
`456`	`464`	`}`
`457`	`465`