public/pysim
1
0
Fork 1
mirror of https://gitea.osmocom.org/sim-card/pysim.git synced 2026-03-25 14:58:33 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add a new pySim-shell program

Browse Source 
pySim-prog was nice when there were only 5 parameters on a SIM that we
could program, and where the use case was pretty limited.  Today, we
have SIM/USIM/ISIM cards with hundreds of files and even more parameters
to program.  We cannot add a command line argument for each file to
pySim-prog.

Instead, this introduces an interactive command-line shell / REPL,
in which one can navigate the file system of the card, read and update
files both in raw format and in decoded/parsed format.

The idea is primarily inspired by Henryk Ploatz' venerable
cyberflex-shell, but implemented on a more modern basis using
the cmd2 python module.

See https://lists.osmocom.org/pipermail/simtrace/2021-January/000860.html
and https://lists.osmocom.org/pipermail/simtrace/2021-February/000864.html
for some related background.

Most code by Harald Welte. Some bug fixes by Philipp Maier
have been squashed.

Change-Id: Iad117596e922223bdc1e5b956f84844b7c577e02
Related: OS#4963
This commit is contained in:
Harald Welte
2021-01-08 23:29:35 +01:00
parent 4f6ca43e1f
commit b2edd14475
8 changed files with 1800 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

131
pySim/ts_31_102.py
View File

@@ -263,3 +263,134 @@ EF_USIM_ADF_map = {
'ePDGIdEm': '6FF5',
'ePDGSelectionEm': '6FF6',
}
######################################################################
# ADF.USIM
######################################################################
from pySim.filesystem import *
from pySim.ts_51_011 import EF_IMSI, EF_xPLMNwAcT, EF_SPN, EF_CBMI, EF_ACC, EF_PLMNsel, EF_AD
from pySim.ts_51_011 import EF_CBMID, EF_ECC, EF_CBMIR
import pySim.ts_102_221
class EF_LI(TransRecEF):
def __init__(self, fid='6f05', sfid=None, name='EF.LI', size={2,None}, rec_len=2,
desc='Language Indication'):
super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, rec_len=rec_len)
def _decode_record_bin(self, in_bin):
if in_bin == b'\xff\xff':
return None
else:
# officially this is 7-bit GSM alphabet with one padding bit in each byte
return in_bin.decode('ascii')
def _encode_record_bin(self, in_json):
if in_json == None:
return b'\xff\xff'
else:
# officially this is 7-bit GSM alphabet with one padding bit in each byte
return in_json.encode('ascii')
class EF_Keys(TransparentEF):
def __init__(self, fid='6f08', sfid=0x08, name='EF.Keys', size={33,33},
desc='Ciphering and Integrity Keys'):
super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size)
def _decode_bin(self, in_bin):
return {'ksi': in_bin[0],
'ck': b2h(in_bin[1:17]),
'ik': b2h(in_bin[17:33])}
def _encode_bin(self, in_json):
return h2b(in_json['ksi']) + h2b(in_json['ck']) + h2b(in_json['ik'])
# TS 31.103 Section 4.2.7
class EF_UST(TransparentEF):
def __init__(self, fid='6f38', sfid=0x04, name='EF.UST', desc='USIM Service Table'):
super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, size={1,17})
# add those commands to the general commands of a TransparentEF
self.shell_commands += [self.AddlShellCommands()]
def _decode_bin(self, in_bin):
ret = []
for i in range (0, len(in_bin)):
byte = in_bin[i]
for bitno in range(0,7):
if byte & (1 << bitno):
ret.append(i * 8 + bitno + 1)
return ret
def _encode_bin(self, in_json):
# FIXME: size this to length of file
ret = bytearray(20)
for srv in in_json:
print("srv=%d"%srv)
srv = srv-1
byte_nr = srv // 8
# FIXME: detect if service out of range was selected
bit_nr = srv % 8
ret[byte_nr] |= (1 << bit_nr)
return ret
@with_default_category('File-Specific Commands')
class AddlShellCommands(CommandSet):
def __init__(self):
super().__init__()
def do_ust_service_activate(self, arg):
"""Activate a service within EF.UST"""
self._cmd.card.update_ust(int(arg), 1)
def do_ust_service_deactivate(self, arg):
"""Deactivate a service within EF.UST"""
self._cmd.card.update_ust(int(arg), 0)
class ADF_USIM(CardADF):
def __init__(self, aid='a0000000871002', name='ADF.USIM', fid=None, sfid=None,
desc='USIM Application'):
super().__init__(aid=aid, fid=fid, sfid=sfid, name=name, desc=desc)
self.shell_commands = [self.ShellCommands()]
files = [
EF_LI(sfid=0x02),
EF_IMSI(sfid=0x07),
EF_Keys(),
EF_Keys('6f09', 0x09, 'EF.KeysPS', desc='Ciphering and Integrity Keys for PS domain'),
EF_xPLMNwAcT('6f60', 0x0a, 'EF.PLMNwAcT',
'User controlled PLMN Selector with Access Technology'),
TransparentEF('6f31', 0x12, 'EF.HPPLMN', 'Higher Priority PLMN search period'),
# EF.ACMmax
EF_UST(),
CyclicEF('6f39', None, 'EF.ACM', 'Accumulated call meter', rec_len={3,3}),
TransparentEF('6f3e', None, 'EF.GID1', 'Group Identifier Level 1'),
TransparentEF('6f3f', None, 'EF.GID2', 'Group Identifier Level 2'),
EF_SPN(),
TransparentEF('6f41', None, 'EF.PUCT', 'Price per unit and currency table', size={5,5}),
EF_CBMI(),
EF_ACC(sfid=0x06),
EF_PLMNsel('6f7b', 0x0d, 'EF.FPLMN', 'Forbidden PLMNs', size={12,None}),
TransparentEF('6f7e', 0x0b, 'EF.LOCI', 'Locationn information', size={11,11}),
EF_AD(sfid=0x03),
EF_CBMID(sfid=0x0e),
EF_ECC(sfid=0x01),
EF_CBMIR(),
]
self.add_files(files)
def decode_select_response(self, data_hex):
return pySim.ts_102_221.decode_select_response(data_hex)
@with_default_category('File-Specific Commands')
class ShellCommands(CommandSet):
def __init__(self):
super().__init__()
# TS 31.102 Section 7.3
sw_usim = {
'Security management': {
'9862': 'Authentication error, incorrect MAC',
'9864': 'Authentication error, security context not supported',
'9865': 'Key freshness failure',
'9866': 'Authentication error, no memory space available',
'9867': 'Authentication error, no memory space available in EF MUK',
}
}
CardApplicationUSIM = CardApplication('USIM', adf=ADF_USIM(), sw=sw_usim)