Alexander Chemeris | 067f69c | 2017-07-18 16:44:26 +0300 | [diff] [blame] | 1 | # -*- coding: utf-8 -*- |
| 2 | |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 3 | # 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 Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 7 | """ Various constants from ETSI TS 151.011 + |
| 8 | Representation of the GSM SIM/USIM/ISIM filesystem hierarchy. |
| 9 | |
| 10 | The File (and its derived classes) uses the classes of pySim.filesystem in |
| 11 | order to describe the files specified in the relevant ETSI + 3GPP specifications. |
Alexander Chemeris | 067f69c | 2017-07-18 16:44:26 +0300 | [diff] [blame] | 12 | """ |
| 13 | |
| 14 | # |
| 15 | # Copyright (C) 2017 Alexander.Chemeris <Alexander.Chemeris@gmail.com> |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 16 | # Copyright (C) 2021 Harald Welte <laforge@osmocom.org> |
Alexander Chemeris | 067f69c | 2017-07-18 16:44:26 +0300 | [diff] [blame] | 17 | # |
| 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 | |
| 32 | MF_num = '3F00' |
| 33 | |
| 34 | DF_num = { |
| 35 | 'TELECOM': '7F10', |
| 36 | |
| 37 | 'GSM': '7F20', |
| 38 | 'IS-41': '7F22', |
| 39 | 'FP-CTS': '7F23', |
| 40 | |
| 41 | 'GRAPHICS': '5F50', |
| 42 | |
| 43 | 'IRIDIUM': '5F30', |
| 44 | 'GLOBST': '5F31', |
| 45 | 'ICO': '5F32', |
| 46 | 'ACeS': '5F33', |
| 47 | |
| 48 | 'EIA/TIA-553': '5F40', |
| 49 | 'CTS': '5F60', |
| 50 | 'SOLSA': '5F70', |
| 51 | |
| 52 | 'MExE': '5F3C', |
| 53 | } |
| 54 | |
| 55 | EF_num = { |
| 56 | # MF |
| 57 | 'ICCID': '2FE2', |
| 58 | 'ELP': '2F05', |
Sebastian Viviani | 0dc8f69 | 2020-05-29 00:14:55 +0100 | [diff] [blame] | 59 | 'DIR': '2F00', |
Alexander Chemeris | 067f69c | 2017-07-18 16:44:26 +0300 | [diff] [blame] | 60 | |
| 61 | # DF_TELECOM |
| 62 | 'ADN': '6F3A', |
| 63 | 'FDN': '6F3B', |
| 64 | 'SMS': '6F3C', |
| 65 | 'CCP': '6F3D', |
| 66 | 'MSISDN': '6F40', |
| 67 | 'SMSP': '6F42', |
| 68 | 'SMSS': '6F43', |
| 69 | 'LND': '6F44', |
| 70 | 'SMSR': '6F47', |
| 71 | 'SDN': '6F49', |
| 72 | 'EXT1': '6F4A', |
| 73 | 'EXT2': '6F4B', |
| 74 | 'EXT3': '6F4C', |
| 75 | 'BDN': '6F4D', |
| 76 | 'EXT4': '6F4E', |
| 77 | 'CMI': '6F58', |
| 78 | 'ECCP': '6F4F', |
| 79 | |
| 80 | # DF_GRAPHICS |
| 81 | 'IMG': '4F20', |
| 82 | |
| 83 | # DF_SoLSA |
| 84 | 'SAI': '4F30', |
| 85 | 'SLL': '4F31', |
| 86 | |
| 87 | # DF_MExE |
| 88 | 'MExE-ST': '4F40', |
| 89 | 'ORPK': '4F41', |
| 90 | 'ARPK': '4F42', |
| 91 | 'TPRPK': '4F43', |
| 92 | |
| 93 | # DF_GSM |
| 94 | 'LP': '6F05', |
| 95 | 'IMSI': '6F07', |
| 96 | 'Kc': '6F20', |
| 97 | 'DCK': '6F2C', |
| 98 | 'PLMNsel': '6F30', |
| 99 | 'HPPLMN': '6F31', |
| 100 | 'CNL': '6F32', |
| 101 | 'ACMmax': '6F37', |
| 102 | 'SST': '6F38', |
| 103 | 'ACM': '6F39', |
| 104 | 'GID1': '6F3E', |
| 105 | 'GID2': '6F3F', |
| 106 | 'PUCT': '6F41', |
| 107 | 'CBMI': '6F45', |
| 108 | 'SPN': '6F46', |
| 109 | 'CBMID': '6F48', |
| 110 | 'BCCH': '6F74', |
| 111 | 'ACC': '6F78', |
| 112 | 'FPLMN': '6F7B', |
| 113 | 'LOCI': '6F7E', |
| 114 | 'AD': '6FAD', |
| 115 | 'PHASE': '6FAE', |
| 116 | 'VGCS': '6FB1', |
| 117 | 'VGCSS': '6FB2', |
| 118 | 'VBS': '6FB3', |
| 119 | 'VBSS': '6FB4', |
| 120 | 'eMLPP': '6FB5', |
| 121 | 'AAeM': '6FB6', |
| 122 | 'ECC': '6FB7', |
| 123 | 'CBMIR': '6F50', |
| 124 | 'NIA': '6F51', |
| 125 | 'KcGPRS': '6F52', |
| 126 | 'LOCIGPRS': '6F53', |
| 127 | 'SUME': '6F54', |
| 128 | 'PLMNwAcT': '6F60', |
| 129 | 'OPLMNwAcT': '6F61', |
| 130 | # Figure 8 names it HPLMNAcT, but in the text it's names it HPLMNwAcT |
| 131 | 'HPLMNAcT': '6F62', |
| 132 | 'HPLMNwAcT': '6F62', |
| 133 | 'CPBCCH': '6F63', |
| 134 | 'INVSCAN': '6F64', |
| 135 | 'PNN': '6FC5', |
| 136 | 'OPL': '6FC6', |
| 137 | 'MBDN': '6FC7', |
| 138 | 'EXT6': '6FC8', |
| 139 | 'MBI': '6FC9', |
| 140 | 'MWIS': '6FCA', |
| 141 | 'CFIS': '6FCB', |
| 142 | 'EXT7': '6FCC', |
| 143 | 'SPDI': '6FCD', |
| 144 | 'MMSN': '6FCE', |
| 145 | 'EXT8': '6FCF', |
| 146 | 'MMSICP': '6FD0', |
| 147 | 'MMSUP': '6FD1', |
| 148 | 'MMSUCP': '6FD2', |
| 149 | } |
| 150 | |
| 151 | DF = { |
| 152 | 'TELECOM': [MF_num, DF_num['TELECOM']], |
| 153 | |
| 154 | 'GSM': [MF_num, DF_num['GSM']], |
| 155 | 'IS-41': [MF_num, DF_num['IS-41']], |
| 156 | 'FP-CTS': [MF_num, DF_num['FP-CTS']], |
| 157 | |
| 158 | 'GRAPHICS': [MF_num, DF_num['GRAPHICS']], |
| 159 | |
| 160 | 'IRIDIUM': [MF_num, DF_num['IRIDIUM']], |
| 161 | 'GLOBST': [MF_num, DF_num['GLOBST']], |
| 162 | 'ICO': [MF_num, DF_num['ICO']], |
| 163 | 'ACeS': [MF_num, DF_num['ACeS']], |
| 164 | |
| 165 | 'EIA/TIA-553': [MF_num, DF_num['EIA/TIA-553']], |
| 166 | 'CTS': [MF_num, DF_num['CTS']], |
| 167 | 'SoLSA': [MF_num, DF_num['SOLSA']], |
| 168 | |
| 169 | 'MExE': [MF_num, DF_num['MExE']], |
| 170 | } |
| 171 | |
| 172 | |
| 173 | EF = { |
| 174 | 'ICCID': [MF_num, EF_num['ICCID']], |
| 175 | 'ELP': [MF_num, EF_num['ELP']], |
Sebastian Viviani | 0dc8f69 | 2020-05-29 00:14:55 +0100 | [diff] [blame] | 176 | 'DIR': [MF_num, EF_num['DIR']], |
Alexander Chemeris | 067f69c | 2017-07-18 16:44:26 +0300 | [diff] [blame] | 177 | |
| 178 | 'ADN': DF['TELECOM']+[EF_num['ADN']], |
| 179 | 'FDN': DF['TELECOM']+[EF_num['FDN']], |
| 180 | 'SMS': DF['TELECOM']+[EF_num['SMS']], |
| 181 | 'CCP': DF['TELECOM']+[EF_num['CCP']], |
| 182 | 'MSISDN': DF['TELECOM']+[EF_num['MSISDN']], |
| 183 | 'SMSP': DF['TELECOM']+[EF_num['SMSP']], |
| 184 | 'SMSS': DF['TELECOM']+[EF_num['SMSS']], |
| 185 | 'LND': DF['TELECOM']+[EF_num['LND']], |
| 186 | 'SMSR': DF['TELECOM']+[EF_num['SMSR']], |
| 187 | 'SDN': DF['TELECOM']+[EF_num['SDN']], |
| 188 | 'EXT1': DF['TELECOM']+[EF_num['EXT1']], |
| 189 | 'EXT2': DF['TELECOM']+[EF_num['EXT2']], |
| 190 | 'EXT3': DF['TELECOM']+[EF_num['EXT3']], |
| 191 | 'BDN': DF['TELECOM']+[EF_num['BDN']], |
| 192 | 'EXT4': DF['TELECOM']+[EF_num['EXT4']], |
| 193 | 'CMI': DF['TELECOM']+[EF_num['CMI']], |
| 194 | 'ECCP': DF['TELECOM']+[EF_num['ECCP']], |
| 195 | |
| 196 | 'IMG': DF['GRAPHICS']+[EF_num['IMG']], |
| 197 | |
| 198 | 'SAI': DF['SoLSA']+[EF_num['SAI']], |
| 199 | 'SLL': DF['SoLSA']+[EF_num['SLL']], |
| 200 | |
| 201 | 'MExE-ST': DF['MExE']+[EF_num['MExE-ST']], |
| 202 | 'ORPK': DF['MExE']+[EF_num['ORPK']], |
| 203 | 'ARPK': DF['MExE']+[EF_num['ARPK']], |
| 204 | 'TPRPK': DF['MExE']+[EF_num['TPRPK']], |
| 205 | |
| 206 | 'LP': DF['GSM']+[EF_num['LP']], |
| 207 | 'IMSI': DF['GSM']+[EF_num['IMSI']], |
| 208 | 'Kc': DF['GSM']+[EF_num['Kc']], |
| 209 | 'DCK': DF['GSM']+[EF_num['DCK']], |
| 210 | 'PLMNsel': DF['GSM']+[EF_num['PLMNsel']], |
| 211 | 'HPPLMN': DF['GSM']+[EF_num['HPPLMN']], |
| 212 | 'CNL': DF['GSM']+[EF_num['CNL']], |
| 213 | 'ACMmax': DF['GSM']+[EF_num['ACMmax']], |
| 214 | 'SST': DF['GSM']+[EF_num['SST']], |
| 215 | 'ACM': DF['GSM']+[EF_num['ACM']], |
| 216 | 'GID1': DF['GSM']+[EF_num['GID1']], |
| 217 | 'GID2': DF['GSM']+[EF_num['GID2']], |
| 218 | 'PUCT': DF['GSM']+[EF_num['PUCT']], |
| 219 | 'CBMI': DF['GSM']+[EF_num['CBMI']], |
| 220 | 'SPN': DF['GSM']+[EF_num['SPN']], |
| 221 | 'CBMID': DF['GSM']+[EF_num['CBMID']], |
| 222 | 'BCCH': DF['GSM']+[EF_num['BCCH']], |
| 223 | 'ACC': DF['GSM']+[EF_num['ACC']], |
| 224 | 'FPLMN': DF['GSM']+[EF_num['FPLMN']], |
| 225 | 'LOCI': DF['GSM']+[EF_num['LOCI']], |
| 226 | 'AD': DF['GSM']+[EF_num['AD']], |
| 227 | 'PHASE': DF['GSM']+[EF_num['PHASE']], |
| 228 | 'VGCS': DF['GSM']+[EF_num['VGCS']], |
| 229 | 'VGCSS': DF['GSM']+[EF_num['VGCSS']], |
| 230 | 'VBS': DF['GSM']+[EF_num['VBS']], |
| 231 | 'VBSS': DF['GSM']+[EF_num['VBSS']], |
| 232 | 'eMLPP': DF['GSM']+[EF_num['eMLPP']], |
| 233 | 'AAeM': DF['GSM']+[EF_num['AAeM']], |
| 234 | 'ECC': DF['GSM']+[EF_num['ECC']], |
| 235 | 'CBMIR': DF['GSM']+[EF_num['CBMIR']], |
| 236 | 'NIA': DF['GSM']+[EF_num['NIA']], |
| 237 | 'KcGPRS': DF['GSM']+[EF_num['KcGPRS']], |
| 238 | 'LOCIGPRS': DF['GSM']+[EF_num['LOCIGPRS']], |
| 239 | 'SUME': DF['GSM']+[EF_num['SUME']], |
| 240 | 'PLMNwAcT': DF['GSM']+[EF_num['PLMNwAcT']], |
| 241 | 'OPLMNwAcT': DF['GSM']+[EF_num['OPLMNwAcT']], |
| 242 | # Figure 8 names it HPLMNAcT, but in the text it's names it HPLMNwAcT |
| 243 | 'HPLMNAcT': DF['GSM']+[EF_num['HPLMNAcT']], |
| 244 | 'HPLMNwAcT': DF['GSM']+[EF_num['HPLMNAcT']], |
| 245 | 'CPBCCH': DF['GSM']+[EF_num['CPBCCH']], |
| 246 | 'INVSCAN': DF['GSM']+[EF_num['INVSCAN']], |
| 247 | 'PNN': DF['GSM']+[EF_num['PNN']], |
| 248 | 'OPL': DF['GSM']+[EF_num['OPL']], |
| 249 | 'MBDN': DF['GSM']+[EF_num['MBDN']], |
| 250 | 'EXT6': DF['GSM']+[EF_num['EXT6']], |
| 251 | 'MBI': DF['GSM']+[EF_num['MBI']], |
| 252 | 'MWIS': DF['GSM']+[EF_num['MWIS']], |
| 253 | 'CFIS': DF['GSM']+[EF_num['CFIS']], |
| 254 | 'EXT7': DF['GSM']+[EF_num['EXT7']], |
| 255 | 'SPDI': DF['GSM']+[EF_num['SPDI']], |
| 256 | 'MMSN': DF['GSM']+[EF_num['MMSN']], |
| 257 | 'EXT8': DF['GSM']+[EF_num['EXT8']], |
| 258 | 'MMSICP': DF['GSM']+[EF_num['MMSICP']], |
| 259 | 'MMSUP': DF['GSM']+[EF_num['MMSUP']], |
| 260 | 'MMSUCP': DF['GSM']+[EF_num['MMSUCP']], |
| 261 | } |
Supreeth Herle | bf5d602 | 2020-03-20 15:18:27 +0100 | [diff] [blame] | 262 | |
| 263 | # Mapping between SIM Service Number and its description |
| 264 | EF_SST_map = { |
| 265 | 1: 'CHV1 disable function', |
| 266 | 2: 'Abbreviated Dialling Numbers (ADN)', |
| 267 | 3: 'Fixed Dialling Numbers (FDN)', |
| 268 | 4: 'Short Message Storage (SMS)', |
| 269 | 5: 'Advice of Charge (AoC)', |
| 270 | 6: 'Capability Configuration Parameters (CCP)', |
| 271 | 7: 'PLMN selector', |
| 272 | 8: 'RFU', |
| 273 | 9: 'MSISDN', |
| 274 | 10: 'Extension1', |
| 275 | 11: 'Extension2', |
| 276 | 12: 'SMS Parameters', |
| 277 | 13: 'Last Number Dialled (LND)', |
| 278 | 14: 'Cell Broadcast Message Identifier', |
| 279 | 15: 'Group Identifier Level 1', |
| 280 | 16: 'Group Identifier Level 2', |
| 281 | 17: 'Service Provider Name', |
| 282 | 18: 'Service Dialling Numbers (SDN)', |
| 283 | 19: 'Extension3', |
| 284 | 20: 'RFU', |
| 285 | 21: 'VGCS Group Identifier List (EFVGCS and EFVGCSS)', |
| 286 | 22: 'VBS Group Identifier List (EFVBS and EFVBSS)', |
| 287 | 23: 'enhanced Multi-Level Precedence and Pre-emption Service', |
| 288 | 24: 'Automatic Answer for eMLPP', |
| 289 | 25: 'Data download via SMS-CB', |
| 290 | 26: 'Data download via SMS-PP', |
| 291 | 27: 'Menu selection', |
| 292 | 28: 'Call control', |
| 293 | 29: 'Proactive SIM', |
| 294 | 30: 'Cell Broadcast Message Identifier Ranges', |
| 295 | 31: 'Barred Dialling Numbers (BDN)', |
| 296 | 32: 'Extension4', |
| 297 | 33: 'De-personalization Control Keys', |
| 298 | 34: 'Co-operative Network List', |
| 299 | 35: 'Short Message Status Reports', |
| 300 | 36: 'Network\'s indication of alerting in the MS', |
| 301 | 37: 'Mobile Originated Short Message control by SIM', |
| 302 | 38: 'GPRS', |
| 303 | 39: 'Image (IMG)', |
| 304 | 40: 'SoLSA (Support of Local Service Area)', |
| 305 | 41: 'USSD string data object supported in Call Control', |
| 306 | 42: 'RUN AT COMMAND command', |
| 307 | 43: 'User controlled PLMN Selector with Access Technology', |
| 308 | 44: 'Operator controlled PLMN Selector with Access Technology', |
| 309 | 45: 'HPLMN Selector with Access Technology', |
| 310 | 46: 'CPBCCH Information', |
| 311 | 47: 'Investigation Scan', |
| 312 | 48: 'Extended Capability Configuration Parameters', |
| 313 | 49: 'MExE', |
| 314 | 50: 'Reserved and shall be ignored', |
| 315 | 51: 'PLMN Network Name', |
| 316 | 52: 'Operator PLMN List', |
| 317 | 53: 'Mailbox Dialling Numbers', |
| 318 | 54: 'Message Waiting Indication Status', |
| 319 | 55: 'Call Forwarding Indication Status', |
| 320 | 56: 'Service Provider Display Information', |
| 321 | 57: 'Multimedia Messaging Service (MMS)', |
| 322 | 58: 'Extension 8', |
| 323 | 59: 'MMS User Connectivity Parameters', |
Vadim Yanitskiy | dfe3dbb | 2020-07-28 05:26:02 +0700 | [diff] [blame] | 324 | } |
| 325 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 326 | from pySim.utils import * |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 327 | from pySim.tlv import * |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 328 | from struct import pack, unpack |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 329 | from construct import * |
| 330 | from construct import Optional as COptional |
Robert Falkenberg | b07a3e9 | 2021-05-07 15:23:20 +0200 | [diff] [blame] | 331 | from pySim.construct import * |
Robert Falkenberg | 9d16fbc | 2021-04-12 11:43:22 +0200 | [diff] [blame] | 332 | import enum |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 333 | |
| 334 | from pySim.filesystem import * |
| 335 | import pySim.ts_102_221 |
| 336 | |
| 337 | ###################################################################### |
| 338 | # DF.TELECOM |
| 339 | ###################################################################### |
| 340 | |
| 341 | # TS 51.011 Section 10.5.1 |
| 342 | class EF_ADN(LinFixedEF): |
| 343 | def __init__(self, fid='6f3a', sfid=None, name='EF.ADN', desc='Abbreviated Dialing Numbers'): |
| 344 | super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len={14, 30}) |
| 345 | def _decode_record_bin(self, raw_bin_data): |
| 346 | alpha_id_len = len(raw_bin_data) - 14 |
| 347 | alpha_id = raw_bin_data[:alpha_id_len] |
| 348 | u = unpack('!BB10sBB', raw_bin_data[-14:]) |
| 349 | return {'alpha_id': alpha_id, 'len_of_bcd': u[0], 'ton_npi': u[1], |
| 350 | 'dialing_nr': u[2], 'cap_conf_id': u[3], 'ext1_record_id': u[4]} |
| 351 | |
| 352 | # TS 51.011 Section 10.5.5 |
Harald Welte | ec7d0da | 2021-04-02 22:01:19 +0200 | [diff] [blame] | 353 | class EF_SMS(LinFixedEF): |
| 354 | def __init__(self, fid='6f3c', sfid=None, name='EF.SMS', desc='Short messages'): |
| 355 | super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len={176,176}) |
| 356 | def _decode_record_bin(self, raw_bin_data): |
| 357 | def decode_status(status): |
| 358 | if status & 0x01 == 0x00: |
| 359 | return (None, 'free_space') |
| 360 | elif status & 0x07 == 0x01: |
| 361 | return ('mt', 'message_read') |
| 362 | elif status & 0x07 == 0x03: |
| 363 | return ('mt', 'message_to_be_read') |
| 364 | elif status & 0x07 == 0x07: |
| 365 | return ('mo', 'message_to_be_sent') |
| 366 | elif status & 0x1f == 0x05: |
| 367 | return ('mo', 'sent_status_not_requested') |
| 368 | elif status & 0x1f == 0x0d: |
| 369 | return ('mo', 'sent_status_req_but_not_received') |
| 370 | elif status & 0x1f == 0x15: |
| 371 | return ('mo', 'sent_status_req_rx_not_stored_smsr') |
| 372 | elif status & 0x1f == 0x1d: |
| 373 | return ('mo', 'sent_status_req_rx_stored_smsr') |
| 374 | else: |
| 375 | return (None, 'rfu') |
| 376 | |
| 377 | status = decode_status(raw_bin_data[0]) |
| 378 | remainder = raw_bin_data[1:] |
| 379 | return {'direction': status[0], 'status': status[1], 'remainder': b2h(remainder)} |
| 380 | |
| 381 | |
| 382 | # TS 51.011 Section 10.5.5 |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 383 | class EF_MSISDN(LinFixedEF): |
Harald Welte | ec7d0da | 2021-04-02 22:01:19 +0200 | [diff] [blame] | 384 | def __init__(self, fid='6f40', sfid=None, name='EF.MSISDN', desc='MSISDN'): |
Philipp Maier | b46cb3f | 2021-04-20 22:38:21 +0200 | [diff] [blame] | 385 | super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len={15, 34}) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 386 | def _decode_record_hex(self, raw_hex_data): |
| 387 | return {'msisdn': dec_msisdn(raw_hex_data)} |
| 388 | def _encode_record_hex(self, abstract): |
Philipp Maier | f9cbe09 | 2021-04-23 19:37:36 +0200 | [diff] [blame] | 389 | msisdn = abstract['msisdn'] |
| 390 | if type(msisdn) == str: |
| 391 | encoded_msisdn = enc_msisdn(msisdn) |
| 392 | else: |
| 393 | encoded_msisdn = enc_msisdn(msisdn[2],msisdn[0],msisdn[1]) |
Philipp Maier | b46cb3f | 2021-04-20 22:38:21 +0200 | [diff] [blame] | 394 | alpha_identifier = (list(self.rec_len)[0] - len(encoded_msisdn) // 2) * "ff" |
| 395 | return alpha_identifier + encoded_msisdn |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 396 | |
| 397 | # TS 51.011 Section 10.5.6 |
| 398 | class EF_SMSP(LinFixedEF): |
| 399 | def __init__(self, fid='6f42', sfid=None, name='EF.SMSP', desc='Short message service parameters'): |
| 400 | super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len={28, None}) |
| 401 | |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 402 | # TS 51.011 Section 10.5.7 |
| 403 | class EF_SMSS(TransparentEF): |
| 404 | class MemCapAdapter(Adapter): |
| 405 | def _decode(self, obj, context, path): |
| 406 | return False if obj & 1 else True |
| 407 | def _encode(self, obj, context, path): |
| 408 | return 0 if obj else 1 |
| 409 | def __init__(self, fid='6f43', sfid=None, name='EF.SMSS', desc='SMS status', size={2,8}): |
| 410 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size) |
| 411 | self._construct = Struct('last_used_tpmr'/Int8ub, 'memory_capacity_exceeded'/self.MemCapAdapter(Int8ub)) |
| 412 | |
| 413 | # TS 51.011 Section 10.5.8 |
| 414 | class EF_SMSR(LinFixedEF): |
| 415 | def __init__(self, fid='6f47', sfid=None, name='EF.SMSR', desc='SMS status reports', rec_len={30,30}): |
| 416 | super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len=rec_len) |
| 417 | self._construct = Struct('sms_record_id'/Int8ub, 'sms_status_report'/HexAdapter(Bytes(29))) |
| 418 | |
| 419 | class EF_EXT(LinFixedEF): |
| 420 | def __init__(self, fid, sfid=None, name='EF.EXT', desc='Extension', rec_len={13,13}): |
| 421 | super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, rec_len=rec_len) |
| 422 | self._construct = Struct('record_type'/Int8ub, 'extension_data'/HexAdapter(Bytes(11)), 'identifier'/Int8ub) |
| 423 | |
| 424 | # TS 51.011 Section 10.5.16 |
| 425 | class EF_CMI(LinFixedEF): |
| 426 | def __init__(self, fid='6f58', sfid=None, name='EF.CMI', rec_len={2,21}, |
Harald Welte | c9cdce3 | 2021-04-11 10:28:28 +0200 | [diff] [blame] | 427 | desc='Comparison Method Information'): |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 428 | super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len=rec_len) |
| 429 | self._construct = Struct('alpha_id'/Bytes(this._.total_len-1), 'comparison_method_id'/Int8ub) |
| 430 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 431 | class DF_TELECOM(CardDF): |
| 432 | def __init__(self, fid='7f10', name='DF.TELECOM', desc=None): |
| 433 | super().__init__(fid=fid, name=name, desc=desc) |
| 434 | files = [ |
| 435 | EF_ADN(), |
Harald Welte | ec7d0da | 2021-04-02 22:01:19 +0200 | [diff] [blame] | 436 | EF_ADN(fid='6f3b', name='EF_FDN', desc='Fixed dialling numbers'), |
| 437 | EF_SMS(), |
| 438 | LinFixedEF(fid='6f3d', name='EF.CCP', desc='Capability Configuration Parameters', rec_len={14,14}), |
| 439 | LinFixedEF(fid='6f4f', name='EF.ECCP', desc='Extended Capability Configuration Parameters', rec_len={15,32}), |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 440 | EF_MSISDN(), |
| 441 | EF_SMSP(), |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 442 | EF_SMSS(), |
| 443 | # LND, SDN |
| 444 | EF_EXT('6f4a', None, 'EF.EXT1', 'Extension1 (ADN/SSC)'), |
| 445 | EF_EXT('6f4b', None, 'EF.EXT2', 'Extension2 (FDN/SSC)'), |
| 446 | EF_EXT('6f4c', None, 'EF.EXT3', 'Extension3 (SDN)'), |
| 447 | EF_ADN(fid='6f4d', name='EF.BDN', desc='Barred Dialling Numbers'), |
| 448 | EF_EXT('6f4e', None, 'EF.EXT4', 'Extension4 (BDN/SSC)'), |
| 449 | EF_SMSR(), |
| 450 | EF_CMI(), |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 451 | ] |
| 452 | self.add_files(files) |
| 453 | |
| 454 | def decode_select_response(self, data_hex): |
| 455 | return decode_select_response(data_hex) |
| 456 | |
| 457 | ###################################################################### |
| 458 | # DF.GSM |
| 459 | ###################################################################### |
| 460 | |
| 461 | # TS 51.011 Section 10.3.1 |
| 462 | class EF_LP(TransRecEF): |
| 463 | def __init__(self, fid='6f05', sfid=None, name='EF.LP', size={1,None}, rec_len=1, |
| 464 | desc='Language Preference'): |
| 465 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, rec_len=rec_len) |
| 466 | def _decode_record_bin(self, in_bin): |
| 467 | return b2h(in_bin) |
| 468 | def _encode_record_bin(self, in_json): |
| 469 | return h2b(in_json) |
| 470 | |
| 471 | # TS 51.011 Section 10.3.2 |
| 472 | class EF_IMSI(TransparentEF): |
| 473 | def __init__(self, fid='6f07', sfid=None, name='EF.IMSI', desc='IMSI', size={9,9}): |
| 474 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size) |
| 475 | def _decode_hex(self, raw_hex): |
| 476 | return {'imsi': dec_imsi(raw_hex)} |
| 477 | def _encode_hex(self, abstract): |
| 478 | return enc_imsi(abstract['imsi']) |
| 479 | |
| 480 | # TS 51.011 Section 10.3.4 |
| 481 | class EF_PLMNsel(TransRecEF): |
| 482 | def __init__(self, fid='6f30', sfid=None, name='EF.PLMNsel', desc='PLMN selector', |
| 483 | size={24,None}, rec_len=3): |
| 484 | super().__init__(fid, name=name, sfid=sfid, desc=desc, size=size, rec_len=rec_len) |
| 485 | def _decode_record_hex(self, in_hex): |
| 486 | if in_hex[:6] == "ffffff": |
| 487 | return None |
| 488 | else: |
| 489 | return dec_plmn(in_hex) |
| 490 | def _encode_record_hex(self, in_json): |
| 491 | if in_json == None: |
| 492 | return "ffffff" |
| 493 | else: |
| 494 | return enc_plmn(in_json['mcc'], in_json['mnc']) |
| 495 | |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 496 | # TS 51.011 Section 10.3.6 |
| 497 | class EF_ACMmax(TransparentEF): |
| 498 | def __init__(self, fid='6f37', sfid=None, name='EF.ACMmax', size={3,3}, |
| 499 | desc='ACM maximum value'): |
| 500 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size) |
| 501 | self._construct = Struct('acm_max'/Int24ub) |
| 502 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 503 | # TS 51.011 Section 10.3.7 |
| 504 | class EF_ServiceTable(TransparentEF): |
| 505 | def __init__(self, fid, sfid, name, desc, size, table): |
| 506 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size) |
| 507 | self.table = table |
Harald Welte | 7a8aa86 | 2021-10-14 20:46:19 +0200 | [diff] [blame] | 508 | @staticmethod |
| 509 | def _bit_byte_offset_for_service(service:int) -> (int, int): |
| 510 | i = service - 1 |
| 511 | byte_offset = i//4 |
| 512 | bit_offset = (i % 4) * 2 |
| 513 | return (byte_offset, bit_offset) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 514 | def _decode_bin(self, raw_bin): |
| 515 | ret = {} |
| 516 | for i in range(0, len(raw_bin)*4): |
| 517 | service_nr = i+1 |
| 518 | byte = int(raw_bin[i//4]) |
| 519 | bit_offset = (i % 4) * 2 |
| 520 | bits = (byte >> bit_offset) & 3 |
| 521 | ret[service_nr] = { |
Harald Welte | f898c28 | 2021-10-14 16:13:23 +0200 | [diff] [blame] | 522 | 'description': self.table[service_nr] if service_nr in self.table else None, |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 523 | 'allocated': True if bits & 1 else False, |
| 524 | 'activated': True if bits & 2 else False, |
| 525 | } |
| 526 | return ret |
Harald Welte | 7a8aa86 | 2021-10-14 20:46:19 +0200 | [diff] [blame] | 527 | def _encode_bin(self, in_json): |
| 528 | # compute the required binary size |
| 529 | bin_len = 0 |
| 530 | for srv in in_json.keys(): |
| 531 | service_nr = int(srv) |
| 532 | (byte_offset, bit_offset) = EF_ServiceTable._bit_byte_offset_for_service(service_nr) |
| 533 | if byte_offset >= bin_len: |
| 534 | bin_len = byte_offset+1 |
| 535 | # encode the actual data |
| 536 | out = bytearray(b'\x00' * bin_len) |
| 537 | for srv in in_json.keys(): |
| 538 | service_nr = int(srv) |
| 539 | (byte_offset, bit_offset) = EF_ServiceTable._bit_byte_offset_for_service(service_nr) |
| 540 | bits = 0 |
| 541 | if in_json[srv]['allocated'] == True: |
| 542 | bits |= 1 |
| 543 | if in_json[srv]['activated'] == True: |
| 544 | bits |= 2 |
| 545 | out[byte_offset] |= ((bits & 3) << bit_offset) |
| 546 | return out |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 547 | |
| 548 | # TS 51.011 Section 10.3.11 |
| 549 | class EF_SPN(TransparentEF): |
| 550 | def __init__(self, fid='6f46', sfid=None, name='EF.SPN', desc='Service Provider Name', size={17,17}): |
| 551 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size) |
Robert Falkenberg | b07a3e9 | 2021-05-07 15:23:20 +0200 | [diff] [blame] | 552 | self._construct = BitStruct( |
| 553 | # Byte 1 |
| 554 | 'rfu'/BitsRFU(6), |
| 555 | 'hide_in_oplmn'/Flag, |
| 556 | 'show_in_hplmn'/Flag, |
| 557 | # Bytes 2..17 |
| 558 | 'spn'/Bytewise(GsmString(16)) |
| 559 | ) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 560 | |
| 561 | # TS 51.011 Section 10.3.13 |
| 562 | class EF_CBMI(TransRecEF): |
| 563 | def __init__(self, fid='6f45', sfid=None, name='EF.CBMI', size={2,None}, rec_len=2, |
| 564 | desc='Cell Broadcast message identifier selection'): |
| 565 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, rec_len=rec_len) |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 566 | self._construct = GreedyRange(Int16ub) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 567 | |
| 568 | # TS 51.011 Section 10.3.15 |
| 569 | class EF_ACC(TransparentEF): |
| 570 | def __init__(self, fid='6f78', sfid=None, name='EF.ACC', desc='Access Control Class', size={2,2}): |
| 571 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size) |
| 572 | def _decode_bin(self, raw_bin): |
| 573 | return {'acc': unpack('!H', raw_bin)[0]} |
| 574 | def _encode_bin(self, abstract): |
| 575 | return pack('!H', abstract['acc']) |
| 576 | |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 577 | # TS 51.011 Section 10.3.16 |
| 578 | class EF_LOCI(TransparentEF): |
| 579 | def __init__(self, fid='6f7e', sfid=None, name='EF.LOCI', desc='Location Information', size={11,11}): |
| 580 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size) |
| 581 | self._construct = Struct('tmsi'/Bytes(4), 'lai'/Bytes(5), 'tmsi_time'/Int8ub, |
| 582 | 'lu_status'/Enum(Byte, updated=0, not_updated=1, plmn_not_allowed=2, |
| 583 | location_area_not_allowed=3)) |
| 584 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 585 | # TS 51.011 Section 10.3.18 |
| 586 | class EF_AD(TransparentEF): |
Robert Falkenberg | 9d16fbc | 2021-04-12 11:43:22 +0200 | [diff] [blame] | 587 | class OP_MODE(enum.IntEnum): |
| 588 | normal = 0x00 |
| 589 | type_approval = 0x80 |
| 590 | normal_and_specific_facilities = 0x01 |
| 591 | type_approval_and_specific_facilities = 0x81 |
| 592 | maintenance_off_line = 0x02 |
| 593 | cell_test = 0x04 |
| 594 | #OP_MODE_DICT = {int(v) : str(v) for v in EF_AD.OP_MODE} |
| 595 | #OP_MODE_DICT_REVERSED = {str(v) : int(v) for v in EF_AD.OP_MODE} |
| 596 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 597 | def __init__(self, fid='6fad', sfid=None, name='EF.AD', desc='Administrative Data', size={3,4}): |
| 598 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size) |
Robert Falkenberg | 9d16fbc | 2021-04-12 11:43:22 +0200 | [diff] [blame] | 599 | self._construct = BitStruct( |
| 600 | # Byte 1 |
| 601 | 'ms_operation_mode'/Bytewise(Enum(Byte, EF_AD.OP_MODE)), |
| 602 | # Byte 2 |
| 603 | 'rfu1'/Bytewise(ByteRFU), |
| 604 | # Byte 3 |
| 605 | 'rfu2'/BitsRFU(7), |
| 606 | 'ofm'/Flag, |
| 607 | # Byte 4 (optional), |
| 608 | 'extensions'/COptional(Struct( |
| 609 | 'rfu3'/BitsRFU(4), |
| 610 | 'mnc_len'/BitsInteger(4), |
| 611 | # Byte 5..N-4 (optional, RFU) |
| 612 | 'extensions'/Bytewise(GreedyBytesRFU) |
| 613 | )) |
| 614 | ) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 615 | |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 616 | # TS 51.011 Section 10.3.20 / 10.3.22 |
| 617 | class EF_VGCS(TransRecEF): |
| 618 | def __init__(self, fid='6fb1', sfid=None, name='EF.VGCS', size={4,200}, rec_len=4, |
| 619 | desc='Voice Group Call Service'): |
| 620 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, rec_len=rec_len) |
| 621 | self._construct = BcdAdapter(Bytes(4)) |
| 622 | |
| 623 | # TS 51.011 Section 10.3.21 / 10.3.23 |
| 624 | class EF_VGCSS(TransparentEF): |
| 625 | def __init__(self, fid='6fb2', sfid=None, name='EF.VGCSS', size={7,7}, |
| 626 | desc='Voice Group Call Service Status'): |
| 627 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size) |
| 628 | self._construct = BitStruct('flags'/Bit[50], Padding(6, pattern=b'\xff')) |
| 629 | |
| 630 | # TS 51.011 Section 10.3.24 |
| 631 | class EF_eMLPP(TransparentEF): |
| 632 | def __init__(self, fid='6fb5', sfid=None, name='EF.eMLPP', size={2,2}, |
| 633 | desc='enhanced Multi Level Pre-emption and Priority'): |
| 634 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size) |
| 635 | FlagsConstruct = FlagsEnum(Byte, A=1, B=2, zero=4, one=8, two=16, three=32, four=64) |
| 636 | self._construct = Struct('levels'/FlagsConstruct, 'fast_call_setup_cond'/FlagsConstruct) |
| 637 | |
| 638 | # TS 51.011 Section 10.3.25 |
| 639 | class EF_AAeM(TransparentEF): |
| 640 | def __init__(self, fid='6fb6', sfid=None, name='EF.AAeM', size={1,1}, |
| 641 | desc='Automatic Answer for eMLPP Service'): |
| 642 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size) |
| 643 | FlagsConstruct = FlagsEnum(Byte, A=1, B=2, zero=4, one=8, two=16, three=32, four=64) |
| 644 | self._construct = Struct('auto_answer_prio_levels'/FlagsConstruct) |
| 645 | |
| 646 | # TS 51.011 Section 10.3.26 |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 647 | class EF_CBMID(EF_CBMI): |
| 648 | def __init__(self, fid='6f48', sfid=None, name='EF.CBMID', size={2,None}, rec_len=2, |
| 649 | desc='Cell Broadcast Message Identifier for Data Download'): |
| 650 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, rec_len=rec_len) |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 651 | self._construct = GreedyRange(Int16ub) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 652 | |
Harald Welte | 89e5954 | 2021-04-02 21:33:13 +0200 | [diff] [blame] | 653 | # TS 51.011 Section 10.3.27 |
| 654 | class EF_ECC(TransRecEF): |
| 655 | def __init__(self, fid='6fb7', sfid=None, name='EF.ECC', size={3,15}, rec_len=3, |
| 656 | desc='Emergency Call Codes'): |
| 657 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, rec_len=rec_len) |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 658 | self._construct = GreedyRange(BcdAdapter(Bytes(3))) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 659 | |
| 660 | # TS 51.011 Section 10.3.28 |
| 661 | class EF_CBMIR(TransRecEF): |
| 662 | def __init__(self, fid='6f50', sfid=None, name='EF.CBMIR', size={4,None}, rec_len=4, |
| 663 | desc='Cell Broadcast message identifier range selection'): |
| 664 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, rec_len=rec_len) |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 665 | self._construct = GreedyRange(Struct('lower'/Int16ub, 'upper'/Int16ub)) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 666 | |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 667 | # TS 51.011 Section 10.3.29 |
| 668 | class EF_DCK(TransparentEF): |
| 669 | def __init__(self, fid='6f2c', sfid=None, name='EF.DCK', size={16,16}, |
| 670 | desc='Depersonalisation Control Keys'): |
| 671 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size) |
| 672 | self._construct = Struct('network'/BcdAdapter(Bytes(4)), |
| 673 | 'network_subset'/BcdAdapter(Bytes(4)), |
| 674 | 'service_provider'/BcdAdapter(Bytes(4)), |
| 675 | 'corporate'/BcdAdapter(Bytes(4))) |
| 676 | # TS 51.011 Section 10.3.30 |
| 677 | class EF_CNL(TransRecEF): |
| 678 | def __init__(self, fid='6f32', sfid=None, name='EF.CNL', size={6,None}, rec_len=6, |
| 679 | desc='Co-operative Network List'): |
| 680 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, rec_len=rec_len) |
| 681 | def _decode_record_hex(self, in_hex): |
| 682 | (in_plmn, sub, svp, corp) = unpack('!3sBBB', h2b(in_hex)) |
| 683 | res = dec_plmn(b2h(in_plmn)) |
| 684 | res['network_subset'] = sub |
| 685 | res['service_provider_id'] = svp |
| 686 | res['corporate_id'] = corp |
| 687 | return res |
| 688 | def _encode_record_hex(self, in_json): |
| 689 | plmn = enc_plmn(in_json['mcc'], in_json['mnc']) |
Vadim Yanitskiy | 1a95d2b | 2021-05-02 01:42:09 +0200 | [diff] [blame] | 690 | return b2h(pack('!3sBBB', |
| 691 | h2b(plmn), |
| 692 | in_json['network_subset'], |
| 693 | in_json['service_provider_id'], |
| 694 | in_json['corporate_id'])) |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 695 | |
| 696 | # TS 51.011 Section 10.3.31 |
| 697 | class EF_NIA(LinFixedEF): |
| 698 | def __init__(self, fid='6f51', sfid=None, name='EF.NIA', rec_len={1,32}, |
| 699 | desc='Network\'s Indication of Alerting'): |
| 700 | super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len=rec_len) |
| 701 | self._construct = Struct('alerting_category'/Int8ub, 'category'/GreedyBytes) |
| 702 | |
| 703 | # TS 51.011 Section 10.3.32 |
| 704 | class EF_Kc(TransparentEF): |
| 705 | def __init__(self, fid='6f20', sfid=None, name='EF.Kc', desc='Ciphering key Kc', size={9,9}): |
| 706 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size) |
| 707 | self._construct = Struct('kc'/HexAdapter(Bytes(8)), 'cksn'/Int8ub) |
| 708 | |
| 709 | # TS 51.011 Section 10.3.33 |
| 710 | class EF_LOCIGPRS(TransparentEF): |
| 711 | def __init__(self, fid='6f53', sfid=None, name='EF.LOCIGPRS', desc='GPRS Location Information', size={14,14}): |
| 712 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size) |
| 713 | self._construct = Struct('ptmsi'/Bytes(4), 'ptmsi_sig'/Int8ub, 'rai'/Bytes(6), |
| 714 | 'rau_status'/Enum(Byte, updated=0, not_updated=1, plmn_not_allowed=2, |
| 715 | routing_area_not_allowed=3)) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 716 | |
| 717 | # TS 51.011 Section 10.3.35..37 |
| 718 | class EF_xPLMNwAcT(TransRecEF): |
| 719 | def __init__(self, fid, sfid=None, name=None, desc=None, size={40,None}, rec_len=5): |
| 720 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, rec_len=rec_len) |
| 721 | def _decode_record_hex(self, in_hex): |
| 722 | if in_hex[:6] == "ffffff": |
| 723 | return None |
| 724 | else: |
| 725 | return dec_xplmn_w_act(in_hex) |
| 726 | def _encode_record_hex(self, in_json): |
| 727 | if in_json == None: |
| 728 | return "ffffff0000" |
| 729 | else: |
| 730 | hplmn = enc_plmn(in_json['mcc'], in_json['mnc']) |
| 731 | act = self.enc_act(in_json['act']) |
| 732 | return hplmn + act |
| 733 | @staticmethod |
| 734 | def enc_act(in_list): |
| 735 | u16 = 0 |
| 736 | # first the simple ones |
| 737 | if 'UTRAN' in in_list: |
| 738 | u16 |= 0x8000 |
| 739 | if 'NG-RAN' in in_list: |
| 740 | u16 |= 0x0800 |
| 741 | if 'GSM COMPACT' in in_list: |
| 742 | u16 |= 0x0040 |
| 743 | if 'cdma2000 HRPD' in in_list: |
| 744 | u16 |= 0x0020 |
| 745 | if 'cdma2000 1xRTT' in in_list: |
| 746 | u16 |= 0x0010 |
| 747 | # E-UTRAN |
Philipp Maier | e7d4179 | 2021-04-29 16:20:07 +0200 | [diff] [blame] | 748 | if 'E-UTRAN' in in_list: |
| 749 | u16 |= 0x4000 |
Vadim Yanitskiy | 5452d64 | 2021-03-07 21:45:34 +0100 | [diff] [blame] | 750 | if 'E-UTRAN WB-S1' in in_list: |
| 751 | u16 |= 0x6000 |
| 752 | if 'E-UTRAN NB-S1' in in_list: |
| 753 | u16 |= 0x5000 |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 754 | # GSM mess |
| 755 | if 'GSM' in in_list and 'EC-GSM-IoT' in in_list: |
| 756 | u16 |= 0x008C |
| 757 | elif 'GSM' in in_list: |
| 758 | u16 |= 0x0084 |
| 759 | elif 'EC-GSM-IuT' in in_list: |
| 760 | u16 |= 0x0088 |
| 761 | return '%04X'%(u16) |
| 762 | |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 763 | # TS 51.011 Section 10.3.38 |
| 764 | class EF_CPBCCH(TransRecEF): |
| 765 | def __init__(self, fid='6f63', sfid=None, name='EF.CPBCCH', size={2,14}, rec_len=2, |
| 766 | desc='CPBCCH Information'): |
| 767 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, rec_len=rec_len) |
| 768 | self._construct = Struct('cpbcch'/Int16ub) |
| 769 | |
| 770 | # TS 51.011 Section 10.3.39 |
| 771 | class EF_InvScan(TransparentEF): |
| 772 | def __init__(self, fid='6f64', sfid=None, name='EF.InvScan', size={1,1}, |
| 773 | desc='IOnvestigation Scan'): |
| 774 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size) |
| 775 | self._construct = FlagsEnum(Byte, in_limited_service_mode=1, after_successful_plmn_selection=2) |
| 776 | |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 777 | # TS 51.011 Section 4.2.58 |
| 778 | class EF_PNN(LinFixedEF): |
| 779 | class FullNameForNetwork(BER_TLV_IE, tag=0x43): |
| 780 | # TS 24.008 10.5.3.5a |
| 781 | pass |
| 782 | class ShortNameForNetwork(BER_TLV_IE, tag=0x45): |
| 783 | # TS 24.008 10.5.3.5a |
| 784 | pass |
| 785 | class NetworkNameCollection(TLV_IE_Collection, nested=[FullNameForNetwork, ShortNameForNetwork]): |
| 786 | pass |
| 787 | def __init__(self, fid='6fc5', sfid=None, name='EF.PNN', desc='PLMN Network Name'): |
| 788 | super().__init__(fid, sfid=sfid, name=name, desc=desc) |
| 789 | self._tlv = EF_PNN.NetworkNameCollection |
| 790 | |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 791 | # TS 51.011 Section 10.3.42 |
| 792 | class EF_OPL(LinFixedEF): |
| 793 | def __init__(self, fid='6fc6', sfid=None, name='EF.OPL', rec_len={8,8}, desc='Operator PLMN List'): |
| 794 | super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len=rec_len) |
| 795 | self._construct = Struct('lai'/Bytes(5), 'pnn_record_id'/Int8ub) |
| 796 | |
| 797 | # TS 51.011 Section 10.3.44 + TS 31.102 4.2.62 |
| 798 | class EF_MBI(LinFixedEF): |
| 799 | def __init__(self, fid='6fc9', sfid=None, name='EF.MBI', rec_len={4,5}, desc='Mailbox Identifier'): |
| 800 | super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len=rec_len) |
| 801 | self._construct = Struct('mbi_voicemail'/Int8ub, 'mbi_fax'/Int8ub, 'mbi_email'/Int8ub, |
| 802 | 'mbi_other'/Int8ub, 'mbi_videocall'/COptional(Int8ub)) |
| 803 | |
| 804 | # TS 51.011 Section 10.3.45 + TS 31.102 4.2.63 |
| 805 | class EF_MWIS(LinFixedEF): |
| 806 | def __init__(self, fid='6fca', sfid=None, name='EF.MWIS', rec_len={5,6}, |
| 807 | desc='Message Waiting Indication Status'): |
| 808 | super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len=rec_len) |
| 809 | self._construct = Struct('mwi_status'/FlagsEnum(Byte, voicemail=1, fax=2, email=4, other=8, videomail=16), |
| 810 | 'num_waiting_voicemail'/Int8ub, |
| 811 | 'num_waiting_fax'/Int8ub, 'num_waiting_email'/Int8ub, |
| 812 | 'num_waiting_other'/Int8ub, 'num_waiting_videomail'/COptional(Int8ub)) |
| 813 | |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 814 | # TS 51.011 Section 10.3.66 |
| 815 | class EF_SPDI(TransparentEF): |
| 816 | class ServiceProviderPLMN(BER_TLV_IE, tag=0x80): |
| 817 | # flexible numbers of 3-byte PLMN records |
| 818 | _construct = GreedyRange(BcdAdapter(Bytes(3))) |
| 819 | class SPDI(BER_TLV_IE, tag=0xA3, nested=[ServiceProviderPLMN]): |
| 820 | pass |
| 821 | def __init__(self, fid='6fcd', sfid=None, name='EF.SPDI', |
| 822 | desc='Service Provider Display Information'): |
| 823 | super().__init__(fid, sfid=sfid, name=name, desc=desc) |
| 824 | self._tlv = EF_SPDI.SPDI |
| 825 | |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 826 | # TS 51.011 Section 10.3.51 |
| 827 | class EF_MMSN(LinFixedEF): |
| 828 | def __init__(self, fid='6fce', sfid=None, name='EF.MMSN', rec_len={4,20}, desc='MMS Notification'): |
| 829 | super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len=rec_len) |
| 830 | self._construct = Struct('mms_status'/Bytes(2), 'mms_implementation'/Bytes(1), |
| 831 | 'mms_notification'/Bytes(this._.total_len-4), 'ext_record_nr'/Byte) |
| 832 | |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 833 | # TS 51.011 Annex K.1 |
| 834 | class MMS_Implementation(BER_TLV_IE, tag=0x80): |
| 835 | _construct = FlagsEnum(Byte, WAP=1) |
| 836 | |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 837 | # TS 51.011 Section 10.3.53 |
| 838 | class EF_MMSICP(TransparentEF): |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 839 | class MMS_Relay_Server(BER_TLV_IE, tag=0x81): |
| 840 | # 3GPP TS 23.140 |
| 841 | pass |
| 842 | class Interface_to_CN(BER_TLV_IE, tag=0x82): |
| 843 | # 3GPP TS 23.140 |
| 844 | pass |
| 845 | class Gateway(BER_TLV_IE, tag=0x83): |
| 846 | # Address, Type of address, Port, Service, AuthType, AuthId, AuthPass / 3GPP TS 23.140 |
| 847 | pass |
| 848 | class MMS_ConnectivityParamters(TLV_IE_Collection, |
| 849 | nested=[MMS_Implementation, MMS_Relay_Server, Interface_to_CN, Gateway]): |
| 850 | pass |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 851 | def __init__(self, fid='6fd0', sfid=None, name='EF.MMSICP', size={1,None}, |
| 852 | desc='MMS Issuer Connectivity Parameters'): |
| 853 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size) |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 854 | self._tlv = EF_MMSICP.MMS_ConnectivityParamters |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 855 | |
| 856 | # TS 51.011 Section 10.3.54 |
| 857 | class EF_MMSUP(LinFixedEF): |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 858 | class MMS_UserPref_ProfileName(BER_TLV_IE, tag=0x81): |
| 859 | pass |
| 860 | class MMS_UserPref_Info(BER_TLV_IE, tag=0x82): |
| 861 | pass |
| 862 | class MMS_User_Preferences(TLV_IE_Collection, |
| 863 | nested=[MMS_Implementation,MMS_UserPref_ProfileName,MMS_UserPref_Info]): |
| 864 | pass |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 865 | def __init__(self, fid='6fd1', sfid=None, name='EF.MMSUP', rec_len={1,None}, |
| 866 | desc='MMS User Preferences'): |
| 867 | super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len=rec_len) |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 868 | self.tlv = EF_MMSUP.MMS_User_Preferences |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 869 | |
| 870 | # TS 51.011 Section 10.3.55 |
| 871 | class EF_MMSUCP(TransparentEF): |
| 872 | def __init__(self, fid='6fd2', sfid=None, name='EF.MMSUCP', size={1,None}, |
| 873 | desc='MMS User Connectivity Parameters'): |
| 874 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size) |
| 875 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 876 | |
| 877 | class DF_GSM(CardDF): |
| 878 | def __init__(self, fid='7f20', name='DF.GSM', desc='GSM Network related files'): |
| 879 | super().__init__(fid=fid, name=name, desc=desc) |
| 880 | files = [ |
| 881 | EF_LP(), |
| 882 | EF_IMSI(), |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 883 | EF_Kc(), |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 884 | EF_PLMNsel(), |
| 885 | TransparentEF('6f31', None, 'EF.HPPLMN', 'Higher Priority PLMN search period'), |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 886 | EF_ACMmax(), |
| 887 | EF_ServiceTable('6f38', None, 'EF.SST', 'SIM service table', table=EF_SST_map, size={2,16}), |
| 888 | CyclicEF('6f39', None, 'EF.ACM', 'Accumulated call meter', rec_len={3,3}), |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 889 | TransparentEF('6f3e', None, 'EF.GID1', 'Group Identifier Level 1'), |
| 890 | TransparentEF('6f3f', None, 'EF.GID2', 'Group Identifier Level 2'), |
| 891 | EF_SPN(), |
| 892 | TransparentEF('6f41', None, 'EF.PUCT', 'Price per unit and currency table', size={5,5}), |
| 893 | EF_CBMI(), |
| 894 | TransparentEF('6f7f', None, 'EF.BCCH', 'Broadcast control channels', size={16,16}), |
| 895 | EF_ACC(), |
| 896 | EF_PLMNsel('6f7b', None, 'EF.FPLMN', 'Forbidden PLMNs', size={12,12}), |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 897 | EF_LOCI(), |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 898 | EF_AD(), |
| 899 | TransparentEF('6fa3', None, 'EF.Phase', 'Phase identification', size={1,1}), |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 900 | EF_VGCS(), |
| 901 | EF_VGCSS(), |
| 902 | EF_VGCS('6fb3', None, 'EF.VBS', 'Voice Broadcast Service'), |
| 903 | EF_VGCSS('6fb4', None, 'EF.VBSS', 'Voice Broadcast Service Status'), |
| 904 | EF_eMLPP(), |
| 905 | EF_AAeM(), |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 906 | EF_CBMID(), |
| 907 | EF_ECC(), |
| 908 | EF_CBMIR(), |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 909 | EF_DCK(), |
| 910 | EF_CNL(), |
| 911 | EF_NIA(), |
| 912 | EF_Kc('6f52', None, 'EF.KcGPRS', 'GPRS Ciphering key KcGPRS'), |
| 913 | EF_LOCIGPRS(), |
| 914 | TransparentEF('6f54', None, 'EF.SUME', 'SetUpMenu Elements'), |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 915 | EF_xPLMNwAcT('6f60', None, 'EF.PLMNwAcT', |
| 916 | 'User controlled PLMN Selector with Access Technology'), |
| 917 | EF_xPLMNwAcT('6f61', None, 'EF.OPLMNwAcT', |
| 918 | 'Operator controlled PLMN Selector with Access Technology'), |
| 919 | EF_xPLMNwAcT('6f62', None, 'EF.HPLMNwAcT', 'HPLMN Selector with Access Technology'), |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 920 | EF_CPBCCH(), |
| 921 | EF_InvScan(), |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 922 | EF_PNN(), |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 923 | EF_OPL(), |
| 924 | EF_ADN('6fc7', None, 'EF.MBDN', 'Mailbox Dialling Numbers'), |
| 925 | EF_MBI(), |
| 926 | EF_MWIS(), |
| 927 | EF_ADN('6fcb', None, 'EF.CFIS', 'Call Forwarding Indication Status'), |
| 928 | EF_EXT('6fc8', None, 'EF.EXT6', 'Externsion6 (MBDN)'), |
| 929 | EF_EXT('6fcc', None, 'EF.EXT7', 'Externsion7 (CFIS)'), |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 930 | EF_SPDI(), |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 931 | EF_MMSN(), |
| 932 | EF_EXT('6fcf', None, 'EF.EXT8', 'Extension8 (MMSN)'), |
| 933 | EF_MMSICP(), |
| 934 | EF_MMSUP(), |
| 935 | EF_MMSUCP(), |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 936 | ] |
| 937 | self.add_files(files) |
| 938 | |
| 939 | def decode_select_response(self, data_hex): |
| 940 | return decode_select_response(data_hex) |
| 941 | |
| 942 | def decode_select_response(resp_hex): |
| 943 | resp_bin = h2b(resp_hex) |
| 944 | if resp_bin[0] == 0x62: |
| 945 | return pySim.ts_102_221.decode_select_response(resp_hex) |
| 946 | struct_of_file_map = { |
| 947 | 0: 'transparent', |
| 948 | 1: 'linear_fixed', |
| 949 | 3: 'cyclic' |
| 950 | } |
| 951 | type_of_file_map = { |
| 952 | 1: 'mf', |
| 953 | 2: 'df', |
| 954 | 4: 'working_ef' |
| 955 | } |
| 956 | ret = { |
| 957 | 'file_descriptor': {}, |
| 958 | 'proprietary_info': {}, |
| 959 | } |
| 960 | ret['file_id'] = b2h(resp_bin[4:6]) |
| 961 | ret['proprietary_info']['available_memory'] = int.from_bytes(resp_bin[2:4], 'big') |
| 962 | file_type = type_of_file_map[resp_bin[6]] if resp_bin[6] in type_of_file_map else resp_bin[6] |
| 963 | ret['file_descriptor']['file_type'] = file_type |
| 964 | if file_type in ['mf', 'df']: |
Philipp Maier | 3c30988 | 2021-10-14 17:55:04 +0200 | [diff] [blame] | 965 | ret['file_characteristics'] = b2h(resp_bin[13:14]) |
| 966 | ret['num_direct_child_df'] = resp_bin[14] |
| 967 | ret['num_direct_child_ef'] = resp_bin[15] |
Harald Welte | c9cdce3 | 2021-04-11 10:28:28 +0200 | [diff] [blame] | 968 | ret['num_chv_unblock_adm_codes'] = int(resp_bin[16]) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 969 | # CHV / UNBLOCK CHV stats |
| 970 | elif file_type in ['working_ef']: |
| 971 | file_struct = struct_of_file_map[resp_bin[13]] if resp_bin[13] in struct_of_file_map else resp_bin[13] |
| 972 | ret['file_descriptor']['structure'] = file_struct |
| 973 | ret['access_conditions'] = b2h(resp_bin[8:10]) |
| 974 | if resp_bin[11] & 0x01 == 0: |
| 975 | ret['life_cycle_status_int'] = 'operational_activated' |
| 976 | elif resp_bin[11] & 0x04: |
| 977 | ret['life_cycle_status_int'] = 'operational_deactivated' |
| 978 | else: |
| 979 | ret['life_cycle_status_int'] = 'terminated' |
| 980 | |
| 981 | return ret |
| 982 | |
Philipp Maier | c8387dc | 2021-10-29 17:59:50 +0200 | [diff] [blame] | 983 | class CardProfileSIM(CardProfile): |
| 984 | def __init__(self): |
| 985 | super().__init__('SIM', desc='GSM SIM Card', files_in_mf=[DF_TELECOM(), DF_GSM()]) |