Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1 | # coding=utf-8 |
| 2 | """Representation of the ISO7816-4 filesystem model. |
| 3 | |
| 4 | The File (and its derived classes) represent the structure / hierarchy |
| 5 | of the ISO7816-4 smart card file system with the MF, DF, EF and ADF |
| 6 | entries, further sub-divided into the EF sub-types Transparent, Linear Fixed, etc. |
| 7 | |
| 8 | The classes are intended to represent the *specification* of the filesystem, |
| 9 | not the actual contents / runtime state of interacting with a given smart card. |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 10 | """ |
| 11 | |
Harald Welte | 5a4fd52 | 2021-04-02 16:05:26 +0200 | [diff] [blame] | 12 | # (C) 2021 by Harald Welte <laforge@osmocom.org> |
| 13 | # |
| 14 | # This program is free software: you can redistribute it and/or modify |
| 15 | # it under the terms of the GNU General Public License as published by |
| 16 | # the Free Software Foundation, either version 2 of the License, or |
| 17 | # (at your option) any later version. |
| 18 | # |
| 19 | # This program is distributed in the hope that it will be useful, |
| 20 | # but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 21 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 22 | # GNU General Public License for more details. |
| 23 | # |
| 24 | # You should have received a copy of the GNU General Public License |
| 25 | # along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 26 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 27 | import code |
| 28 | import json |
| 29 | |
| 30 | import cmd2 |
| 31 | from cmd2 import CommandSet, with_default_category, with_argparser |
| 32 | import argparse |
| 33 | |
Harald Welte | 1e45657 | 2021-04-02 17:16:30 +0200 | [diff] [blame] | 34 | from typing import cast, Optional, Iterable, List, Any, Dict, Tuple |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 35 | |
Philipp Maier | 3aec871 | 2021-03-09 21:49:01 +0100 | [diff] [blame] | 36 | from pySim.utils import sw_match, h2b, b2h, is_hex |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 37 | from pySim.exceptions import * |
| 38 | |
| 39 | class CardFile(object): |
| 40 | """Base class for all objects in the smart card filesystem. |
| 41 | Serve as a common ancestor to all other file types; rarely used directly. |
| 42 | """ |
| 43 | RESERVED_NAMES = ['..', '.', '/', 'MF'] |
| 44 | RESERVED_FIDS = ['3f00'] |
| 45 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 46 | def __init__(self, fid:str=None, sfid:str=None, name:str=None, desc:str=None, |
| 47 | parent:Optional['CardDF']=None): |
| 48 | """ |
| 49 | Args: |
| 50 | fid : File Identifier (4 hex digits) |
| 51 | sfid : Short File Identifier (2 hex digits, optional) |
| 52 | name : Brief name of the file, lik EF_ICCID |
| 53 | desc : Descriptoin of the file |
| 54 | parent : Parent CardFile object within filesystem hierarchy |
| 55 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 56 | if not isinstance(self, CardADF) and fid == None: |
| 57 | raise ValueError("fid is mandatory") |
| 58 | if fid: |
| 59 | fid = fid.lower() |
| 60 | self.fid = fid # file identifier |
| 61 | self.sfid = sfid # short file identifier |
| 62 | self.name = name # human readable name |
| 63 | self.desc = desc # human readable description |
| 64 | self.parent = parent |
| 65 | if self.parent and self.parent != self and self.fid: |
| 66 | self.parent.add_file(self) |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 67 | self.shell_commands: List[CommandSet] = [] |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 68 | |
Philipp Maier | 6606158 | 2021-03-09 21:57:57 +0100 | [diff] [blame] | 69 | # Note: the basic properties (fid, name, ect.) are verified when |
| 70 | # the file is attached to a parent file. See method add_file() in |
| 71 | # class Card DF |
| 72 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 73 | def __str__(self): |
| 74 | if self.name: |
| 75 | return self.name |
| 76 | else: |
| 77 | return self.fid |
| 78 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 79 | def _path_element(self, prefer_name:bool) -> Optional[str]: |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 80 | if prefer_name and self.name: |
| 81 | return self.name |
| 82 | else: |
| 83 | return self.fid |
| 84 | |
Harald Welte | 1e45657 | 2021-04-02 17:16:30 +0200 | [diff] [blame] | 85 | def fully_qualified_path(self, prefer_name:bool=True) -> List[str]: |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 86 | """Return fully qualified path to file as list of FID or name strings. |
| 87 | |
| 88 | Args: |
| 89 | prefer_name : Preferably build path of names; fall-back to FIDs as required |
| 90 | """ |
Harald Welte | 1e45657 | 2021-04-02 17:16:30 +0200 | [diff] [blame] | 91 | if self.parent and self.parent != self: |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 92 | ret = self.parent.fully_qualified_path(prefer_name) |
| 93 | else: |
| 94 | ret = [] |
Harald Welte | 1e45657 | 2021-04-02 17:16:30 +0200 | [diff] [blame] | 95 | elem = self._path_element(prefer_name) |
| 96 | if elem: |
| 97 | ret.append(elem) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 98 | return ret |
| 99 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 100 | def get_mf(self) -> Optional['CardMF']: |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 101 | """Return the MF (root) of the file system.""" |
| 102 | if self.parent == None: |
| 103 | return None |
| 104 | # iterate towards the top. MF has parent == self |
| 105 | node = self |
Harald Welte | 1e45657 | 2021-04-02 17:16:30 +0200 | [diff] [blame] | 106 | while node.parent and node.parent != node: |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 107 | node = node.parent |
Harald Welte | 1e45657 | 2021-04-02 17:16:30 +0200 | [diff] [blame] | 108 | return cast(CardMF, node) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 109 | |
Harald Welte | 1e45657 | 2021-04-02 17:16:30 +0200 | [diff] [blame] | 110 | def _get_self_selectables(self, alias:str=None, flags = []) -> Dict[str, 'CardFile']: |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 111 | """Return a dict of {'identifier': self} tuples. |
| 112 | |
| 113 | Args: |
| 114 | alias : Add an alias with given name to 'self' |
| 115 | flags : Specify which selectables to return 'FIDS' and/or 'NAMES'; |
| 116 | If not specified, all selectables will be returned. |
| 117 | Returns: |
| 118 | dict containing reference to 'self' for all identifiers. |
| 119 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 120 | sels = {} |
| 121 | if alias: |
| 122 | sels.update({alias: self}) |
Philipp Maier | 786f781 | 2021-02-25 16:48:10 +0100 | [diff] [blame] | 123 | if self.fid and (flags == [] or 'FIDS' in flags): |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 124 | sels.update({self.fid: self}) |
Philipp Maier | bd8ed2c | 2021-03-18 17:09:33 +0100 | [diff] [blame] | 125 | if self.name and (flags == [] or 'FNAMES' in flags): |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 126 | sels.update({self.name: self}) |
| 127 | return sels |
| 128 | |
Harald Welte | 1e45657 | 2021-04-02 17:16:30 +0200 | [diff] [blame] | 129 | def get_selectables(self, flags = []) -> Dict[str, 'CardFile']: |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 130 | """Return a dict of {'identifier': File} that is selectable from the current file. |
| 131 | |
| 132 | Args: |
| 133 | flags : Specify which selectables to return 'FIDS' and/or 'NAMES'; |
| 134 | If not specified, all selectables will be returned. |
| 135 | Returns: |
| 136 | dict containing all selectable items. Key is identifier (string), value |
| 137 | a reference to a CardFile (or derived class) instance. |
| 138 | """ |
Philipp Maier | 786f781 | 2021-02-25 16:48:10 +0100 | [diff] [blame] | 139 | sels = {} |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 140 | # we can always select ourself |
Philipp Maier | 786f781 | 2021-02-25 16:48:10 +0100 | [diff] [blame] | 141 | if flags == [] or 'SELF' in flags: |
| 142 | sels = self._get_self_selectables('.', flags) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 143 | # we can always select our parent |
Philipp Maier | 786f781 | 2021-02-25 16:48:10 +0100 | [diff] [blame] | 144 | if flags == [] or 'PARENT' in flags: |
Harald Welte | 1e45657 | 2021-04-02 17:16:30 +0200 | [diff] [blame] | 145 | if self.parent: |
| 146 | sels = self.parent._get_self_selectables('..', flags) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 147 | # if we have a MF, we can always select its applications |
Philipp Maier | 786f781 | 2021-02-25 16:48:10 +0100 | [diff] [blame] | 148 | if flags == [] or 'MF' in flags: |
| 149 | mf = self.get_mf() |
| 150 | if mf: |
| 151 | sels.update(mf._get_self_selectables(flags = flags)) |
Philipp Maier | bd8ed2c | 2021-03-18 17:09:33 +0100 | [diff] [blame] | 152 | sels.update(mf.get_app_selectables(flags = flags)) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 153 | return sels |
| 154 | |
Harald Welte | 1e45657 | 2021-04-02 17:16:30 +0200 | [diff] [blame] | 155 | def get_selectable_names(self, flags = []) -> List[str]: |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 156 | """Return a dict of {'identifier': File} that is selectable from the current file. |
| 157 | |
| 158 | Args: |
| 159 | flags : Specify which selectables to return 'FIDS' and/or 'NAMES'; |
| 160 | If not specified, all selectables will be returned. |
| 161 | Returns: |
Harald Welte | 1e45657 | 2021-04-02 17:16:30 +0200 | [diff] [blame] | 162 | list containing all selectable names. |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 163 | """ |
Philipp Maier | 786f781 | 2021-02-25 16:48:10 +0100 | [diff] [blame] | 164 | sels = self.get_selectables(flags) |
Harald Welte | 1e45657 | 2021-04-02 17:16:30 +0200 | [diff] [blame] | 165 | return list(sels.keys()) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 166 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 167 | def decode_select_response(self, data_hex:str): |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 168 | """Decode the response to a SELECT command.""" |
Harald Welte | 1e45657 | 2021-04-02 17:16:30 +0200 | [diff] [blame] | 169 | if self.parent: |
| 170 | return self.parent.decode_select_response(data_hex) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 171 | |
| 172 | |
| 173 | class CardDF(CardFile): |
| 174 | """DF (Dedicated File) in the smart card filesystem. Those are basically sub-directories.""" |
Philipp Maier | 63f572d | 2021-03-09 22:42:47 +0100 | [diff] [blame] | 175 | |
| 176 | @with_default_category('DF/ADF Commands') |
| 177 | class ShellCommands(CommandSet): |
| 178 | def __init__(self): |
| 179 | super().__init__() |
| 180 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 181 | def __init__(self, **kwargs): |
| 182 | if not isinstance(self, CardADF): |
| 183 | if not 'fid' in kwargs: |
| 184 | raise TypeError('fid is mandatory for all DF') |
| 185 | super().__init__(**kwargs) |
| 186 | self.children = dict() |
Philipp Maier | 63f572d | 2021-03-09 22:42:47 +0100 | [diff] [blame] | 187 | self.shell_commands = [self.ShellCommands()] |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 188 | |
| 189 | def __str__(self): |
| 190 | return "DF(%s)" % (super().__str__()) |
| 191 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 192 | def add_file(self, child:CardFile, ignore_existing:bool=False): |
| 193 | """Add a child (DF/EF) to this DF. |
| 194 | Args: |
| 195 | child: The new DF/EF to be added |
| 196 | ignore_existing: Ignore, if file with given FID already exists. Old one will be kept. |
| 197 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 198 | if not isinstance(child, CardFile): |
| 199 | raise TypeError("Expected a File instance") |
Philipp Maier | 3aec871 | 2021-03-09 21:49:01 +0100 | [diff] [blame] | 200 | if not is_hex(child.fid, minlen = 4, maxlen = 4): |
| 201 | raise ValueError("File name %s is not a valid fid" % (child.fid)) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 202 | if child.name in CardFile.RESERVED_NAMES: |
| 203 | raise ValueError("File name %s is a reserved name" % (child.name)) |
| 204 | if child.fid in CardFile.RESERVED_FIDS: |
Philipp Maier | e8bc1b4 | 2021-03-09 20:33:41 +0100 | [diff] [blame] | 205 | raise ValueError("File fid %s is a reserved fid" % (child.fid)) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 206 | if child.fid in self.children: |
| 207 | if ignore_existing: |
| 208 | return |
| 209 | raise ValueError("File with given fid %s already exists" % (child.fid)) |
| 210 | if self.lookup_file_by_sfid(child.sfid): |
| 211 | raise ValueError("File with given sfid %s already exists" % (child.sfid)) |
| 212 | if self.lookup_file_by_name(child.name): |
| 213 | if ignore_existing: |
| 214 | return |
| 215 | raise ValueError("File with given name %s already exists" % (child.name)) |
| 216 | self.children[child.fid] = child |
| 217 | child.parent = self |
| 218 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 219 | def add_files(self, children:Iterable[CardFile], ignore_existing:bool=False): |
| 220 | """Add a list of child (DF/EF) to this DF |
| 221 | |
| 222 | Args: |
| 223 | children: List of new DF/EFs to be added |
| 224 | ignore_existing: Ignore, if file[s] with given FID already exists. Old one[s] will be kept. |
| 225 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 226 | for child in children: |
| 227 | self.add_file(child, ignore_existing) |
| 228 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 229 | def get_selectables(self, flags = []) -> dict: |
| 230 | """Return a dict of {'identifier': File} that is selectable from the current DF. |
| 231 | |
| 232 | Args: |
| 233 | flags : Specify which selectables to return 'FIDS' and/or 'NAMES'; |
| 234 | If not specified, all selectables will be returned. |
| 235 | Returns: |
| 236 | dict containing all selectable items. Key is identifier (string), value |
| 237 | a reference to a CardFile (or derived class) instance. |
| 238 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 239 | # global selectables + our children |
Philipp Maier | 786f781 | 2021-02-25 16:48:10 +0100 | [diff] [blame] | 240 | sels = super().get_selectables(flags) |
| 241 | if flags == [] or 'FIDS' in flags: |
| 242 | sels.update({x.fid: x for x in self.children.values() if x.fid}) |
Philipp Maier | bd8ed2c | 2021-03-18 17:09:33 +0100 | [diff] [blame] | 243 | if flags == [] or 'FNAMES' in flags: |
Philipp Maier | 786f781 | 2021-02-25 16:48:10 +0100 | [diff] [blame] | 244 | sels.update({x.name: x for x in self.children.values() if x.name}) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 245 | return sels |
| 246 | |
Harald Welte | 1e45657 | 2021-04-02 17:16:30 +0200 | [diff] [blame] | 247 | def lookup_file_by_name(self, name:Optional[str]) -> Optional[CardFile]: |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 248 | """Find a file with given name within current DF.""" |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 249 | if name == None: |
| 250 | return None |
| 251 | for i in self.children.values(): |
| 252 | if i.name and i.name == name: |
| 253 | return i |
| 254 | return None |
| 255 | |
Harald Welte | 1e45657 | 2021-04-02 17:16:30 +0200 | [diff] [blame] | 256 | def lookup_file_by_sfid(self, sfid:Optional[str]) -> Optional[CardFile]: |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 257 | """Find a file with given short file ID within current DF.""" |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 258 | if sfid == None: |
| 259 | return None |
| 260 | for i in self.children.values(): |
Harald Welte | 1e45657 | 2021-04-02 17:16:30 +0200 | [diff] [blame] | 261 | if i.sfid == int(str(sfid)): |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 262 | return i |
| 263 | return None |
| 264 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 265 | def lookup_file_by_fid(self, fid:str) -> Optional[CardFile]: |
| 266 | """Find a file with given file ID within current DF.""" |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 267 | if fid in self.children: |
| 268 | return self.children[fid] |
| 269 | return None |
| 270 | |
| 271 | |
| 272 | class CardMF(CardDF): |
| 273 | """MF (Master File) in the smart card filesystem""" |
| 274 | def __init__(self, **kwargs): |
| 275 | # can be overridden; use setdefault |
| 276 | kwargs.setdefault('fid', '3f00') |
| 277 | kwargs.setdefault('name', 'MF') |
| 278 | kwargs.setdefault('desc', 'Master File (directory root)') |
| 279 | # cannot be overridden; use assignment |
| 280 | kwargs['parent'] = self |
| 281 | super().__init__(**kwargs) |
| 282 | self.applications = dict() |
| 283 | |
| 284 | def __str__(self): |
| 285 | return "MF(%s)" % (self.fid) |
| 286 | |
Harald Welte | 5ce3524 | 2021-04-02 20:27:05 +0200 | [diff] [blame] | 287 | def add_application_df(self, app:'CardADF'): |
| 288 | """Add an Application to the MF""" |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 289 | if not isinstance(app, CardADF): |
| 290 | raise TypeError("Expected an ADF instance") |
| 291 | if app.aid in self.applications: |
| 292 | raise ValueError("AID %s already exists" % (app.aid)) |
| 293 | self.applications[app.aid] = app |
| 294 | app.parent=self |
| 295 | |
| 296 | def get_app_names(self): |
| 297 | """Get list of completions (AID names)""" |
| 298 | return [x.name for x in self.applications] |
| 299 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 300 | def get_selectables(self, flags = []) -> dict: |
| 301 | """Return a dict of {'identifier': File} that is selectable from the current DF. |
| 302 | |
| 303 | Args: |
| 304 | flags : Specify which selectables to return 'FIDS' and/or 'NAMES'; |
| 305 | If not specified, all selectables will be returned. |
| 306 | Returns: |
| 307 | dict containing all selectable items. Key is identifier (string), value |
| 308 | a reference to a CardFile (or derived class) instance. |
| 309 | """ |
Philipp Maier | 786f781 | 2021-02-25 16:48:10 +0100 | [diff] [blame] | 310 | sels = super().get_selectables(flags) |
Philipp Maier | bd8ed2c | 2021-03-18 17:09:33 +0100 | [diff] [blame] | 311 | sels.update(self.get_app_selectables(flags)) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 312 | return sels |
| 313 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 314 | def get_app_selectables(self, flags = []) -> dict: |
Philipp Maier | 786f781 | 2021-02-25 16:48:10 +0100 | [diff] [blame] | 315 | """Get applications by AID + name""" |
| 316 | sels = {} |
Philipp Maier | bd8ed2c | 2021-03-18 17:09:33 +0100 | [diff] [blame] | 317 | if flags == [] or 'AIDS' in flags: |
Philipp Maier | 786f781 | 2021-02-25 16:48:10 +0100 | [diff] [blame] | 318 | sels.update({x.aid: x for x in self.applications.values()}) |
Philipp Maier | bd8ed2c | 2021-03-18 17:09:33 +0100 | [diff] [blame] | 319 | if flags == [] or 'ANAMES' in flags: |
Philipp Maier | 786f781 | 2021-02-25 16:48:10 +0100 | [diff] [blame] | 320 | sels.update({x.name: x for x in self.applications.values() if x.name}) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 321 | return sels |
| 322 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 323 | def decode_select_response(self, data_hex:str) -> Any: |
| 324 | """Decode the response to a SELECT command. |
| 325 | |
| 326 | This is the fall-back method which doesn't perform any decoding. It mostly |
| 327 | exists so specific derived classes can overload it for actual decoding. |
| 328 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 329 | return data_hex |
| 330 | |
| 331 | |
| 332 | |
| 333 | class CardADF(CardDF): |
| 334 | """ADF (Application Dedicated File) in the smart card filesystem""" |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 335 | def __init__(self, aid:str, **kwargs): |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 336 | super().__init__(**kwargs) |
Harald Welte | 5ce3524 | 2021-04-02 20:27:05 +0200 | [diff] [blame] | 337 | # reference to CardApplication may be set from CardApplication constructor |
| 338 | self.application:Optional[CardApplication] = None |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 339 | self.aid = aid # Application Identifier |
Harald Welte | 1e45657 | 2021-04-02 17:16:30 +0200 | [diff] [blame] | 340 | mf = self.get_mf() |
| 341 | if mf: |
Harald Welte | 5ce3524 | 2021-04-02 20:27:05 +0200 | [diff] [blame] | 342 | mf.add_application_df(self) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 343 | |
| 344 | def __str__(self): |
| 345 | return "ADF(%s)" % (self.aid) |
| 346 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 347 | def _path_element(self, prefer_name:bool): |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 348 | if self.name and prefer_name: |
| 349 | return self.name |
| 350 | else: |
| 351 | return self.aid |
| 352 | |
| 353 | |
| 354 | class CardEF(CardFile): |
| 355 | """EF (Entry File) in the smart card filesystem""" |
| 356 | def __init__(self, *, fid, **kwargs): |
| 357 | kwargs['fid'] = fid |
| 358 | super().__init__(**kwargs) |
| 359 | |
| 360 | def __str__(self): |
| 361 | return "EF(%s)" % (super().__str__()) |
| 362 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 363 | def get_selectables(self, flags = []) -> dict: |
| 364 | """Return a dict of {'identifier': File} that is selectable from the current DF. |
| 365 | |
| 366 | Args: |
| 367 | flags : Specify which selectables to return 'FIDS' and/or 'NAMES'; |
| 368 | If not specified, all selectables will be returned. |
| 369 | Returns: |
| 370 | dict containing all selectable items. Key is identifier (string), value |
| 371 | a reference to a CardFile (or derived class) instance. |
| 372 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 373 | #global selectable names + those of the parent DF |
Philipp Maier | 786f781 | 2021-02-25 16:48:10 +0100 | [diff] [blame] | 374 | sels = super().get_selectables(flags) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 375 | sels.update({x.name:x for x in self.parent.children.values() if x != self}) |
| 376 | return sels |
| 377 | |
| 378 | |
| 379 | class TransparentEF(CardEF): |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 380 | """Transparent EF (Entry File) in the smart card filesystem. |
| 381 | |
| 382 | A Transparent EF is a binary file with no formal structure. This is contrary to |
| 383 | Record based EFs which have [fixed size] records that can be individually read/updated.""" |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 384 | |
| 385 | @with_default_category('Transparent EF Commands') |
| 386 | class ShellCommands(CommandSet): |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 387 | """Shell commands specific for Trransparent EFs.""" |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 388 | def __init__(self): |
| 389 | super().__init__() |
| 390 | |
| 391 | read_bin_parser = argparse.ArgumentParser() |
| 392 | read_bin_parser.add_argument('--offset', type=int, default=0, help='Byte offset for start of read') |
| 393 | read_bin_parser.add_argument('--length', type=int, help='Number of bytes to read') |
| 394 | @cmd2.with_argparser(read_bin_parser) |
| 395 | def do_read_binary(self, opts): |
| 396 | """Read binary data from a transparent EF""" |
| 397 | (data, sw) = self._cmd.rs.read_binary(opts.length, opts.offset) |
| 398 | self._cmd.poutput(data) |
| 399 | |
| 400 | def do_read_binary_decoded(self, opts): |
| 401 | """Read + decode data from a transparent EF""" |
| 402 | (data, sw) = self._cmd.rs.read_binary_dec() |
| 403 | self._cmd.poutput(json.dumps(data, indent=4)) |
| 404 | |
| 405 | upd_bin_parser = argparse.ArgumentParser() |
| 406 | upd_bin_parser.add_argument('--offset', type=int, default=0, help='Byte offset for start of read') |
| 407 | upd_bin_parser.add_argument('data', help='Data bytes (hex format) to write') |
| 408 | @cmd2.with_argparser(upd_bin_parser) |
| 409 | def do_update_binary(self, opts): |
| 410 | """Update (Write) data of a transparent EF""" |
| 411 | (data, sw) = self._cmd.rs.update_binary(opts.data, opts.offset) |
Philipp Maier | e6bc4f9 | 2021-03-11 17:13:46 +0100 | [diff] [blame] | 412 | if data: |
| 413 | self._cmd.poutput(data) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 414 | |
| 415 | upd_bin_dec_parser = argparse.ArgumentParser() |
| 416 | upd_bin_dec_parser.add_argument('data', help='Abstract data (JSON format) to write') |
| 417 | @cmd2.with_argparser(upd_bin_dec_parser) |
| 418 | def do_update_binary_decoded(self, opts): |
| 419 | """Encode + Update (Write) data of a transparent EF""" |
| 420 | data_json = json.loads(opts.data) |
| 421 | (data, sw) = self._cmd.rs.update_binary_dec(data_json) |
Philipp Maier | e6bc4f9 | 2021-03-11 17:13:46 +0100 | [diff] [blame] | 422 | if data: |
| 423 | self._cmd.poutput(json.dumps(data, indent=4)) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 424 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 425 | def __init__(self, fid:str, sfid:str=None, name:str=None, desc:str=None, parent:CardDF=None, |
| 426 | size={1,None}): |
| 427 | """ |
| 428 | Args: |
| 429 | fid : File Identifier (4 hex digits) |
| 430 | sfid : Short File Identifier (2 hex digits, optional) |
| 431 | name : Brief name of the file, lik EF_ICCID |
| 432 | desc : Descriptoin of the file |
| 433 | parent : Parent CardFile object within filesystem hierarchy |
| 434 | size : tuple of (minimum_size, recommended_size) |
| 435 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 436 | super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, parent=parent) |
| 437 | self.size = size |
| 438 | self.shell_commands = [self.ShellCommands()] |
| 439 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 440 | def decode_bin(self, raw_bin_data:bytearray) -> dict: |
| 441 | """Decode raw (binary) data into abstract representation. |
| 442 | |
| 443 | A derived class would typically provide a _decode_bin() or _decode_hex() method |
| 444 | for implementing this specifically for the given file. This function checks which |
| 445 | of the method exists, add calls them (with conversion, as needed). |
| 446 | |
| 447 | Args: |
| 448 | raw_bin_data : binary encoded data |
| 449 | Returns: |
| 450 | abstract_data; dict representing the decoded data |
| 451 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 452 | method = getattr(self, '_decode_bin', None) |
| 453 | if callable(method): |
| 454 | return method(raw_bin_data) |
| 455 | method = getattr(self, '_decode_hex', None) |
| 456 | if callable(method): |
| 457 | return method(b2h(raw_bin_data)) |
| 458 | return {'raw': raw_bin_data.hex()} |
| 459 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 460 | def decode_hex(self, raw_hex_data:str) -> dict: |
| 461 | """Decode raw (hex string) data into abstract representation. |
| 462 | |
| 463 | A derived class would typically provide a _decode_bin() or _decode_hex() method |
| 464 | for implementing this specifically for the given file. This function checks which |
| 465 | of the method exists, add calls them (with conversion, as needed). |
| 466 | |
| 467 | Args: |
| 468 | raw_hex_data : hex-encoded data |
| 469 | Returns: |
| 470 | abstract_data; dict representing the decoded data |
| 471 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 472 | method = getattr(self, '_decode_hex', None) |
| 473 | if callable(method): |
| 474 | return method(raw_hex_data) |
| 475 | raw_bin_data = h2b(raw_hex_data) |
| 476 | method = getattr(self, '_decode_bin', None) |
| 477 | if callable(method): |
| 478 | return method(raw_bin_data) |
| 479 | return {'raw': raw_bin_data.hex()} |
| 480 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 481 | def encode_bin(self, abstract_data:dict) -> bytearray: |
| 482 | """Encode abstract representation into raw (binary) data. |
| 483 | |
| 484 | A derived class would typically provide an _encode_bin() or _encode_hex() method |
| 485 | for implementing this specifically for the given file. This function checks which |
| 486 | of the method exists, add calls them (with conversion, as needed). |
| 487 | |
| 488 | Args: |
| 489 | abstract_data : dict representing the decoded data |
| 490 | Returns: |
| 491 | binary encoded data |
| 492 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 493 | method = getattr(self, '_encode_bin', None) |
| 494 | if callable(method): |
| 495 | return method(abstract_data) |
| 496 | method = getattr(self, '_encode_hex', None) |
| 497 | if callable(method): |
| 498 | return h2b(method(abstract_data)) |
| 499 | raise NotImplementedError |
| 500 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 501 | def encode_hex(self, abstract_data:dict) -> str: |
| 502 | """Encode abstract representation into raw (hex string) data. |
| 503 | |
| 504 | A derived class would typically provide an _encode_bin() or _encode_hex() method |
| 505 | for implementing this specifically for the given file. This function checks which |
| 506 | of the method exists, add calls them (with conversion, as needed). |
| 507 | |
| 508 | Args: |
| 509 | abstract_data : dict representing the decoded data |
| 510 | Returns: |
| 511 | hex string encoded data |
| 512 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 513 | method = getattr(self, '_encode_hex', None) |
| 514 | if callable(method): |
| 515 | return method(abstract_data) |
| 516 | method = getattr(self, '_encode_bin', None) |
| 517 | if callable(method): |
| 518 | raw_bin_data = method(abstract_data) |
| 519 | return b2h(raw_bin_data) |
| 520 | raise NotImplementedError |
| 521 | |
| 522 | |
| 523 | class LinFixedEF(CardEF): |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 524 | """Linear Fixed EF (Entry File) in the smart card filesystem. |
| 525 | |
| 526 | Linear Fixed EFs are record oriented files. They consist of a number of fixed-size |
| 527 | records. The records can be individually read/updated.""" |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 528 | |
| 529 | @with_default_category('Linear Fixed EF Commands') |
| 530 | class ShellCommands(CommandSet): |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 531 | """Shell commands specific for Linear Fixed EFs.""" |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 532 | def __init__(self): |
| 533 | super().__init__() |
| 534 | |
| 535 | read_rec_parser = argparse.ArgumentParser() |
| 536 | read_rec_parser.add_argument('record_nr', type=int, help='Number of record to be read') |
Philipp Maier | 4155573 | 2021-02-25 16:52:08 +0100 | [diff] [blame] | 537 | read_rec_parser.add_argument('--count', type=int, default=1, help='Number of records to be read, beginning at record_nr') |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 538 | @cmd2.with_argparser(read_rec_parser) |
| 539 | def do_read_record(self, opts): |
Philipp Maier | 4155573 | 2021-02-25 16:52:08 +0100 | [diff] [blame] | 540 | """Read one or multiple records from a record-oriented EF""" |
| 541 | for r in range(opts.count): |
| 542 | recnr = opts.record_nr + r |
| 543 | (data, sw) = self._cmd.rs.read_record(recnr) |
| 544 | if (len(data) > 0): |
| 545 | recstr = str(data) |
| 546 | else: |
| 547 | recstr = "(empty)" |
| 548 | self._cmd.poutput("%03d %s" % (recnr, recstr)) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 549 | |
| 550 | read_rec_dec_parser = argparse.ArgumentParser() |
| 551 | read_rec_dec_parser.add_argument('record_nr', type=int, help='Number of record to be read') |
| 552 | @cmd2.with_argparser(read_rec_dec_parser) |
| 553 | def do_read_record_decoded(self, opts): |
| 554 | """Read + decode a record from a record-oriented EF""" |
| 555 | (data, sw) = self._cmd.rs.read_record_dec(opts.record_nr) |
| 556 | self._cmd.poutput(json.dumps(data, indent=4)) |
| 557 | |
| 558 | upd_rec_parser = argparse.ArgumentParser() |
| 559 | upd_rec_parser.add_argument('record_nr', type=int, help='Number of record to be read') |
| 560 | upd_rec_parser.add_argument('data', help='Data bytes (hex format) to write') |
| 561 | @cmd2.with_argparser(upd_rec_parser) |
| 562 | def do_update_record(self, opts): |
| 563 | """Update (write) data to a record-oriented EF""" |
| 564 | (data, sw) = self._cmd.rs.update_record(opts.record_nr, opts.data) |
Philipp Maier | e6bc4f9 | 2021-03-11 17:13:46 +0100 | [diff] [blame] | 565 | if data: |
| 566 | self._cmd.poutput(data) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 567 | |
| 568 | upd_rec_dec_parser = argparse.ArgumentParser() |
| 569 | upd_rec_dec_parser.add_argument('record_nr', type=int, help='Number of record to be read') |
| 570 | upd_rec_dec_parser.add_argument('data', help='Data bytes (hex format) to write') |
| 571 | @cmd2.with_argparser(upd_rec_dec_parser) |
| 572 | def do_update_record_decoded(self, opts): |
| 573 | """Encode + Update (write) data to a record-oriented EF""" |
| 574 | (data, sw) = self._cmd.rs.update_record_dec(opts.record_nr, opts.data) |
Philipp Maier | e6bc4f9 | 2021-03-11 17:13:46 +0100 | [diff] [blame] | 575 | if data: |
| 576 | self._cmd.poutput(data) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 577 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 578 | def __init__(self, fid:str, sfid:str=None, name:str=None, desc:str=None, |
| 579 | parent:Optional[CardDF]=None, rec_len={1,None}): |
| 580 | """ |
| 581 | Args: |
| 582 | fid : File Identifier (4 hex digits) |
| 583 | sfid : Short File Identifier (2 hex digits, optional) |
| 584 | name : Brief name of the file, lik EF_ICCID |
| 585 | desc : Descriptoin of the file |
| 586 | parent : Parent CardFile object within filesystem hierarchy |
| 587 | rec_len : tuple of (minimum_length, recommended_length) |
| 588 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 589 | super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, parent=parent) |
| 590 | self.rec_len = rec_len |
| 591 | self.shell_commands = [self.ShellCommands()] |
| 592 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 593 | def decode_record_hex(self, raw_hex_data:str) -> dict: |
| 594 | """Decode raw (hex string) data into abstract representation. |
| 595 | |
| 596 | A derived class would typically provide a _decode_record_bin() or _decode_record_hex() |
| 597 | method for implementing this specifically for the given file. This function checks which |
| 598 | of the method exists, add calls them (with conversion, as needed). |
| 599 | |
| 600 | Args: |
| 601 | raw_hex_data : hex-encoded data |
| 602 | Returns: |
| 603 | abstract_data; dict representing the decoded data |
| 604 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 605 | method = getattr(self, '_decode_record_hex', None) |
| 606 | if callable(method): |
| 607 | return method(raw_hex_data) |
| 608 | raw_bin_data = h2b(raw_hex_data) |
| 609 | method = getattr(self, '_decode_record_bin', None) |
| 610 | if callable(method): |
| 611 | return method(raw_bin_data) |
| 612 | return {'raw': raw_bin_data.hex()} |
| 613 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 614 | def decode_record_bin(self, raw_bin_data:bytearray) -> dict: |
| 615 | """Decode raw (binary) data into abstract representation. |
| 616 | |
| 617 | A derived class would typically provide a _decode_record_bin() or _decode_record_hex() |
| 618 | method for implementing this specifically for the given file. This function checks which |
| 619 | of the method exists, add calls them (with conversion, as needed). |
| 620 | |
| 621 | Args: |
| 622 | raw_bin_data : binary encoded data |
| 623 | Returns: |
| 624 | abstract_data; dict representing the decoded data |
| 625 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 626 | method = getattr(self, '_decode_record_bin', None) |
| 627 | if callable(method): |
| 628 | return method(raw_bin_data) |
| 629 | raw_hex_data = b2h(raw_bin_data) |
| 630 | method = getattr(self, '_decode_record_hex', None) |
| 631 | if callable(method): |
| 632 | return method(raw_hex_data) |
| 633 | return {'raw': raw_hex_data} |
| 634 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 635 | def encode_record_hex(self, abstract_data:dict) -> str: |
| 636 | """Encode abstract representation into raw (hex string) data. |
| 637 | |
| 638 | A derived class would typically provide an _encode_record_bin() or _encode_record_hex() |
| 639 | method for implementing this specifically for the given file. This function checks which |
| 640 | of the method exists, add calls them (with conversion, as needed). |
| 641 | |
| 642 | Args: |
| 643 | abstract_data : dict representing the decoded data |
| 644 | Returns: |
| 645 | hex string encoded data |
| 646 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 647 | method = getattr(self, '_encode_record_hex', None) |
| 648 | if callable(method): |
| 649 | return method(abstract_data) |
| 650 | method = getattr(self, '_encode_record_bin', None) |
| 651 | if callable(method): |
| 652 | raw_bin_data = method(abstract_data) |
Harald Welte | 1e45657 | 2021-04-02 17:16:30 +0200 | [diff] [blame] | 653 | return b2h(raw_bin_data) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 654 | raise NotImplementedError |
| 655 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 656 | def encode_record_bin(self, abstract_data:dict) -> bytearray: |
| 657 | """Encode abstract representation into raw (binary) data. |
| 658 | |
| 659 | A derived class would typically provide an _encode_record_bin() or _encode_record_hex() |
| 660 | method for implementing this specifically for the given file. This function checks which |
| 661 | of the method exists, add calls them (with conversion, as needed). |
| 662 | |
| 663 | Args: |
| 664 | abstract_data : dict representing the decoded data |
| 665 | Returns: |
| 666 | binary encoded data |
| 667 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 668 | method = getattr(self, '_encode_record_bin', None) |
| 669 | if callable(method): |
| 670 | return method(abstract_data) |
| 671 | method = getattr(self, '_encode_record_hex', None) |
| 672 | if callable(method): |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 673 | return h2b(method(abstract_data)) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 674 | raise NotImplementedError |
| 675 | |
| 676 | class CyclicEF(LinFixedEF): |
| 677 | """Cyclic EF (Entry File) in the smart card filesystem""" |
| 678 | # we don't really have any special support for those; just recycling LinFixedEF here |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 679 | def __init__(self, fid:str, sfid:str=None, name:str=None, desc:str=None, parent:CardDF=None, |
| 680 | rec_len={1,None}): |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 681 | super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, parent=parent, rec_len=rec_len) |
| 682 | |
| 683 | class TransRecEF(TransparentEF): |
| 684 | """Transparent EF (Entry File) containing fixed-size records. |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 685 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 686 | These are the real odd-balls and mostly look like mistakes in the specification: |
| 687 | Specified as 'transparent' EF, but actually containing several fixed-length records |
| 688 | inside. |
| 689 | We add a special class for those, so the user only has to provide encoder/decoder functions |
| 690 | for a record, while this class takes care of split / merge of records. |
| 691 | """ |
Harald Welte | 1e45657 | 2021-04-02 17:16:30 +0200 | [diff] [blame] | 692 | def __init__(self, fid:str, rec_len:int, sfid:str=None, name:str=None, desc:str=None, |
| 693 | parent:Optional[CardDF]=None, size={1,None}): |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 694 | """ |
| 695 | Args: |
| 696 | fid : File Identifier (4 hex digits) |
| 697 | sfid : Short File Identifier (2 hex digits, optional) |
| 698 | name : Brief name of the file, lik EF_ICCID |
| 699 | desc : Descriptoin of the file |
| 700 | parent : Parent CardFile object within filesystem hierarchy |
| 701 | rec_len : Length of the fixed-length records within transparent EF |
| 702 | size : tuple of (minimum_size, recommended_size) |
| 703 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 704 | super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, parent=parent, size=size) |
| 705 | self.rec_len = rec_len |
| 706 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 707 | def decode_record_hex(self, raw_hex_data:str) -> dict: |
| 708 | """Decode raw (hex string) data into abstract representation. |
| 709 | |
| 710 | A derived class would typically provide a _decode_record_bin() or _decode_record_hex() |
| 711 | method for implementing this specifically for the given file. This function checks which |
| 712 | of the method exists, add calls them (with conversion, as needed). |
| 713 | |
| 714 | Args: |
| 715 | raw_hex_data : hex-encoded data |
| 716 | Returns: |
| 717 | abstract_data; dict representing the decoded data |
| 718 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 719 | method = getattr(self, '_decode_record_hex', None) |
| 720 | if callable(method): |
| 721 | return method(raw_hex_data) |
| 722 | method = getattr(self, '_decode_record_bin', None) |
| 723 | if callable(method): |
| 724 | raw_bin_data = h2b(raw_hex_data) |
| 725 | return method(raw_bin_data) |
| 726 | return {'raw': raw_hex_data} |
| 727 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 728 | def decode_record_bin(self, raw_bin_data:bytearray) -> dict: |
| 729 | """Decode raw (binary) data into abstract representation. |
| 730 | |
| 731 | A derived class would typically provide a _decode_record_bin() or _decode_record_hex() |
| 732 | method for implementing this specifically for the given file. This function checks which |
| 733 | of the method exists, add calls them (with conversion, as needed). |
| 734 | |
| 735 | Args: |
| 736 | raw_bin_data : binary encoded data |
| 737 | Returns: |
| 738 | abstract_data; dict representing the decoded data |
| 739 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 740 | method = getattr(self, '_decode_record_bin', None) |
| 741 | if callable(method): |
| 742 | return method(raw_bin_data) |
| 743 | raw_hex_data = b2h(raw_bin_data) |
| 744 | method = getattr(self, '_decode_record_hex', None) |
| 745 | if callable(method): |
| 746 | return method(raw_hex_data) |
| 747 | return {'raw': raw_hex_data} |
| 748 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 749 | def encode_record_hex(self, abstract_data:dict) -> str: |
| 750 | """Encode abstract representation into raw (hex string) data. |
| 751 | |
| 752 | A derived class would typically provide an _encode_record_bin() or _encode_record_hex() |
| 753 | method for implementing this specifically for the given file. This function checks which |
| 754 | of the method exists, add calls them (with conversion, as needed). |
| 755 | |
| 756 | Args: |
| 757 | abstract_data : dict representing the decoded data |
| 758 | Returns: |
| 759 | hex string encoded data |
| 760 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 761 | method = getattr(self, '_encode_record_hex', None) |
| 762 | if callable(method): |
| 763 | return method(abstract_data) |
| 764 | method = getattr(self, '_encode_record_bin', None) |
| 765 | if callable(method): |
Harald Welte | 1e45657 | 2021-04-02 17:16:30 +0200 | [diff] [blame] | 766 | return b2h(method(abstract_data)) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 767 | raise NotImplementedError |
| 768 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 769 | def encode_record_bin(self, abstract_data:dict) -> bytearray: |
| 770 | """Encode abstract representation into raw (binary) data. |
| 771 | |
| 772 | A derived class would typically provide an _encode_record_bin() or _encode_record_hex() |
| 773 | method for implementing this specifically for the given file. This function checks which |
| 774 | of the method exists, add calls them (with conversion, as needed). |
| 775 | |
| 776 | Args: |
| 777 | abstract_data : dict representing the decoded data |
| 778 | Returns: |
| 779 | binary encoded data |
| 780 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 781 | method = getattr(self, '_encode_record_bin', None) |
| 782 | if callable(method): |
| 783 | return method(abstract_data) |
| 784 | method = getattr(self, '_encode_record_hex', None) |
| 785 | if callable(method): |
| 786 | return h2b(method(abstract_data)) |
| 787 | raise NotImplementedError |
| 788 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 789 | def _decode_bin(self, raw_bin_data:bytearray): |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 790 | chunks = [raw_bin_data[i:i+self.rec_len] for i in range(0, len(raw_bin_data), self.rec_len)] |
| 791 | return [self.decode_record_bin(x) for x in chunks] |
| 792 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 793 | def _encode_bin(self, abstract_data) -> bytes: |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 794 | chunks = [self.encode_record_bin(x) for x in abstract_data] |
| 795 | # FIXME: pad to file size |
| 796 | return b''.join(chunks) |
| 797 | |
| 798 | |
| 799 | |
| 800 | |
| 801 | |
| 802 | class RuntimeState(object): |
| 803 | """Represent the runtime state of a session with a card.""" |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 804 | def __init__(self, card, profile:'CardProfile'): |
| 805 | """ |
| 806 | Args: |
| 807 | card : pysim.cards.Card instance |
| 808 | profile : CardProfile instance |
| 809 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 810 | self.mf = CardMF() |
| 811 | self.card = card |
Harald Welte | 5ce3524 | 2021-04-02 20:27:05 +0200 | [diff] [blame] | 812 | self.selected_file:CardDF = self.mf |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 813 | self.profile = profile |
Harald Welte | 5ce3524 | 2021-04-02 20:27:05 +0200 | [diff] [blame] | 814 | # add application ADFs + MF-files from profile |
Philipp Maier | 1e896f3 | 2021-03-10 17:02:53 +0100 | [diff] [blame] | 815 | apps = self._match_applications() |
| 816 | for a in apps: |
Harald Welte | 5ce3524 | 2021-04-02 20:27:05 +0200 | [diff] [blame] | 817 | if a.adf: |
| 818 | self.mf.add_application_df(a.adf) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 819 | for f in self.profile.files_in_mf: |
| 820 | self.mf.add_file(f) |
Philipp Maier | 38c74f6 | 2021-03-17 17:19:52 +0100 | [diff] [blame] | 821 | self.conserve_write = True |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 822 | |
Philipp Maier | 1e896f3 | 2021-03-10 17:02:53 +0100 | [diff] [blame] | 823 | def _match_applications(self): |
| 824 | """match the applications from the profile with applications on the card""" |
| 825 | apps_profile = self.profile.applications |
| 826 | aids_card = self.card.read_aids() |
| 827 | apps_taken = [] |
| 828 | if aids_card: |
| 829 | aids_taken = [] |
| 830 | print("AIDs on card:") |
| 831 | for a in aids_card: |
| 832 | for f in apps_profile: |
| 833 | if f.aid in a: |
| 834 | print(" %s: %s" % (f.name, a)) |
| 835 | aids_taken.append(a) |
| 836 | apps_taken.append(f) |
| 837 | aids_unknown = set(aids_card) - set(aids_taken) |
| 838 | for a in aids_unknown: |
| 839 | print(" unknown: %s" % a) |
| 840 | else: |
| 841 | print("error: could not determine card applications") |
| 842 | return apps_taken |
| 843 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 844 | def get_cwd(self) -> CardDF: |
| 845 | """Obtain the current working directory. |
| 846 | |
| 847 | Returns: |
| 848 | CardDF instance |
| 849 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 850 | if isinstance(self.selected_file, CardDF): |
| 851 | return self.selected_file |
| 852 | else: |
| 853 | return self.selected_file.parent |
| 854 | |
Harald Welte | 5ce3524 | 2021-04-02 20:27:05 +0200 | [diff] [blame] | 855 | def get_application_df(self) -> Optional[CardADF]: |
| 856 | """Obtain the currently selected application DF (if any). |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 857 | |
| 858 | Returns: |
| 859 | CardADF() instance or None""" |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 860 | # iterate upwards from selected file; check if any is an ADF |
| 861 | node = self.selected_file |
| 862 | while node.parent != node: |
| 863 | if isinstance(node, CardADF): |
| 864 | return node |
| 865 | node = node.parent |
| 866 | return None |
| 867 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 868 | def interpret_sw(self, sw:str): |
| 869 | """Interpret a given status word relative to the currently selected application |
| 870 | or the underlying card profile. |
| 871 | |
| 872 | Args: |
| 873 | sw : Status word as string of 4 hexd digits |
| 874 | |
| 875 | Returns: |
| 876 | Tuple of two strings |
| 877 | """ |
Harald Welte | 86fbd39 | 2021-04-02 22:13:09 +0200 | [diff] [blame] | 878 | res = None |
Harald Welte | 5ce3524 | 2021-04-02 20:27:05 +0200 | [diff] [blame] | 879 | adf = self.get_application_df() |
| 880 | if adf: |
| 881 | app = adf.application |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 882 | # The application either comes with its own interpret_sw |
| 883 | # method or we will use the interpret_sw method from the |
| 884 | # card profile. |
Harald Welte | 5ce3524 | 2021-04-02 20:27:05 +0200 | [diff] [blame] | 885 | if app and hasattr(app, "interpret_sw"): |
Harald Welte | 86fbd39 | 2021-04-02 22:13:09 +0200 | [diff] [blame] | 886 | res = app.interpret_sw(sw) |
| 887 | return res or self.profile.interpret_sw(sw) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 888 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 889 | def probe_file(self, fid:str, cmd_app=None): |
| 890 | """Blindly try to select a file and automatically add a matching file |
| 891 | object if the file actually exists.""" |
Philipp Maier | 63f572d | 2021-03-09 22:42:47 +0100 | [diff] [blame] | 892 | if not is_hex(fid, 4, 4): |
| 893 | raise ValueError("Cannot select unknown file by name %s, only hexadecimal 4 digit FID is allowed" % fid) |
| 894 | |
| 895 | try: |
| 896 | (data, sw) = self.card._scc.select_file(fid) |
| 897 | except SwMatchError as swm: |
| 898 | k = self.interpret_sw(swm.sw_actual) |
| 899 | if not k: |
| 900 | raise(swm) |
| 901 | raise RuntimeError("%s: %s - %s" % (swm.sw_actual, k[0], k[1])) |
| 902 | |
| 903 | select_resp = self.selected_file.decode_select_response(data) |
| 904 | if (select_resp['file_descriptor']['file_type'] == 'df'): |
| 905 | f = CardDF(fid=fid, sfid=None, name="DF." + str(fid).upper(), desc="dedicated file, manually added at runtime") |
| 906 | else: |
| 907 | if (select_resp['file_descriptor']['structure'] == 'transparent'): |
| 908 | f = TransparentEF(fid=fid, sfid=None, name="EF." + str(fid).upper(), desc="elementry file, manually added at runtime") |
| 909 | else: |
| 910 | f = LinFixedEF(fid=fid, sfid=None, name="EF." + str(fid).upper(), desc="elementry file, manually added at runtime") |
| 911 | |
| 912 | self.selected_file.add_files([f]) |
| 913 | self.selected_file = f |
| 914 | return select_resp |
| 915 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 916 | def select(self, name:str, cmd_app=None): |
| 917 | """Select a file (EF, DF, ADF, MF, ...). |
| 918 | |
| 919 | Args: |
| 920 | name : Name of file to select |
| 921 | cmd_app : Command Application State (for unregistering old file commands) |
| 922 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 923 | sels = self.selected_file.get_selectables() |
Philipp Maier | 7744b6e | 2021-03-11 14:29:37 +0100 | [diff] [blame] | 924 | if is_hex(name): |
| 925 | name = name.lower() |
Philipp Maier | 63f572d | 2021-03-09 22:42:47 +0100 | [diff] [blame] | 926 | |
| 927 | # unregister commands of old file |
| 928 | if cmd_app and self.selected_file.shell_commands: |
| 929 | for c in self.selected_file.shell_commands: |
| 930 | cmd_app.unregister_command_set(c) |
| 931 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 932 | if name in sels: |
| 933 | f = sels[name] |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 934 | try: |
| 935 | if isinstance(f, CardADF): |
Philipp Maier | cba6dbc | 2021-03-11 13:03:18 +0100 | [diff] [blame] | 936 | (data, sw) = self.card.select_adf_by_aid(f.aid) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 937 | else: |
| 938 | (data, sw) = self.card._scc.select_file(f.fid) |
| 939 | self.selected_file = f |
| 940 | except SwMatchError as swm: |
| 941 | k = self.interpret_sw(swm.sw_actual) |
| 942 | if not k: |
| 943 | raise(swm) |
| 944 | raise RuntimeError("%s: %s - %s" % (swm.sw_actual, k[0], k[1])) |
Philipp Maier | 63f572d | 2021-03-09 22:42:47 +0100 | [diff] [blame] | 945 | select_resp = f.decode_select_response(data) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 946 | else: |
Philipp Maier | 63f572d | 2021-03-09 22:42:47 +0100 | [diff] [blame] | 947 | select_resp = self.probe_file(name, cmd_app) |
| 948 | |
| 949 | # register commands of new file |
| 950 | if cmd_app and self.selected_file.shell_commands: |
| 951 | for c in self.selected_file.shell_commands: |
| 952 | cmd_app.register_command_set(c) |
| 953 | |
| 954 | return select_resp |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 955 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 956 | def read_binary(self, length:int=None, offset:int=0): |
| 957 | """Read [part of] a transparent EF binary data. |
| 958 | |
| 959 | Args: |
| 960 | length : Amount of data to read (None: as much as possible) |
| 961 | offset : Offset into the file from which to read 'length' bytes |
| 962 | Returns: |
| 963 | binary data read from the file |
| 964 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 965 | if not isinstance(self.selected_file, TransparentEF): |
| 966 | raise TypeError("Only works with TransparentEF") |
| 967 | return self.card._scc.read_binary(self.selected_file.fid, length, offset) |
| 968 | |
Harald Welte | 2d4a64b | 2021-04-03 09:01:24 +0200 | [diff] [blame] | 969 | def read_binary_dec(self) -> Tuple[dict, str]: |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 970 | """Read [part of] a transparent EF binary data and decode it. |
| 971 | |
| 972 | Args: |
| 973 | length : Amount of data to read (None: as much as possible) |
| 974 | offset : Offset into the file from which to read 'length' bytes |
| 975 | Returns: |
| 976 | abstract decode data read from the file |
| 977 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 978 | (data, sw) = self.read_binary() |
| 979 | dec_data = self.selected_file.decode_hex(data) |
| 980 | print("%s: %s -> %s" % (sw, data, dec_data)) |
| 981 | return (dec_data, sw) |
| 982 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 983 | def update_binary(self, data_hex:str, offset:int=0): |
| 984 | """Update transparent EF binary data. |
| 985 | |
| 986 | Args: |
| 987 | data_hex : hex string of data to be written |
| 988 | offset : Offset into the file from which to write 'data_hex' |
| 989 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 990 | if not isinstance(self.selected_file, TransparentEF): |
| 991 | raise TypeError("Only works with TransparentEF") |
Philipp Maier | 38c74f6 | 2021-03-17 17:19:52 +0100 | [diff] [blame] | 992 | return self.card._scc.update_binary(self.selected_file.fid, data_hex, offset, conserve=self.conserve_write) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 993 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 994 | def update_binary_dec(self, data:dict): |
| 995 | """Update transparent EF from abstract data. Encodes the data to binary and |
| 996 | then updates the EF with it. |
| 997 | |
| 998 | Args: |
| 999 | data : abstract data which is to be encoded and written |
| 1000 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1001 | data_hex = self.selected_file.encode_hex(data) |
| 1002 | print("%s -> %s" % (data, data_hex)) |
| 1003 | return self.update_binary(data_hex) |
| 1004 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 1005 | def read_record(self, rec_nr:int=0): |
| 1006 | """Read a record as binary data. |
| 1007 | |
| 1008 | Args: |
| 1009 | rec_nr : Record number to read |
| 1010 | Returns: |
| 1011 | hex string of binary data contained in record |
| 1012 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1013 | if not isinstance(self.selected_file, LinFixedEF): |
| 1014 | raise TypeError("Only works with Linear Fixed EF") |
| 1015 | # returns a string of hex nibbles |
| 1016 | return self.card._scc.read_record(self.selected_file.fid, rec_nr) |
| 1017 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 1018 | def read_record_dec(self, rec_nr:int=0) -> Tuple[dict, str]: |
| 1019 | """Read a record and decode it to abstract data. |
| 1020 | |
| 1021 | Args: |
| 1022 | rec_nr : Record number to read |
| 1023 | Returns: |
| 1024 | abstract data contained in record |
| 1025 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1026 | (data, sw) = self.read_record(rec_nr) |
| 1027 | return (self.selected_file.decode_record_hex(data), sw) |
| 1028 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 1029 | def update_record(self, rec_nr:int, data_hex:str): |
| 1030 | """Update a record with given binary data |
| 1031 | |
| 1032 | Args: |
| 1033 | rec_nr : Record number to read |
| 1034 | data_hex : Hex string binary data to be written |
| 1035 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1036 | if not isinstance(self.selected_file, LinFixedEF): |
| 1037 | raise TypeError("Only works with Linear Fixed EF") |
Philipp Maier | 38c74f6 | 2021-03-17 17:19:52 +0100 | [diff] [blame] | 1038 | return self.card._scc.update_record(self.selected_file.fid, rec_nr, data_hex, conserve=self.conserve_write) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1039 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 1040 | def update_record_dec(self, rec_nr:int, data:dict): |
| 1041 | """Update a record with given abstract data. Will encode abstract to binary data |
| 1042 | and then write it to the given record on the card. |
| 1043 | |
| 1044 | Args: |
| 1045 | rec_nr : Record number to read |
| 1046 | data_hex : Abstract data to be written |
| 1047 | """ |
Harald Welte | 1e45657 | 2021-04-02 17:16:30 +0200 | [diff] [blame] | 1048 | data_hex = self.selected_file.encode_record_hex(data) |
| 1049 | return self.update_record(rec_nr, data_hex) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1050 | |
| 1051 | |
| 1052 | |
| 1053 | class FileData(object): |
| 1054 | """Represent the runtime, on-card data.""" |
| 1055 | def __init__(self, fdesc): |
| 1056 | self.desc = fdesc |
| 1057 | self.fcp = None |
| 1058 | |
| 1059 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 1060 | def interpret_sw(sw_data:dict, sw:str): |
| 1061 | """Interpret a given status word. |
| 1062 | |
| 1063 | Args: |
| 1064 | sw_data : Hierarchical dict of status word matches |
| 1065 | sw : status word to match (string of 4 hex digits) |
| 1066 | Returns: |
| 1067 | tuple of two strings (class_string, description) |
| 1068 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1069 | for class_str, swdict in sw_data.items(): |
| 1070 | # first try direct match |
| 1071 | if sw in swdict: |
| 1072 | return (class_str, swdict[sw]) |
| 1073 | # next try wildcard matches |
| 1074 | for pattern, descr in swdict.items(): |
| 1075 | if sw_match(sw, pattern): |
| 1076 | return (class_str, descr) |
| 1077 | return None |
| 1078 | |
| 1079 | class CardApplication(object): |
| 1080 | """A card application is represented by an ADF (with contained hierarchy) and optionally |
| 1081 | some SW definitions.""" |
Harald Welte | 5ce3524 | 2021-04-02 20:27:05 +0200 | [diff] [blame] | 1082 | def __init__(self, name, adf:Optional[CardADF]=None, aid:str=None, sw:dict=None): |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 1083 | """ |
| 1084 | Args: |
| 1085 | adf : ADF name |
| 1086 | sw : Dict of status word conversions |
| 1087 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1088 | self.name = name |
| 1089 | self.adf = adf |
Vadim Yanitskiy | 98f872b | 2021-03-27 01:25:46 +0100 | [diff] [blame] | 1090 | self.sw = sw or dict() |
Harald Welte | 5ce3524 | 2021-04-02 20:27:05 +0200 | [diff] [blame] | 1091 | # back-reference from ADF to Applicaiton |
| 1092 | if self.adf: |
| 1093 | self.aid = aid or self.adf.aid |
| 1094 | self.adf.application = self |
| 1095 | else: |
| 1096 | self.aid = aid |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1097 | |
| 1098 | def __str__(self): |
| 1099 | return "APP(%s)" % (self.name) |
| 1100 | |
| 1101 | def interpret_sw(self, sw): |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 1102 | """Interpret a given status word within the application. |
| 1103 | |
| 1104 | Args: |
| 1105 | sw : Status word as string of 4 hexd digits |
| 1106 | |
| 1107 | Returns: |
| 1108 | Tuple of two strings |
| 1109 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1110 | return interpret_sw(self.sw, sw) |
| 1111 | |
| 1112 | class CardProfile(object): |
| 1113 | """A Card Profile describes a card, it's filessystem hierarchy, an [initial] list of |
| 1114 | applications as well as profile-specific SW and shell commands. Every card has |
| 1115 | one card profile, but there may be multiple applications within that profile.""" |
Vadim Yanitskiy | 98f872b | 2021-03-27 01:25:46 +0100 | [diff] [blame] | 1116 | def __init__(self, name, **kw): |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 1117 | """ |
| 1118 | Args: |
| 1119 | desc (str) : Description |
| 1120 | files_in_mf : List of CardEF instances present in MF |
| 1121 | applications : List of CardApplications present on card |
| 1122 | sw : List of status word definitions |
| 1123 | shell_cmdsets : List of cmd2 shell command sets of profile-specific commands |
| 1124 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1125 | self.name = name |
Vadim Yanitskiy | 98f872b | 2021-03-27 01:25:46 +0100 | [diff] [blame] | 1126 | self.desc = kw.get("desc", None) |
| 1127 | self.files_in_mf = kw.get("files_in_mf", []) |
| 1128 | self.sw = kw.get("sw", []) |
| 1129 | self.applications = kw.get("applications", []) |
| 1130 | self.shell_cmdsets = kw.get("shell_cmdsets", []) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1131 | |
| 1132 | def __str__(self): |
| 1133 | return self.name |
| 1134 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 1135 | def add_application(self, app:CardApplication): |
| 1136 | """Add an application to a card profile. |
| 1137 | |
| 1138 | Args: |
| 1139 | app : CardApplication instance to be added to profile |
| 1140 | """ |
Philipp Maier | eb72fa4 | 2021-03-26 21:29:57 +0100 | [diff] [blame] | 1141 | self.applications.append(app) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1142 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 1143 | def interpret_sw(self, sw:str): |
| 1144 | """Interpret a given status word within the profile. |
| 1145 | |
| 1146 | Args: |
| 1147 | sw : Status word as string of 4 hexd digits |
| 1148 | |
| 1149 | Returns: |
| 1150 | Tuple of two strings |
| 1151 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1152 | return interpret_sw(self.sw, sw) |