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 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 32 | from pySim.profile import match_sim |
| 33 | from pySim.profile import CardProfile |
| 34 | from pySim.filesystem import * |
Harald Welte | 228ae8e | 2022-07-17 22:01:04 +0200 | [diff] [blame] | 35 | from pySim.ts_31_102_telecom import DF_PHONEBOOK, DF_MULTIMEDIA, DF_MCS, DF_V2X |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 36 | import enum |
| 37 | from pySim.construct import * |
| 38 | from construct import Optional as COptional |
| 39 | from construct import * |
| 40 | from struct import pack, unpack |
| 41 | from typing import Tuple |
| 42 | from pySim.tlv import * |
| 43 | from pySim.utils import * |
Alexander Chemeris | 067f69c | 2017-07-18 16:44:26 +0300 | [diff] [blame] | 44 | MF_num = '3F00' |
| 45 | |
| 46 | DF_num = { |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 47 | 'TELECOM': '7F10', |
Alexander Chemeris | 067f69c | 2017-07-18 16:44:26 +0300 | [diff] [blame] | 48 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 49 | 'GSM': '7F20', |
| 50 | 'IS-41': '7F22', |
| 51 | 'FP-CTS': '7F23', |
Alexander Chemeris | 067f69c | 2017-07-18 16:44:26 +0300 | [diff] [blame] | 52 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 53 | 'GRAPHICS': '5F50', |
Alexander Chemeris | 067f69c | 2017-07-18 16:44:26 +0300 | [diff] [blame] | 54 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 55 | 'IRIDIUM': '5F30', |
| 56 | 'GLOBST': '5F31', |
| 57 | 'ICO': '5F32', |
| 58 | 'ACeS': '5F33', |
Alexander Chemeris | 067f69c | 2017-07-18 16:44:26 +0300 | [diff] [blame] | 59 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 60 | 'EIA/TIA-553': '5F40', |
| 61 | 'CTS': '5F60', |
| 62 | 'SOLSA': '5F70', |
Alexander Chemeris | 067f69c | 2017-07-18 16:44:26 +0300 | [diff] [blame] | 63 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 64 | 'MExE': '5F3C', |
Alexander Chemeris | 067f69c | 2017-07-18 16:44:26 +0300 | [diff] [blame] | 65 | } |
| 66 | |
| 67 | EF_num = { |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 68 | # MF |
| 69 | 'ICCID': '2FE2', |
| 70 | 'ELP': '2F05', |
| 71 | 'DIR': '2F00', |
Alexander Chemeris | 067f69c | 2017-07-18 16:44:26 +0300 | [diff] [blame] | 72 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 73 | # DF_TELECOM |
| 74 | 'ADN': '6F3A', |
| 75 | 'FDN': '6F3B', |
| 76 | 'SMS': '6F3C', |
| 77 | 'CCP': '6F3D', |
| 78 | 'MSISDN': '6F40', |
| 79 | 'SMSP': '6F42', |
| 80 | 'SMSS': '6F43', |
| 81 | 'LND': '6F44', |
| 82 | 'SMSR': '6F47', |
| 83 | 'SDN': '6F49', |
| 84 | 'EXT1': '6F4A', |
| 85 | 'EXT2': '6F4B', |
| 86 | 'EXT3': '6F4C', |
| 87 | 'BDN': '6F4D', |
| 88 | 'EXT4': '6F4E', |
| 89 | 'CMI': '6F58', |
| 90 | 'ECCP': '6F4F', |
Alexander Chemeris | 067f69c | 2017-07-18 16:44:26 +0300 | [diff] [blame] | 91 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 92 | # DF_GRAPHICS |
| 93 | 'IMG': '4F20', |
Alexander Chemeris | 067f69c | 2017-07-18 16:44:26 +0300 | [diff] [blame] | 94 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 95 | # DF_SoLSA |
| 96 | 'SAI': '4F30', |
| 97 | 'SLL': '4F31', |
Alexander Chemeris | 067f69c | 2017-07-18 16:44:26 +0300 | [diff] [blame] | 98 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 99 | # DF_MExE |
| 100 | 'MExE-ST': '4F40', |
| 101 | 'ORPK': '4F41', |
| 102 | 'ARPK': '4F42', |
| 103 | 'TPRPK': '4F43', |
Alexander Chemeris | 067f69c | 2017-07-18 16:44:26 +0300 | [diff] [blame] | 104 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 105 | # DF_GSM |
| 106 | 'LP': '6F05', |
| 107 | 'IMSI': '6F07', |
| 108 | 'Kc': '6F20', |
| 109 | 'DCK': '6F2C', |
| 110 | 'PLMNsel': '6F30', |
| 111 | 'HPPLMN': '6F31', |
| 112 | 'CNL': '6F32', |
| 113 | 'ACMmax': '6F37', |
| 114 | 'SST': '6F38', |
| 115 | 'ACM': '6F39', |
| 116 | 'GID1': '6F3E', |
| 117 | 'GID2': '6F3F', |
| 118 | 'PUCT': '6F41', |
| 119 | 'CBMI': '6F45', |
| 120 | 'SPN': '6F46', |
| 121 | 'CBMID': '6F48', |
| 122 | 'BCCH': '6F74', |
| 123 | 'ACC': '6F78', |
| 124 | 'FPLMN': '6F7B', |
| 125 | 'LOCI': '6F7E', |
| 126 | 'AD': '6FAD', |
| 127 | 'PHASE': '6FAE', |
| 128 | 'VGCS': '6FB1', |
| 129 | 'VGCSS': '6FB2', |
| 130 | 'VBS': '6FB3', |
| 131 | 'VBSS': '6FB4', |
| 132 | 'eMLPP': '6FB5', |
| 133 | 'AAeM': '6FB6', |
| 134 | 'ECC': '6FB7', |
| 135 | 'CBMIR': '6F50', |
| 136 | 'NIA': '6F51', |
| 137 | 'KcGPRS': '6F52', |
| 138 | 'LOCIGPRS': '6F53', |
| 139 | 'SUME': '6F54', |
| 140 | 'PLMNwAcT': '6F60', |
| 141 | 'OPLMNwAcT': '6F61', |
| 142 | # Figure 8 names it HPLMNAcT, but in the text it's names it HPLMNwAcT |
| 143 | 'HPLMNAcT': '6F62', |
| 144 | 'HPLMNwAcT': '6F62', |
| 145 | 'CPBCCH': '6F63', |
| 146 | 'INVSCAN': '6F64', |
| 147 | 'PNN': '6FC5', |
| 148 | 'OPL': '6FC6', |
| 149 | 'MBDN': '6FC7', |
| 150 | 'EXT6': '6FC8', |
| 151 | 'MBI': '6FC9', |
| 152 | 'MWIS': '6FCA', |
| 153 | 'CFIS': '6FCB', |
| 154 | 'EXT7': '6FCC', |
| 155 | 'SPDI': '6FCD', |
| 156 | 'MMSN': '6FCE', |
| 157 | 'EXT8': '6FCF', |
| 158 | 'MMSICP': '6FD0', |
| 159 | 'MMSUP': '6FD1', |
| 160 | 'MMSUCP': '6FD2', |
Alexander Chemeris | 067f69c | 2017-07-18 16:44:26 +0300 | [diff] [blame] | 161 | } |
| 162 | |
| 163 | DF = { |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 164 | 'TELECOM': [MF_num, DF_num['TELECOM']], |
Alexander Chemeris | 067f69c | 2017-07-18 16:44:26 +0300 | [diff] [blame] | 165 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 166 | 'GSM': [MF_num, DF_num['GSM']], |
| 167 | 'IS-41': [MF_num, DF_num['IS-41']], |
| 168 | 'FP-CTS': [MF_num, DF_num['FP-CTS']], |
Alexander Chemeris | 067f69c | 2017-07-18 16:44:26 +0300 | [diff] [blame] | 169 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 170 | 'GRAPHICS': [MF_num, DF_num['GRAPHICS']], |
Alexander Chemeris | 067f69c | 2017-07-18 16:44:26 +0300 | [diff] [blame] | 171 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 172 | 'IRIDIUM': [MF_num, DF_num['IRIDIUM']], |
| 173 | 'GLOBST': [MF_num, DF_num['GLOBST']], |
| 174 | 'ICO': [MF_num, DF_num['ICO']], |
| 175 | 'ACeS': [MF_num, DF_num['ACeS']], |
Alexander Chemeris | 067f69c | 2017-07-18 16:44:26 +0300 | [diff] [blame] | 176 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 177 | 'EIA/TIA-553': [MF_num, DF_num['EIA/TIA-553']], |
| 178 | 'CTS': [MF_num, DF_num['CTS']], |
| 179 | 'SoLSA': [MF_num, DF_num['SOLSA']], |
Alexander Chemeris | 067f69c | 2017-07-18 16:44:26 +0300 | [diff] [blame] | 180 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 181 | 'MExE': [MF_num, DF_num['MExE']], |
Alexander Chemeris | 067f69c | 2017-07-18 16:44:26 +0300 | [diff] [blame] | 182 | } |
| 183 | |
| 184 | |
| 185 | EF = { |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 186 | 'ICCID': [MF_num, EF_num['ICCID']], |
| 187 | 'ELP': [MF_num, EF_num['ELP']], |
| 188 | 'DIR': [MF_num, EF_num['DIR']], |
Alexander Chemeris | 067f69c | 2017-07-18 16:44:26 +0300 | [diff] [blame] | 189 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 190 | 'ADN': DF['TELECOM']+[EF_num['ADN']], |
| 191 | 'FDN': DF['TELECOM']+[EF_num['FDN']], |
| 192 | 'SMS': DF['TELECOM']+[EF_num['SMS']], |
| 193 | 'CCP': DF['TELECOM']+[EF_num['CCP']], |
| 194 | 'MSISDN': DF['TELECOM']+[EF_num['MSISDN']], |
| 195 | 'SMSP': DF['TELECOM']+[EF_num['SMSP']], |
| 196 | 'SMSS': DF['TELECOM']+[EF_num['SMSS']], |
| 197 | 'LND': DF['TELECOM']+[EF_num['LND']], |
| 198 | 'SMSR': DF['TELECOM']+[EF_num['SMSR']], |
| 199 | 'SDN': DF['TELECOM']+[EF_num['SDN']], |
| 200 | 'EXT1': DF['TELECOM']+[EF_num['EXT1']], |
| 201 | 'EXT2': DF['TELECOM']+[EF_num['EXT2']], |
| 202 | 'EXT3': DF['TELECOM']+[EF_num['EXT3']], |
| 203 | 'BDN': DF['TELECOM']+[EF_num['BDN']], |
| 204 | 'EXT4': DF['TELECOM']+[EF_num['EXT4']], |
| 205 | 'CMI': DF['TELECOM']+[EF_num['CMI']], |
| 206 | 'ECCP': DF['TELECOM']+[EF_num['ECCP']], |
Alexander Chemeris | 067f69c | 2017-07-18 16:44:26 +0300 | [diff] [blame] | 207 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 208 | 'IMG': DF['GRAPHICS']+[EF_num['IMG']], |
Alexander Chemeris | 067f69c | 2017-07-18 16:44:26 +0300 | [diff] [blame] | 209 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 210 | 'SAI': DF['SoLSA']+[EF_num['SAI']], |
| 211 | 'SLL': DF['SoLSA']+[EF_num['SLL']], |
Alexander Chemeris | 067f69c | 2017-07-18 16:44:26 +0300 | [diff] [blame] | 212 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 213 | 'MExE-ST': DF['MExE']+[EF_num['MExE-ST']], |
| 214 | 'ORPK': DF['MExE']+[EF_num['ORPK']], |
| 215 | 'ARPK': DF['MExE']+[EF_num['ARPK']], |
| 216 | 'TPRPK': DF['MExE']+[EF_num['TPRPK']], |
Alexander Chemeris | 067f69c | 2017-07-18 16:44:26 +0300 | [diff] [blame] | 217 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 218 | 'LP': DF['GSM']+[EF_num['LP']], |
| 219 | 'IMSI': DF['GSM']+[EF_num['IMSI']], |
| 220 | 'Kc': DF['GSM']+[EF_num['Kc']], |
| 221 | 'DCK': DF['GSM']+[EF_num['DCK']], |
| 222 | 'PLMNsel': DF['GSM']+[EF_num['PLMNsel']], |
| 223 | 'HPPLMN': DF['GSM']+[EF_num['HPPLMN']], |
| 224 | 'CNL': DF['GSM']+[EF_num['CNL']], |
| 225 | 'ACMmax': DF['GSM']+[EF_num['ACMmax']], |
| 226 | 'SST': DF['GSM']+[EF_num['SST']], |
| 227 | 'ACM': DF['GSM']+[EF_num['ACM']], |
| 228 | 'GID1': DF['GSM']+[EF_num['GID1']], |
| 229 | 'GID2': DF['GSM']+[EF_num['GID2']], |
| 230 | 'PUCT': DF['GSM']+[EF_num['PUCT']], |
| 231 | 'CBMI': DF['GSM']+[EF_num['CBMI']], |
| 232 | 'SPN': DF['GSM']+[EF_num['SPN']], |
| 233 | 'CBMID': DF['GSM']+[EF_num['CBMID']], |
| 234 | 'BCCH': DF['GSM']+[EF_num['BCCH']], |
| 235 | 'ACC': DF['GSM']+[EF_num['ACC']], |
| 236 | 'FPLMN': DF['GSM']+[EF_num['FPLMN']], |
| 237 | 'LOCI': DF['GSM']+[EF_num['LOCI']], |
| 238 | 'AD': DF['GSM']+[EF_num['AD']], |
| 239 | 'PHASE': DF['GSM']+[EF_num['PHASE']], |
| 240 | 'VGCS': DF['GSM']+[EF_num['VGCS']], |
| 241 | 'VGCSS': DF['GSM']+[EF_num['VGCSS']], |
| 242 | 'VBS': DF['GSM']+[EF_num['VBS']], |
| 243 | 'VBSS': DF['GSM']+[EF_num['VBSS']], |
| 244 | 'eMLPP': DF['GSM']+[EF_num['eMLPP']], |
| 245 | 'AAeM': DF['GSM']+[EF_num['AAeM']], |
| 246 | 'ECC': DF['GSM']+[EF_num['ECC']], |
| 247 | 'CBMIR': DF['GSM']+[EF_num['CBMIR']], |
| 248 | 'NIA': DF['GSM']+[EF_num['NIA']], |
| 249 | 'KcGPRS': DF['GSM']+[EF_num['KcGPRS']], |
| 250 | 'LOCIGPRS': DF['GSM']+[EF_num['LOCIGPRS']], |
| 251 | 'SUME': DF['GSM']+[EF_num['SUME']], |
| 252 | 'PLMNwAcT': DF['GSM']+[EF_num['PLMNwAcT']], |
| 253 | 'OPLMNwAcT': DF['GSM']+[EF_num['OPLMNwAcT']], |
| 254 | # Figure 8 names it HPLMNAcT, but in the text it's names it HPLMNwAcT |
| 255 | 'HPLMNAcT': DF['GSM']+[EF_num['HPLMNAcT']], |
| 256 | 'HPLMNwAcT': DF['GSM']+[EF_num['HPLMNAcT']], |
| 257 | 'CPBCCH': DF['GSM']+[EF_num['CPBCCH']], |
| 258 | 'INVSCAN': DF['GSM']+[EF_num['INVSCAN']], |
| 259 | 'PNN': DF['GSM']+[EF_num['PNN']], |
| 260 | 'OPL': DF['GSM']+[EF_num['OPL']], |
| 261 | 'MBDN': DF['GSM']+[EF_num['MBDN']], |
| 262 | 'EXT6': DF['GSM']+[EF_num['EXT6']], |
| 263 | 'MBI': DF['GSM']+[EF_num['MBI']], |
| 264 | 'MWIS': DF['GSM']+[EF_num['MWIS']], |
| 265 | 'CFIS': DF['GSM']+[EF_num['CFIS']], |
| 266 | 'EXT7': DF['GSM']+[EF_num['EXT7']], |
| 267 | 'SPDI': DF['GSM']+[EF_num['SPDI']], |
| 268 | 'MMSN': DF['GSM']+[EF_num['MMSN']], |
| 269 | 'EXT8': DF['GSM']+[EF_num['EXT8']], |
| 270 | 'MMSICP': DF['GSM']+[EF_num['MMSICP']], |
| 271 | 'MMSUP': DF['GSM']+[EF_num['MMSUP']], |
| 272 | 'MMSUCP': DF['GSM']+[EF_num['MMSUCP']], |
Alexander Chemeris | 067f69c | 2017-07-18 16:44:26 +0300 | [diff] [blame] | 273 | } |
Supreeth Herle | bf5d602 | 2020-03-20 15:18:27 +0100 | [diff] [blame] | 274 | |
| 275 | # Mapping between SIM Service Number and its description |
| 276 | EF_SST_map = { |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 277 | 1: 'CHV1 disable function', |
| 278 | 2: 'Abbreviated Dialling Numbers (ADN)', |
| 279 | 3: 'Fixed Dialling Numbers (FDN)', |
| 280 | 4: 'Short Message Storage (SMS)', |
| 281 | 5: 'Advice of Charge (AoC)', |
| 282 | 6: 'Capability Configuration Parameters (CCP)', |
| 283 | 7: 'PLMN selector', |
| 284 | 8: 'RFU', |
| 285 | 9: 'MSISDN', |
| 286 | 10: 'Extension1', |
| 287 | 11: 'Extension2', |
| 288 | 12: 'SMS Parameters', |
| 289 | 13: 'Last Number Dialled (LND)', |
| 290 | 14: 'Cell Broadcast Message Identifier', |
| 291 | 15: 'Group Identifier Level 1', |
| 292 | 16: 'Group Identifier Level 2', |
| 293 | 17: 'Service Provider Name', |
| 294 | 18: 'Service Dialling Numbers (SDN)', |
| 295 | 19: 'Extension3', |
| 296 | 20: 'RFU', |
| 297 | 21: 'VGCS Group Identifier List (EFVGCS and EFVGCSS)', |
| 298 | 22: 'VBS Group Identifier List (EFVBS and EFVBSS)', |
| 299 | 23: 'enhanced Multi-Level Precedence and Pre-emption Service', |
| 300 | 24: 'Automatic Answer for eMLPP', |
| 301 | 25: 'Data download via SMS-CB', |
| 302 | 26: 'Data download via SMS-PP', |
| 303 | 27: 'Menu selection', |
| 304 | 28: 'Call control', |
| 305 | 29: 'Proactive SIM', |
| 306 | 30: 'Cell Broadcast Message Identifier Ranges', |
| 307 | 31: 'Barred Dialling Numbers (BDN)', |
| 308 | 32: 'Extension4', |
| 309 | 33: 'De-personalization Control Keys', |
| 310 | 34: 'Co-operative Network List', |
| 311 | 35: 'Short Message Status Reports', |
| 312 | 36: 'Network\'s indication of alerting in the MS', |
| 313 | 37: 'Mobile Originated Short Message control by SIM', |
| 314 | 38: 'GPRS', |
| 315 | 39: 'Image (IMG)', |
| 316 | 40: 'SoLSA (Support of Local Service Area)', |
| 317 | 41: 'USSD string data object supported in Call Control', |
| 318 | 42: 'RUN AT COMMAND command', |
| 319 | 43: 'User controlled PLMN Selector with Access Technology', |
| 320 | 44: 'Operator controlled PLMN Selector with Access Technology', |
| 321 | 45: 'HPLMN Selector with Access Technology', |
| 322 | 46: 'CPBCCH Information', |
| 323 | 47: 'Investigation Scan', |
| 324 | 48: 'Extended Capability Configuration Parameters', |
| 325 | 49: 'MExE', |
| 326 | 50: 'Reserved and shall be ignored', |
| 327 | 51: 'PLMN Network Name', |
| 328 | 52: 'Operator PLMN List', |
| 329 | 53: 'Mailbox Dialling Numbers', |
| 330 | 54: 'Message Waiting Indication Status', |
| 331 | 55: 'Call Forwarding Indication Status', |
| 332 | 56: 'Service Provider Display Information', |
| 333 | 57: 'Multimedia Messaging Service (MMS)', |
| 334 | 58: 'Extension 8', |
| 335 | 59: 'MMS User Connectivity Parameters', |
Vadim Yanitskiy | dfe3dbb | 2020-07-28 05:26:02 +0700 | [diff] [blame] | 336 | } |
| 337 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 338 | |
| 339 | ###################################################################### |
| 340 | # DF.TELECOM |
| 341 | ###################################################################### |
| 342 | |
Harald Welte | f11f130 | 2023-01-24 17:59:59 +0100 | [diff] [blame] | 343 | |
| 344 | # TS 51.011 Section 10.5.1 / Table 12 |
| 345 | class ExtendedBcdAdapter(Adapter): |
| 346 | """Replace some hex-characters with other ASCII characters""" |
| 347 | # we only translate a=* / b=# as they habe a clear representation |
| 348 | # in terms of USSD / SS service codes |
| 349 | def _decode(self, obj, context, path): |
| 350 | if not isinstance(obj, str): |
| 351 | return obj |
| 352 | return obj.lower().replace("a","*").replace("b","#") |
| 353 | |
| 354 | def _encode(self, obj, context, path): |
| 355 | if not isinstance(obj, str): |
| 356 | return obj |
| 357 | return obj.replace("*","a").replace("#","b") |
| 358 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 359 | # TS 51.011 Section 10.5.1 |
| 360 | class EF_ADN(LinFixedEF): |
Harald Welte | 0dc6c20 | 2023-01-24 18:10:13 +0100 | [diff] [blame] | 361 | def __init__(self, fid='6f3a', sfid=None, name='EF.ADN', desc='Abbreviated Dialing Numbers', ext=1, **kwargs): |
Harald Welte | 99e4cc0 | 2022-07-21 15:25:47 +0200 | [diff] [blame] | 362 | super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len=(14, 30), **kwargs) |
Harald Welte | 0dc6c20 | 2023-01-24 18:10:13 +0100 | [diff] [blame] | 363 | ext_name = 'ext%u_record_id' % ext |
Harald Welte | 1e73d22 | 2022-02-13 11:32:50 +0100 | [diff] [blame] | 364 | self._construct = Struct('alpha_id'/COptional(GsmStringAdapter(Rpad(Bytes(this._.total_len-14)), codec='ascii')), |
| 365 | 'len_of_bcd'/Int8ub, |
| 366 | 'ton_npi'/TonNpi, |
Harald Welte | f11f130 | 2023-01-24 17:59:59 +0100 | [diff] [blame] | 367 | 'dialing_nr'/ExtendedBcdAdapter(BcdAdapter(Rpad(Bytes(10)))), |
Harald Welte | 1e73d22 | 2022-02-13 11:32:50 +0100 | [diff] [blame] | 368 | 'cap_conf_id'/Int8ub, |
Harald Welte | 0dc6c20 | 2023-01-24 18:10:13 +0100 | [diff] [blame] | 369 | ext_name/Int8ub) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 370 | |
| 371 | # TS 51.011 Section 10.5.5 |
Harald Welte | ec7d0da | 2021-04-02 22:01:19 +0200 | [diff] [blame] | 372 | class EF_SMS(LinFixedEF): |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 373 | def __init__(self, fid='6f3c', sfid=None, name='EF.SMS', desc='Short messages', **kwargs): |
Harald Welte | 99e4cc0 | 2022-07-21 15:25:47 +0200 | [diff] [blame] | 374 | super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len=(176, 176), **kwargs) |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 375 | |
Harald Welte | f6b37af | 2023-01-24 15:42:26 +0100 | [diff] [blame] | 376 | def _decode_record_bin(self, raw_bin_data, **kwargs): |
Harald Welte | ec7d0da | 2021-04-02 22:01:19 +0200 | [diff] [blame] | 377 | def decode_status(status): |
| 378 | if status & 0x01 == 0x00: |
| 379 | return (None, 'free_space') |
| 380 | elif status & 0x07 == 0x01: |
| 381 | return ('mt', 'message_read') |
| 382 | elif status & 0x07 == 0x03: |
| 383 | return ('mt', 'message_to_be_read') |
| 384 | elif status & 0x07 == 0x07: |
| 385 | return ('mo', 'message_to_be_sent') |
| 386 | elif status & 0x1f == 0x05: |
| 387 | return ('mo', 'sent_status_not_requested') |
| 388 | elif status & 0x1f == 0x0d: |
| 389 | return ('mo', 'sent_status_req_but_not_received') |
| 390 | elif status & 0x1f == 0x15: |
| 391 | return ('mo', 'sent_status_req_rx_not_stored_smsr') |
| 392 | elif status & 0x1f == 0x1d: |
| 393 | return ('mo', 'sent_status_req_rx_stored_smsr') |
| 394 | else: |
| 395 | return (None, 'rfu') |
| 396 | |
| 397 | status = decode_status(raw_bin_data[0]) |
| 398 | remainder = raw_bin_data[1:] |
| 399 | return {'direction': status[0], 'status': status[1], 'remainder': b2h(remainder)} |
| 400 | |
| 401 | |
| 402 | # TS 51.011 Section 10.5.5 |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 403 | class EF_MSISDN(LinFixedEF): |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 404 | def __init__(self, fid='6f40', sfid=None, name='EF.MSISDN', desc='MSISDN', **kwargs): |
Harald Welte | 99e4cc0 | 2022-07-21 15:25:47 +0200 | [diff] [blame] | 405 | super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len=(15, 34), **kwargs) |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 406 | |
Harald Welte | f6b37af | 2023-01-24 15:42:26 +0100 | [diff] [blame] | 407 | def _decode_record_hex(self, raw_hex_data, **kwargs): |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 408 | return {'msisdn': dec_msisdn(raw_hex_data)} |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 409 | |
Harald Welte | f6b37af | 2023-01-24 15:42:26 +0100 | [diff] [blame] | 410 | def _encode_record_hex(self, abstract, **kwargs): |
Philipp Maier | f9cbe09 | 2021-04-23 19:37:36 +0200 | [diff] [blame] | 411 | msisdn = abstract['msisdn'] |
| 412 | if type(msisdn) == str: |
| 413 | encoded_msisdn = enc_msisdn(msisdn) |
| 414 | else: |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 415 | encoded_msisdn = enc_msisdn(msisdn[2], msisdn[0], msisdn[1]) |
| 416 | alpha_identifier = (list(self.rec_len)[ |
| 417 | 0] - len(encoded_msisdn) // 2) * "ff" |
Philipp Maier | b46cb3f | 2021-04-20 22:38:21 +0200 | [diff] [blame] | 418 | return alpha_identifier + encoded_msisdn |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 419 | |
| 420 | # TS 51.011 Section 10.5.6 |
| 421 | class EF_SMSP(LinFixedEF): |
Harald Welte | bc0e209 | 2022-02-13 10:54:58 +0100 | [diff] [blame] | 422 | class ValidityPeriodAdapter(Adapter): |
| 423 | def _decode(self, obj, context, path): |
| 424 | if obj <= 143: |
| 425 | return obj + 1 * 5 |
| 426 | elif obj <= 167: |
| 427 | return 12 * 60 + ((obj - 143) * 30) |
| 428 | elif obj <= 196: |
| 429 | return (obj - 166) * (24 * 60) |
| 430 | elif obj <= 255: |
| 431 | return (obj - 192) * (7 * 24 * 60) |
| 432 | else: |
| 433 | raise ValueError |
| 434 | def _encode(self, obj, context, path): |
| 435 | if obj <= 12*60: |
| 436 | return obj/5 - 1 |
| 437 | elif obj <= 24*60: |
Harald Welte | 136bdb0 | 2023-01-31 16:23:32 +0100 | [diff] [blame] | 438 | return 143 + ((obj - (12 * 60)) // 30) |
Harald Welte | bc0e209 | 2022-02-13 10:54:58 +0100 | [diff] [blame] | 439 | elif obj <= 30 * 24 * 60: |
| 440 | return 166 + (obj / (24 * 60)) |
| 441 | elif obj <= 63 * 7 * 24 * 60: |
Harald Welte | 136bdb0 | 2023-01-31 16:23:32 +0100 | [diff] [blame] | 442 | return 192 + (obj // (7 * 24 * 60)) |
Harald Welte | bc0e209 | 2022-02-13 10:54:58 +0100 | [diff] [blame] | 443 | else: |
| 444 | raise ValueError |
| 445 | |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 446 | def __init__(self, fid='6f42', sfid=None, name='EF.SMSP', desc='Short message service parameters', **kwargs): |
Harald Welte | 99e4cc0 | 2022-07-21 15:25:47 +0200 | [diff] [blame] | 447 | super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len=(28, None), **kwargs) |
Harald Welte | bc0e209 | 2022-02-13 10:54:58 +0100 | [diff] [blame] | 448 | ScAddr = Struct('length'/Int8ub, 'ton_npi'/TonNpi, 'call_number'/BcdAdapter(Rpad(Bytes(10)))) |
| 449 | self._construct = Struct('alpha_id'/COptional(GsmStringAdapter(Rpad(Bytes(this._.total_len-28)))), |
| 450 | 'parameter_indicators'/InvertAdapter(FlagsEnum(Byte, tp_dest_addr=1, tp_sc_addr=2, |
| 451 | tp_pid=3, tp_dcs=4, tp_vp=5)), |
| 452 | 'tp_dest_addr'/ScAddr, |
| 453 | 'tp_sc_addr'/ScAddr, |
| 454 | |
| 455 | 'tp_pid'/HexAdapter(Bytes(1)), |
| 456 | 'tp_dcs'/HexAdapter(Bytes(1)), |
| 457 | 'tp_vp_minutes'/EF_SMSP.ValidityPeriodAdapter(Byte)) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 458 | |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 459 | # TS 51.011 Section 10.5.7 |
| 460 | class EF_SMSS(TransparentEF): |
| 461 | class MemCapAdapter(Adapter): |
| 462 | def _decode(self, obj, context, path): |
| 463 | return False if obj & 1 else True |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 464 | |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 465 | def _encode(self, obj, context, path): |
| 466 | return 0 if obj else 1 |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 467 | |
Harald Welte | 13edf30 | 2022-07-21 15:19:23 +0200 | [diff] [blame] | 468 | def __init__(self, fid='6f43', sfid=None, name='EF.SMSS', desc='SMS status', size=(2, 8), **kwargs): |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 469 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, **kwargs) |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 470 | self._construct = Struct( |
| 471 | 'last_used_tpmr'/Int8ub, 'memory_capacity_exceeded'/self.MemCapAdapter(Int8ub)) |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 472 | |
| 473 | # TS 51.011 Section 10.5.8 |
| 474 | class EF_SMSR(LinFixedEF): |
Harald Welte | 99e4cc0 | 2022-07-21 15:25:47 +0200 | [diff] [blame] | 475 | def __init__(self, fid='6f47', sfid=None, name='EF.SMSR', desc='SMS status reports', rec_len=(30, 30), **kwargs): |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 476 | super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len=rec_len, **kwargs) |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 477 | self._construct = Struct( |
| 478 | 'sms_record_id'/Int8ub, 'sms_status_report'/HexAdapter(Bytes(29))) |
| 479 | |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 480 | |
| 481 | class EF_EXT(LinFixedEF): |
Harald Welte | 99e4cc0 | 2022-07-21 15:25:47 +0200 | [diff] [blame] | 482 | def __init__(self, fid, sfid=None, name='EF.EXT', desc='Extension', rec_len=(13, 13), **kwargs): |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 483 | super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, rec_len=rec_len, **kwargs) |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 484 | self._construct = Struct( |
| 485 | 'record_type'/Int8ub, 'extension_data'/HexAdapter(Bytes(11)), 'identifier'/Int8ub) |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 486 | |
| 487 | # TS 51.011 Section 10.5.16 |
| 488 | class EF_CMI(LinFixedEF): |
Harald Welte | 99e4cc0 | 2022-07-21 15:25:47 +0200 | [diff] [blame] | 489 | def __init__(self, fid='6f58', sfid=None, name='EF.CMI', rec_len=(2, 21), |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 490 | desc='Comparison Method Information', **kwargs): |
| 491 | super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len=rec_len, **kwargs) |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 492 | self._construct = Struct( |
Harald Welte | 540adb0 | 2022-02-13 11:33:21 +0100 | [diff] [blame] | 493 | 'alpha_id'/GsmStringAdapter(Rpad(Bytes(this._.total_len-1))), 'comparison_method_id'/Int8ub) |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 494 | |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 495 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 496 | class DF_TELECOM(CardDF): |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 497 | def __init__(self, fid='7f10', name='DF.TELECOM', desc=None, **kwargs): |
| 498 | super().__init__(fid=fid, name=name, desc=desc, **kwargs) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 499 | files = [ |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 500 | EF_ADN(), |
Harald Welte | 0dc6c20 | 2023-01-24 18:10:13 +0100 | [diff] [blame] | 501 | EF_ADN(fid='6f3b', name='EF.FDN', desc='Fixed dialling numbers', ext=2), |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 502 | EF_SMS(), |
| 503 | LinFixedEF(fid='6f3d', name='EF.CCP', |
Harald Welte | 99e4cc0 | 2022-07-21 15:25:47 +0200 | [diff] [blame] | 504 | desc='Capability Configuration Parameters', rec_len=(14, 14)), |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 505 | LinFixedEF(fid='6f4f', name='EF.ECCP', |
Harald Welte | 99e4cc0 | 2022-07-21 15:25:47 +0200 | [diff] [blame] | 506 | desc='Extended Capability Configuration Parameters', rec_len=(15, 32)), |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 507 | EF_MSISDN(), |
| 508 | EF_SMSP(), |
| 509 | EF_SMSS(), |
Harald Welte | a1bb3f7 | 2023-01-24 18:15:56 +0100 | [diff] [blame] | 510 | EF_ADN('6f44', None, 'EF.LND', 'Last Number Dialled', ext=1), |
Harald Welte | 0dc6c20 | 2023-01-24 18:10:13 +0100 | [diff] [blame] | 511 | EF_ADN('6f49', None, 'EF.SDN', 'Service Dialling Numbers', ext=3), |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 512 | EF_EXT('6f4a', None, 'EF.EXT1', 'Extension1 (ADN/SSC)'), |
| 513 | EF_EXT('6f4b', None, 'EF.EXT2', 'Extension2 (FDN/SSC)'), |
| 514 | EF_EXT('6f4c', None, 'EF.EXT3', 'Extension3 (SDN)'), |
| 515 | EF_ADN(fid='6f4d', name='EF.BDN', desc='Barred Dialling Numbers'), |
| 516 | EF_EXT('6f4e', None, 'EF.EXT4', 'Extension4 (BDN/SSC)'), |
| 517 | EF_SMSR(), |
| 518 | EF_CMI(), |
Harald Welte | de4c14c | 2022-07-16 11:53:59 +0200 | [diff] [blame] | 519 | # not really part of 51.011 but something that TS 31.102 specifies may exist here. |
| 520 | DF_PHONEBOOK(), |
Harald Welte | a045221 | 2022-07-17 21:23:21 +0200 | [diff] [blame] | 521 | DF_MULTIMEDIA(), |
Harald Welte | 650f612 | 2022-07-17 21:42:50 +0200 | [diff] [blame] | 522 | DF_MCS(), |
Harald Welte | 228ae8e | 2022-07-17 22:01:04 +0200 | [diff] [blame] | 523 | DF_V2X(), |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 524 | ] |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 525 | self.add_files(files) |
| 526 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 527 | ###################################################################### |
| 528 | # DF.GSM |
| 529 | ###################################################################### |
| 530 | |
| 531 | # TS 51.011 Section 10.3.1 |
| 532 | class EF_LP(TransRecEF): |
Harald Welte | 13edf30 | 2022-07-21 15:19:23 +0200 | [diff] [blame] | 533 | def __init__(self, fid='6f05', sfid=None, name='EF.LP', size=(1, None), rec_len=1, |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 534 | desc='Language Preference'): |
| 535 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, rec_len=rec_len) |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 536 | |
Harald Welte | f6b37af | 2023-01-24 15:42:26 +0100 | [diff] [blame] | 537 | def _decode_record_bin(self, in_bin, **kwargs): |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 538 | return b2h(in_bin) |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 539 | |
Harald Welte | f6b37af | 2023-01-24 15:42:26 +0100 | [diff] [blame] | 540 | def _encode_record_bin(self, in_json, **kwargs): |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 541 | return h2b(in_json) |
| 542 | |
| 543 | # TS 51.011 Section 10.3.2 |
| 544 | class EF_IMSI(TransparentEF): |
Harald Welte | 13edf30 | 2022-07-21 15:19:23 +0200 | [diff] [blame] | 545 | def __init__(self, fid='6f07', sfid=None, name='EF.IMSI', desc='IMSI', size=(9, 9)): |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 546 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size) |
Bjoern Riemer | e91405e | 2021-12-17 15:16:35 +0100 | [diff] [blame] | 547 | # add those commands to the general commands of a TransparentEF |
| 548 | self.shell_commands += [self.AddlShellCommands(self)] |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 549 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 550 | def _decode_hex(self, raw_hex): |
| 551 | return {'imsi': dec_imsi(raw_hex)} |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 552 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 553 | def _encode_hex(self, abstract): |
| 554 | return enc_imsi(abstract['imsi']) |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 555 | |
Bjoern Riemer | e91405e | 2021-12-17 15:16:35 +0100 | [diff] [blame] | 556 | @with_default_category('File-Specific Commands') |
| 557 | class AddlShellCommands(CommandSet): |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 558 | def __init__(self, ef: TransparentEF): |
Bjoern Riemer | e91405e | 2021-12-17 15:16:35 +0100 | [diff] [blame] | 559 | super().__init__() |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 560 | self._ef = ef |
Bjoern Riemer | e91405e | 2021-12-17 15:16:35 +0100 | [diff] [blame] | 561 | |
| 562 | def do_update_imsi_plmn(self, arg: str): |
| 563 | """Change the plmn part of the IMSI""" |
| 564 | plmn = arg.strip() |
| 565 | if len(plmn) == 5 or len(plmn) == 6: |
Harald Welte | a6c0f88 | 2022-07-17 14:23:17 +0200 | [diff] [blame] | 566 | (data, sw) = self._cmd.lchan.read_binary_dec() |
Bjoern Riemer | e91405e | 2021-12-17 15:16:35 +0100 | [diff] [blame] | 567 | if sw == '9000' and len(data['imsi'])-len(plmn) == 10: |
| 568 | imsi = data['imsi'] |
| 569 | msin = imsi[len(plmn):] |
Harald Welte | a6c0f88 | 2022-07-17 14:23:17 +0200 | [diff] [blame] | 570 | (data, sw) = self._cmd.lchan.update_binary_dec( |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 571 | {'imsi': plmn+msin}) |
Bjoern Riemer | e91405e | 2021-12-17 15:16:35 +0100 | [diff] [blame] | 572 | if sw == '9000' and data: |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 573 | self._cmd.poutput_json( |
Harald Welte | a6c0f88 | 2022-07-17 14:23:17 +0200 | [diff] [blame] | 574 | self._cmd.lchan.selected_file.decode_hex(data)) |
Bjoern Riemer | e91405e | 2021-12-17 15:16:35 +0100 | [diff] [blame] | 575 | else: |
| 576 | raise ValueError("PLMN length does not match IMSI length") |
| 577 | else: |
| 578 | raise ValueError("PLMN has wrong length!") |
| 579 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 580 | |
| 581 | # TS 51.011 Section 10.3.4 |
| 582 | class EF_PLMNsel(TransRecEF): |
| 583 | def __init__(self, fid='6f30', sfid=None, name='EF.PLMNsel', desc='PLMN selector', |
Harald Welte | 13edf30 | 2022-07-21 15:19:23 +0200 | [diff] [blame] | 584 | size=(24, None), rec_len=3, **kwargs): |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 585 | super().__init__(fid, name=name, sfid=sfid, desc=desc, size=size, rec_len=rec_len, **kwargs) |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 586 | |
Harald Welte | f6b37af | 2023-01-24 15:42:26 +0100 | [diff] [blame] | 587 | def _decode_record_hex(self, in_hex, **kwargs): |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 588 | if in_hex[:6] == "ffffff": |
| 589 | return None |
| 590 | else: |
| 591 | return dec_plmn(in_hex) |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 592 | |
Harald Welte | f6b37af | 2023-01-24 15:42:26 +0100 | [diff] [blame] | 593 | def _encode_record_hex(self, in_json, **kwargs): |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 594 | if in_json == None: |
| 595 | return "ffffff" |
| 596 | else: |
| 597 | return enc_plmn(in_json['mcc'], in_json['mnc']) |
| 598 | |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 599 | # TS 51.011 Section 10.3.6 |
| 600 | class EF_ACMmax(TransparentEF): |
Harald Welte | 13edf30 | 2022-07-21 15:19:23 +0200 | [diff] [blame] | 601 | def __init__(self, fid='6f37', sfid=None, name='EF.ACMmax', size=(3, 3), |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 602 | desc='ACM maximum value', **kwargs): |
| 603 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, **kwargs) |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 604 | self._construct = Struct('acm_max'/Int24ub) |
| 605 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 606 | # TS 51.011 Section 10.3.7 |
| 607 | class EF_ServiceTable(TransparentEF): |
| 608 | def __init__(self, fid, sfid, name, desc, size, table): |
| 609 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size) |
| 610 | self.table = table |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 611 | |
Harald Welte | 7a8aa86 | 2021-10-14 20:46:19 +0200 | [diff] [blame] | 612 | @staticmethod |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 613 | def _bit_byte_offset_for_service(service: int) -> Tuple[int, int]: |
Harald Welte | 7a8aa86 | 2021-10-14 20:46:19 +0200 | [diff] [blame] | 614 | i = service - 1 |
| 615 | byte_offset = i//4 |
| 616 | bit_offset = (i % 4) * 2 |
| 617 | return (byte_offset, bit_offset) |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 618 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 619 | def _decode_bin(self, raw_bin): |
| 620 | ret = {} |
| 621 | for i in range(0, len(raw_bin)*4): |
| 622 | service_nr = i+1 |
| 623 | byte = int(raw_bin[i//4]) |
| 624 | bit_offset = (i % 4) * 2 |
| 625 | bits = (byte >> bit_offset) & 3 |
| 626 | ret[service_nr] = { |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 627 | 'description': self.table[service_nr] if service_nr in self.table else None, |
| 628 | 'allocated': True if bits & 1 else False, |
| 629 | 'activated': True if bits & 2 else False, |
| 630 | } |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 631 | return ret |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 632 | |
Harald Welte | 7a8aa86 | 2021-10-14 20:46:19 +0200 | [diff] [blame] | 633 | def _encode_bin(self, in_json): |
| 634 | # compute the required binary size |
| 635 | bin_len = 0 |
| 636 | for srv in in_json.keys(): |
| 637 | service_nr = int(srv) |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 638 | (byte_offset, bit_offset) = EF_ServiceTable._bit_byte_offset_for_service( |
| 639 | service_nr) |
Harald Welte | 7a8aa86 | 2021-10-14 20:46:19 +0200 | [diff] [blame] | 640 | if byte_offset >= bin_len: |
| 641 | bin_len = byte_offset+1 |
| 642 | # encode the actual data |
| 643 | out = bytearray(b'\x00' * bin_len) |
| 644 | for srv in in_json.keys(): |
| 645 | service_nr = int(srv) |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 646 | (byte_offset, bit_offset) = EF_ServiceTable._bit_byte_offset_for_service( |
| 647 | service_nr) |
Harald Welte | 7a8aa86 | 2021-10-14 20:46:19 +0200 | [diff] [blame] | 648 | bits = 0 |
| 649 | if in_json[srv]['allocated'] == True: |
| 650 | bits |= 1 |
| 651 | if in_json[srv]['activated'] == True: |
| 652 | bits |= 2 |
| 653 | out[byte_offset] |= ((bits & 3) << bit_offset) |
| 654 | return out |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 655 | |
| 656 | # TS 51.011 Section 10.3.11 |
| 657 | class EF_SPN(TransparentEF): |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 658 | def __init__(self, fid='6f46', sfid=None, name='EF.SPN', |
Harald Welte | 13edf30 | 2022-07-21 15:19:23 +0200 | [diff] [blame] | 659 | desc='Service Provider Name', size=(17, 17), **kwargs): |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 660 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, **kwargs) |
Robert Falkenberg | b07a3e9 | 2021-05-07 15:23:20 +0200 | [diff] [blame] | 661 | self._construct = BitStruct( |
| 662 | # Byte 1 |
| 663 | 'rfu'/BitsRFU(6), |
| 664 | 'hide_in_oplmn'/Flag, |
| 665 | 'show_in_hplmn'/Flag, |
| 666 | # Bytes 2..17 |
| 667 | 'spn'/Bytewise(GsmString(16)) |
| 668 | ) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 669 | |
| 670 | # TS 51.011 Section 10.3.13 |
| 671 | class EF_CBMI(TransRecEF): |
Harald Welte | 13edf30 | 2022-07-21 15:19:23 +0200 | [diff] [blame] | 672 | def __init__(self, fid='6f45', sfid=None, name='EF.CBMI', size=(2, None), rec_len=2, |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 673 | desc='Cell Broadcast message identifier selection', **kwargs): |
| 674 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, rec_len=rec_len, **kwargs) |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 675 | self._construct = GreedyRange(Int16ub) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 676 | |
| 677 | # TS 51.011 Section 10.3.15 |
| 678 | class EF_ACC(TransparentEF): |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 679 | def __init__(self, fid='6f78', sfid=None, name='EF.ACC', |
Harald Welte | 13edf30 | 2022-07-21 15:19:23 +0200 | [diff] [blame] | 680 | desc='Access Control Class', size=(2, 2), **kwargs): |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 681 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, **kwargs) |
Harald Welte | 1e73d22 | 2022-02-13 11:32:50 +0100 | [diff] [blame] | 682 | self._construct = HexAdapter(Bytes(2)) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 683 | |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 684 | # TS 51.011 Section 10.3.16 |
| 685 | class EF_LOCI(TransparentEF): |
Harald Welte | 13edf30 | 2022-07-21 15:19:23 +0200 | [diff] [blame] | 686 | def __init__(self, fid='6f7e', sfid=None, name='EF.LOCI', desc='Location Information', size=(11, 11)): |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 687 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size) |
Harald Welte | 3c98d5e | 2022-07-20 07:40:05 +0200 | [diff] [blame] | 688 | self._construct = Struct('tmsi'/HexAdapter(Bytes(4)), 'lai'/HexAdapter(Bytes(5)), 'tmsi_time'/Int8ub, |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 689 | 'lu_status'/Enum(Byte, updated=0, not_updated=1, plmn_not_allowed=2, |
| 690 | location_area_not_allowed=3)) |
| 691 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 692 | # TS 51.011 Section 10.3.18 |
| 693 | class EF_AD(TransparentEF): |
Robert Falkenberg | 9d16fbc | 2021-04-12 11:43:22 +0200 | [diff] [blame] | 694 | class OP_MODE(enum.IntEnum): |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 695 | normal = 0x00 |
| 696 | type_approval = 0x80 |
| 697 | normal_and_specific_facilities = 0x01 |
| 698 | type_approval_and_specific_facilities = 0x81 |
| 699 | maintenance_off_line = 0x02 |
| 700 | cell_test = 0x04 |
Robert Falkenberg | 9d16fbc | 2021-04-12 11:43:22 +0200 | [diff] [blame] | 701 | #OP_MODE_DICT = {int(v) : str(v) for v in EF_AD.OP_MODE} |
| 702 | #OP_MODE_DICT_REVERSED = {str(v) : int(v) for v in EF_AD.OP_MODE} |
| 703 | |
Harald Welte | 13edf30 | 2022-07-21 15:19:23 +0200 | [diff] [blame] | 704 | def __init__(self, fid='6fad', sfid=None, name='EF.AD', desc='Administrative Data', size=(3, 4)): |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 705 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size) |
Robert Falkenberg | 9d16fbc | 2021-04-12 11:43:22 +0200 | [diff] [blame] | 706 | self._construct = BitStruct( |
| 707 | # Byte 1 |
| 708 | 'ms_operation_mode'/Bytewise(Enum(Byte, EF_AD.OP_MODE)), |
| 709 | # Byte 2 |
| 710 | 'rfu1'/Bytewise(ByteRFU), |
| 711 | # Byte 3 |
| 712 | 'rfu2'/BitsRFU(7), |
| 713 | 'ofm'/Flag, |
| 714 | # Byte 4 (optional), |
| 715 | 'extensions'/COptional(Struct( |
| 716 | 'rfu3'/BitsRFU(4), |
| 717 | 'mnc_len'/BitsInteger(4), |
| 718 | # Byte 5..N-4 (optional, RFU) |
| 719 | 'extensions'/Bytewise(GreedyBytesRFU) |
| 720 | )) |
| 721 | ) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 722 | |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 723 | # TS 51.011 Section 10.3.20 / 10.3.22 |
| 724 | class EF_VGCS(TransRecEF): |
Harald Welte | 13edf30 | 2022-07-21 15:19:23 +0200 | [diff] [blame] | 725 | def __init__(self, fid='6fb1', sfid=None, name='EF.VGCS', size=(4, 200), rec_len=4, |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 726 | desc='Voice Group Call Service', **kwargs): |
| 727 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, rec_len=rec_len, **kwargs) |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 728 | self._construct = BcdAdapter(Bytes(4)) |
| 729 | |
| 730 | # TS 51.011 Section 10.3.21 / 10.3.23 |
| 731 | class EF_VGCSS(TransparentEF): |
Harald Welte | 13edf30 | 2022-07-21 15:19:23 +0200 | [diff] [blame] | 732 | def __init__(self, fid='6fb2', sfid=None, name='EF.VGCSS', size=(7, 7), |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 733 | desc='Voice Group Call Service Status', **kwargs): |
| 734 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, **kwargs) |
Harald Welte | 5b9472d | 2023-01-24 17:26:59 +0100 | [diff] [blame] | 735 | self._construct = BitsSwapped(BitStruct( |
| 736 | 'flags'/Bit[50], Padding(6, pattern=b'\xff'))) |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 737 | |
| 738 | # TS 51.011 Section 10.3.24 |
| 739 | class EF_eMLPP(TransparentEF): |
Harald Welte | 13edf30 | 2022-07-21 15:19:23 +0200 | [diff] [blame] | 740 | def __init__(self, fid='6fb5', sfid=None, name='EF.eMLPP', size=(2, 2), |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 741 | desc='enhanced Multi Level Pre-emption and Priority', **kwargs): |
| 742 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, **kwargs) |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 743 | FlagsConstruct = FlagsEnum( |
| 744 | Byte, A=1, B=2, zero=4, one=8, two=16, three=32, four=64) |
| 745 | self._construct = Struct( |
| 746 | 'levels'/FlagsConstruct, 'fast_call_setup_cond'/FlagsConstruct) |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 747 | |
| 748 | # TS 51.011 Section 10.3.25 |
| 749 | class EF_AAeM(TransparentEF): |
Harald Welte | 13edf30 | 2022-07-21 15:19:23 +0200 | [diff] [blame] | 750 | def __init__(self, fid='6fb6', sfid=None, name='EF.AAeM', size=(1, 1), |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 751 | desc='Automatic Answer for eMLPP Service', **kwargs): |
| 752 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, **kwargs) |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 753 | FlagsConstruct = FlagsEnum( |
| 754 | Byte, A=1, B=2, zero=4, one=8, two=16, three=32, four=64) |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 755 | self._construct = Struct('auto_answer_prio_levels'/FlagsConstruct) |
| 756 | |
| 757 | # TS 51.011 Section 10.3.26 |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 758 | class EF_CBMID(EF_CBMI): |
Harald Welte | 13edf30 | 2022-07-21 15:19:23 +0200 | [diff] [blame] | 759 | def __init__(self, fid='6f48', sfid=None, name='EF.CBMID', size=(2, None), rec_len=2, |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 760 | desc='Cell Broadcast Message Identifier for Data Download', **kwargs): |
| 761 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, rec_len=rec_len, **kwargs) |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 762 | self._construct = GreedyRange(Int16ub) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 763 | |
Harald Welte | 89e5954 | 2021-04-02 21:33:13 +0200 | [diff] [blame] | 764 | # TS 51.011 Section 10.3.27 |
| 765 | class EF_ECC(TransRecEF): |
Harald Welte | 13edf30 | 2022-07-21 15:19:23 +0200 | [diff] [blame] | 766 | def __init__(self, fid='6fb7', sfid=None, name='EF.ECC', size=(3, 15), rec_len=3, |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 767 | desc='Emergency Call Codes', **kwargs): |
| 768 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, rec_len=rec_len, **kwargs) |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 769 | self._construct = GreedyRange(BcdAdapter(Bytes(3))) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 770 | |
| 771 | # TS 51.011 Section 10.3.28 |
| 772 | class EF_CBMIR(TransRecEF): |
Harald Welte | 13edf30 | 2022-07-21 15:19:23 +0200 | [diff] [blame] | 773 | def __init__(self, fid='6f50', sfid=None, name='EF.CBMIR', size=(4, None), rec_len=4, |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 774 | desc='Cell Broadcast message identifier range selection', **kwargs): |
| 775 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, rec_len=rec_len, **kwargs) |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 776 | self._construct = GreedyRange(Struct('lower'/Int16ub, 'upper'/Int16ub)) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 777 | |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 778 | # TS 51.011 Section 10.3.29 |
| 779 | class EF_DCK(TransparentEF): |
Harald Welte | 13edf30 | 2022-07-21 15:19:23 +0200 | [diff] [blame] | 780 | def __init__(self, fid='6f2c', sfid=None, name='EF.DCK', size=(16, 16), |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 781 | desc='Depersonalisation Control Keys', **kwargs): |
| 782 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, **kwargs) |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 783 | self._construct = Struct('network'/BcdAdapter(Bytes(4)), |
| 784 | 'network_subset'/BcdAdapter(Bytes(4)), |
| 785 | 'service_provider'/BcdAdapter(Bytes(4)), |
| 786 | 'corporate'/BcdAdapter(Bytes(4))) |
| 787 | # TS 51.011 Section 10.3.30 |
| 788 | class EF_CNL(TransRecEF): |
Harald Welte | 13edf30 | 2022-07-21 15:19:23 +0200 | [diff] [blame] | 789 | def __init__(self, fid='6f32', sfid=None, name='EF.CNL', size=(6, None), rec_len=6, |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 790 | desc='Co-operative Network List', **kwargs): |
| 791 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, rec_len=rec_len, **kwargs) |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 792 | |
Harald Welte | f6b37af | 2023-01-24 15:42:26 +0100 | [diff] [blame] | 793 | def _decode_record_hex(self, in_hex, **kwargs): |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 794 | (in_plmn, sub, svp, corp) = unpack('!3sBBB', h2b(in_hex)) |
| 795 | res = dec_plmn(b2h(in_plmn)) |
| 796 | res['network_subset'] = sub |
| 797 | res['service_provider_id'] = svp |
| 798 | res['corporate_id'] = corp |
| 799 | return res |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 800 | |
Harald Welte | f6b37af | 2023-01-24 15:42:26 +0100 | [diff] [blame] | 801 | def _encode_record_hex(self, in_json, **kwargs): |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 802 | plmn = enc_plmn(in_json['mcc'], in_json['mnc']) |
Vadim Yanitskiy | 1a95d2b | 2021-05-02 01:42:09 +0200 | [diff] [blame] | 803 | return b2h(pack('!3sBBB', |
| 804 | h2b(plmn), |
| 805 | in_json['network_subset'], |
| 806 | in_json['service_provider_id'], |
| 807 | in_json['corporate_id'])) |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 808 | |
| 809 | # TS 51.011 Section 10.3.31 |
| 810 | class EF_NIA(LinFixedEF): |
Harald Welte | 99e4cc0 | 2022-07-21 15:25:47 +0200 | [diff] [blame] | 811 | def __init__(self, fid='6f51', sfid=None, name='EF.NIA', rec_len=(1, 32), |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 812 | desc='Network\'s Indication of Alerting', **kwargs): |
| 813 | super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len=rec_len, **kwargs) |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 814 | self._construct = Struct( |
| 815 | 'alerting_category'/Int8ub, 'category'/GreedyBytes) |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 816 | |
| 817 | # TS 51.011 Section 10.3.32 |
| 818 | class EF_Kc(TransparentEF): |
Harald Welte | 13edf30 | 2022-07-21 15:19:23 +0200 | [diff] [blame] | 819 | def __init__(self, fid='6f20', sfid=None, name='EF.Kc', desc='Ciphering key Kc', size=(9, 9), **kwargs): |
Harald Welte | d90ceb8 | 2022-07-17 22:10:58 +0200 | [diff] [blame] | 820 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, **kwargs) |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 821 | self._construct = Struct('kc'/HexAdapter(Bytes(8)), 'cksn'/Int8ub) |
| 822 | |
| 823 | # TS 51.011 Section 10.3.33 |
| 824 | class EF_LOCIGPRS(TransparentEF): |
Harald Welte | 13edf30 | 2022-07-21 15:19:23 +0200 | [diff] [blame] | 825 | def __init__(self, fid='6f53', sfid=None, name='EF.LOCIGPRS', desc='GPRS Location Information', size=(14, 14)): |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 826 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size) |
Harald Welte | d2edd41 | 2023-01-31 16:49:03 +0100 | [diff] [blame^] | 827 | self._construct = Struct('ptmsi'/HexAdapter(Bytes(4)), 'ptmsi_sig'/HexAdapter(Bytes(3)), |
| 828 | 'rai'/HexAdapter(Bytes(6)), |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 829 | 'rau_status'/Enum(Byte, updated=0, not_updated=1, plmn_not_allowed=2, |
| 830 | routing_area_not_allowed=3)) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 831 | |
| 832 | # TS 51.011 Section 10.3.35..37 |
| 833 | class EF_xPLMNwAcT(TransRecEF): |
Harald Welte | 13edf30 | 2022-07-21 15:19:23 +0200 | [diff] [blame] | 834 | def __init__(self, fid, sfid=None, name=None, desc=None, size=(40, None), rec_len=5, **kwargs): |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 835 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, rec_len=rec_len, **kwargs) |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 836 | |
Harald Welte | f6b37af | 2023-01-24 15:42:26 +0100 | [diff] [blame] | 837 | def _decode_record_hex(self, in_hex, **kwargs): |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 838 | if in_hex[:6] == "ffffff": |
| 839 | return None |
| 840 | else: |
| 841 | return dec_xplmn_w_act(in_hex) |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 842 | |
Harald Welte | f6b37af | 2023-01-24 15:42:26 +0100 | [diff] [blame] | 843 | def _encode_record_hex(self, in_json, **kwargs): |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 844 | if in_json == None: |
| 845 | return "ffffff0000" |
| 846 | else: |
| 847 | hplmn = enc_plmn(in_json['mcc'], in_json['mnc']) |
| 848 | act = self.enc_act(in_json['act']) |
| 849 | return hplmn + act |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 850 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 851 | @staticmethod |
| 852 | def enc_act(in_list): |
| 853 | u16 = 0 |
| 854 | # first the simple ones |
| 855 | if 'UTRAN' in in_list: |
| 856 | u16 |= 0x8000 |
| 857 | if 'NG-RAN' in in_list: |
| 858 | u16 |= 0x0800 |
| 859 | if 'GSM COMPACT' in in_list: |
| 860 | u16 |= 0x0040 |
| 861 | if 'cdma2000 HRPD' in in_list: |
| 862 | u16 |= 0x0020 |
| 863 | if 'cdma2000 1xRTT' in in_list: |
| 864 | u16 |= 0x0010 |
| 865 | # E-UTRAN |
Philipp Maier | e7d4179 | 2021-04-29 16:20:07 +0200 | [diff] [blame] | 866 | if 'E-UTRAN' in in_list: |
| 867 | u16 |= 0x4000 |
Vadim Yanitskiy | 5452d64 | 2021-03-07 21:45:34 +0100 | [diff] [blame] | 868 | if 'E-UTRAN WB-S1' in in_list: |
| 869 | u16 |= 0x6000 |
| 870 | if 'E-UTRAN NB-S1' in in_list: |
| 871 | u16 |= 0x5000 |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 872 | # GSM mess |
| 873 | if 'GSM' in in_list and 'EC-GSM-IoT' in in_list: |
| 874 | u16 |= 0x008C |
| 875 | elif 'GSM' in in_list: |
| 876 | u16 |= 0x0084 |
| 877 | elif 'EC-GSM-IuT' in in_list: |
| 878 | u16 |= 0x0088 |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 879 | return '%04X' % (u16) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 880 | |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 881 | # TS 51.011 Section 10.3.38 |
| 882 | class EF_CPBCCH(TransRecEF): |
Harald Welte | 13edf30 | 2022-07-21 15:19:23 +0200 | [diff] [blame] | 883 | def __init__(self, fid='6f63', sfid=None, name='EF.CPBCCH', size=(2, 14), rec_len=2, |
Harald Welte | d90ceb8 | 2022-07-17 22:10:58 +0200 | [diff] [blame] | 884 | desc='CPBCCH Information', **kwargs): |
| 885 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, rec_len=rec_len, **kwargs) |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 886 | self._construct = Struct('cpbcch'/Int16ub) |
| 887 | |
| 888 | # TS 51.011 Section 10.3.39 |
| 889 | class EF_InvScan(TransparentEF): |
Harald Welte | 13edf30 | 2022-07-21 15:19:23 +0200 | [diff] [blame] | 890 | def __init__(self, fid='6f64', sfid=None, name='EF.InvScan', size=(1, 1), |
Harald Welte | d90ceb8 | 2022-07-17 22:10:58 +0200 | [diff] [blame] | 891 | desc='IOnvestigation Scan', **kwargs): |
| 892 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, **kwargs) |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 893 | self._construct = FlagsEnum( |
| 894 | Byte, in_limited_service_mode=1, after_successful_plmn_selection=2) |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 895 | |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 896 | # TS 51.011 Section 4.2.58 |
| 897 | class EF_PNN(LinFixedEF): |
| 898 | class FullNameForNetwork(BER_TLV_IE, tag=0x43): |
| 899 | # TS 24.008 10.5.3.5a |
Harald Welte | 857f110 | 2022-07-20 07:44:25 +0200 | [diff] [blame] | 900 | # TODO: proper decode |
| 901 | _construct = HexAdapter(GreedyBytes) |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 902 | |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 903 | class ShortNameForNetwork(BER_TLV_IE, tag=0x45): |
| 904 | # TS 24.008 10.5.3.5a |
Harald Welte | 857f110 | 2022-07-20 07:44:25 +0200 | [diff] [blame] | 905 | # TODO: proper decode |
| 906 | _construct = HexAdapter(GreedyBytes) |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 907 | |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 908 | class NetworkNameCollection(TLV_IE_Collection, nested=[FullNameForNetwork, ShortNameForNetwork]): |
| 909 | pass |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 910 | |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 911 | def __init__(self, fid='6fc5', sfid=None, name='EF.PNN', desc='PLMN Network Name', **kwargs): |
| 912 | super().__init__(fid, sfid=sfid, name=name, desc=desc, **kwargs) |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 913 | self._tlv = EF_PNN.NetworkNameCollection |
| 914 | |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 915 | # TS 51.011 Section 10.3.42 |
| 916 | class EF_OPL(LinFixedEF): |
Harald Welte | 99e4cc0 | 2022-07-21 15:25:47 +0200 | [diff] [blame] | 917 | def __init__(self, fid='6fc6', sfid=None, name='EF.OPL', rec_len=(8, 8), desc='Operator PLMN List', **kwargs): |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 918 | super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len=rec_len, **kwargs) |
Harald Welte | 3c98d5e | 2022-07-20 07:40:05 +0200 | [diff] [blame] | 919 | self._construct = Struct('lai'/Struct('mcc_mnc'/BcdAdapter(Bytes(3)), |
| 920 | 'lac_min'/HexAdapter(Bytes(2)), 'lac_max'/HexAdapter(Bytes(2))), 'pnn_record_id'/Int8ub) |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 921 | |
| 922 | # TS 51.011 Section 10.3.44 + TS 31.102 4.2.62 |
| 923 | class EF_MBI(LinFixedEF): |
Harald Welte | 99e4cc0 | 2022-07-21 15:25:47 +0200 | [diff] [blame] | 924 | def __init__(self, fid='6fc9', sfid=None, name='EF.MBI', rec_len=(4, 5), desc='Mailbox Identifier', **kwargs): |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 925 | super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len=rec_len, **kwargs) |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 926 | self._construct = Struct('mbi_voicemail'/Int8ub, 'mbi_fax'/Int8ub, 'mbi_email'/Int8ub, |
| 927 | 'mbi_other'/Int8ub, 'mbi_videocall'/COptional(Int8ub)) |
| 928 | |
| 929 | # TS 51.011 Section 10.3.45 + TS 31.102 4.2.63 |
| 930 | class EF_MWIS(LinFixedEF): |
Harald Welte | 99e4cc0 | 2022-07-21 15:25:47 +0200 | [diff] [blame] | 931 | def __init__(self, fid='6fca', sfid=None, name='EF.MWIS', rec_len=(5, 6), |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 932 | desc='Message Waiting Indication Status', **kwargs): |
| 933 | super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len=rec_len, **kwargs) |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 934 | self._construct = Struct('mwi_status'/FlagsEnum(Byte, voicemail=1, fax=2, email=4, other=8, videomail=16), |
| 935 | 'num_waiting_voicemail'/Int8ub, |
| 936 | 'num_waiting_fax'/Int8ub, 'num_waiting_email'/Int8ub, |
| 937 | 'num_waiting_other'/Int8ub, 'num_waiting_videomail'/COptional(Int8ub)) |
| 938 | |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 939 | # TS 51.011 Section 10.3.66 |
| 940 | class EF_SPDI(TransparentEF): |
| 941 | class ServiceProviderPLMN(BER_TLV_IE, tag=0x80): |
| 942 | # flexible numbers of 3-byte PLMN records |
| 943 | _construct = GreedyRange(BcdAdapter(Bytes(3))) |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 944 | |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 945 | class SPDI(BER_TLV_IE, tag=0xA3, nested=[ServiceProviderPLMN]): |
| 946 | pass |
| 947 | def __init__(self, fid='6fcd', sfid=None, name='EF.SPDI', |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 948 | desc='Service Provider Display Information', **kwargs): |
| 949 | super().__init__(fid, sfid=sfid, name=name, desc=desc, **kwargs) |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 950 | self._tlv = EF_SPDI.SPDI |
| 951 | |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 952 | # TS 51.011 Section 10.3.51 |
| 953 | class EF_MMSN(LinFixedEF): |
Harald Welte | 99e4cc0 | 2022-07-21 15:25:47 +0200 | [diff] [blame] | 954 | def __init__(self, fid='6fce', sfid=None, name='EF.MMSN', rec_len=(4, 20), desc='MMS Notification', **kwargs): |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 955 | super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len=rec_len, **kwargs) |
Harald Welte | 3c98d5e | 2022-07-20 07:40:05 +0200 | [diff] [blame] | 956 | self._construct = Struct('mms_status'/HexAdapter(Bytes(2)), 'mms_implementation'/HexAdapter(Bytes(1)), |
| 957 | 'mms_notification'/HexAdapter(Bytes(this._.total_len-4)), 'ext_record_nr'/Byte) |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 958 | |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 959 | # TS 51.011 Annex K.1 |
| 960 | class MMS_Implementation(BER_TLV_IE, tag=0x80): |
| 961 | _construct = FlagsEnum(Byte, WAP=1) |
| 962 | |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 963 | # TS 51.011 Section 10.3.53 |
| 964 | class EF_MMSICP(TransparentEF): |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 965 | class MMS_Relay_Server(BER_TLV_IE, tag=0x81): |
| 966 | # 3GPP TS 23.140 |
| 967 | pass |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 968 | |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 969 | class Interface_to_CN(BER_TLV_IE, tag=0x82): |
| 970 | # 3GPP TS 23.140 |
| 971 | pass |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 972 | |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 973 | class Gateway(BER_TLV_IE, tag=0x83): |
| 974 | # Address, Type of address, Port, Service, AuthType, AuthId, AuthPass / 3GPP TS 23.140 |
| 975 | pass |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 976 | |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 977 | class MMS_ConnectivityParamters(TLV_IE_Collection, |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 978 | nested=[MMS_Implementation, MMS_Relay_Server, Interface_to_CN, Gateway]): |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 979 | pass |
Harald Welte | 13edf30 | 2022-07-21 15:19:23 +0200 | [diff] [blame] | 980 | def __init__(self, fid='6fd0', sfid=None, name='EF.MMSICP', size=(1, None), |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 981 | desc='MMS Issuer Connectivity Parameters', **kwargs): |
| 982 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, **kwargs) |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 983 | self._tlv = EF_MMSICP.MMS_ConnectivityParamters |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 984 | |
| 985 | # TS 51.011 Section 10.3.54 |
| 986 | class EF_MMSUP(LinFixedEF): |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 987 | class MMS_UserPref_ProfileName(BER_TLV_IE, tag=0x81): |
| 988 | pass |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 989 | |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 990 | class MMS_UserPref_Info(BER_TLV_IE, tag=0x82): |
| 991 | pass |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 992 | |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 993 | class MMS_User_Preferences(TLV_IE_Collection, |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 994 | nested=[MMS_Implementation, MMS_UserPref_ProfileName, MMS_UserPref_Info]): |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 995 | pass |
Harald Welte | 99e4cc0 | 2022-07-21 15:25:47 +0200 | [diff] [blame] | 996 | def __init__(self, fid='6fd1', sfid=None, name='EF.MMSUP', rec_len=(1, None), |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 997 | desc='MMS User Preferences', **kwargs): |
| 998 | super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len=rec_len, **kwargs) |
Harald Welte | 6113fe9 | 2022-01-21 15:51:35 +0100 | [diff] [blame] | 999 | self._tlv = EF_MMSUP.MMS_User_Preferences |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 1000 | |
| 1001 | # TS 51.011 Section 10.3.55 |
| 1002 | class EF_MMSUCP(TransparentEF): |
Harald Welte | 13edf30 | 2022-07-21 15:19:23 +0200 | [diff] [blame] | 1003 | def __init__(self, fid='6fd2', sfid=None, name='EF.MMSUCP', size=(1, None), |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 1004 | desc='MMS User Connectivity Parameters', **kwargs): |
| 1005 | super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, **kwargs) |
Harald Welte | 790b270 | 2021-04-11 00:01:35 +0200 | [diff] [blame] | 1006 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1007 | |
| 1008 | class DF_GSM(CardDF): |
| 1009 | def __init__(self, fid='7f20', name='DF.GSM', desc='GSM Network related files'): |
| 1010 | super().__init__(fid=fid, name=name, desc=desc) |
| 1011 | files = [ |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1012 | EF_LP(), |
| 1013 | EF_IMSI(), |
| 1014 | EF_Kc(), |
| 1015 | EF_PLMNsel(), |
| 1016 | TransparentEF('6f31', None, 'EF.HPPLMN', |
| 1017 | 'Higher Priority PLMN search period'), |
| 1018 | EF_ACMmax(), |
| 1019 | EF_ServiceTable('6f38', None, 'EF.SST', |
Harald Welte | 13edf30 | 2022-07-21 15:19:23 +0200 | [diff] [blame] | 1020 | 'SIM service table', table=EF_SST_map, size=(2, 16)), |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1021 | CyclicEF('6f39', None, 'EF.ACM', |
Harald Welte | 99e4cc0 | 2022-07-21 15:25:47 +0200 | [diff] [blame] | 1022 | 'Accumulated call meter', rec_len=(3, 3)), |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1023 | TransparentEF('6f3e', None, 'EF.GID1', 'Group Identifier Level 1'), |
| 1024 | TransparentEF('6f3f', None, 'EF.GID2', 'Group Identifier Level 2'), |
| 1025 | EF_SPN(), |
| 1026 | TransparentEF('6f41', None, 'EF.PUCT', |
Harald Welte | 13edf30 | 2022-07-21 15:19:23 +0200 | [diff] [blame] | 1027 | 'Price per unit and currency table', size=(5, 5)), |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1028 | EF_CBMI(), |
| 1029 | TransparentEF('6f7f', None, 'EF.BCCH', |
Harald Welte | 13edf30 | 2022-07-21 15:19:23 +0200 | [diff] [blame] | 1030 | 'Broadcast control channels', size=(16, 16)), |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1031 | EF_ACC(), |
| 1032 | EF_PLMNsel('6f7b', None, 'EF.FPLMN', |
Harald Welte | 13edf30 | 2022-07-21 15:19:23 +0200 | [diff] [blame] | 1033 | 'Forbidden PLMNs', size=(12, 12)), |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1034 | EF_LOCI(), |
| 1035 | EF_AD(), |
| 1036 | TransparentEF('6fa3', None, 'EF.Phase', |
Harald Welte | 13edf30 | 2022-07-21 15:19:23 +0200 | [diff] [blame] | 1037 | 'Phase identification', size=(1, 1)), |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1038 | EF_VGCS(), |
| 1039 | EF_VGCSS(), |
| 1040 | EF_VGCS('6fb3', None, 'EF.VBS', 'Voice Broadcast Service'), |
| 1041 | EF_VGCSS('6fb4', None, 'EF.VBSS', |
| 1042 | 'Voice Broadcast Service Status'), |
| 1043 | EF_eMLPP(), |
| 1044 | EF_AAeM(), |
| 1045 | EF_CBMID(), |
| 1046 | EF_ECC(), |
| 1047 | EF_CBMIR(), |
| 1048 | EF_DCK(), |
| 1049 | EF_CNL(), |
| 1050 | EF_NIA(), |
| 1051 | EF_Kc('6f52', None, 'EF.KcGPRS', 'GPRS Ciphering key KcGPRS'), |
| 1052 | EF_LOCIGPRS(), |
| 1053 | TransparentEF('6f54', None, 'EF.SUME', 'SetUpMenu Elements'), |
| 1054 | EF_xPLMNwAcT('6f60', None, 'EF.PLMNwAcT', |
| 1055 | 'User controlled PLMN Selector with Access Technology'), |
| 1056 | EF_xPLMNwAcT('6f61', None, 'EF.OPLMNwAcT', |
| 1057 | 'Operator controlled PLMN Selector with Access Technology'), |
| 1058 | EF_xPLMNwAcT('6f62', None, 'EF.HPLMNwAcT', |
| 1059 | 'HPLMN Selector with Access Technology'), |
| 1060 | EF_CPBCCH(), |
| 1061 | EF_InvScan(), |
| 1062 | EF_PNN(), |
| 1063 | EF_OPL(), |
| 1064 | EF_ADN('6fc7', None, 'EF.MBDN', 'Mailbox Dialling Numbers'), |
| 1065 | EF_MBI(), |
| 1066 | EF_MWIS(), |
| 1067 | EF_ADN('6fcb', None, 'EF.CFIS', |
| 1068 | 'Call Forwarding Indication Status'), |
| 1069 | EF_EXT('6fc8', None, 'EF.EXT6', 'Externsion6 (MBDN)'), |
| 1070 | EF_EXT('6fcc', None, 'EF.EXT7', 'Externsion7 (CFIS)'), |
| 1071 | EF_SPDI(), |
| 1072 | EF_MMSN(), |
| 1073 | EF_EXT('6fcf', None, 'EF.EXT8', 'Extension8 (MMSN)'), |
| 1074 | EF_MMSICP(), |
| 1075 | EF_MMSUP(), |
| 1076 | EF_MMSUCP(), |
| 1077 | ] |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1078 | self.add_files(files) |
| 1079 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1080 | |
Philipp Maier | c8387dc | 2021-10-29 17:59:50 +0200 | [diff] [blame] | 1081 | class CardProfileSIM(CardProfile): |
Philipp Maier | a028c7d | 2021-11-08 16:12:03 +0100 | [diff] [blame] | 1082 | |
| 1083 | ORDER = 2 |
| 1084 | |
Philipp Maier | c8387dc | 2021-10-29 17:59:50 +0200 | [diff] [blame] | 1085 | def __init__(self): |
Philipp Maier | a4df942 | 2021-11-10 17:13:40 +0100 | [diff] [blame] | 1086 | sw = { |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1087 | 'Normal': { |
| 1088 | '9000': 'Normal ending of the command', |
| 1089 | '91xx': 'normal ending of the command, with extra information from the proactive SIM containing a command for the ME', |
| 1090 | '9exx': 'length XX of the response data given in case of a SIM data download error', |
| 1091 | '9fxx': 'length XX of the response data', |
Philipp Maier | a4df942 | 2021-11-10 17:13:40 +0100 | [diff] [blame] | 1092 | }, |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1093 | 'Postponed processing': { |
| 1094 | '9300': 'SIM Application Toolkit is busy. Command cannot be executed at present, further normal commands are allowed', |
Philipp Maier | a4df942 | 2021-11-10 17:13:40 +0100 | [diff] [blame] | 1095 | }, |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1096 | 'Memory management': { |
| 1097 | '920x': 'command successful but after using an internal update retry routine X times', |
| 1098 | '9240': 'memory problem', |
Philipp Maier | a4df942 | 2021-11-10 17:13:40 +0100 | [diff] [blame] | 1099 | }, |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1100 | 'Referencing management': { |
| 1101 | '9400': 'no EF selected', |
| 1102 | '9402': 'out of range (invalid address)', |
| 1103 | '9404': 'file ID not found or pattern not found', |
| 1104 | '9408': 'file is inconsistent with the command', |
Philipp Maier | a4df942 | 2021-11-10 17:13:40 +0100 | [diff] [blame] | 1105 | }, |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1106 | 'Security management': { |
| 1107 | '9802': 'no CHV initialized', |
| 1108 | '9804': 'access condition not fulfilled, unsuccessful CHV verification or authentication failed', |
| 1109 | '9808': 'in contradiction with CHV status', |
| 1110 | '9810': 'in contradiction with invalidation status', |
| 1111 | '9840': 'unsuccessful verification, CHV blocked, UNBLOCK CHV blocked', |
| 1112 | '9850': 'increase cannot be performed, Max value reached', |
Philipp Maier | a4df942 | 2021-11-10 17:13:40 +0100 | [diff] [blame] | 1113 | }, |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1114 | 'Application independent errors': { |
| 1115 | '67xx': 'incorrect parameter P3', |
| 1116 | '6bxx': 'incorrect parameter P1 or P2', |
| 1117 | '6dxx': 'unknown instruction code given in the command', |
| 1118 | '6exx': 'wrong instruction class given in the command', |
| 1119 | '6fxx': 'technical problem with no diagnostic given', |
Philipp Maier | a4df942 | 2021-11-10 17:13:40 +0100 | [diff] [blame] | 1120 | }, |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1121 | } |
Philipp Maier | a4df942 | 2021-11-10 17:13:40 +0100 | [diff] [blame] | 1122 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1123 | super().__init__('SIM', desc='GSM SIM Card', cla="a0", |
| 1124 | sel_ctrl="0000", files_in_mf=[DF_TELECOM(), DF_GSM()], sw=sw) |
Philipp Maier | 4ab971c | 2021-11-11 11:53:49 +0100 | [diff] [blame] | 1125 | |
Philipp Maier | 5998a3a | 2021-11-16 15:16:39 +0100 | [diff] [blame] | 1126 | @staticmethod |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1127 | def decode_select_response(resp_hex: str) -> object: |
Harald Welte | 5924ec4 | 2023-01-24 19:49:24 +0100 | [diff] [blame] | 1128 | # we try to build something that resembles a dict resulting from the TLV decoder |
| 1129 | # of TS 102.221 (FcpTemplate), so that higher-level code only has to deal with one |
| 1130 | # format of SELECT response |
Philipp Maier | 4ab971c | 2021-11-11 11:53:49 +0100 | [diff] [blame] | 1131 | resp_bin = h2b(resp_hex) |
| 1132 | struct_of_file_map = { |
| 1133 | 0: 'transparent', |
| 1134 | 1: 'linear_fixed', |
| 1135 | 3: 'cyclic' |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1136 | } |
Philipp Maier | 4ab971c | 2021-11-11 11:53:49 +0100 | [diff] [blame] | 1137 | type_of_file_map = { |
| 1138 | 1: 'mf', |
| 1139 | 2: 'df', |
| 1140 | 4: 'working_ef' |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1141 | } |
Philipp Maier | 4ab971c | 2021-11-11 11:53:49 +0100 | [diff] [blame] | 1142 | ret = { |
Harald Welte | 747a978 | 2022-02-13 17:52:28 +0100 | [diff] [blame] | 1143 | 'file_descriptor': { |
| 1144 | 'file_descriptor_byte': {}, |
| 1145 | }, |
Philipp Maier | 4ab971c | 2021-11-11 11:53:49 +0100 | [diff] [blame] | 1146 | 'proprietary_info': {}, |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1147 | } |
Philipp Maier | 4ab971c | 2021-11-11 11:53:49 +0100 | [diff] [blame] | 1148 | ret['file_id'] = b2h(resp_bin[4:6]) |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1149 | file_type = type_of_file_map[resp_bin[6] |
| 1150 | ] if resp_bin[6] in type_of_file_map else resp_bin[6] |
Harald Welte | 747a978 | 2022-02-13 17:52:28 +0100 | [diff] [blame] | 1151 | ret['file_descriptor']['file_descriptor_byte']['file_type'] = file_type |
Philipp Maier | 4ab971c | 2021-11-11 11:53:49 +0100 | [diff] [blame] | 1152 | if file_type in ['mf', 'df']: |
Harald Welte | 5924ec4 | 2023-01-24 19:49:24 +0100 | [diff] [blame] | 1153 | ret['proprietary_info']['available_memory'] = int.from_bytes(resp_bin[2:4], 'big') |
Philipp Maier | 4ab971c | 2021-11-11 11:53:49 +0100 | [diff] [blame] | 1154 | ret['file_characteristics'] = b2h(resp_bin[13:14]) |
| 1155 | ret['num_direct_child_df'] = resp_bin[14] |
| 1156 | ret['num_direct_child_ef'] = resp_bin[15] |
| 1157 | ret['num_chv_unblock_adm_codes'] = int(resp_bin[16]) |
| 1158 | # CHV / UNBLOCK CHV stats |
| 1159 | elif file_type in ['working_ef']: |
Harald Welte | 5924ec4 | 2023-01-24 19:49:24 +0100 | [diff] [blame] | 1160 | ret['file_size'] = int.from_bytes(resp_bin[2:4], 'big') |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1161 | file_struct = struct_of_file_map[resp_bin[13] |
| 1162 | ] if resp_bin[13] in struct_of_file_map else resp_bin[13] |
Harald Welte | 747a978 | 2022-02-13 17:52:28 +0100 | [diff] [blame] | 1163 | ret['file_descriptor']['file_descriptor_byte']['structure'] = file_struct |
Harald Welte | 5924ec4 | 2023-01-24 19:49:24 +0100 | [diff] [blame] | 1164 | if file_struct != 'transparent': |
| 1165 | record_len = resp_bin[14] |
| 1166 | ret['file_descriptor']['record_len'] = record_len |
| 1167 | ret['file_descriptor']['num_of_rec'] = ret['file_size'] // record_len |
Philipp Maier | 4ab971c | 2021-11-11 11:53:49 +0100 | [diff] [blame] | 1168 | ret['access_conditions'] = b2h(resp_bin[8:10]) |
| 1169 | if resp_bin[11] & 0x01 == 0: |
| 1170 | ret['life_cycle_status_int'] = 'operational_activated' |
| 1171 | elif resp_bin[11] & 0x04: |
| 1172 | ret['life_cycle_status_int'] = 'operational_deactivated' |
| 1173 | else: |
| 1174 | ret['life_cycle_status_int'] = 'terminated' |
| 1175 | return ret |
Philipp Maier | a028c7d | 2021-11-08 16:12:03 +0100 | [diff] [blame] | 1176 | |
| 1177 | @staticmethod |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1178 | def match_with_card(scc: SimCardCommands) -> bool: |
Philipp Maier | a028c7d | 2021-11-08 16:12:03 +0100 | [diff] [blame] | 1179 | return match_sim(scc) |