Supreeth Herle | 8b72c27 | 2020-03-22 08:55:50 +0100 | [diff] [blame] | 1 | # -*- coding: utf-8 -*- |
| 2 | |
| 3 | """ |
Harald Welte | 16ec96a | 2021-04-21 10:46:19 +0200 | [diff] [blame] | 4 | Various constants from 3GPP TS 31.103 V16.1.0 |
Supreeth Herle | 8b72c27 | 2020-03-22 08:55:50 +0100 | [diff] [blame] | 5 | """ |
| 6 | |
| 7 | # |
| 8 | # Copyright (C) 2020 Supreeth Herle <herlesupreeth@gmail.com> |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 9 | # Copyright (C) 2021 Harald Welte <laforge@osmocom.org> |
Supreeth Herle | 8b72c27 | 2020-03-22 08:55:50 +0100 | [diff] [blame] | 10 | # |
| 11 | # This program is free software: you can redistribute it and/or modify |
| 12 | # it under the terms of the GNU General Public License as published by |
| 13 | # the Free Software Foundation, either version 2 of the License, or |
| 14 | # (at your option) any later version. |
| 15 | # |
| 16 | # This program is distributed in the hope that it will be useful, |
| 17 | # but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 18 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 19 | # GNU General Public License for more details. |
| 20 | # |
| 21 | # You should have received a copy of the GNU General Public License |
| 22 | # along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 23 | # |
| 24 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 25 | from pySim.filesystem import * |
| 26 | from pySim.utils import * |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 27 | from pySim.tlv import * |
Harald Welte | 35dfe82 | 2021-04-21 10:50:12 +0200 | [diff] [blame] | 28 | from pySim.ts_51_011 import EF_AD, EF_SMS, EF_SMSS, EF_SMSR, EF_SMSP |
Harald Welte | e894749 | 2022-02-10 10:33:20 +0100 | [diff] [blame] | 29 | from pySim.ts_31_102 import ADF_USIM, EF_FromPreferred, EF_UServiceTable |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 30 | import pySim.ts_102_221 |
Harald Welte | fc4833e | 2021-05-02 21:46:06 +0200 | [diff] [blame] | 31 | from pySim.ts_102_221 import EF_ARR |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 32 | |
Supreeth Herle | 8b72c27 | 2020-03-22 08:55:50 +0100 | [diff] [blame] | 33 | # Mapping between ISIM Service Number and its description |
| 34 | EF_IST_map = { |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 35 | 1: 'P-CSCF address', |
| 36 | 2: 'Generic Bootstrapping Architecture (GBA)', |
| 37 | 3: 'HTTP Digest', |
| 38 | 4: 'GBA-based Local Key Establishment Mechanism', |
| 39 | 5: 'Support of P-CSCF discovery for IMS Local Break Out', |
| 40 | 6: 'Short Message Storage (SMS)', |
| 41 | 7: 'Short Message Status Reports (SMSR)', |
| 42 | 8: 'Support for SM-over-IP including data download via SMS-PP as defined in TS 31.111 [31]', |
| 43 | 9: 'Communication Control for IMS by ISIM', |
| 44 | 10: 'Support of UICC access to IMS', |
| 45 | 11: 'URI support by UICC', |
| 46 | 12: 'Media Type support', |
| 47 | 13: 'IMS call disconnection cause', |
| 48 | 14: 'URI support for MO SHORT MESSAGE CONTROL', |
| 49 | 15: 'MCPTT', |
| 50 | 16: 'URI support for SMS-PP DOWNLOAD as defined in 3GPP TS 31.111 [31]', |
| 51 | 17: 'From Preferred', |
| 52 | 18: 'IMS configuration data', |
| 53 | 19: 'XCAP Configuration Data', |
| 54 | 20: 'WebRTC URI', |
| 55 | 21: 'MuD and MiD configuration data', |
Supreeth Herle | 8b72c27 | 2020-03-22 08:55:50 +0100 | [diff] [blame] | 56 | } |
herlesupreeth | 75c14c0 | 2020-12-23 09:41:07 +0100 | [diff] [blame] | 57 | |
| 58 | EF_ISIM_ADF_map = { |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 59 | 'IST': '6F07', |
| 60 | 'IMPI': '6F02', |
| 61 | 'DOMAIN': '6F03', |
| 62 | 'IMPU': '6F04', |
| 63 | 'AD': '6FAD', |
| 64 | 'ARR': '6F06', |
| 65 | 'PCSCF': '6F09', |
| 66 | 'GBAP': '6FD5', |
| 67 | 'GBANL': '6FD7', |
| 68 | 'NAFKCA': '6FDD', |
| 69 | 'UICCIARI': '6FE7', |
| 70 | 'SMS': '6F3C', |
| 71 | 'SMSS': '6F43', |
| 72 | 'SMSR': '6F47', |
| 73 | 'SMSP': '6F42', |
| 74 | 'FromPreferred': '6FF7', |
| 75 | 'IMSConfigData': '6FF8', |
| 76 | 'XCAPConfigData': '6FFC', |
| 77 | 'WebRTCURI': '6FFA' |
herlesupreeth | 75c14c0 | 2020-12-23 09:41:07 +0100 | [diff] [blame] | 78 | } |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 79 | |
| 80 | # TS 31.103 Section 4.2.2 |
| 81 | class EF_IMPI(TransparentEF): |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 82 | class nai(BER_TLV_IE, tag=0x80): |
| 83 | _construct = GreedyString("utf8") |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 84 | |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 85 | def __init__(self, fid='6f02', sfid=0x02, name='EF.IMPI', desc='IMS private user identity', **kwargs): |
| 86 | super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, **kwargs) |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 87 | self._tlv = EF_IMPI.nai |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 88 | |
| 89 | # TS 31.103 Section 4.2.3 |
| 90 | class EF_DOMAIN(TransparentEF): |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 91 | class domain(BER_TLV_IE, tag=0x80): |
| 92 | _construct = GreedyString("utf8") |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 93 | |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 94 | def __init__(self, fid='6f05', sfid=0x05, name='EF.DOMAIN', desc='Home Network Domain Name', **kwargs): |
| 95 | super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, **kwargs) |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 96 | self._tlv = EF_DOMAIN.domain |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 97 | |
| 98 | # TS 31.103 Section 4.2.4 |
| 99 | class EF_IMPU(LinFixedEF): |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 100 | class impu(BER_TLV_IE, tag=0x80): |
| 101 | _construct = GreedyString("utf8") |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 102 | |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 103 | def __init__(self, fid='6f04', sfid=0x04, name='EF.IMPU', desc='IMS public user identity', **kwargs): |
| 104 | super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, **kwargs) |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 105 | self._tlv = EF_IMPU.impu |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 106 | |
Harald Welte | 6ca2fa7 | 2022-02-12 16:29:31 +0100 | [diff] [blame] | 107 | # TS 31.103 Section 4.2.7 |
| 108 | class EF_IST(EF_UServiceTable): |
| 109 | def __init__(self, **kwargs): |
| 110 | super().__init__('6f07', 0x07, 'EF.IST', 'ISIM Service Table', {1, None}, EF_IST_map) |
| 111 | # add those commands to the general commands of a TransparentEF |
| 112 | self.shell_commands += [self.AddlShellCommands()] |
| 113 | |
| 114 | @with_default_category('File-Specific Commands') |
| 115 | class AddlShellCommands(CommandSet): |
| 116 | def __init__(self): |
| 117 | super().__init__() |
| 118 | |
| 119 | def do_ist_service_activate(self, arg): |
| 120 | """Activate a service within EF.IST""" |
| 121 | self._cmd.card.update_ist(int(arg), 1) |
| 122 | |
| 123 | def do_ist_service_deactivate(self, arg): |
| 124 | """Deactivate a service within EF.IST""" |
| 125 | self._cmd.card.update_ist(int(arg), 0) |
| 126 | |
| 127 | def do_ist_service_check(self, arg): |
| 128 | """Check consistency between services of this file and files present/activated""" |
| 129 | selected_file = self._cmd.rs.selected_file |
| 130 | selected_file.ust_service_check(self._cmd) |
| 131 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 132 | # TS 31.103 Section 4.2.8 |
| 133 | class EF_PCSCF(LinFixedEF): |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 134 | def __init__(self, fid='6f09', sfid=None, name='EF.P-CSCF', desc='P-CSCF Address', **kwargs): |
| 135 | super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, **kwargs) |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 136 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 137 | def _decode_record_hex(self, raw_hex): |
Philipp Maier | 86b09da | 2021-04-30 15:13:57 +0200 | [diff] [blame] | 138 | addr, addr_type = dec_addr_tlv(raw_hex) |
| 139 | return {"addr": addr, "addr_type": addr_type} |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 140 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 141 | def _encode_record_hex(self, json_in): |
Philipp Maier | 86b09da | 2021-04-30 15:13:57 +0200 | [diff] [blame] | 142 | addr = json_in['addr'] |
| 143 | addr_type = json_in['addr_type'] |
| 144 | return enc_addr_tlv(addr, addr_type) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 145 | |
| 146 | # TS 31.103 Section 4.2.9 |
Harald Welte | 89e5954 | 2021-04-02 21:33:13 +0200 | [diff] [blame] | 147 | class EF_GBABP(TransparentEF): |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 148 | def __init__(self, fid='6fd5', sfid=None, name='EF.GBABP', desc='GBA Bootstrapping', **kwargs): |
| 149 | super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, **kwargs) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 150 | |
| 151 | # TS 31.103 Section 4.2.10 |
| 152 | class EF_GBANL(LinFixedEF): |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 153 | def __init__(self, fid='6fd7', sfid=None, name='EF.GBANL', desc='GBA NAF List', **kwargs): |
| 154 | super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, **kwargs) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 155 | |
| 156 | # TS 31.103 Section 4.2.11 |
| 157 | class EF_NAFKCA(LinFixedEF): |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 158 | def __init__(self, fid='6fdd', sfid=None, name='EF.NAFKCA', desc='NAF Key Centre Address', **kwargs): |
| 159 | super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, **kwargs) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 160 | |
| 161 | # TS 31.103 Section 4.2.16 |
| 162 | class EF_UICCIARI(LinFixedEF): |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 163 | class iari(BER_TLV_IE, tag=0x80): |
| 164 | _construct = GreedyString("utf8") |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 165 | |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 166 | def __init__(self, fid='6fe7', sfid=None, name='EF.UICCIARI', desc='UICC IARI', **kwargs): |
| 167 | super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, **kwargs) |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 168 | self._tlv = EF_UICCIARI.iari |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 169 | |
| 170 | # TS 31.103 Section 4.2.18 |
Harald Welte | 2788162 | 2021-04-21 11:16:31 +0200 | [diff] [blame] | 171 | class EF_IMSConfigData(BerTlvEF): |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 172 | def __init__(self, fid='6ff8', sfid=None, name='EF.IMSConfigData', desc='IMS Configuration Data', **kwargs): |
| 173 | super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, **kwargs) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 174 | |
| 175 | # TS 31.103 Section 4.2.19 |
Harald Welte | 2788162 | 2021-04-21 11:16:31 +0200 | [diff] [blame] | 176 | class EF_XCAPConfigData(BerTlvEF): |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 177 | def __init__(self, fid='6ffc', sfid=None, name='EF.XCAPConfigData', desc='XCAP Configuration Data', **kwargs): |
| 178 | super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, **kwargs) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 179 | |
| 180 | # TS 31.103 Section 4.2.20 |
| 181 | class EF_WebRTCURI(TransparentEF): |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 182 | class uri(BER_TLV_IE, tag=0x80): |
| 183 | _construct = GreedyString("utf8") |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 184 | |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 185 | def __init__(self, fid='6ffa', sfid=None, name='EF.WebRTCURI', desc='WebRTC URI', **kwargs): |
| 186 | super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, **kwargs) |
Harald Welte | 14105dc | 2021-05-31 08:48:51 +0200 | [diff] [blame] | 187 | self._tlv = EF_WebRTCURI.uri |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 188 | |
Harald Welte | 16ec96a | 2021-04-21 10:46:19 +0200 | [diff] [blame] | 189 | # TS 31.103 Section 4.2.21 |
Harald Welte | 2788162 | 2021-04-21 11:16:31 +0200 | [diff] [blame] | 190 | class EF_MuDMiDConfigData(BerTlvEF): |
Harald Welte | 16ec96a | 2021-04-21 10:46:19 +0200 | [diff] [blame] | 191 | def __init__(self, fid='6ffe', sfid=None, name='EF.MuDMiDConfigData', |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 192 | desc='MuD and MiD Configuration Data', **kwargs): |
| 193 | super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, **kwargs) |
Harald Welte | 16ec96a | 2021-04-21 10:46:19 +0200 | [diff] [blame] | 194 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 195 | |
| 196 | class ADF_ISIM(CardADF): |
| 197 | def __init__(self, aid='a0000000871004', name='ADF.ISIM', fid=None, sfid=None, |
| 198 | desc='ISIM Application'): |
| 199 | super().__init__(aid=aid, fid=fid, sfid=sfid, name=name, desc=desc) |
| 200 | |
| 201 | files = [ |
| 202 | EF_IMPI(), |
| 203 | EF_DOMAIN(), |
| 204 | EF_IMPU(), |
| 205 | EF_AD(), |
Harald Welte | fc4833e | 2021-05-02 21:46:06 +0200 | [diff] [blame] | 206 | EF_ARR('6f06', 0x06), |
Harald Welte | 6ca2fa7 | 2022-02-12 16:29:31 +0100 | [diff] [blame] | 207 | EF_IST(), |
Harald Welte | 6169c72 | 2022-02-12 09:05:15 +0100 | [diff] [blame] | 208 | EF_PCSCF(service=5), |
| 209 | EF_GBABP(service=2), |
| 210 | EF_GBANL(service=2), |
| 211 | EF_NAFKCA(service=2), |
| 212 | EF_SMS(service=(6,8)), |
| 213 | EF_SMSS(service=(6,8)), |
| 214 | EF_SMSR(service=(7,8)), |
| 215 | EF_SMSP(service=8), |
| 216 | EF_UICCIARI(service=10), |
| 217 | EF_FromPreferred(service=17), |
| 218 | EF_IMSConfigData(service=18), |
| 219 | EF_XCAPConfigData(service=19), |
| 220 | EF_WebRTCURI(service=20), |
| 221 | EF_MuDMiDConfigData(service=21), |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 222 | ] |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 223 | self.add_files(files) |
Harald Welte | 15fae98 | 2021-04-10 10:22:27 +0200 | [diff] [blame] | 224 | # add those commands to the general commands of a TransparentEF |
| 225 | self.shell_commands += [ADF_USIM.AddlShellCommands()] |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 226 | |
| 227 | def decode_select_response(self, data_hex): |
Philipp Maier | 5998a3a | 2021-11-16 15:16:39 +0100 | [diff] [blame] | 228 | return pySim.ts_102_221.CardProfileUICC.decode_select_response(data_hex) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 229 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 230 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 231 | # TS 31.103 Section 7.1 |
| 232 | sw_isim = { |
| 233 | 'Security management': { |
| 234 | '9862': 'Authentication error, incorrect MAC', |
| 235 | '9864': 'Authentication error, security context not supported', |
| 236 | } |
| 237 | } |
| 238 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 239 | |
Philipp Maier | 57f65ee | 2021-10-18 14:09:02 +0200 | [diff] [blame] | 240 | class CardApplicationISIM(CardApplication): |
| 241 | def __init__(self): |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 242 | super().__init__('ISIM', adf=ADF_ISIM(), sw=sw_isim) |