tests: Add new, data-driven OTA tests

Rather than writing one test class with associated method for each
OTA algorithm / test, let's do this in a data-driven way, where new
test cases just have to provide test data, while the code iterates over
it.

Change-Id: I8789a21fa5a4793bdabd468adc9fee3b6e633c25

1 files changed, 137 insertions, 0 deletions

diff --git a/tests/test_ota.py b/tests/test_ota.py
index c58a69d..7de5cff 100644
--- a/tests/test_ota.py
+++ b/tests/test_ota.py
@@ -2,6 +2,7 @@
 
 import unittest
 from pySim.utils import h2b, b2h
+from pySim.sms import SMS_SUBMIT, SMS_DELIVER, AddressField
 from pySim.ota import *
 
 # pre-defined SPI values for use in test cases below
@@ -35,6 +36,9 @@ SPI_CC_POR_UNCIPHERED_NOCC = {
     'por': 'por_required'
 }
 
+######################################################################
+# old-style code-driven test (lots of code copy+paste)
+######################################################################
 
 class Test_SMS_AES128(unittest.TestCase):
     tar = h2b('B00011')
@@ -146,3 +150,136 @@ class Test_SMS_3DES(unittest.TestCase):
         spi['rc_cc_ds'] = 'no_rc_cc_ds'
         r = self.dialect.encode_cmd(self.od, self.tar, spi, h2b('00a40000023f00'))
         self.assertEqual(b2h(r), '0d00193535b0000000000000000000a40000023f00')
+
+
+
+######################################################################
+# new-style data-driven tests
+######################################################################
+
+# SJA5 SAMPLE cards provisioned by execute_ipr.py
+OTA_KEYSET_SJA5_SAMPLES = OtaKeyset(algo_crypt='triple_des_cbc2', kic_idx=3,
+                                    algo_auth='triple_des_cbc2', kid_idx=3,
+                                    kic=h2b('300102030405060708090a0b0c0d0e0f'),
+                                    kid=h2b('301102030405060708090a0b0c0d0e0f'))
+
+OTA_KEYSET_SJA5_AES128 = OtaKeyset(algo_crypt='aes_cbc', kic_idx=2,
+                                   algo_auth='aes_cmac', kid_idx=2,
+                                   kic=h2b('200102030405060708090a0b0c0d0e0f'),
+                                   kid=h2b('201102030405060708090a0b0c0d0e0f'))
+
+class OtaTestCase(unittest.TestCase):
+    def __init__(self, methodName='runTest', **kwargs):
+        super().__init__(methodName, **kwargs)
+        # RAM: B00000
+        # SIM RFM: B00010
+        # USIM RFM: B00011
+        self.tar = h2b('B00011')
+
+class SmsOtaTestCase(OtaTestCase):
+    # Array describing the input/output data for the tests.  We use the
+    # unittest subTests context manager to iterate over the entries of
+    # this testdatasets list.  This is much more productive than
+    # manually writing one class per test.
+    testdatasets = [
+        {
+            'name': '3DES-SJA5-CIPHERED-CC',
+            'ota_keyset': OTA_KEYSET_SJA5_SAMPLES,
+            'spi': SPI_CC_POR_CIPHERED_CC,
+            'request': {
+                'apdu': b'\x00\xa4\x00\x04\x02\x3f\x00',
+                'encoded_cmd': '00201506193535b00011ae733256918d050b87c94fbfe12e4dc402f262c41cf67f2f',
+                'encoded_tpdu': '400881214365877ff6227052000000000302700000201506193535b00011ae733256918d050b87c94fbfe12e4dc402f262c41cf67f2f',
+                },
+            'response': {
+                'encoded_resp': '027100001c12b000118bb989492c632529326a2f4681feb37c825bc9021c9f6d0b',
+                'response_status': 'por_ok',
+                'number_of_commands': 1,
+                'last_status_word': '6132',
+                'last_response_data': '',
+                }
+        }, {
+            'name': '3DES-SJA5-UNCIPHERED-CC',
+            'ota_keyset': OTA_KEYSET_SJA5_SAMPLES,
+            'spi': SPI_CC_POR_UNCIPHERED_CC,
+            'request': {
+                'apdu': b'\x00\xa4\x00\x04\x02\x3f\x00',
+                'encoded_cmd': '00201506093535b00011c49ac91ab8159ba5b83a54fb6385e0a5e31694f8b215fafc',
+                'encoded_tpdu': '400881214365877ff6227052000000000302700000201506093535b00011c49ac91ab8159ba5b83a54fb6385e0a5e31694f8b215fafc',
+                },
+            'response': {
+                'encoded_resp': '027100001612b0001100000000000000b5bcd6353a421fae016132',
+                'response_status': 'por_ok',
+                'number_of_commands': 1,
+                'last_status_word': '6132',
+                'last_response_data': '',
+                }
+        }, {
+            'name': '3DES-SJA5-UNCIPHERED-NOCC',
+            'ota_keyset': OTA_KEYSET_SJA5_SAMPLES,
+            'spi': SPI_CC_POR_UNCIPHERED_NOCC,
+            'request': {
+                'apdu': b'\x00\xa4\x00\x04\x02\x3f\x00',
+                'encoded_cmd': '00201506013535b000113190be334900f52b025f3f7eddfe868e96ebf310023b7769',
+                'encoded_tpdu': '400881214365877ff6227052000000000302700000201506013535b000113190be334900f52b025f3f7eddfe868e96ebf310023b7769',
+                },
+            'response': {
+                'encoded_resp': '027100000e0ab0001100000000000000016132',
+                'response_status': 'por_ok',
+                'number_of_commands': 1,
+                'last_status_word': '6132',
+                'last_response_data': '',
+                }
+        }, {
+            'name': 'AES128-SJA5-CIPHERED-CC',
+            'ota_keyset': OTA_KEYSET_SJA5_AES128,
+            'spi': SPI_CC_POR_CIPHERED_CC,
+            'request': {
+                'apdu': b'\x00\xa4\x00\x04\x02\x3f\x00',
+                'encoded_cmd': '00281506192222b00011e87cceebb2d93083011ce294f93fc4d8de80da1abae8c37ca3e72ec4432e5058',
+                'encoded_tpdu': '400881214365877ff6227052000000000302700000281506192222b00011e87cceebb2d93083011ce294f93fc4d8de80da1abae8c37ca3e72ec4432e5058',
+                },
+            'response': {
+                'encoded_resp': '027100002412b00011ebc6b497e2cad7aedf36ace0e3a29b38853f0fe9ccde81913be5702b73abce1f',
+                'response_status': 'por_ok',
+                'number_of_commands': 1,
+                'last_status_word': '6132',
+                'last_response_data': '',
+                }
+        },
+        # TODO: AES192
+        # TODO: AES256
+    ]
+
+    def __init__(self, methodName='runTest', **kwargs):
+        super().__init__(methodName, **kwargs)
+        self.dialect = OtaDialectSms()
+        self.da = AddressField('12345678', 'unknown', 'isdn_e164')
+
+    def test_encode_cmd(self):
+        for t in SmsOtaTestCase.testdatasets:
+            with self.subTest(name=t['name']):
+                kset = t['ota_keyset']
+                outp = self.dialect.encode_cmd(kset, self.tar, t['spi'], apdu=t['request']['apdu'])
+                #print("result: %s" % b2h(outp))
+                self.assertEqual(b2h(outp), t['request']['encoded_cmd'])
+
+                with_udh = b'\x02\x70\x00' + outp
+                #print("with_udh: %s" % b2h(with_udh))
+
+                tpdu = SMS_DELIVER(tp_udhi=True, tp_oa=self.da, tp_pid=0x7F, tp_dcs=0xF6,
+                                   tp_scts=h2b('22705200000000'), tp_udl=3, tp_ud=with_udh)
+                #print("TPDU: %s" % tpdu)
+                #print("tpdu: %s" % b2h(tpdu.toBytes()))
+                self.assertEqual(b2h(tpdu.toBytes()), t['request']['encoded_tpdu'])
+
+    def test_decode_resp(self):
+        for t in SmsOtaTestCase.testdatasets:
+            with self.subTest(name=t['name']):
+                kset = t['ota_keyset']
+                r, d = self.dialect.decode_resp(kset, t['spi'], t['response']['encoded_resp'])
+                #print("RESP: %s / %s" % (r, d))
+                self.assertEqual(r.response_status, t['response']['response_status'])
+                self.assertEqual(d.number_of_commands, t['response']['number_of_commands'])
+                self.assertEqual(d.last_status_word, t['response']['last_status_word'])
+                self.assertEqual(d.last_response_data, t['response']['last_response_data'])