#!/usr/bin/env python3 """Unit tests for the OTA helper functions in pysim_otaman_server.server. Reference vectors are key-free: synthetic dummy keys plus the already-public sysmocom sample-key vectors that ship in pySim's own tests/unittests/test_ota.py. No live/sample card keys and no ICCIDs appear here. """ import sys import unittest from pathlib import Path from unittest import mock # pySim checkout is a sibling of this repo; put it on sys.path so the server # module (which imports pySim at module level) can be exercised against it. PROJECTS = Path(__file__).resolve().parents[2] PY_SIM = PROJECTS / 'pysim' if str(PY_SIM) not in sys.path: sys.path.insert(0, str(PY_SIM)) from pysim_otaman_server.server import ( _build_sms_tpdu, _decode_por, _ota_reference, _spi_from_bytes, ) # Synthetic dummy key material (no real card keys). K = '00112233445566778899AABBCCDDEEFF' # Public sysmocom sample keys from pySim tests/unittests/test_ota.py. KIC3 = 'C21DD66ACAC13CB3BC8B331B24AFB57B' KID3 = '12110C78E678C25408233076AA033615' # Public synthetic AES keys from pySim tests/unittests/test_ota.py. KIC_AES = '200102030405060708090a0b0c0d0e0f' KID_AES = '201102030405060708090a0b0c0d0e0f' APDU = '00a40000023f00' # (spi1, spi2) -> expected secured packet, generated with _ota_reference # against pySim's OtaDialectSms.encode_cmd and cross-checked with the JS genSp(). REFERENCE_VECTORS = { ('06', '09'): '00201506091515b00000c08f58c38860acb3a362fffe670ad13759a2a6b4c1a91116', ('16', '01'): '00201516011515b00000e42573469e68a8462a57a505b0e2b1c09c1928c7a182311f', ('02', '09'): '001d1502091515b0000000000000010085a8ca1a9828b0bb00a40000023f00', } # AES-128 reference vectors (public synthetic keys from pySim test_ota.py). AES_APDU = '00a40004023f00' AES_REFERENCE_VECTORS = { ('16', '19'): '00281516192222b000115a47655527e96e832f1a5c698655715d4331454a0d83952c0ed35245706976b1', ('12', '09'): '001d1512092222b0001100000000110029826122c7a0b79500a40004023f00', ('1e', '19'): '0028151e192222b0001118b202ee47a3203e7370861c383b4142e704157b36e5c0eb4bb33eb6036cbaf8', } class TestSpiFromBytes(unittest.TestCase): def test_06_09_ciphered_cc(self): spi = _spi_from_bytes(0x06, 0x09) self.assertEqual(spi, { 'counter': 'no_counter', 'ciphering': True, 'rc_cc_ds': 'cc', 'por_in_submit': False, 'por_shall_be_ciphered': False, 'por_rc_cc_ds': 'cc', 'por': 'por_required', }) def test_16_01_counter_must_be_higher(self): spi = _spi_from_bytes(0x16, 0x01) self.assertEqual(spi['counter'], 'counter_must_be_higher') self.assertTrue(spi['ciphering']) self.assertEqual(spi['rc_cc_ds'], 'cc') self.assertEqual(spi['por_rc_cc_ds'], 'no_rc_cc_ds') def test_02_09_unciphered_cc(self): spi = _spi_from_bytes(0x02, 0x09) self.assertFalse(spi['ciphering']) self.assertEqual(spi['rc_cc_ds'], 'cc') self.assertEqual(spi['por_rc_cc_ds'], 'cc') def test_04_19_ciphered_no_cc(self): spi = _spi_from_bytes(0x04, 0x19) self.assertTrue(spi['ciphering']) self.assertEqual(spi['rc_cc_ds'], 'no_rc_cc_ds') self.assertTrue(spi['por_shall_be_ciphered']) self.assertEqual(spi['por_rc_cc_ds'], 'cc') class TestBuildSmsTpdu(unittest.TestCase): CHUNK = '00201506091515b00000c08f58c38860acb3a362fffe670ad13759a2a6b4c1a91116' SCTS = bytes.fromhex('24051215173000') def _build(self, *args, **kwargs): with mock.patch('pysim_otaman_server.server._encode_scts', return_value=self.SCTS): return _build_sms_tpdu(*args, **kwargs) def test_single_message_with_cpi(self): self.assertEqual( self._build(self.CHUNK, include_cpi=True), '4005812143f57ff6240512151730002502700000201506091515b00000' 'c08f58c38860acb3a362fffe670ad13759a2a6b4c1a91116') def test_single_message_without_cpi(self): self.assertEqual( self._build(self.CHUNK, include_cpi=False), '0405812143f57ff6240512151730002200201506091515b00000' 'c08f58c38860acb3a362fffe670ad13759a2a6b4c1a91116') def test_first_chunk_has_cpi(self): self.assertEqual( self._build(self.CHUNK, chunk_total=3, chunk_num=1, include_cpi=True), '4405812143f57ff6240512151730002a070003010301700000201506091515b00000' 'c08f58c38860acb3a362fffe670ad13759a2a6b4c1a91116') def test_later_chunk_concat_only(self): self.assertEqual( self._build(self.CHUNK, chunk_total=3, chunk_num=2, include_cpi=True), '4405812143f57ff6240512151730002805000301030200201506091515b00000' 'c08f58c38860acb3a362fffe670ad13759a2a6b4c1a91116') class TestOtaReference(unittest.TestCase): def test_ciphered_spi_06_09(self): out, _ = _ota_reference('06', '09', '15', '15', 'b00000', '0000000001', APDU, K, K) self.assertEqual(out, REFERENCE_VECTORS[('06', '09')]) def test_ciphered_spi_16_01(self): out, _ = _ota_reference('16', '01', '15', '15', 'b00000', '0000000001', APDU, K, K) self.assertEqual(out, REFERENCE_VECTORS[('16', '01')]) def test_unciphered_spi_02_09(self): out, _ = _ota_reference('02', '09', '15', '15', 'b00000', '0000000001', APDU, K, K) self.assertEqual(out, REFERENCE_VECTORS[('02', '09')]) def test_unciphered_cpl_is_0x001d(self): # Regression: CPL counts octets from the CHL octet to the last octet # of the secured data (29 here), it must NOT be len(out)-2 (27/0x001b). out, _ = _ota_reference('02', '09', '15', '15', 'b00000', '0000000001', APDU, K, K) self.assertEqual(out[:4], '001d') self.assertEqual(len(out) // 2, 31) def test_sysmocom_reference_vector(self): # Public vector from pySim tests/unittests/test_ota.py (test_cmd_3des_ciphered). out, _ = _ota_reference('04', '19', '35', '35', 'b00000', '0000000000', APDU, KIC3, KID3) self.assertEqual(out, '00180d04193535b00000e3ec80a849b554421276af3883927c20') def test_returns_spi_dict(self): _, spi = _ota_reference('16', '01', '15', '15', 'b00000', '0000000001', APDU, K, K) self.assertEqual(spi['counter'], 'counter_must_be_higher') self.assertTrue(spi['ciphering']) def test_aes128_ciphered_cc(self): out, _ = _ota_reference('16', '19', '22', '22', 'b00011', '0000000011', AES_APDU, KIC_AES, KID_AES) self.assertEqual(out, AES_REFERENCE_VECTORS[('16', '19')]) def test_aes128_unciphered_cc(self): out, _ = _ota_reference('12', '09', '22', '22', 'b00011', '0000000011', AES_APDU, KIC_AES, KID_AES) self.assertEqual(out, AES_REFERENCE_VECTORS[('12', '09')]) def test_aes128_counter_plus_one(self): out, spi = _ota_reference('1e', '19', '22', '22', 'b00011', '0000000011', AES_APDU, KIC_AES, KID_AES) self.assertEqual(out, AES_REFERENCE_VECTORS[('1e', '19')]) self.assertEqual(spi['counter'], 'counter_must_be_lower') class TestDecodePor(unittest.TestCase): def test_plaintext_no_cc_synthetic(self): r = _decode_por('02', '01', '15', '15', '0000000001', K, K, '027100000e0ab0000000000000010000016e00') self.assertEqual(r['response_status'], 'por_ok') self.assertEqual(r['tar'], 'B00000') self.assertEqual(r['decoded']['last_status_word'], '6e00') def test_sysmocom_signed(self): r = _decode_por('06', '09', '35', '35', '0000000001', KIC3, KID3, '027100001612b000110000000000000055f47118381175fb01612f') self.assertEqual(r['response_status'], 'por_ok') self.assertEqual(r['decoded']['last_status_word'], '612f') def test_sysmocom_ciphered(self): r = _decode_por('06', '19', '35', '35', '0000000001', KIC3, KID3, '027100001c12b000119660ebdb81be189b5e4389e9e7ab2bc0954f963ad869ed7c') self.assertEqual(r['response_status'], 'por_ok') self.assertEqual(r['decoded']['last_status_word'], '612f') def test_sysmocom_no_cc(self): r = _decode_por('06', '01', '35', '35', '0000000001', KIC3, KID3, '027100000e0ab000110000000000000001612f') self.assertEqual(r['response_status'], 'por_ok') self.assertEqual(r['decoded']['last_status_word'], '612f') def test_sysmocom_bad_cc_returns_none(self): r = _decode_por('06', '09', '35', '35', '0000000001', KIC3, KID3, '027100001612b000110000000000000055f47118381175fb02612f') self.assertIsNone(r) def test_aes128_ciphered(self): r = _decode_por('06', '19', '22', '22', '0000000001', KIC_AES, KID_AES, '027100002412b00011ebc6b497e2cad7aedf36ace0e3a29b38853f0fe9ccde81913be5702b73abce1f') self.assertEqual(r['response_status'], 'por_ok') self.assertEqual(r['decoded']['last_status_word'], '6132') def test_malformed_returns_none(self): for bad in ['', '00', '00027100000e0a', '027100000e0ab00000', 'garbage', 'zz']: self.assertIsNone( _decode_por('02', '01', '15', '15', '0000000001', K, K, bad), msg='expected None for %r' % bad) if __name__ == '__main__': unittest.main()