Merge branch 'develop' into gpg_secp256k1

Author: odudex

firmware/MaixPy

@@ -57,6 +57,7 @@ def print_test(self):
     def test_suite(self, interactive=False):
         """run each on-device tests in all_tests, report summary and details"""
         all_tests = [
+            self.multi_layer_decrypt,
             self.hw_acc_hashing,
             self.deflate_compression,
             self.touch_gestures,
@@ -202,6 +203,62 @@ def run_one_test(self, test):
     # * return something True on success
     # * return False/empty/None/Exception on failure
 
+    def multi_layer_decrypt(self, interactive=False):
+        """
+        Decrypts a matryoshka of all kef versions built w/ Crypto.Cipher --
+        outside-of MaixyPy's ucryptolib on k210 devices.
+        Runs as very first test because it's suspected that an uninitialized
+        hasher (in uhashlib_hw.pbkdf2_hmac_sha256()) can cause problems when
+        booted from ktool (until something is hashed), as opposed to booting
+        from flash where both bootloaders and firmware are hashed during Kboot.
+        """
+        from binascii import hexlify
+        from krux import kef
+
+        results = []
+        err = ""
+        expected_plain = b"\xde\xad\xbe\xef"
+        kef_envelope = (
+            b"\x00\x15\x00\x00\x01OR\xa1\x93l>2q \x9e\x9ddZt\xe3e\xfa\x93`"
+            b"\x97 \xa4\xf5)\xddp~I[\xd0\xb7*\xe8\xe4s\xed\x06ca\x9c'5\x0eb"
+            b"\xd8\x82\xc28\xeelP~&\x0b\xf8\x98\xea*S\xf00\xed7EFk\xa6a\xce"
+            b"\x80~`\xaeAK\nT\xcd6d\x0c\x16\x88\xb4R\xfe\xe2\xfc#5\xf8\x8f5"
+            b".\x0c\xfa\xa2iN\x02W\x16\xce\x88\x88\x99)\xc8=\xe11\x0ey\xe6"
+            b"\xa1\xcb3&\xac\x01\xb0\xb8\xd5#\xce\xa6\xfd-k(+\x97\xe6\x07\x02"
+            b'\x8d\\\xdc51<\xe3K_\xba\x0b\xf5]"O6\x03\xe3\x9aV\xec=\xda\xfa'
+            b"\xec.;@CmPc\x01\x9a\x1eG\xde\xd2\x13\xcc\n\x0e\xf4\x80/\xea\xec"
+            b"\xf0\x05q\xe0\x0c\x01\xfeK\xc5v\xc9|A\x0eM.\xd95\x7f\x16\xc8/%"
+            b"\xbb\x1aX\xecoi\x9e\x92bd\xf7\x90\xc2I\xa6\x13\xc1j\xa5\xee\xc0"
+            b"\x7f/c\xc8yOp\x8d&\x17\xfe\xd5*Q\x12s\xd3\x8d/\x9dhjG\xc6{G\xee"
+            b"\xef\x07H\x86\xeat\x1e\xb5\xa6\xb1\x94\x80\x83\x15\x98<0i\xb5"
+            b"\xb5\x8eQ~\x0b\x84\x97\xc1H\x0e\xbf\x9c\x83\x98\xc9\xb8\xe4i"
+            b"\xab\x8fx\xa8*\xb2z\x85\x97W\xd5\xd67\xe0\x9c\xec,\x02\xed\x1b"
+            b"(\xec\x1d\x0c6\xb7\x95\xcf"
+        )
+        while True:
+            try:
+                id_, version, iterations, cipherpayload = kef.unwrap(kef_envelope)
+                results.append(kef.VERSIONS[version]["name"])
+            except:
+                break
+            decryptor = kef.Cipher(b"abc", id_, iterations)
+            kef_envelope = decryptor.decrypt(cipherpayload, version)
+            if kef_envelope is None:
+                err += "FAILED {}\n".format(kef.VERSIONS[version]["name"])
+                break
+
+        if kef_envelope != expected_plain:
+            err += "unexpected plain text: {}".format(kef_envelope)
+
+        if err:
+            raise AssertionError(err)
+
+        results.append(
+            "expected plaintext revealed: 0x{}".format(hexlify(kef_envelope).decode())
+        )
+
+        return results
+
     def hw_acc_hashing(self, interactive=False):
         """
         churns nonce through sha256() and pbkdf_hmac(sha256,) calls,

src/krux/pages/device_tests.py

@@ -14,6 +14,15 @@ def mocked_run_one_test(mocker):
     return mocker.patch("krux.pages.device_tests.DeviceTests.run_one_test")
 
 
+@pytest.fixture
+def mock_multi_layer_decrypt(mocker):
+    """Fixture to mock multi_layer_decrypt failing"""
+
+    return mocker.patch(
+        "krux.kef.Cipher.decrypt", side_effect=lambda cpl, version: None
+    )
+
+
 @pytest.fixture
 def mock_hw_acc_hashing(mocker):
     """Fixture to mock the hardware acceleration hashing test to fail"""
@@ -165,6 +174,37 @@ def test_skip_all_tests(m5stickv, mocker, mocked_print_qr, mocked_run_one_test):
     assert ctx.input.wait_for_button.call_count == len(BTN_SEQUENCE)
 
 
+def test_fail_multi_layer_decrypt(m5stickv, mocker, mock_multi_layer_decrypt):
+    """Directly test multi_layer_decrypt() hitting the except block"""
+    from krux.pages.device_tests import DeviceTests
+    from krux.input import BUTTON_ENTER, BUTTON_PAGE_PREV
+
+    BTN_SEQUENCE = (
+        BUTTON_PAGE_PREV,  # select back
+        BUTTON_ENTER,  # go back
+    )
+
+    ctx = create_ctx(mocker, BTN_SEQUENCE)
+    page = DeviceTests(ctx)
+    page.test_suite()
+
+    # assert that kef.Cipher.decrypt was called
+    decrypt = mock_multi_layer_decrypt
+    assert decrypt.call_count > 0
+
+    # assert that the test suite results are displayed correctly
+    # and that the on-device-test failed
+    page.ctx.display.draw_hcentered_text.assert_has_calls(
+        [
+            mocker.call(
+                "Test Suite Results\nsuccess rate: 75%\nfailed: 1/4", info_box=True
+            )
+        ]
+    )
+
+    assert ctx.input.wait_for_button.call_count == len(BTN_SEQUENCE)
+
+
 def test_fail_hw_acc_hashing(m5stickv, mocker, mock_hw_acc_hashing):
     """Directly test hw_acc_hashing() hmac hitting the except block"""
     from krux.pages.device_tests import DeviceTests
@@ -189,7 +229,7 @@ def test_fail_hw_acc_hashing(m5stickv, mocker, mock_hw_acc_hashing):
     page.ctx.display.draw_hcentered_text.assert_has_calls(
         [
             mocker.call(
-                "Test Suite Results\nsuccess rate: 66%\nfailed: 1/3", info_box=True
+                "Test Suite Results\nsuccess rate: 50%\nfailed: 2/4", info_box=True
             )
         ]
     )
@@ -223,7 +263,7 @@ def test_fail_sha256(m5stickv, mocker, mock_hashlib_sha256):
     page.ctx.display.draw_hcentered_text.assert_has_calls(
         [
             mocker.call(
-                "Test Suite Results\nsuccess rate: 66%\nfailed: 1/3", info_box=True
+                "Test Suite Results\nsuccess rate: 75%\nfailed: 1/4", info_box=True
             )
         ]
     )
@@ -259,7 +299,7 @@ def test_fail_hexilify(m5stickv, mocker, mock_hexlify_endianess):
     page.ctx.display.draw_hcentered_text.assert_has_calls(
         [
             mocker.call(
-                "Test Suite Results\nsuccess rate: 66%\nfailed: 1/3", info_box=True
+                "Test Suite Results\nsuccess rate: 75%\nfailed: 1/4", info_box=True
             )
         ]
     )
@@ -295,7 +335,7 @@ def test_fail_b2a_base64(m5stickv, mocker, mock_b2a_base64_endianess):
     page.ctx.display.draw_hcentered_text.assert_has_calls(
         [
             mocker.call(
-                "Test Suite Results\nsuccess rate: 66%\nfailed: 1/3", info_box=True
+                "Test Suite Results\nsuccess rate: 75%\nfailed: 1/4", info_box=True
             )
         ]
     )
@@ -340,7 +380,7 @@ def test_fail_deflate_compression(m5stickv, mocker, mock_deflate):
     page.ctx.display.draw_hcentered_text.assert_has_calls(
         [
             mocker.call(
-                "Test Suite Results\nsuccess rate: 66%\nfailed: 1/3", info_box=True
+                "Test Suite Results\nsuccess rate: 75%\nfailed: 1/4", info_box=True
             )
         ]
     )
@@ -371,7 +411,7 @@ def test_fail_maixpy_code(m5stickv, mocker, mock_maixpy_code):
     page.ctx.display.draw_hcentered_text.assert_has_calls(
         [
             mocker.call(
-                "Test Suite Results\nsuccess rate: 66%\nfailed: 1/3", info_box=True
+                "Test Suite Results\nsuccess rate: 75%\nfailed: 1/4", info_box=True
             )
         ]
     )
@@ -402,7 +442,7 @@ def test_fail_zlib_code(m5stickv, mocker, mock_zlib_code):
     page.ctx.display.draw_hcentered_text.assert_has_calls(
         [
             mocker.call(
-                "Test Suite Results\nsuccess rate: 66%\nfailed: 1/3", info_box=True
+                "Test Suite Results\nsuccess rate: 75%\nfailed: 1/4", info_box=True
             )
         ]
     )
@@ -476,6 +516,27 @@ def test_run_intreactively(m5stickv, mocker):
     assert ctx.input.wait_for_button.call_count == len(BTN_SEQUENCE)
 
 
+def test_run_one_test_multi_layer_decrypt(m5stickv, mocker):
+    from krux.pages.device_tests import DeviceTests
+    from krux.input import BUTTON_ENTER, BUTTON_PAGE_PREV
+
+    BTN_SEQUENCE = (
+        BUTTON_ENTER,  # hit enter to proceed
+        BUTTON_PAGE_PREV,  #
+        BUTTON_ENTER,  # go back
+    )
+
+    ctx = create_ctx(mocker, BTN_SEQUENCE)
+    page = DeviceTests(ctx)
+
+    # since bypassing test-suite, fake existing results
+    page.results = [(page.multi_layer_decrypt, False)]
+    page.run_one_test(page.multi_layer_decrypt)
+    assert page.results == [(page.multi_layer_decrypt, True)]
+
+    assert ctx.input.wait_for_button.call_count == len(BTN_SEQUENCE)
+
+
 def test_run_one_test_test_hw_acc_hashing(m5stickv, mocker):
     from krux.pages.device_tests import DeviceTests
     from krux.input import BUTTON_ENTER, BUTTON_PAGE_PREV