mirror of
https://gitea.osmocom.org/sim-card/pysim.git
synced 2026-03-25 06:48:33 +03:00
lots of file definitions for classic SIM and USIM
Change-Id: I91475df4a5eaca423473aaebba8c69c54c9a0c1a
This commit is contained in:
Harald Welte
@@ -6,6 +6,7 @@ Various constants from ETSI TS 131 102
|
||||
|
||||
#
|
||||
# Copyright (C) 2020 Supreeth Herle <herlesupreeth@gmail.com>
|
||||
# Copyright (C) 2021 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
|
||||
@@ -270,10 +271,14 @@ EF_USIM_ADF_map = {
|
||||
|
||||
from struct import unpack, pack
|
||||
from construct import *
|
||||
from pySim.construct import HexAdapter
|
||||
from pySim.construct import LV, HexAdapter, BcdAdapter
|
||||
from pySim.filesystem import *
|
||||
from pySim.ts_102_221 import EF_ARR
|
||||
from pySim.ts_51_011 import EF_IMSI, EF_xPLMNwAcT, EF_SPN, EF_CBMI, EF_ACC, EF_PLMNsel, EF_AD
|
||||
from pySim.ts_51_011 import EF_CBMID, EF_CBMIR
|
||||
from pySim.ts_51_011 import EF_CBMID, EF_CBMIR, EF_ADN, EF_SMS, EF_MSISDN, EF_SMSP, EF_SMSS
|
||||
from pySim.ts_51_011 import EF_SMSR, EF_DCK, EF_EXT, EF_CNL, EF_OPL, EF_MBI, EF_MWIS
|
||||
from pySim.ts_51_011 import EF_MMSN, EF_MMSICP, EF_MMSUP, EF_MMSUCP, EF_VGCS, EF_VGCSS, EF_NIA
|
||||
from pySim.ts_51_011 import EF_ACMmax, EF_AAeM, EF_eMLPP, EF_CMI
|
||||
|
||||
import pySim.ts_102_221
|
||||
|
||||
@@ -422,8 +427,8 @@ class EF_Keys(TransparentEF):
|
||||
|
||||
# TS 31.103 Section 4.2.7
|
||||
class EF_UST(TransparentEF):
|
||||
def __init__(self, fid='6f38', sfid=0x04, name='EF.UST', desc='USIM Service Table'):
|
||||
super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, size={1,17})
|
||||
def __init__(self, fid='6f38', sfid=0x04, name='EF.UST', desc='USIM Service Table', size={1,17}):
|
||||
super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, size=size)
|
||||
# add those commands to the general commands of a TransparentEF
|
||||
self.shell_commands += [self.AddlShellCommands()]
|
||||
def _decode_bin(self, in_bin):
|
||||
@@ -464,23 +469,182 @@ class EF_ECC(LinFixedEF):
|
||||
desc='Emergency Call Codes'):
|
||||
super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len={4,20})
|
||||
|
||||
# TS 31.102 Section 4.2.17
|
||||
class EF_LOCI(TransparentEF):
|
||||
def __init__(self, fid='6f7e', sfid=0x0b, name='EF.LOCI', desc='Locationn information', size={11,11}):
|
||||
super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size)
|
||||
self._construct = Struct('tmsi'/HexAdapter(Bytes(4)), 'lai'/HexAdapter(Bytes(5)), 'rfu'/Int8ub,
|
||||
'lu_status'/Int8ub)
|
||||
|
||||
# TS 31.102 Section 4.2.23
|
||||
class EF_PSLOCI(TransparentEF):
|
||||
def __init__(self, fid='6f73', sfid=0x0c, name='EF.PSLOCI', desc='PS Locationn information', size={14,14}):
|
||||
super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size)
|
||||
self._construct = Struct('ptmsi'/HexAdapter(Bytes(4)), 'ptmsi_sig'/HexAdapter(Bytes(3)),
|
||||
'rai'/HexAdapter(Bytes(6)), 'rau_status'/Int8ub)
|
||||
|
||||
# TS 31.102 Section 4.2.33
|
||||
class EF_ICI(CyclicEF):
|
||||
def __init__(self, fid='6f80', sfid=0x14, name='EF.ICI', rec_len={28,48},
|
||||
desc='Incoming Call Information'):
|
||||
super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, rec_len=rec_len)
|
||||
self._construct = Struct('alpha_id'/Bytes(this._.total_len-28),
|
||||
'len_of_bcd_contents'/Int8ub,
|
||||
'ton_npi'/Int8ub,
|
||||
'call_number'/BcdAdapter(Bytes(10)),
|
||||
'cap_cfg2_record_id'/Int8ub,
|
||||
'ext5_record_id'/Int8ub,
|
||||
'date_and_time'/BcdAdapter(Bytes(7)),
|
||||
'duration'/Int24ub,
|
||||
'status'/Byte,
|
||||
'link_to_phonebook'/Bytes(3))
|
||||
|
||||
# TS 31.102 Section 4.2.34
|
||||
class EF_OCI(CyclicEF):
|
||||
def __init__(self, fid='6f81', sfid=0x15, name='EF.OCI', rec_len={27,47},
|
||||
desc='Outgoing Call Information'):
|
||||
super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, rec_len=rec_len)
|
||||
self._construct = Struct('alpha_id'/Bytes(this._.total_len-27),
|
||||
'len_of_bcd_contents'/Int8ub,
|
||||
'ton_npi'/Int8ub,
|
||||
'call_number'/BcdAdapter(Bytes(10)),
|
||||
'cap_cfg2_record_id'/Int8ub,
|
||||
'ext5_record_id'/Int8ub,
|
||||
'date_and_time'/BcdAdapter(Bytes(7)),
|
||||
'duration'/Int24ub,
|
||||
'link_to_phonebook'/Bytes(3))
|
||||
|
||||
# TS 31.102 Section 4.2.35
|
||||
class EF_ICT(CyclicEF):
|
||||
def __init__(self, fid='6f82', sfid=None, name='EF.ICT', rec_len={3,3},
|
||||
desc='Incoming Call Timer'):
|
||||
super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, rec_len=rec_len)
|
||||
self._construct = Struct('accumulated_call_timer'/Int24ub)
|
||||
|
||||
# TS 31.102 Section 4.2.38
|
||||
class EF_CCP2(LinFixedEF):
|
||||
def __init__(self, fid='6f4f', sfid=0x16, name='EF.CCP2', desc='Capability Configuration Parameters 2'):
|
||||
super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, rec_len={15,None})
|
||||
|
||||
# TS 31.102 Section 4.2.48
|
||||
class EF_ACL(TransparentEF):
|
||||
def __init__(self, fid='6f57', sfid=None, name='EF.ACL', size={32,None},
|
||||
desc='Access Point Name Control List'):
|
||||
super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size)
|
||||
self._construct = Struct('num_of_apns'/Int8ub, 'tlvs'/GreedyBytes)
|
||||
|
||||
# TS 31.102 Section 4.2.51
|
||||
class EF_START_HFN(TransparentEF):
|
||||
def __init__(self, fid='6f5b', sfid=0x0f, name='EF.START-HFN', size={6,6},
|
||||
desc='Initialisation values for Hyperframe number'):
|
||||
super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size)
|
||||
self._construct = Struct('start_cs'/Int24ub, 'start_ps'/Int24ub)
|
||||
|
||||
# TS 31.102 Section 4.2.52
|
||||
class EF_THRESHOLD(TransparentEF):
|
||||
def __init__(self, fid='6f5c', sfid=0x10, name='EF.THRESHOLD', size={3,3},
|
||||
desc='Maximum value of START'):
|
||||
super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size)
|
||||
self._construct = Struct('max_start'/Int24ub)
|
||||
|
||||
# TS 31.102 Section 4.2.77
|
||||
class EF_VGCSCA(TransRecEF):
|
||||
def __init__(self, fid='6fd4', sfid=None, name='EF.VGCSCA', size={2,100}, rec_len=2,
|
||||
desc='Voice Group Call Service Ciphering Algorithm'):
|
||||
super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, rec_len=rec_len)
|
||||
self._construct = Struct('alg_v_ki_1'/Int8ub, 'alg_v_ki_2'/Int8ub)
|
||||
|
||||
# TS 31.102 Section 4.2.79
|
||||
class EF_GBABP(TransparentEF):
|
||||
def __init__(self, fid='6fd6', sfid=None, name='EF.GBABP', size={3,50},
|
||||
desc='GBA Bootstrapping parameters'):
|
||||
super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size)
|
||||
self._construct = Struct('rand'/LV, 'b_tid'/LV, 'key_lifetime'/LV)
|
||||
|
||||
# TS 31.102 Section 4.2.80
|
||||
class EF_MSK(LinFixedEF):
|
||||
def __init__(self, fid='6fd7', sfid=None, name='EF.MSK', desc='MBMS Service Key List'):
|
||||
super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, rec_len={20,None})
|
||||
msk_ts_constr = Struct('msk_id'/Int32ub, 'timestamp_counter'/Int32ub)
|
||||
self._construct = Struct('key_domain_id'/Bytes(3),
|
||||
'num_msk_id'/Int8ub,
|
||||
'msk_ids'/msk_ts_constr[this.num_msk_id])
|
||||
|
||||
# TS 31.102 Section 4.2.85
|
||||
class EF_EHPLMNPI(TransparentEF):
|
||||
def __init__(self, fid='6fdb', sfid=None, name='EF.EHPLMNPI', size={1,1},
|
||||
desc='Equivalent HPLMN Presentation Indication'):
|
||||
super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size)
|
||||
self._construct = Struct('presentation_ind'/
|
||||
Enum(Byte, no_preference=0, display_highest_prio_only=1, display_all=2))
|
||||
# TS 31.102 Section 4.2.91
|
||||
class EF_EPSLOCI(TransparentEF):
|
||||
def __init__(self, fid='6fe3', sfid=0x1e, name='EF.EPSLOCI', size={18,18},
|
||||
desc='EPS Location Information'):
|
||||
super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size)
|
||||
upd_status_constr = Enum(Byte, updated=0, not_updated=1, roaming_not_allowed=2)
|
||||
self._construct = Struct('guti'/Bytes(12), 'last_visited_registered_tai'/Bytes(5),
|
||||
'eps_update_status'/upd_status_constr)
|
||||
|
||||
# TS 31.102 Section 4.2.96
|
||||
class EF_PWS(TransparentEF):
|
||||
def __init__(self, fid='6fec', sfid=None, name='EF.PWS', desc='Public Warning System', size={1,1}):
|
||||
super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size)
|
||||
pws_config = FlagsEnum(Byte, ignore_pws_in_hplmn_and_equivalent=1, ignore_pws_in_vplmn=2)
|
||||
self._construct = Struct('pws_configuration'/pws_config)
|
||||
|
||||
# TS 31.102 Section 4.2.101
|
||||
class EF_IPS(CyclicEF):
|
||||
def __init__(self, fid='6ff1', sfid=None, name='EF.IPS', rec_len={4,4},
|
||||
desc='IMEI(SV) Pairing Status'):
|
||||
super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len=rec_len)
|
||||
self._construct = Struct('status'/PaddedString(2, 'ascii'),
|
||||
'link_to_ef_ipd'/Int8ub, 'rfu'/Byte)
|
||||
|
||||
######################################################################
|
||||
# DF.5GS
|
||||
######################################################################
|
||||
|
||||
# TS 31.102 Section 4.4.11.2
|
||||
class EF_5GS3GPPLOCI(TransparentEF):
|
||||
def __init__(self, fid='4f01', sfid=0x01, name='EF.5GS3GPPLOCI', size={20,20},
|
||||
desc='5S 3GP location information'):
|
||||
super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size)
|
||||
upd_status_constr = Enum(Byte, updated=0, not_updated=1, roaming_not_allowed=2)
|
||||
self._construct = Struct('5g_guti'/Bytes(13), 'last_visited_registered_tai_in_5gs'/Bytes(6),
|
||||
'5gs_update_status'/upd_status_constr)
|
||||
|
||||
# TS 31.102 Section 4.4.11.7
|
||||
class EF_UAC_AIC(TransparentEF):
|
||||
def __init__(self, fid='4f06', sfid=0x06, name='EF.UAC_AIC', size={4,4},
|
||||
desc='UAC Access Identities Configuration'):
|
||||
super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size)
|
||||
cfg_constr = FlagsEnum(Byte, multimedia_priority_service=1,
|
||||
mission_critical_service=2)
|
||||
self._construct = Struct('uac_access_id_config'/cfg_constr)
|
||||
|
||||
# TS 31.102 Section 4.4.11.10
|
||||
class EF_OPL5G(LinFixedEF):
|
||||
def __init__(self, fid='6f08', sfid=0x08, name='EF.OPL5G', desc='5GS Operator PLMN List'):
|
||||
super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, rec_len={10,None})
|
||||
self._construct = Struct('tai'/Bytes(9), 'pnn_record_id'/Int8ub)
|
||||
|
||||
class DF_USIM_5GS(CardDF):
|
||||
def __init__(self, fid='5FC0', name='DF.5GS', desc='5GS related files'):
|
||||
super().__init__(fid=fid, name=name, desc=desc)
|
||||
files = [
|
||||
# I'm looking at 31.102 R15.9
|
||||
TransparentEF('4F01', None, 'EF.5GS3GPPLOCI', '5GS 3GPP location information', size={20,20}),
|
||||
TransparentEF('4F02', None, 'EF.5GSN3GPPLOCI', '5GS non-3GPP location information', size={20,20}),
|
||||
#LinFixedEF('4F03', None, 'EF.5GS3GPPNSC', '5GS 3GPP Access NAS Security Context'),
|
||||
#LinFixedEF('4F04', None, 'EF.5GSN3GPPNSC', '5GS non-3GPP Access NAS Security Context'),
|
||||
TransparentEF('4F05', None, 'EF.5GAUTHKEYS', '5G authentication keys', size={68, None}),
|
||||
TransparentEF('4F06', None, 'EF.UAC_AIC', 'UAC Access Identities Configuration', size={4, 4}),
|
||||
EF_SUCI_Calc_Info(), #TransparentEF('4F07', None, 'EF.SUCI_Calc_Info', 'SUCI Calculation Information', size={2, None}),
|
||||
LinFixedEF('4F08', None, 'EF.OPL5G', '5GS Operator PLMN List', rec_len={10, None}),
|
||||
# TransparentEF('4F09', None, 'EF.NSI', 'Network Specific Identifier'), # FFS
|
||||
TransparentEF('4F0A', None, 'EF.Routing_Indicator', 'Routing Indicator', size={4,4}),
|
||||
EF_5GS3GPPLOCI(),
|
||||
EF_5GS3GPPLOCI('4f02', 0x02, 'EF.5GSN3GPPLOCI', '5GS non-3GPP location information'),
|
||||
LinFixedEF('4F03', 0x03, 'EF.5GS3GPPNSC', '5GS 3GPP Access NAS Security Context', rec_len={57,None}),
|
||||
LinFixedEF('4F04', 0x04, 'EF.5GSN3GPPNSC', '5GS non-3GPP Access NAS Security Context', rec_len={57,None}),
|
||||
TransparentEF('4F05', 0x05, 'EF.5GAUTHKEYS', '5G authentication keys', size={68, None}),
|
||||
EF_UAC_AIC(),
|
||||
EF_SUCI_Calc_Info(),
|
||||
EF_OPL5G(),
|
||||
TransparentEF('4F09', 0x09, 'EF.NSI', 'Network Specific Identifier'),
|
||||
TransparentEF('4F0A', 0x0a, 'EF.Routing_Indicator', 'Routing Indicator', size={4,4}),
|
||||
]
|
||||
|
||||
self.add_files(files)
|
||||
|
||||
class ADF_USIM(CardADF):
|
||||
@@ -498,7 +662,7 @@ class ADF_USIM(CardADF):
|
||||
EF_xPLMNwAcT('6f60', 0x0a, 'EF.PLMNwAcT',
|
||||
'User controlled PLMN Selector with Access Technology'),
|
||||
TransparentEF('6f31', 0x12, 'EF.HPPLMN', 'Higher Priority PLMN search period'),
|
||||
# EF.ACMmax
|
||||
EF_ACMmax(),
|
||||
EF_UST(),
|
||||
CyclicEF('6f39', None, 'EF.ACM', 'Accumulated call meter', rec_len={3,3}),
|
||||
TransparentEF('6f3e', None, 'EF.GID1', 'Group Identifier Level 1'),
|
||||
@@ -508,11 +672,92 @@ class ADF_USIM(CardADF):
|
||||
EF_CBMI(),
|
||||
EF_ACC(sfid=0x06),
|
||||
EF_PLMNsel('6f7b', 0x0d, 'EF.FPLMN', 'Forbidden PLMNs', size={12,None}),
|
||||
TransparentEF('6f7e', 0x0b, 'EF.LOCI', 'Locationn information', size={11,11}),
|
||||
EF_LOCI(),
|
||||
EF_AD(sfid=0x03),
|
||||
EF_CBMID(sfid=0x0e),
|
||||
EF_ECC(),
|
||||
EF_CBMIR(),
|
||||
EF_PSLOCI(),
|
||||
EF_ADN('6f3b', None, 'EF.FDN', 'Fixed Dialling Numbers'),
|
||||
EF_SMS('6f3c', None),
|
||||
EF_MSISDN(),
|
||||
EF_SMSP(),
|
||||
EF_SMSS(),
|
||||
EF_ADN('6f49', None, 'EF.SDN', 'Service Dialling Numbers'),
|
||||
EF_EXT('6f4b', None, 'EF.EXT2', 'Extension2 (FDN)'),
|
||||
EF_EXT('6f4c', None, 'EF.EXT3', 'Extension2 (SDN)'),
|
||||
EF_SMSR(),
|
||||
EF_ICI(),
|
||||
EF_OCI(),
|
||||
EF_ICT(),
|
||||
EF_ICT('6f83', None, 'EF.OCT', 'Outgoing Call Timer'),
|
||||
EF_EXT('6f4e', None, 'EF.EXT5', 'Extension5 (ICI/OCI/MSISDN)'),
|
||||
EF_CCP2(),
|
||||
EF_eMLPP(),
|
||||
EF_AAeM(),
|
||||
# EF_Hiddenkey
|
||||
EF_ADN('6f4d', None, 'EF.BDN', 'Barred Dialling Numbers'),
|
||||
EF_EXT('6f55', None, 'EF.EXT4', 'Extension4 (BDN/SSC)'),
|
||||
EF_CMI(),
|
||||
EF_UST('6f56', 0x05, 'EF.EST', 'Enabled Services Table', size={1,None}),
|
||||
EF_ACL(),
|
||||
EF_DCK(),
|
||||
EF_CNL(),
|
||||
EF_START_HFN(),
|
||||
EF_THRESHOLD(),
|
||||
EF_xPLMNwAcT('6f61', 0x11, 'EF.OPLMNwAcT',
|
||||
'User controlled PLMN Selector with Access Technology'),
|
||||
EF_ARR('6f06', 0x17),
|
||||
TransparentEF('6fc4', None, 'EF.NETPAR', 'Network Parameters'),
|
||||
LinFixedEF('6fc5', 0x19, 'EF.PNN', 'PLMN Network Name'),
|
||||
EF_OPL(),
|
||||
EF_ADN('6fc7', None, 'EF.MBDN', 'Mailbox Dialling Numbers'),
|
||||
EF_MBI(),
|
||||
EF_MWIS(),
|
||||
EF_ADN('6fcb', None, 'EF.CFIS', 'Call Forwarding Indication Status'),
|
||||
EF_EXT('6fcc', None, 'EF.EXT7', 'Extension7 (CFIS)'),
|
||||
TransparentEF('6fcd', None, 'EF.SPDI', 'Service Provider Display Information'),
|
||||
EF_MMSN(),
|
||||
EF_EXT('6fcf', None, 'EF.EXT8', 'Extension8 (MMSN)'),
|
||||
EF_MMSICP(),
|
||||
EF_MMSUP(),
|
||||
EF_MMSUCP(),
|
||||
EF_NIA(),
|
||||
EF_VGCS(),
|
||||
EF_VGCSS(),
|
||||
EF_VGCS('6fb3', None, 'EF.VBS', 'Voice Broadcast Service'),
|
||||
EF_VGCSS('6fb4', None, 'EF.VBSS', 'Voice Broadcast Service Status'),
|
||||
EF_VGCSCA(),
|
||||
EF_VGCSCA('6fd5', None, 'EF.VBCSCA', 'Voice Broadcast Service Ciphering Algorithm'),
|
||||
EF_GBABP(),
|
||||
EF_MSK(),
|
||||
LinFixedEF('6fd8', None, 'EF.MUK', 'MBMS User Key'),
|
||||
LinFixedEF('6fda', None, 'EF.GBANL', 'GBA NFA List'),
|
||||
EF_PLMNsel('6fd9', 0x1d, 'EF.EHPLMN', 'Equivalent HPLMN', size={12,None}),
|
||||
EF_EHPLMNPI(),
|
||||
LinFixedEF('6fdd', None, 'EF.NAFKCA', 'NAF Key Centre Address'),
|
||||
TransparentEF('6fde', None, 'EF.SPNI', 'Service Provider Name Icon'),
|
||||
LinFixedEF('6fdf', None, 'EF.PNNI', 'PLMN Network Name Icon'),
|
||||
LinFixedEF('6fe2', None, 'EF.NCP-IP', 'Network Connectivity Parameters for USIM IP connections'),
|
||||
EF_EPSLOCI('6fe3', 0x1e, 'EF.EPSLOCI', 'EPS location information'),
|
||||
LinFixedEF('6fe4', 0x18, 'EF.EPSNSC', 'EPS NAS Security Context', rec_len={54,128}),
|
||||
TransparentEF('6fe6', None, 'EF.UFC', 'USAT Facility Control', size={1,16}),
|
||||
TransparentEF('6fe8', None, 'EF.NASCONFIG', 'Non Access Stratum Configuration'),
|
||||
# UICC IARI (only in cards that have no ISIM)
|
||||
EF_PWS(),
|
||||
LinFixedEF('6fed', None, 'EF.FDNURI', 'Fixed Dialling Numbers URI'),
|
||||
LinFixedEF('6fee', None, 'EF.BDNURI', 'Barred Dialling Numbers URI'),
|
||||
LinFixedEF('6fef', None, 'EF.SDNURI', 'Service Dialling Numbers URI'),
|
||||
EF_IPS(),
|
||||
# FIXME: from EF_ePDGid onwards
|
||||
# FIXME: DF_SoLSA
|
||||
# FIXME: DF_PHONEBOOK
|
||||
# FIXME: DF_GSM_ACCESS
|
||||
# FIXME: DF_WLAN
|
||||
# FIXME: DF_HNB
|
||||
# FIXME: DF_ProSe
|
||||
# FIXME: DF_ACDC
|
||||
# FIXME: DF_TV
|
||||
DF_USIM_5GS(),
|
||||
]
|
||||
self.add_files(files)
|
||||
|
||||
Reference in New Issue
Block a user