blob: f9f1e2a75bc1a628d339f4b6f29dffd25995a3c5 [file] [log] [blame]
Alexander Chemeris067f69c2017-07-18 16:44:26 +03001# -*- coding: utf-8 -*-
2
Harald Welte14105dc2021-05-31 08:48:51 +02003# without this, pylint will fail when inner classes are used
4# within the 'nested' kwarg of our TlvMeta metaclass on python 3.7 :(
5# pylint: disable=undefined-variable
6
Harald Welteb2edd142021-01-08 23:29:35 +01007""" Various constants from ETSI TS 151.011 +
8Representation of the GSM SIM/USIM/ISIM filesystem hierarchy.
9
10The File (and its derived classes) uses the classes of pySim.filesystem in
11order to describe the files specified in the relevant ETSI + 3GPP specifications.
Alexander Chemeris067f69c2017-07-18 16:44:26 +030012"""
13
14#
15# Copyright (C) 2017 Alexander.Chemeris <Alexander.Chemeris@gmail.com>
Harald Welteb2edd142021-01-08 23:29:35 +010016# Copyright (C) 2021 Harald Welte <laforge@osmocom.org>
Alexander Chemeris067f69c2017-07-18 16:44:26 +030017#
18# This program is free software: you can redistribute it and/or modify
19# it under the terms of the GNU General Public License as published by
20# the Free Software Foundation, either version 2 of the License, or
21# (at your option) any later version.
22#
23# This program is distributed in the hope that it will be useful,
24# but WITHOUT ANY WARRANTY; without even the implied warranty of
25# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26# GNU General Public License for more details.
27#
28# You should have received a copy of the GNU General Public License
29# along with this program. If not, see <http://www.gnu.org/licenses/>.
30#
31
Harald Weltec91085e2022-02-10 18:05:45 +010032from pySim.profile import match_sim
33from pySim.profile import CardProfile
34from pySim.filesystem import *
35import enum
36from pySim.construct import *
37from construct import Optional as COptional
38from construct import *
39from struct import pack, unpack
40from typing import Tuple
41from pySim.tlv import *
42from pySim.utils import *
Alexander Chemeris067f69c2017-07-18 16:44:26 +030043MF_num = '3F00'
44
45DF_num = {
Harald Weltec91085e2022-02-10 18:05:45 +010046 'TELECOM': '7F10',
Alexander Chemeris067f69c2017-07-18 16:44:26 +030047
Harald Weltec91085e2022-02-10 18:05:45 +010048 'GSM': '7F20',
49 'IS-41': '7F22',
50 'FP-CTS': '7F23',
Alexander Chemeris067f69c2017-07-18 16:44:26 +030051
Harald Weltec91085e2022-02-10 18:05:45 +010052 'GRAPHICS': '5F50',
Alexander Chemeris067f69c2017-07-18 16:44:26 +030053
Harald Weltec91085e2022-02-10 18:05:45 +010054 'IRIDIUM': '5F30',
55 'GLOBST': '5F31',
56 'ICO': '5F32',
57 'ACeS': '5F33',
Alexander Chemeris067f69c2017-07-18 16:44:26 +030058
Harald Weltec91085e2022-02-10 18:05:45 +010059 'EIA/TIA-553': '5F40',
60 'CTS': '5F60',
61 'SOLSA': '5F70',
Alexander Chemeris067f69c2017-07-18 16:44:26 +030062
Harald Weltec91085e2022-02-10 18:05:45 +010063 'MExE': '5F3C',
Alexander Chemeris067f69c2017-07-18 16:44:26 +030064}
65
66EF_num = {
Harald Weltec91085e2022-02-10 18:05:45 +010067 # MF
68 'ICCID': '2FE2',
69 'ELP': '2F05',
70 'DIR': '2F00',
Alexander Chemeris067f69c2017-07-18 16:44:26 +030071
Harald Weltec91085e2022-02-10 18:05:45 +010072 # DF_TELECOM
73 'ADN': '6F3A',
74 'FDN': '6F3B',
75 'SMS': '6F3C',
76 'CCP': '6F3D',
77 'MSISDN': '6F40',
78 'SMSP': '6F42',
79 'SMSS': '6F43',
80 'LND': '6F44',
81 'SMSR': '6F47',
82 'SDN': '6F49',
83 'EXT1': '6F4A',
84 'EXT2': '6F4B',
85 'EXT3': '6F4C',
86 'BDN': '6F4D',
87 'EXT4': '6F4E',
88 'CMI': '6F58',
89 'ECCP': '6F4F',
Alexander Chemeris067f69c2017-07-18 16:44:26 +030090
Harald Weltec91085e2022-02-10 18:05:45 +010091 # DF_GRAPHICS
92 'IMG': '4F20',
Alexander Chemeris067f69c2017-07-18 16:44:26 +030093
Harald Weltec91085e2022-02-10 18:05:45 +010094 # DF_SoLSA
95 'SAI': '4F30',
96 'SLL': '4F31',
Alexander Chemeris067f69c2017-07-18 16:44:26 +030097
Harald Weltec91085e2022-02-10 18:05:45 +010098 # DF_MExE
99 'MExE-ST': '4F40',
100 'ORPK': '4F41',
101 'ARPK': '4F42',
102 'TPRPK': '4F43',
Alexander Chemeris067f69c2017-07-18 16:44:26 +0300103
Harald Weltec91085e2022-02-10 18:05:45 +0100104 # DF_GSM
105 'LP': '6F05',
106 'IMSI': '6F07',
107 'Kc': '6F20',
108 'DCK': '6F2C',
109 'PLMNsel': '6F30',
110 'HPPLMN': '6F31',
111 'CNL': '6F32',
112 'ACMmax': '6F37',
113 'SST': '6F38',
114 'ACM': '6F39',
115 'GID1': '6F3E',
116 'GID2': '6F3F',
117 'PUCT': '6F41',
118 'CBMI': '6F45',
119 'SPN': '6F46',
120 'CBMID': '6F48',
121 'BCCH': '6F74',
122 'ACC': '6F78',
123 'FPLMN': '6F7B',
124 'LOCI': '6F7E',
125 'AD': '6FAD',
126 'PHASE': '6FAE',
127 'VGCS': '6FB1',
128 'VGCSS': '6FB2',
129 'VBS': '6FB3',
130 'VBSS': '6FB4',
131 'eMLPP': '6FB5',
132 'AAeM': '6FB6',
133 'ECC': '6FB7',
134 'CBMIR': '6F50',
135 'NIA': '6F51',
136 'KcGPRS': '6F52',
137 'LOCIGPRS': '6F53',
138 'SUME': '6F54',
139 'PLMNwAcT': '6F60',
140 'OPLMNwAcT': '6F61',
141 # Figure 8 names it HPLMNAcT, but in the text it's names it HPLMNwAcT
142 'HPLMNAcT': '6F62',
143 'HPLMNwAcT': '6F62',
144 'CPBCCH': '6F63',
145 'INVSCAN': '6F64',
146 'PNN': '6FC5',
147 'OPL': '6FC6',
148 'MBDN': '6FC7',
149 'EXT6': '6FC8',
150 'MBI': '6FC9',
151 'MWIS': '6FCA',
152 'CFIS': '6FCB',
153 'EXT7': '6FCC',
154 'SPDI': '6FCD',
155 'MMSN': '6FCE',
156 'EXT8': '6FCF',
157 'MMSICP': '6FD0',
158 'MMSUP': '6FD1',
159 'MMSUCP': '6FD2',
Alexander Chemeris067f69c2017-07-18 16:44:26 +0300160}
161
162DF = {
Harald Weltec91085e2022-02-10 18:05:45 +0100163 'TELECOM': [MF_num, DF_num['TELECOM']],
Alexander Chemeris067f69c2017-07-18 16:44:26 +0300164
Harald Weltec91085e2022-02-10 18:05:45 +0100165 'GSM': [MF_num, DF_num['GSM']],
166 'IS-41': [MF_num, DF_num['IS-41']],
167 'FP-CTS': [MF_num, DF_num['FP-CTS']],
Alexander Chemeris067f69c2017-07-18 16:44:26 +0300168
Harald Weltec91085e2022-02-10 18:05:45 +0100169 'GRAPHICS': [MF_num, DF_num['GRAPHICS']],
Alexander Chemeris067f69c2017-07-18 16:44:26 +0300170
Harald Weltec91085e2022-02-10 18:05:45 +0100171 'IRIDIUM': [MF_num, DF_num['IRIDIUM']],
172 'GLOBST': [MF_num, DF_num['GLOBST']],
173 'ICO': [MF_num, DF_num['ICO']],
174 'ACeS': [MF_num, DF_num['ACeS']],
Alexander Chemeris067f69c2017-07-18 16:44:26 +0300175
Harald Weltec91085e2022-02-10 18:05:45 +0100176 'EIA/TIA-553': [MF_num, DF_num['EIA/TIA-553']],
177 'CTS': [MF_num, DF_num['CTS']],
178 'SoLSA': [MF_num, DF_num['SOLSA']],
Alexander Chemeris067f69c2017-07-18 16:44:26 +0300179
Harald Weltec91085e2022-02-10 18:05:45 +0100180 'MExE': [MF_num, DF_num['MExE']],
Alexander Chemeris067f69c2017-07-18 16:44:26 +0300181}
182
183
184EF = {
Harald Weltec91085e2022-02-10 18:05:45 +0100185 'ICCID': [MF_num, EF_num['ICCID']],
186 'ELP': [MF_num, EF_num['ELP']],
187 'DIR': [MF_num, EF_num['DIR']],
Alexander Chemeris067f69c2017-07-18 16:44:26 +0300188
Harald Weltec91085e2022-02-10 18:05:45 +0100189 'ADN': DF['TELECOM']+[EF_num['ADN']],
190 'FDN': DF['TELECOM']+[EF_num['FDN']],
191 'SMS': DF['TELECOM']+[EF_num['SMS']],
192 'CCP': DF['TELECOM']+[EF_num['CCP']],
193 'MSISDN': DF['TELECOM']+[EF_num['MSISDN']],
194 'SMSP': DF['TELECOM']+[EF_num['SMSP']],
195 'SMSS': DF['TELECOM']+[EF_num['SMSS']],
196 'LND': DF['TELECOM']+[EF_num['LND']],
197 'SMSR': DF['TELECOM']+[EF_num['SMSR']],
198 'SDN': DF['TELECOM']+[EF_num['SDN']],
199 'EXT1': DF['TELECOM']+[EF_num['EXT1']],
200 'EXT2': DF['TELECOM']+[EF_num['EXT2']],
201 'EXT3': DF['TELECOM']+[EF_num['EXT3']],
202 'BDN': DF['TELECOM']+[EF_num['BDN']],
203 'EXT4': DF['TELECOM']+[EF_num['EXT4']],
204 'CMI': DF['TELECOM']+[EF_num['CMI']],
205 'ECCP': DF['TELECOM']+[EF_num['ECCP']],
Alexander Chemeris067f69c2017-07-18 16:44:26 +0300206
Harald Weltec91085e2022-02-10 18:05:45 +0100207 'IMG': DF['GRAPHICS']+[EF_num['IMG']],
Alexander Chemeris067f69c2017-07-18 16:44:26 +0300208
Harald Weltec91085e2022-02-10 18:05:45 +0100209 'SAI': DF['SoLSA']+[EF_num['SAI']],
210 'SLL': DF['SoLSA']+[EF_num['SLL']],
Alexander Chemeris067f69c2017-07-18 16:44:26 +0300211
Harald Weltec91085e2022-02-10 18:05:45 +0100212 'MExE-ST': DF['MExE']+[EF_num['MExE-ST']],
213 'ORPK': DF['MExE']+[EF_num['ORPK']],
214 'ARPK': DF['MExE']+[EF_num['ARPK']],
215 'TPRPK': DF['MExE']+[EF_num['TPRPK']],
Alexander Chemeris067f69c2017-07-18 16:44:26 +0300216
Harald Weltec91085e2022-02-10 18:05:45 +0100217 'LP': DF['GSM']+[EF_num['LP']],
218 'IMSI': DF['GSM']+[EF_num['IMSI']],
219 'Kc': DF['GSM']+[EF_num['Kc']],
220 'DCK': DF['GSM']+[EF_num['DCK']],
221 'PLMNsel': DF['GSM']+[EF_num['PLMNsel']],
222 'HPPLMN': DF['GSM']+[EF_num['HPPLMN']],
223 'CNL': DF['GSM']+[EF_num['CNL']],
224 'ACMmax': DF['GSM']+[EF_num['ACMmax']],
225 'SST': DF['GSM']+[EF_num['SST']],
226 'ACM': DF['GSM']+[EF_num['ACM']],
227 'GID1': DF['GSM']+[EF_num['GID1']],
228 'GID2': DF['GSM']+[EF_num['GID2']],
229 'PUCT': DF['GSM']+[EF_num['PUCT']],
230 'CBMI': DF['GSM']+[EF_num['CBMI']],
231 'SPN': DF['GSM']+[EF_num['SPN']],
232 'CBMID': DF['GSM']+[EF_num['CBMID']],
233 'BCCH': DF['GSM']+[EF_num['BCCH']],
234 'ACC': DF['GSM']+[EF_num['ACC']],
235 'FPLMN': DF['GSM']+[EF_num['FPLMN']],
236 'LOCI': DF['GSM']+[EF_num['LOCI']],
237 'AD': DF['GSM']+[EF_num['AD']],
238 'PHASE': DF['GSM']+[EF_num['PHASE']],
239 'VGCS': DF['GSM']+[EF_num['VGCS']],
240 'VGCSS': DF['GSM']+[EF_num['VGCSS']],
241 'VBS': DF['GSM']+[EF_num['VBS']],
242 'VBSS': DF['GSM']+[EF_num['VBSS']],
243 'eMLPP': DF['GSM']+[EF_num['eMLPP']],
244 'AAeM': DF['GSM']+[EF_num['AAeM']],
245 'ECC': DF['GSM']+[EF_num['ECC']],
246 'CBMIR': DF['GSM']+[EF_num['CBMIR']],
247 'NIA': DF['GSM']+[EF_num['NIA']],
248 'KcGPRS': DF['GSM']+[EF_num['KcGPRS']],
249 'LOCIGPRS': DF['GSM']+[EF_num['LOCIGPRS']],
250 'SUME': DF['GSM']+[EF_num['SUME']],
251 'PLMNwAcT': DF['GSM']+[EF_num['PLMNwAcT']],
252 'OPLMNwAcT': DF['GSM']+[EF_num['OPLMNwAcT']],
253 # Figure 8 names it HPLMNAcT, but in the text it's names it HPLMNwAcT
254 'HPLMNAcT': DF['GSM']+[EF_num['HPLMNAcT']],
255 'HPLMNwAcT': DF['GSM']+[EF_num['HPLMNAcT']],
256 'CPBCCH': DF['GSM']+[EF_num['CPBCCH']],
257 'INVSCAN': DF['GSM']+[EF_num['INVSCAN']],
258 'PNN': DF['GSM']+[EF_num['PNN']],
259 'OPL': DF['GSM']+[EF_num['OPL']],
260 'MBDN': DF['GSM']+[EF_num['MBDN']],
261 'EXT6': DF['GSM']+[EF_num['EXT6']],
262 'MBI': DF['GSM']+[EF_num['MBI']],
263 'MWIS': DF['GSM']+[EF_num['MWIS']],
264 'CFIS': DF['GSM']+[EF_num['CFIS']],
265 'EXT7': DF['GSM']+[EF_num['EXT7']],
266 'SPDI': DF['GSM']+[EF_num['SPDI']],
267 'MMSN': DF['GSM']+[EF_num['MMSN']],
268 'EXT8': DF['GSM']+[EF_num['EXT8']],
269 'MMSICP': DF['GSM']+[EF_num['MMSICP']],
270 'MMSUP': DF['GSM']+[EF_num['MMSUP']],
271 'MMSUCP': DF['GSM']+[EF_num['MMSUCP']],
Alexander Chemeris067f69c2017-07-18 16:44:26 +0300272}
Supreeth Herlebf5d6022020-03-20 15:18:27 +0100273
274# Mapping between SIM Service Number and its description
275EF_SST_map = {
Harald Weltec91085e2022-02-10 18:05:45 +0100276 1: 'CHV1 disable function',
277 2: 'Abbreviated Dialling Numbers (ADN)',
278 3: 'Fixed Dialling Numbers (FDN)',
279 4: 'Short Message Storage (SMS)',
280 5: 'Advice of Charge (AoC)',
281 6: 'Capability Configuration Parameters (CCP)',
282 7: 'PLMN selector',
283 8: 'RFU',
284 9: 'MSISDN',
285 10: 'Extension1',
286 11: 'Extension2',
287 12: 'SMS Parameters',
288 13: 'Last Number Dialled (LND)',
289 14: 'Cell Broadcast Message Identifier',
290 15: 'Group Identifier Level 1',
291 16: 'Group Identifier Level 2',
292 17: 'Service Provider Name',
293 18: 'Service Dialling Numbers (SDN)',
294 19: 'Extension3',
295 20: 'RFU',
296 21: 'VGCS Group Identifier List (EFVGCS and EFVGCSS)',
297 22: 'VBS Group Identifier List (EFVBS and EFVBSS)',
298 23: 'enhanced Multi-Level Precedence and Pre-emption Service',
299 24: 'Automatic Answer for eMLPP',
300 25: 'Data download via SMS-CB',
301 26: 'Data download via SMS-PP',
302 27: 'Menu selection',
303 28: 'Call control',
304 29: 'Proactive SIM',
305 30: 'Cell Broadcast Message Identifier Ranges',
306 31: 'Barred Dialling Numbers (BDN)',
307 32: 'Extension4',
308 33: 'De-personalization Control Keys',
309 34: 'Co-operative Network List',
310 35: 'Short Message Status Reports',
311 36: 'Network\'s indication of alerting in the MS',
312 37: 'Mobile Originated Short Message control by SIM',
313 38: 'GPRS',
314 39: 'Image (IMG)',
315 40: 'SoLSA (Support of Local Service Area)',
316 41: 'USSD string data object supported in Call Control',
317 42: 'RUN AT COMMAND command',
318 43: 'User controlled PLMN Selector with Access Technology',
319 44: 'Operator controlled PLMN Selector with Access Technology',
320 45: 'HPLMN Selector with Access Technology',
321 46: 'CPBCCH Information',
322 47: 'Investigation Scan',
323 48: 'Extended Capability Configuration Parameters',
324 49: 'MExE',
325 50: 'Reserved and shall be ignored',
326 51: 'PLMN Network Name',
327 52: 'Operator PLMN List',
328 53: 'Mailbox Dialling Numbers',
329 54: 'Message Waiting Indication Status',
330 55: 'Call Forwarding Indication Status',
331 56: 'Service Provider Display Information',
332 57: 'Multimedia Messaging Service (MMS)',
333 58: 'Extension 8',
334 59: 'MMS User Connectivity Parameters',
Vadim Yanitskiydfe3dbb2020-07-28 05:26:02 +0700335}
336
Harald Welteb2edd142021-01-08 23:29:35 +0100337
338######################################################################
339# DF.TELECOM
340######################################################################
341
342# TS 51.011 Section 10.5.1
343class EF_ADN(LinFixedEF):
Harald Welte6169c722022-02-12 09:05:15 +0100344 def __init__(self, fid='6f3a', sfid=None, name='EF.ADN', desc='Abbreviated Dialing Numbers', **kwargs):
345 super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len={14, 30}, **kwargs)
Harald Weltec91085e2022-02-10 18:05:45 +0100346
Harald Welteb2edd142021-01-08 23:29:35 +0100347 def _decode_record_bin(self, raw_bin_data):
348 alpha_id_len = len(raw_bin_data) - 14
349 alpha_id = raw_bin_data[:alpha_id_len]
350 u = unpack('!BB10sBB', raw_bin_data[-14:])
351 return {'alpha_id': alpha_id, 'len_of_bcd': u[0], 'ton_npi': u[1],
352 'dialing_nr': u[2], 'cap_conf_id': u[3], 'ext1_record_id': u[4]}
353
354# TS 51.011 Section 10.5.5
Harald Welteec7d0da2021-04-02 22:01:19 +0200355class EF_SMS(LinFixedEF):
Harald Welte6169c722022-02-12 09:05:15 +0100356 def __init__(self, fid='6f3c', sfid=None, name='EF.SMS', desc='Short messages', **kwargs):
357 super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len={176, 176}, **kwargs)
Harald Weltec91085e2022-02-10 18:05:45 +0100358
Harald Welteec7d0da2021-04-02 22:01:19 +0200359 def _decode_record_bin(self, raw_bin_data):
360 def decode_status(status):
361 if status & 0x01 == 0x00:
362 return (None, 'free_space')
363 elif status & 0x07 == 0x01:
364 return ('mt', 'message_read')
365 elif status & 0x07 == 0x03:
366 return ('mt', 'message_to_be_read')
367 elif status & 0x07 == 0x07:
368 return ('mo', 'message_to_be_sent')
369 elif status & 0x1f == 0x05:
370 return ('mo', 'sent_status_not_requested')
371 elif status & 0x1f == 0x0d:
372 return ('mo', 'sent_status_req_but_not_received')
373 elif status & 0x1f == 0x15:
374 return ('mo', 'sent_status_req_rx_not_stored_smsr')
375 elif status & 0x1f == 0x1d:
376 return ('mo', 'sent_status_req_rx_stored_smsr')
377 else:
378 return (None, 'rfu')
379
380 status = decode_status(raw_bin_data[0])
381 remainder = raw_bin_data[1:]
382 return {'direction': status[0], 'status': status[1], 'remainder': b2h(remainder)}
383
384
385# TS 51.011 Section 10.5.5
Harald Welteb2edd142021-01-08 23:29:35 +0100386class EF_MSISDN(LinFixedEF):
Harald Welte6169c722022-02-12 09:05:15 +0100387 def __init__(self, fid='6f40', sfid=None, name='EF.MSISDN', desc='MSISDN', **kwargs):
388 super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len={15, 34}, **kwargs)
Harald Weltec91085e2022-02-10 18:05:45 +0100389
Harald Welteb2edd142021-01-08 23:29:35 +0100390 def _decode_record_hex(self, raw_hex_data):
391 return {'msisdn': dec_msisdn(raw_hex_data)}
Harald Weltec91085e2022-02-10 18:05:45 +0100392
Harald Welteb2edd142021-01-08 23:29:35 +0100393 def _encode_record_hex(self, abstract):
Philipp Maierf9cbe092021-04-23 19:37:36 +0200394 msisdn = abstract['msisdn']
395 if type(msisdn) == str:
396 encoded_msisdn = enc_msisdn(msisdn)
397 else:
Harald Weltec91085e2022-02-10 18:05:45 +0100398 encoded_msisdn = enc_msisdn(msisdn[2], msisdn[0], msisdn[1])
399 alpha_identifier = (list(self.rec_len)[
400 0] - len(encoded_msisdn) // 2) * "ff"
Philipp Maierb46cb3f2021-04-20 22:38:21 +0200401 return alpha_identifier + encoded_msisdn
Harald Welteb2edd142021-01-08 23:29:35 +0100402
403# TS 51.011 Section 10.5.6
404class EF_SMSP(LinFixedEF):
Harald Welte6169c722022-02-12 09:05:15 +0100405 def __init__(self, fid='6f42', sfid=None, name='EF.SMSP', desc='Short message service parameters', **kwargs):
406 super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len={28, None}, **kwargs)
Harald Welteb2edd142021-01-08 23:29:35 +0100407
Harald Welte790b2702021-04-11 00:01:35 +0200408# TS 51.011 Section 10.5.7
409class EF_SMSS(TransparentEF):
410 class MemCapAdapter(Adapter):
411 def _decode(self, obj, context, path):
412 return False if obj & 1 else True
Harald Weltec91085e2022-02-10 18:05:45 +0100413
Harald Welte790b2702021-04-11 00:01:35 +0200414 def _encode(self, obj, context, path):
415 return 0 if obj else 1
Harald Weltec91085e2022-02-10 18:05:45 +0100416
Harald Welte6169c722022-02-12 09:05:15 +0100417 def __init__(self, fid='6f43', sfid=None, name='EF.SMSS', desc='SMS status', size={2, 8}, **kwargs):
418 super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, **kwargs)
Harald Weltec91085e2022-02-10 18:05:45 +0100419 self._construct = Struct(
420 'last_used_tpmr'/Int8ub, 'memory_capacity_exceeded'/self.MemCapAdapter(Int8ub))
Harald Welte790b2702021-04-11 00:01:35 +0200421
422# TS 51.011 Section 10.5.8
423class EF_SMSR(LinFixedEF):
Harald Welte6169c722022-02-12 09:05:15 +0100424 def __init__(self, fid='6f47', sfid=None, name='EF.SMSR', desc='SMS status reports', rec_len={30, 30}, **kwargs):
425 super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len=rec_len, **kwargs)
Harald Weltec91085e2022-02-10 18:05:45 +0100426 self._construct = Struct(
427 'sms_record_id'/Int8ub, 'sms_status_report'/HexAdapter(Bytes(29)))
428
Harald Welte790b2702021-04-11 00:01:35 +0200429
430class EF_EXT(LinFixedEF):
Harald Welte6169c722022-02-12 09:05:15 +0100431 def __init__(self, fid, sfid=None, name='EF.EXT', desc='Extension', rec_len={13, 13}, **kwargs):
432 super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, rec_len=rec_len, **kwargs)
Harald Weltec91085e2022-02-10 18:05:45 +0100433 self._construct = Struct(
434 'record_type'/Int8ub, 'extension_data'/HexAdapter(Bytes(11)), 'identifier'/Int8ub)
Harald Welte790b2702021-04-11 00:01:35 +0200435
436# TS 51.011 Section 10.5.16
437class EF_CMI(LinFixedEF):
Harald Weltec91085e2022-02-10 18:05:45 +0100438 def __init__(self, fid='6f58', sfid=None, name='EF.CMI', rec_len={2, 21},
Harald Welte6169c722022-02-12 09:05:15 +0100439 desc='Comparison Method Information', **kwargs):
440 super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len=rec_len, **kwargs)
Harald Weltec91085e2022-02-10 18:05:45 +0100441 self._construct = Struct(
442 'alpha_id'/Bytes(this._.total_len-1), 'comparison_method_id'/Int8ub)
443
Harald Welte790b2702021-04-11 00:01:35 +0200444
Harald Welteb2edd142021-01-08 23:29:35 +0100445class DF_TELECOM(CardDF):
Harald Welte6169c722022-02-12 09:05:15 +0100446 def __init__(self, fid='7f10', name='DF.TELECOM', desc=None, **kwargs):
447 super().__init__(fid=fid, name=name, desc=desc, **kwargs)
Harald Welteb2edd142021-01-08 23:29:35 +0100448 files = [
Harald Weltec91085e2022-02-10 18:05:45 +0100449 EF_ADN(),
450 EF_ADN(fid='6f3b', name='EF.FDN', desc='Fixed dialling numbers'),
451 EF_SMS(),
452 LinFixedEF(fid='6f3d', name='EF.CCP',
453 desc='Capability Configuration Parameters', rec_len={14, 14}),
454 LinFixedEF(fid='6f4f', name='EF.ECCP',
455 desc='Extended Capability Configuration Parameters', rec_len={15, 32}),
456 EF_MSISDN(),
457 EF_SMSP(),
458 EF_SMSS(),
459 # LND, SDN
460 EF_EXT('6f4a', None, 'EF.EXT1', 'Extension1 (ADN/SSC)'),
461 EF_EXT('6f4b', None, 'EF.EXT2', 'Extension2 (FDN/SSC)'),
462 EF_EXT('6f4c', None, 'EF.EXT3', 'Extension3 (SDN)'),
463 EF_ADN(fid='6f4d', name='EF.BDN', desc='Barred Dialling Numbers'),
464 EF_EXT('6f4e', None, 'EF.EXT4', 'Extension4 (BDN/SSC)'),
465 EF_SMSR(),
466 EF_CMI(),
467 ]
Harald Welteb2edd142021-01-08 23:29:35 +0100468 self.add_files(files)
469
Harald Welteb2edd142021-01-08 23:29:35 +0100470######################################################################
471# DF.GSM
472######################################################################
473
474# TS 51.011 Section 10.3.1
475class EF_LP(TransRecEF):
Harald Weltec91085e2022-02-10 18:05:45 +0100476 def __init__(self, fid='6f05', sfid=None, name='EF.LP', size={1, None}, rec_len=1,
Harald Welteb2edd142021-01-08 23:29:35 +0100477 desc='Language Preference'):
478 super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, rec_len=rec_len)
Harald Weltec91085e2022-02-10 18:05:45 +0100479
Harald Welteb2edd142021-01-08 23:29:35 +0100480 def _decode_record_bin(self, in_bin):
481 return b2h(in_bin)
Harald Weltec91085e2022-02-10 18:05:45 +0100482
Harald Welteb2edd142021-01-08 23:29:35 +0100483 def _encode_record_bin(self, in_json):
484 return h2b(in_json)
485
486# TS 51.011 Section 10.3.2
487class EF_IMSI(TransparentEF):
Harald Weltec91085e2022-02-10 18:05:45 +0100488 def __init__(self, fid='6f07', sfid=None, name='EF.IMSI', desc='IMSI', size={9, 9}):
Harald Welteb2edd142021-01-08 23:29:35 +0100489 super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size)
Bjoern Riemere91405e2021-12-17 15:16:35 +0100490 # add those commands to the general commands of a TransparentEF
491 self.shell_commands += [self.AddlShellCommands(self)]
Harald Weltec91085e2022-02-10 18:05:45 +0100492
Harald Welteb2edd142021-01-08 23:29:35 +0100493 def _decode_hex(self, raw_hex):
494 return {'imsi': dec_imsi(raw_hex)}
Harald Weltec91085e2022-02-10 18:05:45 +0100495
Harald Welteb2edd142021-01-08 23:29:35 +0100496 def _encode_hex(self, abstract):
497 return enc_imsi(abstract['imsi'])
Harald Weltec91085e2022-02-10 18:05:45 +0100498
Bjoern Riemere91405e2021-12-17 15:16:35 +0100499 @with_default_category('File-Specific Commands')
500 class AddlShellCommands(CommandSet):
Harald Weltec91085e2022-02-10 18:05:45 +0100501 def __init__(self, ef: TransparentEF):
Bjoern Riemere91405e2021-12-17 15:16:35 +0100502 super().__init__()
Harald Weltec91085e2022-02-10 18:05:45 +0100503 self._ef = ef
Bjoern Riemere91405e2021-12-17 15:16:35 +0100504
505 def do_update_imsi_plmn(self, arg: str):
506 """Change the plmn part of the IMSI"""
507 plmn = arg.strip()
508 if len(plmn) == 5 or len(plmn) == 6:
509 (data, sw) = self._cmd.rs.read_binary_dec()
510 if sw == '9000' and len(data['imsi'])-len(plmn) == 10:
511 imsi = data['imsi']
512 msin = imsi[len(plmn):]
Harald Weltec91085e2022-02-10 18:05:45 +0100513 (data, sw) = self._cmd.rs.update_binary_dec(
514 {'imsi': plmn+msin})
Bjoern Riemere91405e2021-12-17 15:16:35 +0100515 if sw == '9000' and data:
Harald Weltec91085e2022-02-10 18:05:45 +0100516 self._cmd.poutput_json(
517 self._cmd.rs.selected_file.decode_hex(data))
Bjoern Riemere91405e2021-12-17 15:16:35 +0100518 else:
519 raise ValueError("PLMN length does not match IMSI length")
520 else:
521 raise ValueError("PLMN has wrong length!")
522
Harald Welteb2edd142021-01-08 23:29:35 +0100523
524# TS 51.011 Section 10.3.4
525class EF_PLMNsel(TransRecEF):
526 def __init__(self, fid='6f30', sfid=None, name='EF.PLMNsel', desc='PLMN selector',
Harald Welte6169c722022-02-12 09:05:15 +0100527 size={24, None}, rec_len=3, **kwargs):
528 super().__init__(fid, name=name, sfid=sfid, desc=desc, size=size, rec_len=rec_len, **kwargs)
Harald Weltec91085e2022-02-10 18:05:45 +0100529
Harald Welteb2edd142021-01-08 23:29:35 +0100530 def _decode_record_hex(self, in_hex):
531 if in_hex[:6] == "ffffff":
532 return None
533 else:
534 return dec_plmn(in_hex)
Harald Weltec91085e2022-02-10 18:05:45 +0100535
Harald Welteb2edd142021-01-08 23:29:35 +0100536 def _encode_record_hex(self, in_json):
537 if in_json == None:
538 return "ffffff"
539 else:
540 return enc_plmn(in_json['mcc'], in_json['mnc'])
541
Harald Welte790b2702021-04-11 00:01:35 +0200542# TS 51.011 Section 10.3.6
543class EF_ACMmax(TransparentEF):
Harald Weltec91085e2022-02-10 18:05:45 +0100544 def __init__(self, fid='6f37', sfid=None, name='EF.ACMmax', size={3, 3},
Harald Welte6169c722022-02-12 09:05:15 +0100545 desc='ACM maximum value', **kwargs):
546 super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, **kwargs)
Harald Welte790b2702021-04-11 00:01:35 +0200547 self._construct = Struct('acm_max'/Int24ub)
548
Harald Welteb2edd142021-01-08 23:29:35 +0100549# TS 51.011 Section 10.3.7
550class EF_ServiceTable(TransparentEF):
551 def __init__(self, fid, sfid, name, desc, size, table):
552 super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size)
553 self.table = table
Harald Weltec91085e2022-02-10 18:05:45 +0100554
Harald Welte7a8aa862021-10-14 20:46:19 +0200555 @staticmethod
Harald Weltec91085e2022-02-10 18:05:45 +0100556 def _bit_byte_offset_for_service(service: int) -> Tuple[int, int]:
Harald Welte7a8aa862021-10-14 20:46:19 +0200557 i = service - 1
558 byte_offset = i//4
559 bit_offset = (i % 4) * 2
560 return (byte_offset, bit_offset)
Harald Weltec91085e2022-02-10 18:05:45 +0100561
Harald Welteb2edd142021-01-08 23:29:35 +0100562 def _decode_bin(self, raw_bin):
563 ret = {}
564 for i in range(0, len(raw_bin)*4):
565 service_nr = i+1
566 byte = int(raw_bin[i//4])
567 bit_offset = (i % 4) * 2
568 bits = (byte >> bit_offset) & 3
569 ret[service_nr] = {
Harald Weltec91085e2022-02-10 18:05:45 +0100570 'description': self.table[service_nr] if service_nr in self.table else None,
571 'allocated': True if bits & 1 else False,
572 'activated': True if bits & 2 else False,
573 }
Harald Welteb2edd142021-01-08 23:29:35 +0100574 return ret
Harald Weltec91085e2022-02-10 18:05:45 +0100575
Harald Welte7a8aa862021-10-14 20:46:19 +0200576 def _encode_bin(self, in_json):
577 # compute the required binary size
578 bin_len = 0
579 for srv in in_json.keys():
580 service_nr = int(srv)
Harald Weltec91085e2022-02-10 18:05:45 +0100581 (byte_offset, bit_offset) = EF_ServiceTable._bit_byte_offset_for_service(
582 service_nr)
Harald Welte7a8aa862021-10-14 20:46:19 +0200583 if byte_offset >= bin_len:
584 bin_len = byte_offset+1
585 # encode the actual data
586 out = bytearray(b'\x00' * bin_len)
587 for srv in in_json.keys():
588 service_nr = int(srv)
Harald Weltec91085e2022-02-10 18:05:45 +0100589 (byte_offset, bit_offset) = EF_ServiceTable._bit_byte_offset_for_service(
590 service_nr)
Harald Welte7a8aa862021-10-14 20:46:19 +0200591 bits = 0
592 if in_json[srv]['allocated'] == True:
593 bits |= 1
594 if in_json[srv]['activated'] == True:
595 bits |= 2
596 out[byte_offset] |= ((bits & 3) << bit_offset)
597 return out
Harald Welteb2edd142021-01-08 23:29:35 +0100598
599# TS 51.011 Section 10.3.11
600class EF_SPN(TransparentEF):
Harald Welte6169c722022-02-12 09:05:15 +0100601 def __init__(self, fid='6f46', sfid=None, name='EF.SPN',
602 desc='Service Provider Name', size={17, 17}, **kwargs):
603 super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, **kwargs)
Robert Falkenbergb07a3e92021-05-07 15:23:20 +0200604 self._construct = BitStruct(
605 # Byte 1
606 'rfu'/BitsRFU(6),
607 'hide_in_oplmn'/Flag,
608 'show_in_hplmn'/Flag,
609 # Bytes 2..17
610 'spn'/Bytewise(GsmString(16))
611 )
Harald Welteb2edd142021-01-08 23:29:35 +0100612
613# TS 51.011 Section 10.3.13
614class EF_CBMI(TransRecEF):
Harald Weltec91085e2022-02-10 18:05:45 +0100615 def __init__(self, fid='6f45', sfid=None, name='EF.CBMI', size={2, None}, rec_len=2,
Harald Welte6169c722022-02-12 09:05:15 +0100616 desc='Cell Broadcast message identifier selection', **kwargs):
617 super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, rec_len=rec_len, **kwargs)
Harald Welte14105dc2021-05-31 08:48:51 +0200618 self._construct = GreedyRange(Int16ub)
Harald Welteb2edd142021-01-08 23:29:35 +0100619
620# TS 51.011 Section 10.3.15
621class EF_ACC(TransparentEF):
Harald Welte6169c722022-02-12 09:05:15 +0100622 def __init__(self, fid='6f78', sfid=None, name='EF.ACC',
623 desc='Access Control Class', size={2, 2}, **kwargs):
624 super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, **kwargs)
Harald Weltec91085e2022-02-10 18:05:45 +0100625
Harald Welteb2edd142021-01-08 23:29:35 +0100626 def _decode_bin(self, raw_bin):
627 return {'acc': unpack('!H', raw_bin)[0]}
Harald Weltec91085e2022-02-10 18:05:45 +0100628
Harald Welteb2edd142021-01-08 23:29:35 +0100629 def _encode_bin(self, abstract):
630 return pack('!H', abstract['acc'])
631
Harald Welte790b2702021-04-11 00:01:35 +0200632# TS 51.011 Section 10.3.16
633class EF_LOCI(TransparentEF):
Harald Weltec91085e2022-02-10 18:05:45 +0100634 def __init__(self, fid='6f7e', sfid=None, name='EF.LOCI', desc='Location Information', size={11, 11}):
Harald Welte790b2702021-04-11 00:01:35 +0200635 super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size)
636 self._construct = Struct('tmsi'/Bytes(4), 'lai'/Bytes(5), 'tmsi_time'/Int8ub,
637 'lu_status'/Enum(Byte, updated=0, not_updated=1, plmn_not_allowed=2,
638 location_area_not_allowed=3))
639
Harald Welteb2edd142021-01-08 23:29:35 +0100640# TS 51.011 Section 10.3.18
641class EF_AD(TransparentEF):
Robert Falkenberg9d16fbc2021-04-12 11:43:22 +0200642 class OP_MODE(enum.IntEnum):
Harald Weltec91085e2022-02-10 18:05:45 +0100643 normal = 0x00
644 type_approval = 0x80
645 normal_and_specific_facilities = 0x01
646 type_approval_and_specific_facilities = 0x81
647 maintenance_off_line = 0x02
648 cell_test = 0x04
Robert Falkenberg9d16fbc2021-04-12 11:43:22 +0200649 #OP_MODE_DICT = {int(v) : str(v) for v in EF_AD.OP_MODE}
650 #OP_MODE_DICT_REVERSED = {str(v) : int(v) for v in EF_AD.OP_MODE}
651
Harald Weltec91085e2022-02-10 18:05:45 +0100652 def __init__(self, fid='6fad', sfid=None, name='EF.AD', desc='Administrative Data', size={3, 4}):
Harald Welteb2edd142021-01-08 23:29:35 +0100653 super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size)
Robert Falkenberg9d16fbc2021-04-12 11:43:22 +0200654 self._construct = BitStruct(
655 # Byte 1
656 'ms_operation_mode'/Bytewise(Enum(Byte, EF_AD.OP_MODE)),
657 # Byte 2
658 'rfu1'/Bytewise(ByteRFU),
659 # Byte 3
660 'rfu2'/BitsRFU(7),
661 'ofm'/Flag,
662 # Byte 4 (optional),
663 'extensions'/COptional(Struct(
664 'rfu3'/BitsRFU(4),
665 'mnc_len'/BitsInteger(4),
666 # Byte 5..N-4 (optional, RFU)
667 'extensions'/Bytewise(GreedyBytesRFU)
668 ))
669 )
Harald Welteb2edd142021-01-08 23:29:35 +0100670
Harald Welte790b2702021-04-11 00:01:35 +0200671# TS 51.011 Section 10.3.20 / 10.3.22
672class EF_VGCS(TransRecEF):
Harald Weltec91085e2022-02-10 18:05:45 +0100673 def __init__(self, fid='6fb1', sfid=None, name='EF.VGCS', size={4, 200}, rec_len=4,
Harald Welte6169c722022-02-12 09:05:15 +0100674 desc='Voice Group Call Service', **kwargs):
675 super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, rec_len=rec_len, **kwargs)
Harald Welte790b2702021-04-11 00:01:35 +0200676 self._construct = BcdAdapter(Bytes(4))
677
678# TS 51.011 Section 10.3.21 / 10.3.23
679class EF_VGCSS(TransparentEF):
Harald Weltec91085e2022-02-10 18:05:45 +0100680 def __init__(self, fid='6fb2', sfid=None, name='EF.VGCSS', size={7, 7},
Harald Welte6169c722022-02-12 09:05:15 +0100681 desc='Voice Group Call Service Status', **kwargs):
682 super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, **kwargs)
Harald Weltec91085e2022-02-10 18:05:45 +0100683 self._construct = BitStruct(
684 'flags'/Bit[50], Padding(6, pattern=b'\xff'))
Harald Welte790b2702021-04-11 00:01:35 +0200685
686# TS 51.011 Section 10.3.24
687class EF_eMLPP(TransparentEF):
Harald Weltec91085e2022-02-10 18:05:45 +0100688 def __init__(self, fid='6fb5', sfid=None, name='EF.eMLPP', size={2, 2},
Harald Welte6169c722022-02-12 09:05:15 +0100689 desc='enhanced Multi Level Pre-emption and Priority', **kwargs):
690 super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, **kwargs)
Harald Weltec91085e2022-02-10 18:05:45 +0100691 FlagsConstruct = FlagsEnum(
692 Byte, A=1, B=2, zero=4, one=8, two=16, three=32, four=64)
693 self._construct = Struct(
694 'levels'/FlagsConstruct, 'fast_call_setup_cond'/FlagsConstruct)
Harald Welte790b2702021-04-11 00:01:35 +0200695
696# TS 51.011 Section 10.3.25
697class EF_AAeM(TransparentEF):
Harald Weltec91085e2022-02-10 18:05:45 +0100698 def __init__(self, fid='6fb6', sfid=None, name='EF.AAeM', size={1, 1},
Harald Welte6169c722022-02-12 09:05:15 +0100699 desc='Automatic Answer for eMLPP Service', **kwargs):
700 super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, **kwargs)
Harald Weltec91085e2022-02-10 18:05:45 +0100701 FlagsConstruct = FlagsEnum(
702 Byte, A=1, B=2, zero=4, one=8, two=16, three=32, four=64)
Harald Welte790b2702021-04-11 00:01:35 +0200703 self._construct = Struct('auto_answer_prio_levels'/FlagsConstruct)
704
705# TS 51.011 Section 10.3.26
Harald Welteb2edd142021-01-08 23:29:35 +0100706class EF_CBMID(EF_CBMI):
Harald Weltec91085e2022-02-10 18:05:45 +0100707 def __init__(self, fid='6f48', sfid=None, name='EF.CBMID', size={2, None}, rec_len=2,
Harald Welte6169c722022-02-12 09:05:15 +0100708 desc='Cell Broadcast Message Identifier for Data Download', **kwargs):
709 super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, rec_len=rec_len, **kwargs)
Harald Welte14105dc2021-05-31 08:48:51 +0200710 self._construct = GreedyRange(Int16ub)
Harald Welteb2edd142021-01-08 23:29:35 +0100711
Harald Welte89e59542021-04-02 21:33:13 +0200712# TS 51.011 Section 10.3.27
713class EF_ECC(TransRecEF):
Harald Weltec91085e2022-02-10 18:05:45 +0100714 def __init__(self, fid='6fb7', sfid=None, name='EF.ECC', size={3, 15}, rec_len=3,
Harald Welte6169c722022-02-12 09:05:15 +0100715 desc='Emergency Call Codes', **kwargs):
716 super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, rec_len=rec_len, **kwargs)
Harald Welte14105dc2021-05-31 08:48:51 +0200717 self._construct = GreedyRange(BcdAdapter(Bytes(3)))
Harald Welteb2edd142021-01-08 23:29:35 +0100718
719# TS 51.011 Section 10.3.28
720class EF_CBMIR(TransRecEF):
Harald Weltec91085e2022-02-10 18:05:45 +0100721 def __init__(self, fid='6f50', sfid=None, name='EF.CBMIR', size={4, None}, rec_len=4,
Harald Welte6169c722022-02-12 09:05:15 +0100722 desc='Cell Broadcast message identifier range selection', **kwargs):
723 super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, rec_len=rec_len, **kwargs)
Harald Welte14105dc2021-05-31 08:48:51 +0200724 self._construct = GreedyRange(Struct('lower'/Int16ub, 'upper'/Int16ub))
Harald Welteb2edd142021-01-08 23:29:35 +0100725
Harald Welte790b2702021-04-11 00:01:35 +0200726# TS 51.011 Section 10.3.29
727class EF_DCK(TransparentEF):
Harald Weltec91085e2022-02-10 18:05:45 +0100728 def __init__(self, fid='6f2c', sfid=None, name='EF.DCK', size={16, 16},
Harald Welte6169c722022-02-12 09:05:15 +0100729 desc='Depersonalisation Control Keys', **kwargs):
730 super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, **kwargs)
Harald Welte790b2702021-04-11 00:01:35 +0200731 self._construct = Struct('network'/BcdAdapter(Bytes(4)),
732 'network_subset'/BcdAdapter(Bytes(4)),
733 'service_provider'/BcdAdapter(Bytes(4)),
734 'corporate'/BcdAdapter(Bytes(4)))
735# TS 51.011 Section 10.3.30
736class EF_CNL(TransRecEF):
Harald Weltec91085e2022-02-10 18:05:45 +0100737 def __init__(self, fid='6f32', sfid=None, name='EF.CNL', size={6, None}, rec_len=6,
Harald Welte6169c722022-02-12 09:05:15 +0100738 desc='Co-operative Network List', **kwargs):
739 super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, rec_len=rec_len, **kwargs)
Harald Weltec91085e2022-02-10 18:05:45 +0100740
Harald Welte790b2702021-04-11 00:01:35 +0200741 def _decode_record_hex(self, in_hex):
742 (in_plmn, sub, svp, corp) = unpack('!3sBBB', h2b(in_hex))
743 res = dec_plmn(b2h(in_plmn))
744 res['network_subset'] = sub
745 res['service_provider_id'] = svp
746 res['corporate_id'] = corp
747 return res
Harald Weltec91085e2022-02-10 18:05:45 +0100748
Harald Welte790b2702021-04-11 00:01:35 +0200749 def _encode_record_hex(self, in_json):
750 plmn = enc_plmn(in_json['mcc'], in_json['mnc'])
Vadim Yanitskiy1a95d2b2021-05-02 01:42:09 +0200751 return b2h(pack('!3sBBB',
752 h2b(plmn),
753 in_json['network_subset'],
754 in_json['service_provider_id'],
755 in_json['corporate_id']))
Harald Welte790b2702021-04-11 00:01:35 +0200756
757# TS 51.011 Section 10.3.31
758class EF_NIA(LinFixedEF):
Harald Weltec91085e2022-02-10 18:05:45 +0100759 def __init__(self, fid='6f51', sfid=None, name='EF.NIA', rec_len={1, 32},
Harald Welte6169c722022-02-12 09:05:15 +0100760 desc='Network\'s Indication of Alerting', **kwargs):
761 super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len=rec_len, **kwargs)
Harald Weltec91085e2022-02-10 18:05:45 +0100762 self._construct = Struct(
763 'alerting_category'/Int8ub, 'category'/GreedyBytes)
Harald Welte790b2702021-04-11 00:01:35 +0200764
765# TS 51.011 Section 10.3.32
766class EF_Kc(TransparentEF):
Harald Weltec91085e2022-02-10 18:05:45 +0100767 def __init__(self, fid='6f20', sfid=None, name='EF.Kc', desc='Ciphering key Kc', size={9, 9}):
Harald Welte790b2702021-04-11 00:01:35 +0200768 super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size)
769 self._construct = Struct('kc'/HexAdapter(Bytes(8)), 'cksn'/Int8ub)
770
771# TS 51.011 Section 10.3.33
772class EF_LOCIGPRS(TransparentEF):
Harald Weltec91085e2022-02-10 18:05:45 +0100773 def __init__(self, fid='6f53', sfid=None, name='EF.LOCIGPRS', desc='GPRS Location Information', size={14, 14}):
Harald Welte790b2702021-04-11 00:01:35 +0200774 super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size)
775 self._construct = Struct('ptmsi'/Bytes(4), 'ptmsi_sig'/Int8ub, 'rai'/Bytes(6),
776 'rau_status'/Enum(Byte, updated=0, not_updated=1, plmn_not_allowed=2,
777 routing_area_not_allowed=3))
Harald Welteb2edd142021-01-08 23:29:35 +0100778
779# TS 51.011 Section 10.3.35..37
780class EF_xPLMNwAcT(TransRecEF):
Harald Welte6169c722022-02-12 09:05:15 +0100781 def __init__(self, fid, sfid=None, name=None, desc=None, size={40, None}, rec_len=5, **kwargs):
782 super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, rec_len=rec_len, **kwargs)
Harald Weltec91085e2022-02-10 18:05:45 +0100783
Harald Welteb2edd142021-01-08 23:29:35 +0100784 def _decode_record_hex(self, in_hex):
785 if in_hex[:6] == "ffffff":
786 return None
787 else:
788 return dec_xplmn_w_act(in_hex)
Harald Weltec91085e2022-02-10 18:05:45 +0100789
Harald Welteb2edd142021-01-08 23:29:35 +0100790 def _encode_record_hex(self, in_json):
791 if in_json == None:
792 return "ffffff0000"
793 else:
794 hplmn = enc_plmn(in_json['mcc'], in_json['mnc'])
795 act = self.enc_act(in_json['act'])
796 return hplmn + act
Harald Weltec91085e2022-02-10 18:05:45 +0100797
Harald Welteb2edd142021-01-08 23:29:35 +0100798 @staticmethod
799 def enc_act(in_list):
800 u16 = 0
801 # first the simple ones
802 if 'UTRAN' in in_list:
803 u16 |= 0x8000
804 if 'NG-RAN' in in_list:
805 u16 |= 0x0800
806 if 'GSM COMPACT' in in_list:
807 u16 |= 0x0040
808 if 'cdma2000 HRPD' in in_list:
809 u16 |= 0x0020
810 if 'cdma2000 1xRTT' in in_list:
811 u16 |= 0x0010
812 # E-UTRAN
Philipp Maiere7d41792021-04-29 16:20:07 +0200813 if 'E-UTRAN' in in_list:
814 u16 |= 0x4000
Vadim Yanitskiy5452d642021-03-07 21:45:34 +0100815 if 'E-UTRAN WB-S1' in in_list:
816 u16 |= 0x6000
817 if 'E-UTRAN NB-S1' in in_list:
818 u16 |= 0x5000
Harald Welteb2edd142021-01-08 23:29:35 +0100819 # GSM mess
820 if 'GSM' in in_list and 'EC-GSM-IoT' in in_list:
821 u16 |= 0x008C
822 elif 'GSM' in in_list:
823 u16 |= 0x0084
824 elif 'EC-GSM-IuT' in in_list:
825 u16 |= 0x0088
Harald Weltec91085e2022-02-10 18:05:45 +0100826 return '%04X' % (u16)
Harald Welteb2edd142021-01-08 23:29:35 +0100827
Harald Welte790b2702021-04-11 00:01:35 +0200828# TS 51.011 Section 10.3.38
829class EF_CPBCCH(TransRecEF):
Harald Weltec91085e2022-02-10 18:05:45 +0100830 def __init__(self, fid='6f63', sfid=None, name='EF.CPBCCH', size={2, 14}, rec_len=2,
Harald Welte790b2702021-04-11 00:01:35 +0200831 desc='CPBCCH Information'):
832 super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, rec_len=rec_len)
833 self._construct = Struct('cpbcch'/Int16ub)
834
835# TS 51.011 Section 10.3.39
836class EF_InvScan(TransparentEF):
Harald Weltec91085e2022-02-10 18:05:45 +0100837 def __init__(self, fid='6f64', sfid=None, name='EF.InvScan', size={1, 1},
Harald Welte790b2702021-04-11 00:01:35 +0200838 desc='IOnvestigation Scan'):
839 super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size)
Harald Weltec91085e2022-02-10 18:05:45 +0100840 self._construct = FlagsEnum(
841 Byte, in_limited_service_mode=1, after_successful_plmn_selection=2)
Harald Welte790b2702021-04-11 00:01:35 +0200842
Harald Welte14105dc2021-05-31 08:48:51 +0200843# TS 51.011 Section 4.2.58
844class EF_PNN(LinFixedEF):
845 class FullNameForNetwork(BER_TLV_IE, tag=0x43):
846 # TS 24.008 10.5.3.5a
847 pass
Harald Weltec91085e2022-02-10 18:05:45 +0100848
Harald Welte14105dc2021-05-31 08:48:51 +0200849 class ShortNameForNetwork(BER_TLV_IE, tag=0x45):
850 # TS 24.008 10.5.3.5a
851 pass
Harald Weltec91085e2022-02-10 18:05:45 +0100852
Harald Welte14105dc2021-05-31 08:48:51 +0200853 class NetworkNameCollection(TLV_IE_Collection, nested=[FullNameForNetwork, ShortNameForNetwork]):
854 pass
Harald Weltec91085e2022-02-10 18:05:45 +0100855
Harald Welte6169c722022-02-12 09:05:15 +0100856 def __init__(self, fid='6fc5', sfid=None, name='EF.PNN', desc='PLMN Network Name', **kwargs):
857 super().__init__(fid, sfid=sfid, name=name, desc=desc, **kwargs)
Harald Welte14105dc2021-05-31 08:48:51 +0200858 self._tlv = EF_PNN.NetworkNameCollection
859
Harald Welte790b2702021-04-11 00:01:35 +0200860# TS 51.011 Section 10.3.42
861class EF_OPL(LinFixedEF):
Harald Welte6169c722022-02-12 09:05:15 +0100862 def __init__(self, fid='6fc6', sfid=None, name='EF.OPL', rec_len={8, 8}, desc='Operator PLMN List', **kwargs):
863 super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len=rec_len, **kwargs)
Harald Welte790b2702021-04-11 00:01:35 +0200864 self._construct = Struct('lai'/Bytes(5), 'pnn_record_id'/Int8ub)
865
866# TS 51.011 Section 10.3.44 + TS 31.102 4.2.62
867class EF_MBI(LinFixedEF):
Harald Welte6169c722022-02-12 09:05:15 +0100868 def __init__(self, fid='6fc9', sfid=None, name='EF.MBI', rec_len={4, 5}, desc='Mailbox Identifier', **kwargs):
869 super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len=rec_len, **kwargs)
Harald Welte790b2702021-04-11 00:01:35 +0200870 self._construct = Struct('mbi_voicemail'/Int8ub, 'mbi_fax'/Int8ub, 'mbi_email'/Int8ub,
871 'mbi_other'/Int8ub, 'mbi_videocall'/COptional(Int8ub))
872
873# TS 51.011 Section 10.3.45 + TS 31.102 4.2.63
874class EF_MWIS(LinFixedEF):
Harald Weltec91085e2022-02-10 18:05:45 +0100875 def __init__(self, fid='6fca', sfid=None, name='EF.MWIS', rec_len={5, 6},
Harald Welte6169c722022-02-12 09:05:15 +0100876 desc='Message Waiting Indication Status', **kwargs):
877 super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len=rec_len, **kwargs)
Harald Welte790b2702021-04-11 00:01:35 +0200878 self._construct = Struct('mwi_status'/FlagsEnum(Byte, voicemail=1, fax=2, email=4, other=8, videomail=16),
879 'num_waiting_voicemail'/Int8ub,
880 'num_waiting_fax'/Int8ub, 'num_waiting_email'/Int8ub,
881 'num_waiting_other'/Int8ub, 'num_waiting_videomail'/COptional(Int8ub))
882
Harald Welte14105dc2021-05-31 08:48:51 +0200883# TS 51.011 Section 10.3.66
884class EF_SPDI(TransparentEF):
885 class ServiceProviderPLMN(BER_TLV_IE, tag=0x80):
886 # flexible numbers of 3-byte PLMN records
887 _construct = GreedyRange(BcdAdapter(Bytes(3)))
Harald Weltec91085e2022-02-10 18:05:45 +0100888
Harald Welte14105dc2021-05-31 08:48:51 +0200889 class SPDI(BER_TLV_IE, tag=0xA3, nested=[ServiceProviderPLMN]):
890 pass
891 def __init__(self, fid='6fcd', sfid=None, name='EF.SPDI',
Harald Welte6169c722022-02-12 09:05:15 +0100892 desc='Service Provider Display Information', **kwargs):
893 super().__init__(fid, sfid=sfid, name=name, desc=desc, **kwargs)
Harald Welte14105dc2021-05-31 08:48:51 +0200894 self._tlv = EF_SPDI.SPDI
895
Harald Welte790b2702021-04-11 00:01:35 +0200896# TS 51.011 Section 10.3.51
897class EF_MMSN(LinFixedEF):
Harald Welte6169c722022-02-12 09:05:15 +0100898 def __init__(self, fid='6fce', sfid=None, name='EF.MMSN', rec_len={4, 20}, desc='MMS Notification', **kwargs):
899 super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len=rec_len, **kwargs)
Harald Welte790b2702021-04-11 00:01:35 +0200900 self._construct = Struct('mms_status'/Bytes(2), 'mms_implementation'/Bytes(1),
901 'mms_notification'/Bytes(this._.total_len-4), 'ext_record_nr'/Byte)
902
Harald Welte14105dc2021-05-31 08:48:51 +0200903# TS 51.011 Annex K.1
904class MMS_Implementation(BER_TLV_IE, tag=0x80):
905 _construct = FlagsEnum(Byte, WAP=1)
906
Harald Welte790b2702021-04-11 00:01:35 +0200907# TS 51.011 Section 10.3.53
908class EF_MMSICP(TransparentEF):
Harald Welte14105dc2021-05-31 08:48:51 +0200909 class MMS_Relay_Server(BER_TLV_IE, tag=0x81):
910 # 3GPP TS 23.140
911 pass
Harald Weltec91085e2022-02-10 18:05:45 +0100912
Harald Welte14105dc2021-05-31 08:48:51 +0200913 class Interface_to_CN(BER_TLV_IE, tag=0x82):
914 # 3GPP TS 23.140
915 pass
Harald Weltec91085e2022-02-10 18:05:45 +0100916
Harald Welte14105dc2021-05-31 08:48:51 +0200917 class Gateway(BER_TLV_IE, tag=0x83):
918 # Address, Type of address, Port, Service, AuthType, AuthId, AuthPass / 3GPP TS 23.140
919 pass
Harald Weltec91085e2022-02-10 18:05:45 +0100920
Harald Welte14105dc2021-05-31 08:48:51 +0200921 class MMS_ConnectivityParamters(TLV_IE_Collection,
Harald Weltec91085e2022-02-10 18:05:45 +0100922 nested=[MMS_Implementation, MMS_Relay_Server, Interface_to_CN, Gateway]):
Harald Welte14105dc2021-05-31 08:48:51 +0200923 pass
Harald Weltec91085e2022-02-10 18:05:45 +0100924 def __init__(self, fid='6fd0', sfid=None, name='EF.MMSICP', size={1, None},
Harald Welte6169c722022-02-12 09:05:15 +0100925 desc='MMS Issuer Connectivity Parameters', **kwargs):
926 super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, **kwargs)
Harald Welte14105dc2021-05-31 08:48:51 +0200927 self._tlv = EF_MMSICP.MMS_ConnectivityParamters
Harald Welte790b2702021-04-11 00:01:35 +0200928
929# TS 51.011 Section 10.3.54
930class EF_MMSUP(LinFixedEF):
Harald Welte14105dc2021-05-31 08:48:51 +0200931 class MMS_UserPref_ProfileName(BER_TLV_IE, tag=0x81):
932 pass
Harald Weltec91085e2022-02-10 18:05:45 +0100933
Harald Welte14105dc2021-05-31 08:48:51 +0200934 class MMS_UserPref_Info(BER_TLV_IE, tag=0x82):
935 pass
Harald Weltec91085e2022-02-10 18:05:45 +0100936
Harald Welte14105dc2021-05-31 08:48:51 +0200937 class MMS_User_Preferences(TLV_IE_Collection,
Harald Weltec91085e2022-02-10 18:05:45 +0100938 nested=[MMS_Implementation, MMS_UserPref_ProfileName, MMS_UserPref_Info]):
Harald Welte14105dc2021-05-31 08:48:51 +0200939 pass
Harald Weltec91085e2022-02-10 18:05:45 +0100940 def __init__(self, fid='6fd1', sfid=None, name='EF.MMSUP', rec_len={1, None},
Harald Welte6169c722022-02-12 09:05:15 +0100941 desc='MMS User Preferences', **kwargs):
942 super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len=rec_len, **kwargs)
Harald Welte6113fe92022-01-21 15:51:35 +0100943 self._tlv = EF_MMSUP.MMS_User_Preferences
Harald Welte790b2702021-04-11 00:01:35 +0200944
945# TS 51.011 Section 10.3.55
946class EF_MMSUCP(TransparentEF):
Harald Weltec91085e2022-02-10 18:05:45 +0100947 def __init__(self, fid='6fd2', sfid=None, name='EF.MMSUCP', size={1, None},
Harald Welte6169c722022-02-12 09:05:15 +0100948 desc='MMS User Connectivity Parameters', **kwargs):
949 super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, **kwargs)
Harald Welte790b2702021-04-11 00:01:35 +0200950
Harald Welteb2edd142021-01-08 23:29:35 +0100951
952class DF_GSM(CardDF):
953 def __init__(self, fid='7f20', name='DF.GSM', desc='GSM Network related files'):
954 super().__init__(fid=fid, name=name, desc=desc)
955 files = [
Harald Weltec91085e2022-02-10 18:05:45 +0100956 EF_LP(),
957 EF_IMSI(),
958 EF_Kc(),
959 EF_PLMNsel(),
960 TransparentEF('6f31', None, 'EF.HPPLMN',
961 'Higher Priority PLMN search period'),
962 EF_ACMmax(),
963 EF_ServiceTable('6f38', None, 'EF.SST',
964 'SIM service table', table=EF_SST_map, size={2, 16}),
965 CyclicEF('6f39', None, 'EF.ACM',
966 'Accumulated call meter', rec_len={3, 3}),
967 TransparentEF('6f3e', None, 'EF.GID1', 'Group Identifier Level 1'),
968 TransparentEF('6f3f', None, 'EF.GID2', 'Group Identifier Level 2'),
969 EF_SPN(),
970 TransparentEF('6f41', None, 'EF.PUCT',
971 'Price per unit and currency table', size={5, 5}),
972 EF_CBMI(),
973 TransparentEF('6f7f', None, 'EF.BCCH',
974 'Broadcast control channels', size={16, 16}),
975 EF_ACC(),
976 EF_PLMNsel('6f7b', None, 'EF.FPLMN',
977 'Forbidden PLMNs', size={12, 12}),
978 EF_LOCI(),
979 EF_AD(),
980 TransparentEF('6fa3', None, 'EF.Phase',
981 'Phase identification', size={1, 1}),
982 EF_VGCS(),
983 EF_VGCSS(),
984 EF_VGCS('6fb3', None, 'EF.VBS', 'Voice Broadcast Service'),
985 EF_VGCSS('6fb4', None, 'EF.VBSS',
986 'Voice Broadcast Service Status'),
987 EF_eMLPP(),
988 EF_AAeM(),
989 EF_CBMID(),
990 EF_ECC(),
991 EF_CBMIR(),
992 EF_DCK(),
993 EF_CNL(),
994 EF_NIA(),
995 EF_Kc('6f52', None, 'EF.KcGPRS', 'GPRS Ciphering key KcGPRS'),
996 EF_LOCIGPRS(),
997 TransparentEF('6f54', None, 'EF.SUME', 'SetUpMenu Elements'),
998 EF_xPLMNwAcT('6f60', None, 'EF.PLMNwAcT',
999 'User controlled PLMN Selector with Access Technology'),
1000 EF_xPLMNwAcT('6f61', None, 'EF.OPLMNwAcT',
1001 'Operator controlled PLMN Selector with Access Technology'),
1002 EF_xPLMNwAcT('6f62', None, 'EF.HPLMNwAcT',
1003 'HPLMN Selector with Access Technology'),
1004 EF_CPBCCH(),
1005 EF_InvScan(),
1006 EF_PNN(),
1007 EF_OPL(),
1008 EF_ADN('6fc7', None, 'EF.MBDN', 'Mailbox Dialling Numbers'),
1009 EF_MBI(),
1010 EF_MWIS(),
1011 EF_ADN('6fcb', None, 'EF.CFIS',
1012 'Call Forwarding Indication Status'),
1013 EF_EXT('6fc8', None, 'EF.EXT6', 'Externsion6 (MBDN)'),
1014 EF_EXT('6fcc', None, 'EF.EXT7', 'Externsion7 (CFIS)'),
1015 EF_SPDI(),
1016 EF_MMSN(),
1017 EF_EXT('6fcf', None, 'EF.EXT8', 'Extension8 (MMSN)'),
1018 EF_MMSICP(),
1019 EF_MMSUP(),
1020 EF_MMSUCP(),
1021 ]
Harald Welteb2edd142021-01-08 23:29:35 +01001022 self.add_files(files)
1023
Harald Weltec91085e2022-02-10 18:05:45 +01001024
Philipp Maierc8387dc2021-10-29 17:59:50 +02001025class CardProfileSIM(CardProfile):
Philipp Maiera028c7d2021-11-08 16:12:03 +01001026
1027 ORDER = 2
1028
Philipp Maierc8387dc2021-10-29 17:59:50 +02001029 def __init__(self):
Philipp Maiera4df9422021-11-10 17:13:40 +01001030 sw = {
Harald Weltec91085e2022-02-10 18:05:45 +01001031 'Normal': {
1032 '9000': 'Normal ending of the command',
1033 '91xx': 'normal ending of the command, with extra information from the proactive SIM containing a command for the ME',
1034 '9exx': 'length XX of the response data given in case of a SIM data download error',
1035 '9fxx': 'length XX of the response data',
Philipp Maiera4df9422021-11-10 17:13:40 +01001036 },
Harald Weltec91085e2022-02-10 18:05:45 +01001037 'Postponed processing': {
1038 '9300': 'SIM Application Toolkit is busy. Command cannot be executed at present, further normal commands are allowed',
Philipp Maiera4df9422021-11-10 17:13:40 +01001039 },
Harald Weltec91085e2022-02-10 18:05:45 +01001040 'Memory management': {
1041 '920x': 'command successful but after using an internal update retry routine X times',
1042 '9240': 'memory problem',
Philipp Maiera4df9422021-11-10 17:13:40 +01001043 },
Harald Weltec91085e2022-02-10 18:05:45 +01001044 'Referencing management': {
1045 '9400': 'no EF selected',
1046 '9402': 'out of range (invalid address)',
1047 '9404': 'file ID not found or pattern not found',
1048 '9408': 'file is inconsistent with the command',
Philipp Maiera4df9422021-11-10 17:13:40 +01001049 },
Harald Weltec91085e2022-02-10 18:05:45 +01001050 'Security management': {
1051 '9802': 'no CHV initialized',
1052 '9804': 'access condition not fulfilled, unsuccessful CHV verification or authentication failed',
1053 '9808': 'in contradiction with CHV status',
1054 '9810': 'in contradiction with invalidation status',
1055 '9840': 'unsuccessful verification, CHV blocked, UNBLOCK CHV blocked',
1056 '9850': 'increase cannot be performed, Max value reached',
Philipp Maiera4df9422021-11-10 17:13:40 +01001057 },
Harald Weltec91085e2022-02-10 18:05:45 +01001058 'Application independent errors': {
1059 '67xx': 'incorrect parameter P3',
1060 '6bxx': 'incorrect parameter P1 or P2',
1061 '6dxx': 'unknown instruction code given in the command',
1062 '6exx': 'wrong instruction class given in the command',
1063 '6fxx': 'technical problem with no diagnostic given',
Philipp Maiera4df9422021-11-10 17:13:40 +01001064 },
Harald Weltec91085e2022-02-10 18:05:45 +01001065 }
Philipp Maiera4df9422021-11-10 17:13:40 +01001066
Harald Weltec91085e2022-02-10 18:05:45 +01001067 super().__init__('SIM', desc='GSM SIM Card', cla="a0",
1068 sel_ctrl="0000", files_in_mf=[DF_TELECOM(), DF_GSM()], sw=sw)
Philipp Maier4ab971c2021-11-11 11:53:49 +01001069
Philipp Maier5998a3a2021-11-16 15:16:39 +01001070 @staticmethod
Harald Weltec91085e2022-02-10 18:05:45 +01001071 def decode_select_response(resp_hex: str) -> object:
Philipp Maier4ab971c2021-11-11 11:53:49 +01001072 resp_bin = h2b(resp_hex)
1073 struct_of_file_map = {
1074 0: 'transparent',
1075 1: 'linear_fixed',
1076 3: 'cyclic'
Harald Weltec91085e2022-02-10 18:05:45 +01001077 }
Philipp Maier4ab971c2021-11-11 11:53:49 +01001078 type_of_file_map = {
1079 1: 'mf',
1080 2: 'df',
1081 4: 'working_ef'
Harald Weltec91085e2022-02-10 18:05:45 +01001082 }
Philipp Maier4ab971c2021-11-11 11:53:49 +01001083 ret = {
1084 'file_descriptor': {},
1085 'proprietary_info': {},
Harald Weltec91085e2022-02-10 18:05:45 +01001086 }
Philipp Maier4ab971c2021-11-11 11:53:49 +01001087 ret['file_id'] = b2h(resp_bin[4:6])
Harald Weltec91085e2022-02-10 18:05:45 +01001088 ret['proprietary_info']['available_memory'] = int.from_bytes(
1089 resp_bin[2:4], 'big')
1090 file_type = type_of_file_map[resp_bin[6]
1091 ] if resp_bin[6] in type_of_file_map else resp_bin[6]
Philipp Maier4ab971c2021-11-11 11:53:49 +01001092 ret['file_descriptor']['file_type'] = file_type
1093 if file_type in ['mf', 'df']:
1094 ret['file_characteristics'] = b2h(resp_bin[13:14])
1095 ret['num_direct_child_df'] = resp_bin[14]
1096 ret['num_direct_child_ef'] = resp_bin[15]
1097 ret['num_chv_unblock_adm_codes'] = int(resp_bin[16])
1098 # CHV / UNBLOCK CHV stats
1099 elif file_type in ['working_ef']:
Harald Weltec91085e2022-02-10 18:05:45 +01001100 file_struct = struct_of_file_map[resp_bin[13]
1101 ] if resp_bin[13] in struct_of_file_map else resp_bin[13]
Philipp Maier4ab971c2021-11-11 11:53:49 +01001102 ret['file_descriptor']['structure'] = file_struct
1103 ret['access_conditions'] = b2h(resp_bin[8:10])
1104 if resp_bin[11] & 0x01 == 0:
1105 ret['life_cycle_status_int'] = 'operational_activated'
1106 elif resp_bin[11] & 0x04:
1107 ret['life_cycle_status_int'] = 'operational_deactivated'
1108 else:
1109 ret['life_cycle_status_int'] = 'terminated'
1110 return ret
Philipp Maiera028c7d2021-11-08 16:12:03 +01001111
1112 @staticmethod
Harald Weltec91085e2022-02-10 18:05:45 +01001113 def match_with_card(scc: SimCardCommands) -> bool:
Philipp Maiera028c7d2021-11-08 16:12:03 +01001114 return match_sim(scc)