aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHarald Welte <laforge@osmocom.org>2021-01-08 23:29:35 +0100
committerHarald Welte <laforge@osmocom.org>2021-01-26 19:04:08 +0100
commit64119924cebb65ad3b6bb8e9a5d035a96f2eae84 (patch)
treec9f5f7272911e1756e4b9ec95340a531fadeb6d9
parent516b26e99de5626ff8a228472f8ac086eb380b7c (diff)
WIP: Add a new pysim-shell program
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. This is still an early beginning. Change-Id: Iad117596e922223bdc1e5b956f84844b7c577e02
-rw-r--r--pySim/exceptions.py7
-rw-r--r--pySim/filesystem.py693
-rw-r--r--pySim/ts_102_221.py224
-rw-r--r--pySim/ts_31_102.py81
-rw-r--r--pySim/ts_31_103.py127
-rw-r--r--pySim/ts_51_011.py200
-rwxr-xr-xpysim-shell.py211
7 files changed, 1541 insertions, 2 deletions
diff --git a/pySim/exceptions.py b/pySim/exceptions.py
index e959a70..0bea2bd 100644
--- a/pySim/exceptions.py
+++ b/pySim/exceptions.py
@@ -42,8 +42,13 @@ class ReaderError(Exception):
class SwMatchError(Exception):
"""Raised when an operation specifies an expected SW but the actual SW from
the card doesn't match."""
- def __init__(self, sw_actual, sw_expected):
+ def __init__(self, sw_actual, sw_expected, rs=None):
self.sw_actual = sw_actual
self.sw_expected = sw_expected
+ self.rs = rs
def __str__(self):
+ if self.rs:
+ r = self.rs.interpret_sw(sw_actual)
+ if r:
+ return "SW %s: %s - %s" % (self.sw_actual, r[0], r[1])
return "Received %s but expected %s from card" % (self.sw_actual, self.sw_expected)
diff --git a/pySim/filesystem.py b/pySim/filesystem.py
new file mode 100644
index 0000000..d5af0b1
--- /dev/null
+++ b/pySim/filesystem.py
@@ -0,0 +1,693 @@
+# coding=utf-8
+"""Representation of the ISO7816-4 filesystem model.
+
+The File (and its derived classes) represent the structure / hierarchy
+of the ISO7816-4 smart card file system with the MF, DF, EF and ADF
+entries, further sub-divided into the EF sub-types Transparent, Linear Fixed, etc.
+
+The classes are intended to represent the *specification* of the filesystem,
+not the actual contents / runtime state of interacting with a given smart card.
+
+(C) 2021 by Harald Welte <laforge@osmocom.org>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+"""
+
+import code
+import json
+
+import cmd2
+from cmd2 import CommandSet, with_default_category, with_argparser
+import argparse
+
+from pySim.utils import sw_match, h2b, b2h
+from pySim.exceptions import *
+
+class CardFile(object):
+ """Base class for all objects in the smart card filesystem.
+ Serve as a common ancestor to all other file types; rarely used directly.
+ """
+ RESERVED_NAMES = ['..', '.', '/', 'MF']
+ RESERVED_FIDS = ['3f00']
+
+ def __init__(self, fid=None, sfid=None, name=None, desc=None, parent=None):
+ if not isinstance(self, CardADF) and fid == None:
+ raise ValueError("fid is mandatory")
+ if fid:
+ fid = fid.lower()
+ self.fid = fid # file identifier
+ self.sfid = sfid # short file identifier
+ self.name = name # human readable name
+ self.desc = desc # human readable description
+ self.parent = parent
+ if self.parent and self.parent != self and self.fid:
+ self.parent.add_file(self)
+ self.shell_commands = []
+
+ def __str__(self):
+ if self.name:
+ return self.name
+ else:
+ return self.fid
+
+ def _path_element(self, prefer_name):
+ if prefer_name and self.name:
+ return self.name
+ else:
+ return self.fid
+
+ def fully_qualified_path(self, prefer_name=True):
+ """Return fully qualified path to file as list of FID or name strings."""
+ if self.parent != self:
+ ret = self.parent.fully_qualified_path(prefer_name)
+ else:
+ ret = []
+ ret.append(self._path_element(prefer_name))
+ return ret
+
+ def get_mf(self):
+ """Return the MF (root) of the file system."""
+ if self.parent == None:
+ return None
+ # iterate towards the top. MF has parent == self
+ node = self
+ while node.parent != node:
+ node = node.parent
+ return node
+
+ def _get_self_selectables(self, alias=None):
+ """Return a dict of {'identifier': self} tuples"""
+ sels = {}
+ if alias:
+ sels |= {alias: self}
+ if self.fid:
+ sels |= {self.fid: self}
+ if self.name:
+ sels |= {self.name: self}
+ return sels
+
+ def get_selectables(self):
+ """Return a dict of {'identifier': File} that is selectable from the current file."""
+ # we can always select ourself
+ sels = self._get_self_selectables('.')
+ # we can always select our parent
+ sels = self.parent._get_self_selectables('..')
+ # if we have a MF, we can always select its applications
+ mf = self.get_mf()
+ if mf:
+ sels |= mf.get_app_selectables()
+ return sels
+
+ def get_selectable_names(self):
+ """Return a list of strings for all identifiers that are selectable from the current file."""
+ sels = self.get_selectables()
+ return sels.keys()
+
+ def decode_select_response(self, data_hex):
+ """Decode the response to a SELECT command."""
+ return self.parent.decode_select_response(data_hex)
+
+
+class CardDF(CardFile):
+ """DF (Dedicated File) in the smart card filesystem. Those are basically sub-directories."""
+ def __init__(self, **kwargs):
+ if not isinstance(self, CardADF):
+ if not 'fid' in kwargs:
+ raise TypeError('fid is mandatory for all DF')
+ super().__init__(**kwargs)
+ self.children = dict()
+
+ def __str__(self):
+ return "DF(%s)" % (super().__str__())
+
+ def add_file(self, child, ignore_existing=False):
+ """Add a child (DF/EF) to this DF"""
+ if not isinstance(child, CardFile):
+ raise TypeError("Expected a File instance")
+ if child.name in CardFile.RESERVED_NAMES:
+ raise ValueError("File name %s is a reserved name" % (child.name))
+ if child.fid in CardFile.RESERVED_FIDS:
+ raise ValueError("File fid %s is a reserved name" % (child.fid))
+ if child.fid in self.children:
+ if ignore_existing:
+ return
+ raise ValueError("File with given fid %s already exists" % (child.fid))
+ if self.lookup_file_by_sfid(child.sfid):
+ raise ValueError("File with given sfid %s already exists" % (child.sfid))
+ if self.lookup_file_by_name(child.name):
+ if ignore_existing:
+ return
+ raise ValueError("File with given name %s already exists" % (child.name))
+ self.children[child.fid] = child
+ child.parent = self
+
+ def add_files(self, children, ignore_existing=False):
+ """Add a list of child (DF/EF) to this DF"""
+ for child in children:
+ self.add_file(child, ignore_existing)
+
+ def get_selectables(self):
+ """Get selectable (DF/EF names) from current DF"""
+ # global selectables + our children
+ sels = super().get_selectables()
+ sels |= {x.fid: x for x in self.children.values() if x.fid}
+ sels |= {x.name: x for x in self.children.values() if x.name}
+ return sels
+
+ def lookup_file_by_name(self, name):
+ if name == None:
+ return None
+ for i in self.children.values():
+ if i.name and i.name == name:
+ return i
+ return None
+
+ def lookup_file_by_sfid(self, sfid):
+ if sfid == None:
+ return None
+ for i in self.children.values():
+ if i.sfid == int(sfid):
+ return i
+ return None
+
+ def lookup_file_by_fid(self, fid):
+ if fid in self.children:
+ return self.children[fid]
+ return None
+
+
+class CardMF(CardDF):
+ """MF (Master File) in the smart card filesystem"""
+ def __init__(self, **kwargs):
+ # can be overridden; use setdefault
+ kwargs.setdefault('fid', '3f00')
+ kwargs.setdefault('name', 'MF')
+ kwargs.setdefault('desc', 'Master File (directory root)')
+ # cannot be overridden; use assignment
+ kwargs['parent'] = self
+ super().__init__(**kwargs)
+ self.applications = dict()
+
+ def __str__(self):
+ return "MF(%s)" % (self.fid)
+
+ def add_application(self, app):
+ """Add an ADF (Application Dedicated File) to the MF"""
+ if not isinstance(app, CardADF):
+ raise TypeError("Expected an ADF instance")
+ if app.aid in self.applications:
+ raise ValueError("AID %s already exists" % (app.aid))
+ self.applications[app.aid] = app
+ app.parent=self
+
+ def get_app_names(self):
+ """Get list of completions (AID names)"""
+ return [x.name for x in self.applications]
+
+ def get_selectables(self):
+ """Get list of completions (DF/EF/ADF names) from current DF"""
+ sels = super().get_selectables()
+ sels |= self.get_app_selectables()
+ return sels
+
+ def get_app_selectables(self):
+ # applications by AID + name
+ sels = {x.aid: x for x in self.applications.values()}
+ sels |= {x.name: x for x in self.applications.values() if x.name}
+ return sels
+
+ def decode_select_response(self, data_hex):
+ """Decode the response to a SELECT command."""
+ return data_hex
+
+
+
+class CardADF(CardDF):
+ """ADF (Application Dedicated File) in the smart card filesystem"""
+ def __init__(self, aid, **kwargs):
+ super().__init__(**kwargs)
+ self.aid = aid # Application Identifier
+ if self.parent:
+ self.parent.add_application(self)
+
+ def __str__(self):
+ return "ADF(%s)" % (self.aid)
+
+ def _path_element(self, prefer_name):
+ if self.name and prefer_name:
+ return self.name
+ else:
+ return self.aid
+
+
+class CardEF(CardFile):
+ """EF (Entry File) in the smart card filesystem"""
+ def __init__(self, *, fid, **kwargs):
+ kwargs['fid'] = fid
+ super().__init__(**kwargs)
+
+ def __str__(self):
+ return "EF(%s)" % (super().__str__())
+
+ def get_selectables(self):
+ """Get list of completions (EF names) from current DF"""
+#global selectable names + those of the parent DF
+ sels = super().get_selectables()
+ sels |= {x.name:x for x in self.parent.children.values() if x != self}
+ return sels
+
+
+class TransparentEF(CardEF):
+ """Transparent EF (Entry File) in the smart card filesystem"""
+
+ @with_default_category('Transparent EF Commands')
+ class ShellCommands(CommandSet):
+ def __init__(self):
+ super().__init__()
+
+ read_bin_parser = argparse.ArgumentParser()
+ read_bin_parser.add_argument('--offset', type=int, default=0, help='Byte offset for start of read')
+ read_bin_parser.add_argument('--length', type=int, help='Number of bytes to read')
+ @cmd2.with_argparser(read_bin_parser)
+ def do_read_binary(self, opts):
+ """Read binary data from a transparent EF"""
+ (data, sw) = self._cmd.rs.read_binary(opts.length, opts.offset)
+ self._cmd.poutput(data)
+
+ def do_read_binary_decoded(self, opts):
+ """Read + decode data from a transparent EF"""
+ (data, sw) = self._cmd.rs.read_binary_dec()
+ self._cmd.poutput(json.dumps(data, indent=4))
+
+ upd_bin_parser = argparse.ArgumentParser()
+ upd_bin_parser.add_argument('--offset', type=int, default=0, help='Byte offset for start of read')
+ upd_bin_parser.add_argument('data', help='Data bytes (hex format) to write')
+ @cmd2.with_argparser(upd_bin_parser)
+ def do_update_binary(self, opts):
+ """Update (Write) data of a transparent EF"""
+ (data, sw) = self._cmd.rs.update_binary(opts.data, opts.offset)
+ self._cmd.poutput(data)
+
+ upd_bin_dec_parser = argparse.ArgumentParser()
+ upd_bin_dec_parser.add_argument('data', help='Abstract data (JSON format) to write')
+ @cmd2.with_argparser(upd_bin_dec_parser)
+ def do_update_binary_dec(self, opts):
+ """Encode + Update (Write) data of a transparent EF"""
+ (data, sw) = self._cmd.rs.update_binary_dec(opts.data)
+ self._cmd.poutput(json.dumps(data, indent=4))
+
+ def __init__(self, fid, sfid=None, name=None, desc=None, parent=None, size={1,None}):
+ super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, parent=parent)
+ self.size = size
+ self.shell_commands = [self.ShellCommands()]
+
+ def decode_bin(self, raw_bin_data):
+ """Decode raw (binary) data into abstract representation. Overloaded by specific classes."""
+ method = getattr(self, '_decode_bin', None)
+ if callable(method):
+ return method(raw_bin_data)
+ method = getattr(self, '_decode_hex', None)
+ if callable(method):
+ return method(b2h(raw_bin_data))
+ return {'raw': raw_bin_data}
+
+ def decode_hex(self, raw_hex_data):
+ """Decode raw (hex string) data into abstract representation. Overloaded by specific classes."""
+ method = getattr(self, '_decode_hex', None)
+ if callable(method):
+ return method(raw_hex_data)
+ raw_bin_data = bytes(h2b(raw_hex_data), encoding='utf8')
+ method = getattr(self, '_decode_bin', None)
+ if callable(method):
+ return method(raw_bin_data)
+ return {'raw': raw_bin_data}
+
+ def encode_bin(self, abstract_data):
+ """Encode abstract representation into raw (binary) data. Overloaded by specific classes."""
+ method = getattr(self, '_encode_bin', None)
+ if callable(method):
+ return method(abstract_data)
+ method = getattr(self, '_encode_hex', None)
+ if callable(method):
+ return h2b(method(abstract_data))
+ raise NotImplementedError
+
+ def encode_hex(self, abstract_data):
+ """Encode abstract representation into raw (hex string) data. Overloaded by specific classes."""
+ method = getattr(self, '_encode_hex', None)
+ if callable(method):
+ return method(abstract_data)
+ method = getattr(self, '_encode_bin', None)
+ if callable(method):
+ return b2h(method(abstract_data))
+ raise NotImplementedError
+
+
+class LinFixedEF(CardEF):
+ """Linear Fixed EF (Entry File) in the smart card filesystem"""
+
+ @with_default_category('Linear Fixed EF Commands')
+ class ShellCommands(CommandSet):
+ def __init__(self):
+ super().__init__()
+
+ read_rec_parser = argparse.ArgumentParser()
+ read_rec_parser.add_argument('--record-nr', type=int, default=0, help='Number of record to read')
+
+ @cmd2.with_argparser(read_rec_parser)
+ def do_read_record(self, opts):
+ """Read a record from a record-oriented EF"""
+ (data, sw) = self._cmd.rs.read_record(opts.record_nr)
+ self._cmd.poutput(json.dumps(data, indent=4))
+
+ @cmd2.with_argparser(read_rec_parser)
+ def do_read_record_decoded(self, opts):
+ """Read + decode a record from a record-oriented EF"""
+ (data, sw) = self._cmd.rs.read_record_dec(opts.record_nr)
+ self._cmd.poutput(json.dumps(data, indent=4))
+
+ upd_rec_parser = argparse.ArgumentParser()
+ upd_rec_parser.add_argument('--record-nr', type=int, default=0, help='Number of record to read')
+ upd_rec_parser.add_argument('data', help='Data bytes (hex format) to write')
+ @cmd2.with_argparser(upd_rec_parser)
+ def do_update_record(self, opts):
+ """Update (write) data to a record-oriented EF"""
+ (data, sw) = self._cmd.rs.update_record(opts.record_nr, opts.data)
+ self._cmd.poutput(data)
+
+ @cmd2.with_argparser(upd_rec_parser)
+ def do_update_record_decoded(self, opts):
+ """Encode + Update (write) data to a record-oriented EF"""
+ (data, sw) = self._cmd.rs.update_record_dec(opts.record_nr, opts.data)
+ self._cmd.poutput(data)
+
+ def __init__(self, fid, sfid=None, name=None, desc=None, parent=None, rec_len={1,None}):
+ super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, parent=parent)
+ self.rec_len = rec_len
+ self.shell_commands = [self.ShellCommands()]
+
+ def decode_record_hex(self, raw_hex_data):
+ """Decode raw (hex string) data into abstract representation. Overloaded by specific classes."""
+ method = getattr(self, '_decode_record_hex', None)
+ if callable(method):
+ return method(raw_hex_data)
+ raw_bin_data = bytes(h2b(raw_hex_data), encoding='utf8')
+ method = getattr(self, '_decode_record_bin', None)
+ if callable(method):
+ return method(raw_bin_data)
+ return {'raw': raw_bin_data}
+
+ def decode_record_bin(self, raw_bin_data):
+ """Decode raw (hex string) data into abstract representation. Overloaded by specific classes."""
+ method = getattr(self, '_decode_record_bin', None)
+ if callable(method):
+ return method(raw_bin_data)
+ method = getattr(self, '_decode_record_hex', None)
+ if callable(method):
+ return method(b2h(raw_bin_data))
+ return {'raw': raw_bin_data}
+
+ def encode_record_hex(self, abstract_data):
+ """Encode abstract representation into raw (hex string) data. Overloaded by specific classes."""
+ method = getattr(self, '_encode_record_hex', None)
+ if callable(method):
+ return method(abstract_data)
+ method = getattr(self, '_encode_record_bin', None)
+ if callable(method):
+ return b2h(method(abstract_data))
+ raise NotImplementedError
+
+ def encode_record_bin(self, abstract_data):
+ """Encode abstract representation into raw (binary) data. Overloaded by specific classes."""
+ method = getattr(self, '_encode_record_bin', None)
+ if callable(method):
+ return method(abstract_data)
+ method = getattr(self, '_encode_record_hex', None)
+ if callable(method):
+ return b2h(method(abstract_data))
+ raise NotImplementedError
+
+class CyclicEF(LinFixedEF):
+ """Cyclic EF (Entry File) in the smart card filesystem"""
+ # we don't really have any special support for those; just recycling LinFixedEF here
+ def __init__(self, fid, sfid=None, name=None, desc=None, parent=None, rec_len={1,None}):
+ super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, parent=parent, rec_len=rec_len)
+
+class TransRecEF(TransparentEF):
+ """Transparent EF (Entry File) containing fixed-size records.
+ These are the real odd-balls and mostly look like mistakes in the specification:
+ Specified as 'transparent' EF, but actually containing several fixed-length records
+ inside.
+ We add a special class for those, so the user only has to provide encoder/decoder functions
+ for a record, while this class takes care of split / merge of records.
+ """
+ def __init__(self, fid, sfid=None, name=None, desc=None, parent=None, rec_len=None, size={1,None}):
+ super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, parent=parent, size=size)
+ self.rec_len = rec_len
+
+ def decode_record_hex(self, raw_hex_data):
+ """Decode raw (hex string) data into abstract representation. Overloaded by specific classes."""
+ method = getattr(self, '_decode_record_hex', None)
+ if callable(method):
+ return method(raw_hex_data)
+ method = getattr(self, '_decode_record_bin', None)
+ if callable(method):
+ return method(h2b(raw_hex_data))
+ return {'raw': h2b(raw_hex_data)}
+
+ def decode_record_bin(self, raw_bin_data):
+ """Decode raw (hex string) data into abstract representation. Overloaded by specific classes."""
+ method = getattr(self, '_decode_record_bin', None)
+ if callable(method):
+ return method(raw_bin_data)
+ method = getattr(self, '_decode_record_hex', None)
+ if callable(method):
+ return method(b2h(raw_bin_data))
+ return {'raw': raw_bin_data}
+
+ def encode_record_hex(self, abstract_data):
+ """Encode abstract representation into raw (hex string) data. Overloaded by specific classes."""
+ method = getattr(self, '_encode_record_hex', None)
+ if callable(method):
+ return method(abstract_data)
+ method = getattr(self, '_encode_record_bin', None)
+ if callable(method):
+ return h2b(method(abstract_data))
+ raise NotImplementedError
+
+ def encode_record_bin(self, abstract_data):
+ """Encode abstract representation into raw (binary) data. Overloaded by specific classes."""
+ method = getattr(self, '_encode_record_bin', None)
+ if callable(method):
+ return method(abstract_data)
+ method = getattr(self, '_encode_record_hex', None)
+ if callable(method):
+ return h2b(method(abstract_data))
+ raise NotImplementedError
+
+ def _decode_bin(self, raw_bin_data):
+ chunks = [raw_bin_data[i:i+self.rec_len] for i in range(0, len(raw_bin_data), self.rec_len)]
+ return [self.decode_record_bin(x) for x in chunks]
+
+ def _encode_bin(self, abstract_data):
+ chunks = [self.encode_record_bin(x) for x in abstract_data]
+# FIXME: pad to file size
+ return b''.join(chunks)
+
+
+
+
+
+class RuntimeState(object):
+ """Represent the runtime state of a session with a card."""
+ def __init__(self, card, profile):
+ self.mf = CardMF()
+ self.card = card
+ self.selected_file = self.mf
+ self.profile = profile
+ # add applications + MF-files from profile
+ for a in self.profile.applications:
+ self.mf.add_application(a)
+ for f in self.profile.files_in_mf:
+ self.mf.add_file(f)
+
+ def get_cwd(self):
+ """Obtain the current working directory."""
+ if isinstance(self.selected_file, CardDF):
+ return self.selected_file
+ else:
+ return self.selected_file.parent
+
+ def get_application(self):
+ """Obtain the currently selected application (if any)."""
+ # iterate upwards from selected file; check if any is an ADF
+ node = self.selected_file
+ while node.parent != node:
+ if isinstance(node, CardADF):
+ return node
+ node = node.parent
+ return None
+
+ def interpret_sw(self, sw):
+ """Interpret the given SW relative to the currently selected Application
+ or the underlying profile."""
+ app = self.get_application()
+ if app:
+ return app.interpret_sw(sw)
+ else:
+ return self.profile.interpret_sw(sw)
+
+ def select(self, name, cmd_app=None):
+ """Change current directory"""
+ sels = self.selected_file.get_selectables()
+ if name in sels:
+ f = sels[name]
+ # unregister commands of old file
+ if cmd_app and self.selected_file.shell_commands:
+ for c in self.selected_file.shell_commands:
+ cmd_app.unregister_command_set(c)
+ try:
+ if isinstance(f, CardADF):
+ (data, sw) = self.card._scc.select_adf(f.aid)
+ else:
+ (data, sw) = self.card._scc.select_file(f.fid)
+ self.selected_file = f
+ except SwMatchError as swm:
+ k = self.interpret_sw(swm.sw_actual)
+ if not k:
+ raise(swm)
+ raise RuntimeError("%s: %s - %s" % (swm.sw_actual, k[0], k[1]))
+ # register commands of new file
+ if cmd_app and self.selected_file.shell_commands:
+ for c in self.selected_file.shell_commands:
+ cmd_app.register_command_set(c)
+ return f.decode_select_response(data)
+ #elif looks_like_fid(name):
+ else:
+ raise ValueError("Cannot select unknown %s" % (name))
+
+ def read_binary(self, length=None, offset=0):
+ if not isinstance(self.selected_file, TransparentEF):
+ raise TypeError("Only works with TransparentEF")
+ return self.card._scc.read_binary(self.selected_file.fid, length, offset)
+
+ def read_binary_dec(self):
+ (data, sw) = self.read_binary()
+ return (self.selected_file.decode_hex(data), sw)
+
+ def update_binary(self, data_hex, offset=0):
+ if not isinstance(self.selected_file, TransparentEF):
+ raise TypeError("Only works with TransparentEF")
+ return self.card._scc.update_binary(self.selected_file.fid, data_hex, offset)
+
+ def update_binary_dec(self, data):
+ hex_data = self.selected_file.encode_hex(data)
+ return self.update_binary(data_hex)
+
+ def read_record(self, rec_nr=0):
+ if not isinstance(self.selected_file, LinFixedEF):
+ raise TypeError("Only works with Linear Fixed EF")
+ return self.card._scc.read_record(self.selected_file.fid, rec_nr)
+
+ def read_record_dec(self, rec_nr=0):
+ (data, sw) = self.read_record(rec_nr)
+ return (self.selected_file.decode_record_hex(data), sw)
+
+ def update_record(self, rec_nr, data_hex):
+ if not isinstance(self.selected_file, LinFixedEF):
+ raise TypeError("Only works with Linear Fixed EF")
+ return self.card._scc.update_record(self.selected_file.fid, rec_nr, data_hex)
+
+ def update_record_dec(self, rec_nr, data):
+ hex_data = self.selected_file.encode_record_hex(data)
+ return self.update_record(self, rec_nr, data_hex)
+
+
+
+class FileData(object):
+ """Represent the runtime, on-card data."""
+ def __init__(self, fdesc):
+ self.desc = fdesc
+ self.fcp = None
+
+
+def interpret_sw(sw_data, sw):
+ """Interpret a given status word within the profile. Returns tuple of
+ two strings"""
+ for class_str, swdict in sw_data.items():
+ # first try direct match
+ if sw in swdict:
+ return (class_str, swdict[sw])
+ # next try wildcard matches
+ for pattern, descr in swdict.items():
+ if sw_match(sw, pattern):
+ return (class_str, descr)
+ return None
+
+class CardApplication(object):
+ """A card application is represented by an ADF (with contained hierarchy) and optionally
+ some SW definitions."""
+ def __init__(self, name, adf=None, sw={}):
+ self.name = name
+ self.adf = adf
+ self.sw = sw
+
+ def __str__(self):
+ return "APP(%s)" % (self.name)
+
+ def interpret_sw(self, sw):
+ """Interpret a given status word within the application. Returns tuple of
+ two strings"""
+ return interpret_sw(self.sw, sw)
+
+class CardProfile(object):
+ """A Card Profile describes a card, it's filessystem hierarchy, an [initial] list of
+ applications as well as profile-specific SW and shell commands. Every card has
+ one card profile, but there may be multiple applications within that profile."""
+ def __init__(self, name, desc=None, files_in_mf=[], sw=[], applications=[], shell_cmdsets=[]):
+ self.name = name
+ self.desc = desc
+ self.files_in_mf = files_in_mf
+ self.sw = sw
+ self.applications = applications
+ self.shell_cmdsets = shell_cmdsets
+
+ def __str__(self):
+ return self.name
+
+ def add_application(self, app):
+ self.applications.add(app)
+
+ def interpret_sw(self, sw):
+ """Interpret a given status word within the profile. Returns tuple of
+ two strings"""
+ return interpret_sw(self.sw, sw)
+
+
+######################################################################
+
+if __name__ == '__main__':
+ mf = CardMF()
+
+ adf_usim = ADF('a0000000871002', name='ADF_USIM')
+ mf.add_application(adf_usim)
+ df_pb = CardDF('5f3a', name='DF.PHONEBOOK')
+ adf_usim.add_file(df_pb)
+ adf_usim.add_file(TransparentEF('6f05', name='EF.LI', size={2,16}))
+ adf_usim.add_file(TransparentEF('6f07', name='EF.IMSI', size={9,9}))
+
+ rss = RuntimeState(mf, None)
+
+ interp = code.InteractiveConsole(locals={'mf':mf, 'rss':rss})
+ interp.interact()
diff --git a/pySim/ts_102_221.py b/pySim/ts_102_221.py
new file mode 100644
index 0000000..1b3516d
--- /dev/null
+++ b/pySim/ts_102_221.py
@@ -0,0 +1,224 @@
+# coding=utf-8
+"""Utilities / Functions related to ETSI TS 102 221, the core UICC spec.
+
+(C) 2021 by Harald Welte <laforge@osmocom.org>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+"""
+
+from pytlv.TLV import *
+from struct import pack, unpack
+from pySim.utils import *
+from pySim.filesystem import *
+
+FCP_TLV_MAP = {
+ '82': 'file_descriptor',
+ '83': 'file_identifier',
+ '84': 'df_name',
+ 'A5': 'proprietary_info',
+ '8A': 'life_cycle_status_int',
+ '8B': 'security_attrib_ref_expanded',
+ '8C': 'security_attrib_compact',
+ 'AB': 'security_attrib_espanded',
+ 'C6': 'pin_status_template_do',
+ '80': 'file_size',
+ '81': 'total_file_size',
+ '88': 'short_file_id',
+ }
+
+# ETSI TS 102 221 11.1.1.4.6
+FCP_Proprietary_TLV_MAP = {
+ '80': 'uicc_characteristics',
+ '81': 'application_power_consumption',
+ '82': 'minimum_app_clock_freq',
+ '83': 'available_memory',
+ '84': 'file_details',
+ '85': 'reserved_file_size',
+ '86': 'maximum_file_size',
+ '87': 'suported_system_commands',
+ '88': 'specific_uicc_env_cond',
+ '89': 'p2p_cat_secured_apdu',
+ # Additional private TLV objects (bits b7 and b8 of the first byte of the tag set to '1')
+ }
+
+# pytlv unfortunately doens't have a setting using which we can make it
+# accept unknown tags. It also doesn't raise a specific exception type but
+# just the generic ValueError, so we cannot ignore those either. Instead,
+# we insert a dict entry for every possible proprietary tag permitted
+def fixup_fcp_proprietary_tlv_map(tlv_map):
+ if 'D0' in tlv_map:
+ return
+ for i in range(0xd0, 0xff):
+ i_hex = i2h([i]).upper()
+ tlv_map[i_hex] = 'proprietary_' + i_hex
+
+
+# ETSI TS 102 221 11.1.1.4.10
+FCP_Pin_Status_TLV_MAP = {
+ '95': 'usage_qualifier',
+ '83': 'key_reference',
+ }
+
+def tlv_key_replace(inmap, indata):
+ def newkey(inmap, key):
+ if key in inmap:
+ return inmap[key]
+ else:
+ return key
+ return {newkey(inmap, d[0]): d[1] for d in indata.items()}
+
+
+
+# ETSI TS 102 221 Section 11.1.1.3
+def decode_select_response(resp_hex):
+ fixup_fcp_proprietary_tlv_map(FCP_Proprietary_TLV_MAP)
+ resp_hex = resp_hex.upper()
+ # outer layer
+ fcp_base_tlv = TLV(['62'])
+ fcp_base = fcp_base_tlv.parse(resp_hex)
+ # actual FCP
+ fcp_tlv = TLV(FCP_TLV_MAP)
+ fcp = fcp_tlv.parse(fcp_base['62'])
+ # further decode the proprietary information
+ if fcp['A5']:
+ prop_tlv = TLV(FCP_Proprietary_TLV_MAP)
+ prop = prop_tlv.parse(fcp['A5'])
+ fcp['A5'] = tlv_key_replace(FCP_Proprietary_TLV_MAP, prop)
+ # finally make sure we get human-readable keys in the output dict
+ return tlv_key_replace(FCP_TLV_MAP, fcp)
+
+
+# TS 102 221 Section 13.1
+class EF_DIR(LinFixedEF):
+ def __init__(self, fid='2f00', sfid=0x1e, name='EF.DIR', desc='Application Directory'):
+ super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len={5,54})
+
+ def _decode_record_hex(self, raw_hex_data):
+ raw_hex_data = raw_hex_data.upper()
+ atempl_base_tlv = TLV(['61'])
+ atempl_base = atempl_base_tlv.parse(raw_hex_data)
+ atempl_TLV_MAP = {'4F': 'aid_value', 50:'label'}
+ atempl_tlv = TLV(atempl_TLV_MAP)
+ atempl = atempl_tlv.parse(atempl_base['61'])
+ # FIXME: "All other Dos are according to ISO/IEC 7816-4"
+ return tlv_key_replace(atempl_TLV_MAP, atempl)
+
+# TS 102 221 Section 13.2
+class EF_ICCID(TransparentEF):
+ def __init__(self, fid='2fe2', sfid=0x02, name='EF.ICCID', desc='ICC Identification'):
+ super().__init__(fid, sfid=sfid, name=name, desc=desc, size={10,10})
+
+ def _decode_hex(self, raw_hex):
+ return {'iccid': dec_iccid(raw_hex)}
+
+ def _encode_hex(self, abstract):
+ return enc_iccid(abstract['iccid'])
+
+# TS 102 221 Section 13.3
+class EF_PL(TransRecEF):
+ def __init__(self, fid='2f05', sfid=0x05, name='EF.PL', desc='Preferred Languages'):
+ super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len=2, size={2,None})
+
+# TS 102 221 Section 13.4
+class EF_ARR(LinFixedEF):
+ def __init__(self, fid='2f06', sfid=0x06, name='EF.ARR', desc='Access Rule Reference'):
+ super().__init__(fid, sfid=sfid, name=name, desc=desc)
+
+# TS 102 221 Section 13.6
+class EF_UMPC(TransparentEF):
+ def __init__(self, fid='2f08', sfid=0x08, name='EF.UMPC', desc='UICC Maximum Power Consumption'):
+ super().__init__(fid, sfid=sfid, name=name, desc=desc, size={5,5})
+
+
+
+class CardProfileUICC(CardProfile):
+ def __init__(self):
+ files = [
+ EF_DIR(),
+ EF_ICCID(),
+ EF_PL(),
+ EF_ARR(),
+ # FIXME: DF.CD
+ EF_UMPC(),
+ ]
+ sw = {
+ 'Normal': {
+ '9000': 'Normal ending of the command',
+ '91xx': 'Normal ending of the command, with extra information from the proactive UICC containing a command for the terminal',
+ '92xx': 'Normal ending of the command, with extra information concerning an ongoing data transfer session',
+ },
+ 'Postponed processing': {
+ '9300': 'SIM Application Toolkit is busy. Command cannot be executed at present, further normal commands are allowed',
+ },
+ 'Warnings': {
+ '6200': 'No information given, state of non-volatile memory unchanged',
+ '6281': 'Part of returned data may be corrupted',
+ '6282': 'End of file/record reached before reading Le bytes or unsuccessful search',
+ '6283': 'Selected file invalidated',
+ '6284': 'Selected file in termination state',
+ '62f1': 'More data available',
+ '62f2': 'More data available and proactive command pending',
+ '62f3': 'Response data available',
+ '63f1': 'More data expected',
+ '63f2': 'More data expected and proactive command pending',
+ '63cx': 'Command successful but after using an internal update retry routine X times',
+ },
+ 'Execution errors': {
+ '6400': 'No information given, state of non-volatile memory unchanged',
+ '6500': 'No information given, state of non-volatile memory changed',
+ '6581': 'Memory problem',
+ },
+ 'Checking errors': {
+ '6700': 'Wrong length',
+ '67xx': 'The interpretation of this status word is command dependent',
+ '6b00': 'Wrong parameter(s) P1-P2',
+ '6d00': 'Instruction code not supported or invalid',
+ '6e00': 'Class not supported',
+ '6f00': 'Technical problem, no precise diagnosis',
+ '6fxx': 'The interpretation of this status word is command dependent',
+ },
+ 'Functions in CLA not supported': {
+ '6800': 'No information given',
+ '6881': 'Logical channel not supported',
+ '6882': 'Secure messaging not supported',
+ },
+ 'Command not allowed': {
+ '6900': 'No information given',
+ '6981': 'Command incompatible with file structure',
+ '6982': 'Security status not satisfied',
+ '6983': 'Authentication/PIN method blocked',
+ '6984': 'Referenced data invalidated',
+ '6985': 'Conditions of use not satisfied',
+ '6986': 'Command not allowed (no EF selected)',
+ '6989': 'Command not allowed - secure channel - security not satisfied',
+ },
+ 'Wrong parameters': {
+ '6a80': 'Incorrect parameters in the data field',
+ '6a81': 'Function not supported',
+ '6a82': 'File not found',
+ '6a83': 'Record not found',
+ '6a84': 'Not enough memory space',
+ '6a86': 'Incorrect parameters P1 to P2',
+ '6a87': 'Lc inconsistent with P1 to P2',
+ '6a88': 'Referenced data not found',
+ },
+ 'Application errors': {
+ '9850': 'INCREASE cannot be performed, max value reached',
+ '9862': 'Authentication error, application specific',
+ '9863': 'Security session or association expired',
+ '9864': 'Minimum UICC suspension time is too long',
+ },
+ }
+
+ super().__init__('UICC', 'ETSI TS 102 221', files, sw)
diff --git a/pySim/ts_31_102.py b/pySim/ts_31_102.py
index 8979d49..c395b84 100644
--- a/pySim/ts_31_102.py
+++ b/pySim/ts_31_102.py
@@ -264,3 +264,84 @@ 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)
+
+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),
+ TransparentEF('6f08', 0x08, 'EF.Keys', size={33,33}, desc='Ciphering and Integrity Keys'),
+ TransparentEF('6f09', 0x09, 'EF.KeysPS', size={33,33},
+ 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 Priprity PLMN search period'),
+ # EF.ACMmax
+ # EF.UST
+ # EF.ACM
+ 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__()
+
+ 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)
+
+
+# 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)
diff --git a/pySim/ts_31_103.py b/pySim/ts_31_103.py
index d48ff97..6a01acd 100644
--- a/pySim/ts_31_103.py
+++ b/pySim/ts_31_103.py
@@ -7,6 +7,7 @@ Various constants from ETSI TS 131 103 V14.2.0
#
# Copyright (C) 2020 Supreeth Herle <herlesupreeth@gmail.com>
+# Copyright (C) 2021 Harald Welte <laforge@osmocom.org>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
@@ -22,6 +23,10 @@ Various constants from ETSI TS 131 103 V14.2.0
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
+from pySim.filesystem import *
+from pySim.ts_51_011 import EF_AD
+import pySim.ts_102_221
+
# Mapping between ISIM Service Number and its description
EF_IST_map = {
1: 'P-CSCF address',
@@ -67,3 +72,125 @@ EF_ISIM_ADF_map = {
'XCAPConfigData': '6FFC',
'WebRTCURI': '6FFA'
}
+
+# TS 31.103 Section 4.2.2
+class EF_IMPI(TransparentEF):
+ def __init__(self, fid='6f02', sfid=0x02, name='EF.IMPI', desc='IMS private user identity'):
+ super().__init__(fid=fid, sfid=sfid, name=name, desc=desc)
+
+# TS 31.103 Section 4.2.3
+class EF_DOMAIN(TransparentEF):
+ def __init__(self, fid='6f05', sfid=0x05, name='EF.DOMAIN', desc='Home Network Domain Name'):
+ super().__init__(fid=fid, sfid=sfid, name=name, desc=desc)
+
+# TS 31.103 Section 4.2.4
+class EF_IMPU(LinFixedEF):
+ def __init__(self, fid='6f04', sfid=0x04, name='EF.IMPU', desc='IMS public user identity'):
+ super().__init__(fid=fid, sfid=sfid, name=name, desc=desc)
+
+# TS 31.103 Section 4.2.6
+class EF_ARR(LinFixedEF):
+ def __init__(self, fid='6f06', sfid=0x06, name='EF.ARR', desc='Access Rule Reference'):
+ super().__init__(fid=fid, sfid=sfid, name=name, desc=desc)
+
+# TS 31.103 Section 4.2.7
+class EF_IST(TransparentEF):
+ def __init__(self, fid='6f07', sfid=0x07, name='EF.IST', desc='ISIM Service Table'):
+ super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, size={1,4})
+ self.shell_commands = [self.ShellCommands()]
+
+ @with_default_category('File-Specific Commands')
+ class ShellCommands(CommandSet):
+ def __init__(self):
+ super().__init__()
+
+ def do_ist_service_activate(self, arg):
+ """Activate a service within EF.IST"""
+ self._cmd.card.update_ist(int(arg), 1)
+
+ def do_ist_service_deactivate(self, arg):
+ """Deactivate a service within EF.IST"""
+ self._cmd.card.update_ist(int(arg), 0)
+
+# TS 31.103 Section 4.2.8
+class EF_PCSCF(LinFixedEF):
+ def __init__(self, fid='6f09', sfid=None, name='EF.P-CSCF', desc='P-CSCF Address'):
+ super().__init__(fid=fid, sfid=sfid, name=name, desc=desc)
+
+# TS 31.103 Section 4.2.9
+class EF_GBABP(LinFixedEF):
+ def __init__(self, fid='6fd5', sfid=None, name='EF.GBABP', desc='GBA Bootstrappng'):
+ super().__init__(fid=fid, sfid=sfid, name=name, desc=desc)
+
+# TS 31.103 Section 4.2.10
+class EF_GBANL(LinFixedEF):
+ def __init__(self, fid='6fd7', sfid=None, name='EF.GBANL', desc='GBA NAF List'):
+ super().__init__(fid=fid, sfid=sfid, name=name, desc=desc)
+
+# TS 31.103 Section 4.2.11
+class EF_NAFKCA(LinFixedEF):
+ def __init__(self, fid='6fdd', sfid=None, name='EF.NAFKCA', desc='NAF Key Centre Address'):
+ super().__init__(fid=fid, sfid=sfid, name=name, desc=desc)
+
+# TS 31.103 Section 4.2.16
+class EF_UICCIARI(LinFixedEF):
+ def __init__(self, fid='6fe7', sfid=None, name='EF.UICCIARI', desc='UICC IARI'):
+ super().__init__(fid=fid, sfid=sfid, name=name, desc=desc)
+
+# TS 31.103 Section 4.2.18
+class EF_IMSConfigData(TransparentEF):
+ def __init__(self, fid='6ff8', sfid=None, name='EF.IMSConfigData', desc='IMS Configuration Data'):
+ super().__init__(fid=fid, sfid=sfid, name=name, desc=desc)
+
+# TS 31.103 Section 4.2.19
+class EF_XCAPConfigData(TransparentEF):
+ def __init__(self, fid='6ffc', sfid=None, name='EF.XCAPConfigData', desc='XCAP Configuration Data'):
+ super().__init__(fid=fid, sfid=sfid, name=name, desc=desc)
+
+# TS 31.103 Section 4.2.20
+class EF_WebRTCURI(TransparentEF):
+ def __init__(self, fid='6ffa', sfid=None, name='EF.WebRTCURI', desc='WebRTC URI'):
+ super().__init__(fid=fid, sfid=sfid, name=name, desc=desc)
+
+
+class ADF_ISIM(CardADF):
+ def __init__(self, aid='a0000000871004', name='ADF.ISIM', fid=None, sfid=None,
+ desc='ISIM Application'):
+ super().__init__(aid=aid, fid=fid, sfid=sfid, name=name, desc=desc)
+ #self.shell_commands += [self.ShellCommands()]
+
+ files = [
+ EF_IMPI(),
+ EF_DOMAIN(),
+ EF_IMPU(),
+ EF_AD(),
+ EF_ARR(),
+ EF_IST(),
+ EF_PCSCF(),
+ EF_GBABP(),
+ EF_GBANL(),
+ EF_NAFKCA(),
+ # SMS
+ # SMSS
+ # SMSR
+ #EF_SMSP(),
+ EF_UICCIARI(),
+ # FromPreferred
+ EF_IMSConfigData(),
+ EF_XCAPConfigData(),
+ EF_WebRTCURI(),
+ ]
+ self.add_files(files)
+
+ def decode_select_response(self, data_hex):
+ return pySim.ts_102_221.decode_select_response(data_hex)
+
+# TS 31.103 Section 7.1
+sw_isim = {
+ 'Security management': {
+ '9862': 'Authentication error, incorrect MAC',
+ '9864': 'Authentication error, security context not supported',
+ }
+}
+
+CardApplicationISIM = CardApplication('ISIM', adf=ADF_ISIM(), sw=sw_isim)
diff --git a/pySim/ts_51_011.py b/pySim/ts_51_011.py
index 8b73f02..5ba7f4e 100644
--- a/pySim/ts_51_011.py
+++ b/pySim/ts_51_011.py
@@ -1,11 +1,16 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
-""" Various constants from ETSI TS 151.011
+""" Various constants from ETSI TS 151.011 +
+Representation of the GSM SIM/USIM/ISIM filesystem hierarchy.
+
+The File (and its derived classes) uses the classes of pySim.filesystem in
+order to describe the files specified in the relevant ETSI + 3GPP specifications.
"""
#
# Copyright (C) 2017 Alexander.Chemeris <Alexander.Chemeris@gmail.com>
+# Copyright (C) 2021 Harald Welte <laforge@osmocom.org>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
@@ -324,3 +329,196 @@ EF_AD_mode_map = {
'02' : 'maintenance (off line)',
'04' : 'cell test operation',
}
+
+
+from pySim.utils import *
+from pySim.ts_51_011 import *
+from struct import pack, unpack
+
+from pySim.filesystem import *
+
+######################################################################
+# DF.TELECOM
+######################################################################
+
+# TS 51.011 Section 10.5.1
+class EF_ADN(LinFixedEF):
+ def __init__(self, fid='6f3a', sfid=None, name='EF.ADN', desc='Abbreviated Dialing Numbers'):
+ super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len={14, 30})
+ def _decode_record_bin(self, raw_bin_data):
+ alpha_id_len = len(raw_bin_data) - 14
+ alpha_id = raw_bin_data[:alpha_id_len]
+ u = unpack('!BB10sBB', raw_bin_data[-14:])
+ return {'alpha_id': alpha_id, 'len_of_bcd': u[0], 'ton_npi': u[1],
+ 'dialing_nr': u[2], 'cap_conf_id': u[3], 'ext1_record_id': u[4]}
+
+# TS 51.011 Section 10.5.5
+class EF_MSISDN(LinFixedEF):
+ def __init__(self, fid='6f4f', sfid=None, name='EF.MSISDN', desc='MSISDN'):
+ super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len={15, None})
+ def _decode_record_hex(self, raw_hex_data):
+ return {'msisdn': dec_msisdn(raw_hex_data)}
+ def _encode_record_hex(self, abstract):
+ return enc_msisdn(abstract['msisdn'])
+
+# TS 51.011 Section 10.5.6
+class EF_SMSP(LinFixedEF):
+ def __init__(self, fid='6f42', sfid=None, name='EF.SMSP', desc='Short message service parameters'):
+ super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len={28, None})
+
+class DF_TELECOM(CardDF):
+ def __init__(self, fid='7f10', name='DF.TELECOM', desc=None):
+ super().__init__(fid=fid, name=name, desc=desc)
+ files = [
+ EF_ADN(),
+ # FDN, SMS, CCP, ECCP
+ EF_MSISDN(),
+ EF_SMSP(),
+ # SMSS, LND, SDN, EXT1, EXT2, EXT3, BDN, EXT4, SMSR, CMI
+ ]
+
+
+######################################################################
+# DF.GSM
+######################################################################
+
+# TS 51.011 Section 10.3.1
+class EF_LP(TransRecEF):
+ def __init__(self, fid='6f05', sfid=None, name='EF.LP', size={1,None}, rec_len=1,
+ desc='Language Preference'):
+ super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, rec_len=rec_len)
+
+# TS 51.011 Section 10.3.2
+class EF_IMSI(TransparentEF):
+ def __init__(self, fid='6f07', sfid=None, name='EF.IMSI', desc='IMSI', size={9,9}):
+ super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size)
+ def _decode_hex(self, raw_hex):
+ return {'imsi': dec_imsi(raw_hex)}
+ def _encode_hex(self, abstract):
+ return enc_imsi(abstract['imsi'])
+
+# TS 51.011 Section 10.3.4
+class EF_PLMNsel(TransRecEF):
+ def __init__(self, fid='6f30', sfid=None, name='EF.PLMNsel', desc='PLMN selector',
+ size={24,None}, rec_len=3):
+ super().__init__(fid, name=name, sfid=sfid, desc=desc, size=size, rec_len=rec_len)
+
+# TS 51.011 Section 10.3.7
+class EF_ServiceTable(TransparentEF):
+ def __init__(self, fid, sfid, name, desc, size, table):
+ super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size)
+ self.table = table
+ def _decode_bin(self, raw_bin):
+ ret = []
+ for i in range(0, len(raw_bin)*4):
+ service_nr = i+1
+ byte = int(raw_bin[i/4])
+ bit_offset = (i % 4) * 2
+ bits = (byte >> bit_offset) & 3
+ ret.add({'number': service_nr,
+ 'description': table[service_nr] or None,
+ 'allocated': bits & 1,
+ 'activated': bits & 2,
+ })
+
+# TS 51.011 Section 10.3.11
+class EF_SPN(TransparentEF):
+ def __init__(self, fid='6f46', sfid=None, name='EF.SPN', desc='Service Provider Name', size={17,17}):
+ super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size)
+ def _decode_hex(self, raw_hex):
+ return {'spn': dec_spn(raw_hex)}
+ def _encode_hex(self, abstract):
+ return enc_spn(abstract['spn'])
+
+# TS 51.011 Section 10.3.13
+class EF_CBMI(TransRecEF):
+ def __init__(self, fid='6f45', sfid=None, name='EF.CBMI', size={2,None}, rec_len=2,
+ desc='Cell Broadcast message identifier selection'):
+ super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, rec_len=rec_len)
+
+# TS 51.011 Section 10.3.15
+class EF_ACC(TransparentEF):
+ def __init__(self, fid='6f78', sfid=None, name='EF.ACC', desc='Access Control Class', size={2,2}):
+ super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size)
+ def _decode_bin(self, raw_bin):
+ return {'acc': unpack('!H', raw_bin)[0]}
+ def _encode_bin(self, abstract):
+ return pack('!H', abstract['acc'])
+
+# TS 51.011 Section 10.3.18
+class EF_AD(TransparentEF):
+ OP_MODE = {
+ 0x00: 'normal operation',
+ 0x80: 'type approval operations',
+ 0x01: 'normal operation + specific facilities',
+ 0x81: 'type approval + specific facilities',
+ 0x02: 'maintenance (off line)',
+ 0x04: 'cell test operation',
+ }
+ def __init__(self, fid='6fad', sfid=None, name='EF.AD', desc='Administrative Data', size={3,4}):
+ super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size)
+ def _decode_bin(self, raw_bin):
+ u = unpack('!BH', raw_bin[:3])
+
+# TS 51.011 Section 10.3.13
+class EF_CBMID(EF_CBMI):
+ def __init__(self, fid='6f48', sfid=None, name='EF.CBMID', size={2,None}, rec_len=2,
+ desc='Cell Broadcast Message Identifier for Data Download'):
+ super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, rec_len=rec_len)
+
+# TS 51.011 Section 10.3.26
+class EF_ECC(LinFixedEF):
+ def __init__(self, fid='6fb7', sfid=None, name='EF.ECC', desc='Emergency Call Codes'):
+ super().__init__(fid, sfid=sfid, name=name, desc=desc, rec_len={4, 20})
+
+# TS 51.011 Section 10.3.28
+class EF_CBMIR(TransRecEF):
+ def __init__(self, fid='6f50', sfid=None, name='EF.CBMIR', size={4,None}, rec_len=4,
+ desc='Cell Broadcast message identifier range selection'):
+ super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, rec_len=rec_len)
+
+
+# TS 51.011 Section 10.3.35..37
+class EF_xPLMNwAcT(TransRecEF):
+ def __init__(self, fid, sfid=None, name=None, desc=None, size={40,None}, rec_len=5):
+ super().__init__(fid, sfid=sfid, name=name, desc=desc, size=size, rec_len=rec_len)
+
+class DF_GSM(CardDF):
+ def __init__(self, fid='7f20', name='DF.GSM', desc='GSM Network related files'):
+ super().__init__(fid=fid, name=name, desc=desc)
+ files = [
+ EF_LP(),
+ EF_IMSI(),
+ TransparentEF('5f20', None, 'EF.Kc', 'Ciphering key Kc'),
+ EF_PLMNsel(),
+ TransparentEF('6f31', None, 'EF.HPPLMN', 'Higher Priprity PLMN search period'),
+ # ACMmax
+ EF_ServiceTable('6f37', None, 'EF.SST', 'SIM service table', table=EF_SST_map, size={2,16}),
+ CyclicEF('6f39', None, 'EF.ACM', 'Accumulated call meter', rec_len={4,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(),
+ TransparentEF('6f7f', None, 'EF.BCCH', 'Broadcast control channels', size={16,16}),
+ EF_ACC(),
+ EF_PLMNsel('6f7b', None, 'EF.FPLMN', 'Forbidden PLMNs', size={12,12}),
+ TransparentEF('6f7e', None, 'EF.LOCI', 'Locationn information', size={11,11}),
+ EF_AD(),
+ TransparentEF('6fa3', None, 'EF.Phase', 'Phase identification', size={1,1}),
+ # TODO EF.VGCS VGCSS, VBS, VBSS, eMLPP, AAeM
+ EF_CBMID(),
+ EF_ECC(),
+ EF_CBMIR(),
+ # DCK, CNL, NIA, KcGRS, LOCIGPRS, SUME
+ EF_xPLMNwAcT('6f60', None, 'EF.PLMNwAcT',
+ 'User controlled PLMN Selector with Access Technology'),
+ EF_xPLMNwAcT('6f61', None, 'EF.OPLMNwAcT',
+ 'Operator controlled PLMN Selector with Access Technology'),
+ EF_xPLMNwAcT('6f62', None, 'EF.HPLMNwAcT', 'HPLMN Selector with Access Technology'),
+ # CPBCCH, InvScan, PNN, OPL, MBDN, MBI, MWIS, CFIS, EXT5, EXT6, EXT7, SPDI, MMSN, EXT8
+ # MMSICP, MMSUP, MMSUCP
+ ]
+ self.add_files(files)
+
+CardProfileSIM = CardProfile('SIM', desc='GSM SIM Card', files_in_mf=[DF_TELECOM(), DF_GSM()])
diff --git a/pysim-shell.py b/pysim-shell.py
new file mode 100755
index 0000000..a5c7fe7
--- /dev/null
+++ b/pysim-shell.py
@@ -0,0 +1,211 @@
+#!/usr/bin/env python3
+
+# Interactive shell for working with SIM / UICC / USIM / ISIM cards
+#
+# (C) 2021 by Harald Welte <laforge@osmocom.org>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+from typing import List
+
+import json
+
+import cmd2
+from cmd2 import style, fg, bg
+from cmd2 import CommandSet, with_default_category, with_argparser
+import argparse
+
+import os
+import sys
+from optparse import OptionParser
+
+from pySim.ts_51_011 import EF, DF, EF_SST_map, EF_AD_mode_map
+from pySim.ts_31_102 import EF_UST_map, EF_USIM_ADF_map
+from pySim.ts_31_103 import EF_IST_map, EF_ISIM_ADF_map
+
+from pySim.exceptions import *
+from pySim.commands import SimCardCommands
+from pySim.cards import card_detect, Card
+from pySim.utils import h2b, swap_nibbles, rpad, h2s
+from pySim.utils import dec_st, init_reader, sanitize_pin_adm
+from pySim.card_handler import card_handler
+
+from pySim.filesystem import CardMF, RuntimeState
+from pySim.ts_51_011 import CardProfileSIM, DF_TELECOM, DF_GSM
+from pySim.ts_102_221 import CardProfileUICC
+from pySim.ts_31_102 import ADF_USIM
+from pySim.ts_31_103 import ADF_ISIM
+
+class PysimApp(cmd2.Cmd):
+ CUSTOM_CATEGORY = 'pySim Commands'
+ def __init__(self, card, rs):
+ basic_commands = [Iso7816Commands(), UsimCommands()]
+ super().__init__(persistent_history_file='~/.pysim_shell_history', allow_cli_args=False,
+ use_ipython=True, auto_load_commands=False, command_sets=basic_commands)
+ self.intro = style('Welcome to pySim-shell!', fg=fg.red)
+ self.default_category = 'pySim-shell built-in commands'
+ self.card = card
+ self.rs = rs
+ self.py_locals = { 'card': self.card, 'rs' : self.rs }
+ self.card.read_aids()
+ self.poutput('AIDs on card: %s' % (self.card._aids))
+ self.numeric_path = False
+ self.add_settable(cmd2.Settable('numeric_path', bool, 'Print File IDs instead of names',
+ onchange_cb=self._onchange_numeric_path))
+ self.update_prompt()
+
+ def _onchange_numeric_path(self, param_name, old, new):
+ self.update_prompt()
+
+ def update_prompt(self):
+ path_list = self.rs.selected_file.fully_qualified_path(not self.numeric_path)
+ self.prompt = 'pySIM-shell (%s)> ' % ('/'.join(path_list))
+
+ @cmd2.with_category(CUSTOM_CATEGORY)
+ def do_intro(self, _):
+ """Display the intro banner"""
+ self.poutput(self.intro)
+
+ @cmd2.with_category(CUSTOM_CATEGORY)
+ def do_verify_adm(self, arg):
+ """VERIFY the ADM1 PIN"""
+ pin_adm = sanitize_pin_adm(arg)
+ self.card.verify_adm(h2b(pin_adm))
+
+
+
+@with_default_category('ISO7816 Commands')
+class Iso7816Commands(CommandSet):
+ def __init__(self):
+ super().__init__()
+
+ def do_select(self, opts):
+ """SELECT a File (ADF/DF/EF)"""
+ path = opts.arg_list[0]
+ fcp_dec = self._cmd.rs.select(path, self._cmd)
+ self._cmd.update_prompt()
+ self._cmd.poutput(json.dumps(fcp_dec, indent=4))
+
+ def complete_select(self, text, line, begidx, endidx) -> List[str]:
+ """Command Line tab completion for SELECT"""
+ index_dict = { 1: self._cmd.rs.selected_file.get_selectable_names() }
+ return self._cmd.index_based_complete(text, line, begidx, endidx, index_dict=index_dict)
+
+ verify_chv_parser = argparse.ArgumentParser()
+ verify_chv_parser.add_argument('--chv-nr', type=int, default=1, help='CHV Number')
+ verify_chv_parser.add_argument('code', help='CODE/PIN/PUK')
+
+ @cmd2.with_argparser(verify_chv_parser)
+ def do_verify_chv(self, opts):
+ """Verify (authenticate) using specified CHV (PIN)"""
+ (data, sw) = self._cmd.card._scc.verify_chv(opts.chv_nr, opts.code)
+ self._cmd.poutput(data)
+
+
+
+
+@with_default_category('USIM Commands')
+class UsimCommands(CommandSet):
+ def __init__(self):
+ super().__init__()
+
+ def do_read_ust(self, _):
+ """Read + Display the EF.UST"""
+ self._cmd.card.select_adf_by_aid(adf="usim")
+ (res, sw) = self._cmd.card.read_ust()
+ self._cmd.poutput(res[0])
+ self._cmd.poutput(res[1])
+
+ def do_read_ehplmn(self, _):
+ """Read EF.EHPLMN"""
+ self._cmd.card.select_adf_by_aid(adf="usim")
+ (res, sw) = self._cmd.card.read_ehplmn()
+ self._cmd.poutput(res)
+
+def parse_options():
+
+ parser = OptionParser(usage="usage: %prog [options]")
+
+ parser.add_option("-d", "--device", dest="device", metavar="DEV",
+ help="Serial Device for SIM access [default: %default]",
+ default="/dev/ttyUSB0",
+ )
+ parser.add_option("-b", "--baud", dest="baudrate", type="int", metavar="BAUD",
+ help="Baudrate used for SIM access [default: %default]",
+ default=9600,
+ )
+ parser.add_option("-p", "--pcsc-device", dest="pcsc_dev", type='int', metavar="PCSC",
+ help="Which PC/SC reader number for SIM access",
+ default=None,
+ )
+ parser.add_option("--modem-device", dest="modem_dev", metavar="DEV",
+ help="Serial port of modem for Generic SIM Access (3GPP TS 27.007)",
+ default=None,
+ )
+ parser.add_option("--modem-baud", dest="modem_baud", type="int", metavar="BAUD",
+ help="Baudrate used for modem's port [default: %default]",
+ default=115200,
+ )
+ parser.add_option("--osmocon", dest="osmocon_sock", metavar="PATH",
+ help="Socket path for Calypso (e.g. Motorola C1XX) based reader (via OsmocomBB)",
+ default=None,
+ )
+
+ parser.add_option("-a", "--pin-adm", dest="pin_adm",
+ help="ADM PIN used for provisioning (overwrites default)",
+ )
+ parser.add_option("-A", "--pin-adm-hex", dest="pin_adm_hex",
+ help="ADM PIN used for provisioning, as hex string (16 characters long",
+ )
+
+ (options, args) = parser.parse_args()
+
+ if args:
+ parser.error("Extraneous arguments")
+
+ return options
+
+
+
+if __name__ == '__main__':
+
+ # Parse options
+ opts = parse_options()
+
+ # Init card reader driver
+ sl = init_reader(opts)
+
+ # Create command layer
+ scc = SimCardCommands(transport=sl)
+
+ sl.wait_for_card();
+
+ card_handler = card_handler(sl)
+
+ card = card_detect("auto", scc)
+ if card is None:
+ print("No card detected!")
+ sys.exit(2)
+
+ profile = CardProfileUICC()
+ rs = RuntimeState(card, profile)
+
+ # FIXME: do this dynamically
+ rs.mf.add_file(DF_TELECOM())
+ rs.mf.add_file(DF_GSM())
+ rs.mf.add_application(ADF_USIM())
+ rs.mf.add_application(ADF_ISIM())
+
+ app = PysimApp(card, rs)
+ app.cmdloop()