pysim-local/tests/unittests/test_esim_saip.py

#!/usr/bin/env python3

# (C) 2023-2024 by Harald Welte <laforge@osmocom.org>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

import unittest
import logging
import copy
from osmocom.utils import h2b, b2h

from pySim.esim.saip import *
from pySim.esim.saip.personalization import *
from pprint import pprint as pp


class SaipTest(unittest.TestCase):
    with open('smdpp-data/upp/TS48v2_SAIP2.3_NoBERTLV.der', 'rb') as f:
        per_input = f.read()
    pes = ProfileElementSequence.from_der(per_input)
    expected_pet_list = ['header', 'mf', 'pukCodes', 'pinCodes', 'telecom', 'pinCodes', 'genericFileManagement', 'usim', 'opt-usim', 'pinCodes', 'akaParameter', 'gsm-access', 'df-5gs', 'df-saip','csim', 'opt-csim', 'pinCodes', 'cdmaParameter', 'isim', 'opt-isim', 'pinCodes', 'akaParameter', 'genericFileManagement', 'genericFileManagement', 'securityDomain', 'rfm', 'rfm', 'rfm', 'rfm', 'end']

    def test_reencode_sequence(self):
        """Test that we can decode and re-encode the entire DER encoded UPP."""
        reencoded_der = self.pes.to_der()
        self.assertEqual(reencoded_der, self.per_input)

    def test_reencode_pe(self):
        """Test that we can decode and re-encode reach individual ProfileElement."""
        remainder = self.per_input
        while len(remainder):
            first_tlv, remainder = bertlv_first_segment(remainder)
            pe = ProfileElement.from_der(first_tlv)
            with self.subTest(pe.type):
                reenc_tlv = pe.to_der()
                self.assertEqual(reenc_tlv, first_tlv)


    def test_sequence_helpers(self):
        """Verify that the convenience helpers worked as expected."""
        self.assertEqual([x.type for x in self.pes.pe_list], self.expected_pet_list)
        self.assertEqual(len(self.pes.pes_by_naa), 4)

    def test_personalization(self):
        """Test some of the personalization operations."""
        pes = copy.deepcopy(self.pes)
        params = [Puk1('01234567'), Puk2(98765432), Pin1('1111'), Pin2(2222), Adm1('11111111'),
                  K(h2b('000102030405060708090a0b0c0d0e0f')), Opc(h2b('101112131415161718191a1b1c1d1e1f'))]
        for p in params:
            p.validate()
            p.apply(pes)
        # TODO: we don't actually test the results here, but we just verify there is no exception
        pes.to_der()

    def test_personalization2(self):
        """Test some of the personalization operations."""
        pes = ProfileElementSequence.from_der(self.per_input)
        prev_val = set(SdKeyScp80_01Kic.get_values_from_pes(pes))
        print(f'{prev_val=}')
        self.assertTrue(prev_val)

        set_val = '42342342342342342342342342342342'
        param = SdKeyScp80_01Kic(set_val)
        param.validate()
        param.apply(pes)

        get_val1 = set(SdKeyScp80_01Kic.get_values_from_pes(pes))
        print(f'{get_val1=} {set_val=}')
        self.assertEqual(get_val1, set((set_val,)))

        get_val1b = set(SdKeyScp80_01Kic.get_values_from_pes(pes))
        print(f'{get_val1b=} {set_val=}')
        self.assertEqual(get_val1b, set((set_val,)))

        print("HELLOO")
        der = pes.to_der()
        print("DONEDONE")

        get_val1c = set(SdKeyScp80_01Kic.get_values_from_pes(pes))
        print(f'{get_val1c=} {set_val=}')
        self.assertEqual(get_val1c, set((set_val,)))

        # assertTrue to not dump the entire der.
        # Expecting the modified DER to be different. If this assertion fails, then no change has happened in the output
        # DER and the ConfigurableParameter subclass is buggy.
        self.assertTrue(der != self.per_input)

        pes2 = ProfileElementSequence.from_der(der)
        get_val2 = set(SdKeyScp80_01Kic.get_values_from_pes(pes2))
        print(f'{get_val2=} {set_val=}')
        self.assertEqual(get_val2, set((set_val,)))

    def test_constructor_encode(self):
        """Test that DER-encoding of PE created by "empty" constructor works without raising exception."""
        for cls in [ProfileElementMF, ProfileElementPuk, ProfileElementPin, ProfileElementTelecom,
                    ProfileElementUSIM, ProfileElementISIM, ProfileElementAKA, ProfileElementSD,
                    ProfileElementSSD, ProfileElementOptUSIM, ProfileElementOptISIM,
                    ProfileElementHeader, ProfileElementEnd]:
            with self.subTest(cls.__name__):
                pes = ProfileElementSequence()
                inst = cls()
                pes.append(inst)
                pes.to_der()

        # RFM requires some constructor arguments
        cls = ProfileElementRFM
        with self.subTest(cls.__name__):
                pes = ProfileElementSequence()
                inst = cls(inst_aid=b'\x01\x02', sd_aid=b'\x03\x04', tar_list=[b'\x01\x02\x03'])
                pes.append(inst)
                pes.to_der()

class OidTest(unittest.TestCase):
    def test_cmp(self):
        self.assertTrue(oid.OID('1.0') > oid.OID('0.9'))
        self.assertTrue(oid.OID('1.0') == oid.OID('1.0'))
        self.assertTrue(oid.OID('1.0.1') > oid.OID('1.0'))
        self.assertTrue(oid.OID('1.0.2') > oid.OID('1.0.1'))

if __name__ == "__main__":
	unittest.main()