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 |
Harald Welte | 4145d3c | 2021-04-08 20:34:13 +0200 | [diff] [blame] | 28 | import tempfile |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 29 | import json |
Harald Welte | f44256c | 2021-10-14 15:53:39 +0200 | [diff] [blame] | 30 | import abc |
| 31 | import inspect |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 32 | |
| 33 | import cmd2 |
| 34 | from cmd2 import CommandSet, with_default_category, with_argparser |
| 35 | import argparse |
| 36 | |
Harald Welte | 9170fbf | 2022-02-11 21:54:37 +0100 | [diff] [blame] | 37 | from typing import cast, Optional, Iterable, List, Dict, Tuple, Union |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 38 | |
Harald Welte | f44256c | 2021-10-14 15:53:39 +0200 | [diff] [blame] | 39 | from smartcard.util import toBytes |
| 40 | |
Harald Welte | daf2b39 | 2021-05-03 23:17:29 +0200 | [diff] [blame] | 41 | from pySim.utils import sw_match, h2b, b2h, i2h, is_hex, auto_int, bertlv_parse_one, Hexstr |
Harald Welte | a5eb924 | 2023-12-23 10:20:20 +0100 | [diff] [blame] | 42 | from pySim.construct import filter_dict, parse_construct, build_construct |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 43 | from pySim.exceptions import * |
Harald Welte | 0d4e98a | 2021-04-07 00:14:40 +0200 | [diff] [blame] | 44 | from pySim.jsonpath import js_path_find, js_path_modify |
Harald Welte | f44256c | 2021-10-14 15:53:39 +0200 | [diff] [blame] | 45 | from pySim.commands import SimCardCommands |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 46 | |
Harald Welte | 9170fbf | 2022-02-11 21:54:37 +0100 | [diff] [blame] | 47 | # int: a single service is associated with this file |
| 48 | # list: any of the listed services requires this file |
| 49 | # tuple: logical-and of the listed services requires this file |
| 50 | CardFileService = Union[int, List[int], Tuple[int, ...]] |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 51 | |
Harald Welte | 13edf30 | 2022-07-21 15:19:23 +0200 | [diff] [blame] | 52 | Size = Tuple[int, Optional[int]] |
| 53 | |
Vadim Yanitskiy | 04b5d9d | 2022-07-07 03:05:30 +0700 | [diff] [blame] | 54 | class CardFile: |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 55 | """Base class for all objects in the smart card filesystem. |
| 56 | Serve as a common ancestor to all other file types; rarely used directly. |
| 57 | """ |
| 58 | RESERVED_NAMES = ['..', '.', '/', 'MF'] |
| 59 | RESERVED_FIDS = ['3f00'] |
| 60 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 61 | def __init__(self, fid: str = None, sfid: str = None, name: str = None, desc: str = None, |
Harald Welte | 9170fbf | 2022-02-11 21:54:37 +0100 | [diff] [blame] | 62 | parent: Optional['CardDF'] = None, profile: Optional['CardProfile'] = None, |
| 63 | service: Optional[CardFileService] = None): |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 64 | """ |
| 65 | Args: |
| 66 | fid : File Identifier (4 hex digits) |
| 67 | sfid : Short File Identifier (2 hex digits, optional) |
| 68 | name : Brief name of the file, lik EF_ICCID |
Harald Welte | c9cdce3 | 2021-04-11 10:28:28 +0200 | [diff] [blame] | 69 | desc : Description of the file |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 70 | parent : Parent CardFile object within filesystem hierarchy |
Philipp Maier | 5af7bdf | 2021-11-04 12:48:41 +0100 | [diff] [blame] | 71 | profile : Card profile that this file should be part of |
Harald Welte | 9170fbf | 2022-02-11 21:54:37 +0100 | [diff] [blame] | 72 | service : Service (SST/UST/IST) associated with the file |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 73 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 74 | if not isinstance(self, CardADF) and fid == None: |
| 75 | raise ValueError("fid is mandatory") |
| 76 | if fid: |
| 77 | fid = fid.lower() |
| 78 | self.fid = fid # file identifier |
| 79 | self.sfid = sfid # short file identifier |
| 80 | self.name = name # human readable name |
| 81 | self.desc = desc # human readable description |
| 82 | self.parent = parent |
| 83 | if self.parent and self.parent != self and self.fid: |
| 84 | self.parent.add_file(self) |
Philipp Maier | 5af7bdf | 2021-11-04 12:48:41 +0100 | [diff] [blame] | 85 | self.profile = profile |
Harald Welte | 9170fbf | 2022-02-11 21:54:37 +0100 | [diff] [blame] | 86 | self.service = service |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 87 | self.shell_commands = [] # type: List[CommandSet] |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 88 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 89 | # Note: the basic properties (fid, name, ect.) are verified when |
| 90 | # the file is attached to a parent file. See method add_file() in |
| 91 | # class Card DF |
Philipp Maier | 6606158 | 2021-03-09 21:57:57 +0100 | [diff] [blame] | 92 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 93 | def __str__(self): |
| 94 | if self.name: |
| 95 | return self.name |
| 96 | else: |
| 97 | return self.fid |
| 98 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 99 | def _path_element(self, prefer_name: bool) -> Optional[str]: |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 100 | if prefer_name and self.name: |
| 101 | return self.name |
| 102 | else: |
| 103 | return self.fid |
| 104 | |
Harald Welte | b2e4b4a | 2022-07-19 23:48:45 +0200 | [diff] [blame] | 105 | def fully_qualified_path_str(self, prefer_name: bool = True) -> str: |
| 106 | """Return fully qualified path to file as string. |
| 107 | |
| 108 | Args: |
| 109 | prefer_name : Preferably build path of names; fall-back to FIDs as required |
| 110 | """ |
| 111 | return '/'.join(self.fully_qualified_path(prefer_name)) |
| 112 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 113 | def fully_qualified_path(self, prefer_name: bool = True) -> List[str]: |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 114 | """Return fully qualified path to file as list of FID or name strings. |
| 115 | |
| 116 | Args: |
| 117 | prefer_name : Preferably build path of names; fall-back to FIDs as required |
| 118 | """ |
Harald Welte | 1e45657 | 2021-04-02 17:16:30 +0200 | [diff] [blame] | 119 | if self.parent and self.parent != self: |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 120 | ret = self.parent.fully_qualified_path(prefer_name) |
| 121 | else: |
| 122 | ret = [] |
Harald Welte | 1e45657 | 2021-04-02 17:16:30 +0200 | [diff] [blame] | 123 | elem = self._path_element(prefer_name) |
| 124 | if elem: |
| 125 | ret.append(elem) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 126 | return ret |
| 127 | |
Harald Welte | aceb2a5 | 2022-02-12 21:41:59 +0100 | [diff] [blame] | 128 | def fully_qualified_path_fobj(self) -> List['CardFile']: |
| 129 | """Return fully qualified path to file as list of CardFile instance references.""" |
| 130 | if self.parent and self.parent != self: |
| 131 | ret = self.parent.fully_qualified_path_fobj() |
| 132 | else: |
| 133 | ret = [] |
| 134 | if self: |
| 135 | ret.append(self) |
| 136 | return ret |
| 137 | |
| 138 | def build_select_path_to(self, target: 'CardFile') -> Optional[List['CardFile']]: |
Philipp Maier | 14bf003 | 2023-12-13 12:12:32 +0100 | [diff] [blame] | 139 | |
| 140 | # special-case handling for applications. Applications may be selected |
| 141 | # any time from any location. If there is an ADF somewhere in the path, |
| 142 | # we may clip everything before that ADF. |
| 143 | def clip_path(inter_path): |
| 144 | for i in reversed(range(0, len(inter_path))): |
| 145 | if isinstance(inter_path[i], CardADF): |
| 146 | return inter_path[i:] |
| 147 | return inter_path |
| 148 | |
Harald Welte | aceb2a5 | 2022-02-12 21:41:59 +0100 | [diff] [blame] | 149 | """Build the relative sequence of files we need to traverse to get from us to 'target'.""" |
Philipp Maier | a5707c7 | 2023-12-13 12:07:24 +0100 | [diff] [blame] | 150 | # special-case handling for selecting MF while the MF is selected |
Harald Welte | 02a7f74 | 2023-07-11 09:21:52 +0200 | [diff] [blame] | 151 | if target == target.get_mf(): |
| 152 | return [target] |
Harald Welte | aceb2a5 | 2022-02-12 21:41:59 +0100 | [diff] [blame] | 153 | cur_fqpath = self.fully_qualified_path_fobj() |
| 154 | target_fqpath = target.fully_qualified_path_fobj() |
| 155 | inter_path = [] |
Harald Welte | aceb2a5 | 2022-02-12 21:41:59 +0100 | [diff] [blame] | 156 | cur_fqpath.reverse() |
| 157 | for ce in cur_fqpath: |
| 158 | inter_path.append(ce) |
| 159 | for i in range(0, len(target_fqpath)-1): |
| 160 | te = target_fqpath[i] |
| 161 | if te == ce: |
| 162 | for te2 in target_fqpath[i+1:]: |
| 163 | inter_path.append(te2) |
| 164 | # we found our common ancestor |
Philipp Maier | 14bf003 | 2023-12-13 12:12:32 +0100 | [diff] [blame] | 165 | return clip_path(inter_path[1:]) |
Harald Welte | aceb2a5 | 2022-02-12 21:41:59 +0100 | [diff] [blame] | 166 | return None |
| 167 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 168 | def get_mf(self) -> Optional['CardMF']: |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 169 | """Return the MF (root) of the file system.""" |
| 170 | if self.parent == None: |
| 171 | return None |
| 172 | # iterate towards the top. MF has parent == self |
| 173 | node = self |
Harald Welte | 1e45657 | 2021-04-02 17:16:30 +0200 | [diff] [blame] | 174 | while node.parent and node.parent != node: |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 175 | node = node.parent |
Harald Welte | 1e45657 | 2021-04-02 17:16:30 +0200 | [diff] [blame] | 176 | return cast(CardMF, node) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 177 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 178 | def _get_self_selectables(self, alias: str = None, flags=[]) -> Dict[str, 'CardFile']: |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 179 | """Return a dict of {'identifier': self} tuples. |
| 180 | |
| 181 | Args: |
| 182 | alias : Add an alias with given name to 'self' |
| 183 | flags : Specify which selectables to return 'FIDS' and/or 'NAMES'; |
| 184 | If not specified, all selectables will be returned. |
| 185 | Returns: |
| 186 | dict containing reference to 'self' for all identifiers. |
| 187 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 188 | sels = {} |
| 189 | if alias: |
| 190 | sels.update({alias: self}) |
Philipp Maier | 786f781 | 2021-02-25 16:48:10 +0100 | [diff] [blame] | 191 | if self.fid and (flags == [] or 'FIDS' in flags): |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 192 | sels.update({self.fid: self}) |
Philipp Maier | bd8ed2c | 2021-03-18 17:09:33 +0100 | [diff] [blame] | 193 | if self.name and (flags == [] or 'FNAMES' in flags): |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 194 | sels.update({self.name: self}) |
| 195 | return sels |
| 196 | |
Harald Welte | f5ff1b8 | 2022-07-24 12:19:57 +0200 | [diff] [blame] | 197 | def _get_parent_selectables(self, alias: Optional[str] = None, flags=[]) -> Dict[str, 'CardFile']: |
| 198 | sels = {} |
| 199 | if not self.parent or self.parent == self: |
| 200 | return sels |
| 201 | # add our immediate parent |
| 202 | if alias: |
| 203 | sels.update({alias: self.parent}) |
| 204 | if self.parent.fid and (flags == [] or 'FIDS' in flags): |
| 205 | sels.update({self.parent.fid: self.parent}) |
| 206 | if self.parent.name and (flags == [] or 'FNAMES' in flags): |
| 207 | sels.update({self.parent.name: self.parent}) |
| 208 | # recurse to parents of our parent, but without any alias |
| 209 | sels.update(self.parent._get_parent_selectables(None, flags)) |
| 210 | return sels |
| 211 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 212 | def get_selectables(self, flags=[]) -> Dict[str, 'CardFile']: |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 213 | """Return a dict of {'identifier': File} that is selectable from the current file. |
| 214 | |
| 215 | Args: |
| 216 | flags : Specify which selectables to return 'FIDS' and/or 'NAMES'; |
| 217 | If not specified, all selectables will be returned. |
| 218 | Returns: |
| 219 | dict containing all selectable items. Key is identifier (string), value |
| 220 | a reference to a CardFile (or derived class) instance. |
| 221 | """ |
Philipp Maier | 786f781 | 2021-02-25 16:48:10 +0100 | [diff] [blame] | 222 | sels = {} |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 223 | # we can always select ourself |
Philipp Maier | 786f781 | 2021-02-25 16:48:10 +0100 | [diff] [blame] | 224 | if flags == [] or 'SELF' in flags: |
| 225 | sels = self._get_self_selectables('.', flags) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 226 | # we can always select our parent |
Philipp Maier | 786f781 | 2021-02-25 16:48:10 +0100 | [diff] [blame] | 227 | if flags == [] or 'PARENT' in flags: |
Harald Welte | f5ff1b8 | 2022-07-24 12:19:57 +0200 | [diff] [blame] | 228 | sels.update(self._get_parent_selectables('..', flags)) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 229 | # if we have a MF, we can always select its applications |
Philipp Maier | 786f781 | 2021-02-25 16:48:10 +0100 | [diff] [blame] | 230 | if flags == [] or 'MF' in flags: |
| 231 | mf = self.get_mf() |
| 232 | if mf: |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 233 | sels.update(mf._get_self_selectables(flags=flags)) |
| 234 | sels.update(mf.get_app_selectables(flags=flags)) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 235 | return sels |
| 236 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 237 | def get_selectable_names(self, flags=[]) -> List[str]: |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 238 | """Return a dict of {'identifier': File} that is selectable from the current file. |
| 239 | |
| 240 | Args: |
| 241 | flags : Specify which selectables to return 'FIDS' and/or 'NAMES'; |
| 242 | If not specified, all selectables will be returned. |
| 243 | Returns: |
Harald Welte | 1e45657 | 2021-04-02 17:16:30 +0200 | [diff] [blame] | 244 | list containing all selectable names. |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 245 | """ |
Philipp Maier | 786f781 | 2021-02-25 16:48:10 +0100 | [diff] [blame] | 246 | sels = self.get_selectables(flags) |
Harald Welte | b3d68c0 | 2022-01-21 15:31:29 +0100 | [diff] [blame] | 247 | sel_keys = list(sels.keys()) |
| 248 | sel_keys.sort() |
| 249 | return sel_keys |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 250 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 251 | def decode_select_response(self, data_hex: str): |
Philipp Maier | 5af7bdf | 2021-11-04 12:48:41 +0100 | [diff] [blame] | 252 | """Decode the response to a SELECT command. |
| 253 | |
| 254 | Args: |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 255 | data_hex: Hex string of the select response |
| 256 | """ |
Philipp Maier | 5af7bdf | 2021-11-04 12:48:41 +0100 | [diff] [blame] | 257 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 258 | # When the current file does not implement a custom select response decoder, |
| 259 | # we just ask the parent file to decode the select response. If this method |
| 260 | # is not overloaded by the current file we will again ask the parent file. |
| 261 | # This way we recursively travel up the file system tree until we hit a file |
| 262 | # that does implement a concrete decoder. |
Harald Welte | 1e45657 | 2021-04-02 17:16:30 +0200 | [diff] [blame] | 263 | if self.parent: |
| 264 | return self.parent.decode_select_response(data_hex) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 265 | |
Philipp Maier | 5af7bdf | 2021-11-04 12:48:41 +0100 | [diff] [blame] | 266 | def get_profile(self): |
| 267 | """Get the profile associated with this file. If this file does not have any |
| 268 | profile assigned, try to find a file above (usually the MF) in the filesystem |
| 269 | hirarchy that has a profile assigned |
| 270 | """ |
| 271 | |
| 272 | # If we have a profile set, return it |
| 273 | if self.profile: |
| 274 | return self.profile |
| 275 | |
| 276 | # Walk up recursively until we hit a parent that has a profile set |
| 277 | if self.parent: |
| 278 | return self.parent.get_profile() |
| 279 | return None |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 280 | |
Harald Welte | 9170fbf | 2022-02-11 21:54:37 +0100 | [diff] [blame] | 281 | def should_exist_for_services(self, services: List[int]): |
| 282 | """Assuming the provided list of activated services, should this file exist and be activated?.""" |
| 283 | if self.service is None: |
| 284 | return None |
| 285 | elif isinstance(self.service, int): |
| 286 | # a single service determines the result |
| 287 | return self.service in services |
| 288 | elif isinstance(self.service, list): |
| 289 | # any of the services active -> true |
| 290 | for s in self.service: |
| 291 | if s in services: |
| 292 | return True |
| 293 | return False |
| 294 | elif isinstance(self.service, tuple): |
| 295 | # all of the services active -> true |
| 296 | for s in self.service: |
| 297 | if not s in services: |
| 298 | return False |
| 299 | return True |
| 300 | else: |
| 301 | raise ValueError("self.service must be either int or list or tuple") |
| 302 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 303 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 304 | class CardDF(CardFile): |
| 305 | """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] | 306 | |
| 307 | @with_default_category('DF/ADF Commands') |
| 308 | class ShellCommands(CommandSet): |
| 309 | def __init__(self): |
| 310 | super().__init__() |
| 311 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 312 | def __init__(self, **kwargs): |
| 313 | if not isinstance(self, CardADF): |
| 314 | if not 'fid' in kwargs: |
| 315 | raise TypeError('fid is mandatory for all DF') |
| 316 | super().__init__(**kwargs) |
| 317 | self.children = dict() |
Philipp Maier | 63f572d | 2021-03-09 22:42:47 +0100 | [diff] [blame] | 318 | self.shell_commands = [self.ShellCommands()] |
Harald Welte | 9170fbf | 2022-02-11 21:54:37 +0100 | [diff] [blame] | 319 | # dict of CardFile affected by service(int), indexed by service |
| 320 | self.files_by_service = {} |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 321 | |
| 322 | def __str__(self): |
| 323 | return "DF(%s)" % (super().__str__()) |
| 324 | |
Harald Welte | 9170fbf | 2022-02-11 21:54:37 +0100 | [diff] [blame] | 325 | def _add_file_services(self, child): |
| 326 | """Add a child (DF/EF) to the files_by_services of the parent.""" |
| 327 | if not child.service: |
| 328 | return |
| 329 | if isinstance(child.service, int): |
| 330 | self.files_by_service.setdefault(child.service, []).append(child) |
| 331 | elif isinstance(child.service, list): |
| 332 | for service in child.service: |
| 333 | self.files_by_service.setdefault(service, []).append(child) |
| 334 | elif isinstance(child.service, tuple): |
| 335 | for service in child.service: |
| 336 | self.files_by_service.setdefault(service, []).append(child) |
| 337 | else: |
| 338 | raise ValueError |
| 339 | |
Harald Welte | d56f45d | 2022-07-16 11:46:59 +0200 | [diff] [blame] | 340 | def _has_service(self): |
| 341 | if self.service: |
| 342 | return True |
| 343 | for c in self.children.values(): |
| 344 | if isinstance(c, CardDF): |
| 345 | if c._has_service(): |
| 346 | return True |
| 347 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 348 | def add_file(self, child: CardFile, ignore_existing: bool = False): |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 349 | """Add a child (DF/EF) to this DF. |
| 350 | Args: |
| 351 | child: The new DF/EF to be added |
| 352 | ignore_existing: Ignore, if file with given FID already exists. Old one will be kept. |
| 353 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 354 | if not isinstance(child, CardFile): |
| 355 | raise TypeError("Expected a File instance") |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 356 | if not is_hex(child.fid, minlen=4, maxlen=4): |
Philipp Maier | 3aec871 | 2021-03-09 21:49:01 +0100 | [diff] [blame] | 357 | raise ValueError("File name %s is not a valid fid" % (child.fid)) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 358 | if child.name in CardFile.RESERVED_NAMES: |
| 359 | raise ValueError("File name %s is a reserved name" % (child.name)) |
| 360 | if child.fid in CardFile.RESERVED_FIDS: |
Philipp Maier | e8bc1b4 | 2021-03-09 20:33:41 +0100 | [diff] [blame] | 361 | raise ValueError("File fid %s is a reserved fid" % (child.fid)) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 362 | if child.fid in self.children: |
| 363 | if ignore_existing: |
| 364 | return |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 365 | raise ValueError( |
| 366 | "File with given fid %s already exists in %s" % (child.fid, self)) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 367 | if self.lookup_file_by_sfid(child.sfid): |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 368 | raise ValueError( |
| 369 | "File with given sfid %s already exists in %s" % (child.sfid, self)) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 370 | if self.lookup_file_by_name(child.name): |
| 371 | if ignore_existing: |
| 372 | return |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 373 | raise ValueError( |
| 374 | "File with given name %s already exists in %s" % (child.name, self)) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 375 | self.children[child.fid] = child |
| 376 | child.parent = self |
Harald Welte | 419bb49 | 2022-02-12 21:39:35 +0100 | [diff] [blame] | 377 | # update the service -> file relationship table |
Harald Welte | 9170fbf | 2022-02-11 21:54:37 +0100 | [diff] [blame] | 378 | self._add_file_services(child) |
Harald Welte | 419bb49 | 2022-02-12 21:39:35 +0100 | [diff] [blame] | 379 | if isinstance(child, CardDF): |
| 380 | for c in child.children.values(): |
| 381 | self._add_file_services(c) |
| 382 | if isinstance(c, CardDF): |
Harald Welte | d56f45d | 2022-07-16 11:46:59 +0200 | [diff] [blame] | 383 | for gc in c.children.values(): |
| 384 | if isinstance(gc, CardDF): |
| 385 | if gc._has_service(): |
| 386 | raise ValueError('TODO: implement recursive service -> file mapping') |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 387 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 388 | def add_files(self, children: Iterable[CardFile], ignore_existing: bool = False): |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 389 | """Add a list of child (DF/EF) to this DF |
| 390 | |
| 391 | Args: |
| 392 | children: List of new DF/EFs to be added |
| 393 | ignore_existing: Ignore, if file[s] with given FID already exists. Old one[s] will be kept. |
| 394 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 395 | for child in children: |
| 396 | self.add_file(child, ignore_existing) |
| 397 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 398 | def get_selectables(self, flags=[]) -> dict: |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 399 | """Return a dict of {'identifier': File} that is selectable from the current DF. |
| 400 | |
| 401 | Args: |
| 402 | flags : Specify which selectables to return 'FIDS' and/or 'NAMES'; |
| 403 | If not specified, all selectables will be returned. |
| 404 | Returns: |
| 405 | dict containing all selectable items. Key is identifier (string), value |
| 406 | a reference to a CardFile (or derived class) instance. |
| 407 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 408 | # global selectables + our children |
Philipp Maier | 786f781 | 2021-02-25 16:48:10 +0100 | [diff] [blame] | 409 | sels = super().get_selectables(flags) |
| 410 | if flags == [] or 'FIDS' in flags: |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 411 | 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] | 412 | if flags == [] or 'FNAMES' in flags: |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 413 | 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] | 414 | return sels |
| 415 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 416 | def lookup_file_by_name(self, name: Optional[str]) -> Optional[CardFile]: |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 417 | """Find a file with given name within current DF.""" |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 418 | if name == None: |
| 419 | return None |
| 420 | for i in self.children.values(): |
| 421 | if i.name and i.name == name: |
| 422 | return i |
| 423 | return None |
| 424 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 425 | def lookup_file_by_sfid(self, sfid: Optional[str]) -> Optional[CardFile]: |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 426 | """Find a file with given short file ID within current DF.""" |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 427 | if sfid == None: |
| 428 | return None |
| 429 | for i in self.children.values(): |
Harald Welte | 1e45657 | 2021-04-02 17:16:30 +0200 | [diff] [blame] | 430 | if i.sfid == int(str(sfid)): |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 431 | return i |
| 432 | return None |
| 433 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 434 | def lookup_file_by_fid(self, fid: str) -> Optional[CardFile]: |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 435 | """Find a file with given file ID within current DF.""" |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 436 | if fid in self.children: |
| 437 | return self.children[fid] |
| 438 | return None |
| 439 | |
| 440 | |
| 441 | class CardMF(CardDF): |
| 442 | """MF (Master File) in the smart card filesystem""" |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 443 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 444 | def __init__(self, **kwargs): |
| 445 | # can be overridden; use setdefault |
| 446 | kwargs.setdefault('fid', '3f00') |
| 447 | kwargs.setdefault('name', 'MF') |
| 448 | kwargs.setdefault('desc', 'Master File (directory root)') |
| 449 | # cannot be overridden; use assignment |
| 450 | kwargs['parent'] = self |
| 451 | super().__init__(**kwargs) |
| 452 | self.applications = dict() |
| 453 | |
| 454 | def __str__(self): |
| 455 | return "MF(%s)" % (self.fid) |
| 456 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 457 | def add_application_df(self, app: 'CardADF'): |
Harald Welte | 5ce3524 | 2021-04-02 20:27:05 +0200 | [diff] [blame] | 458 | """Add an Application to the MF""" |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 459 | if not isinstance(app, CardADF): |
| 460 | raise TypeError("Expected an ADF instance") |
| 461 | if app.aid in self.applications: |
| 462 | raise ValueError("AID %s already exists" % (app.aid)) |
| 463 | self.applications[app.aid] = app |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 464 | app.parent = self |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 465 | |
| 466 | def get_app_names(self): |
| 467 | """Get list of completions (AID names)""" |
Harald Welte | d53918c | 2022-02-12 18:20:49 +0100 | [diff] [blame] | 468 | return list(self.applications.values()) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 469 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 470 | def get_selectables(self, flags=[]) -> dict: |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 471 | """Return a dict of {'identifier': File} that is selectable from the current DF. |
| 472 | |
| 473 | Args: |
| 474 | flags : Specify which selectables to return 'FIDS' and/or 'NAMES'; |
| 475 | If not specified, all selectables will be returned. |
| 476 | Returns: |
| 477 | dict containing all selectable items. Key is identifier (string), value |
| 478 | a reference to a CardFile (or derived class) instance. |
| 479 | """ |
Philipp Maier | 786f781 | 2021-02-25 16:48:10 +0100 | [diff] [blame] | 480 | sels = super().get_selectables(flags) |
Philipp Maier | bd8ed2c | 2021-03-18 17:09:33 +0100 | [diff] [blame] | 481 | sels.update(self.get_app_selectables(flags)) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 482 | return sels |
| 483 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 484 | def get_app_selectables(self, flags=[]) -> dict: |
Philipp Maier | 786f781 | 2021-02-25 16:48:10 +0100 | [diff] [blame] | 485 | """Get applications by AID + name""" |
| 486 | sels = {} |
Philipp Maier | bd8ed2c | 2021-03-18 17:09:33 +0100 | [diff] [blame] | 487 | if flags == [] or 'AIDS' in flags: |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 488 | sels.update({x.aid: x for x in self.applications.values()}) |
Philipp Maier | bd8ed2c | 2021-03-18 17:09:33 +0100 | [diff] [blame] | 489 | if flags == [] or 'ANAMES' in flags: |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 490 | sels.update( |
| 491 | {x.name: x for x in self.applications.values() if x.name}) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 492 | return sels |
| 493 | |
Harald Welte | c975251 | 2022-02-11 16:31:15 +0100 | [diff] [blame] | 494 | def decode_select_response(self, data_hex: Optional[str]) -> object: |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 495 | """Decode the response to a SELECT command. |
| 496 | |
Philipp Maier | 5af7bdf | 2021-11-04 12:48:41 +0100 | [diff] [blame] | 497 | This is the fall-back method which automatically defers to the standard decoding |
| 498 | method defined by the card profile. When no profile is set, then no decoding is |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 499 | performed. Specific derived classes (usually ADF) can overload this method to |
| 500 | install specific decoding. |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 501 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 502 | |
Harald Welte | c975251 | 2022-02-11 16:31:15 +0100 | [diff] [blame] | 503 | if not data_hex: |
| 504 | return data_hex |
| 505 | |
Philipp Maier | 5af7bdf | 2021-11-04 12:48:41 +0100 | [diff] [blame] | 506 | profile = self.get_profile() |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 507 | |
Philipp Maier | 5af7bdf | 2021-11-04 12:48:41 +0100 | [diff] [blame] | 508 | if profile: |
| 509 | return profile.decode_select_response(data_hex) |
| 510 | else: |
| 511 | return data_hex |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 512 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 513 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 514 | class CardADF(CardDF): |
| 515 | """ADF (Application Dedicated File) in the smart card filesystem""" |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 516 | |
Philipp Maier | a1850ae | 2023-10-25 18:05:09 +0200 | [diff] [blame] | 517 | def __init__(self, aid: str, has_fs: bool=False, **kwargs): |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 518 | super().__init__(**kwargs) |
Harald Welte | 5ce3524 | 2021-04-02 20:27:05 +0200 | [diff] [blame] | 519 | # reference to CardApplication may be set from CardApplication constructor |
Harald Welte | fe8a744 | 2021-04-10 11:51:54 +0200 | [diff] [blame] | 520 | self.application = None # type: Optional[CardApplication] |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 521 | self.aid = aid # Application Identifier |
Philipp Maier | a1850ae | 2023-10-25 18:05:09 +0200 | [diff] [blame] | 522 | self.has_fs = has_fs # Flag to tell whether the ADF supports a filesystem or not |
Harald Welte | 1e45657 | 2021-04-02 17:16:30 +0200 | [diff] [blame] | 523 | mf = self.get_mf() |
| 524 | if mf: |
Harald Welte | 5ce3524 | 2021-04-02 20:27:05 +0200 | [diff] [blame] | 525 | mf.add_application_df(self) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 526 | |
| 527 | def __str__(self): |
Harald Welte | 4b00365 | 2022-07-16 11:55:07 +0200 | [diff] [blame] | 528 | return "ADF(%s)" % (self.name if self.name else self.aid) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 529 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 530 | def _path_element(self, prefer_name: bool): |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 531 | if self.name and prefer_name: |
| 532 | return self.name |
| 533 | else: |
| 534 | return self.aid |
| 535 | |
| 536 | |
| 537 | class CardEF(CardFile): |
| 538 | """EF (Entry File) in the smart card filesystem""" |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 539 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 540 | def __init__(self, *, fid, **kwargs): |
| 541 | kwargs['fid'] = fid |
| 542 | super().__init__(**kwargs) |
| 543 | |
| 544 | def __str__(self): |
| 545 | return "EF(%s)" % (super().__str__()) |
| 546 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 547 | def get_selectables(self, flags=[]) -> dict: |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 548 | """Return a dict of {'identifier': File} that is selectable from the current DF. |
| 549 | |
| 550 | Args: |
| 551 | flags : Specify which selectables to return 'FIDS' and/or 'NAMES'; |
| 552 | If not specified, all selectables will be returned. |
| 553 | Returns: |
| 554 | dict containing all selectable items. Key is identifier (string), value |
| 555 | a reference to a CardFile (or derived class) instance. |
| 556 | """ |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 557 | # global selectable names + those of the parent DF |
Philipp Maier | 786f781 | 2021-02-25 16:48:10 +0100 | [diff] [blame] | 558 | sels = super().get_selectables(flags) |
Harald Welte | d2c177b | 2022-07-24 11:35:53 +0200 | [diff] [blame] | 559 | if flags == [] or 'FIDS' in flags: |
| 560 | sels.update({x.fid: x for x in self.parent.children.values() if x.fid and x != self}) |
| 561 | if flags == [] or 'FNAMES' in flags: |
| 562 | sels.update({x.name: x for x in self.parent.children.values() if x.name and x != self}) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 563 | return sels |
| 564 | |
| 565 | |
| 566 | class TransparentEF(CardEF): |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 567 | """Transparent EF (Entry File) in the smart card filesystem. |
| 568 | |
| 569 | A Transparent EF is a binary file with no formal structure. This is contrary to |
| 570 | 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] | 571 | |
| 572 | @with_default_category('Transparent EF Commands') |
| 573 | class ShellCommands(CommandSet): |
Harald Welte | c9cdce3 | 2021-04-11 10:28:28 +0200 | [diff] [blame] | 574 | """Shell commands specific for transparent EFs.""" |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 575 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 576 | def __init__(self): |
| 577 | super().__init__() |
| 578 | |
Harald Welte | aefd064 | 2022-02-25 15:26:37 +0100 | [diff] [blame] | 579 | dec_hex_parser = argparse.ArgumentParser() |
| 580 | dec_hex_parser.add_argument('--oneline', action='store_true', |
| 581 | help='No JSON pretty-printing, dump as a single line') |
| 582 | dec_hex_parser.add_argument('HEXSTR', help='Hex-string of encoded data to decode') |
| 583 | |
| 584 | @cmd2.with_argparser(dec_hex_parser) |
| 585 | def do_decode_hex(self, opts): |
| 586 | """Decode command-line provided hex-string as if it was read from the file.""" |
Harald Welte | a6c0f88 | 2022-07-17 14:23:17 +0200 | [diff] [blame] | 587 | data = self._cmd.lchan.selected_file.decode_hex(opts.HEXSTR) |
Harald Welte | aefd064 | 2022-02-25 15:26:37 +0100 | [diff] [blame] | 588 | self._cmd.poutput_json(data, opts.oneline) |
| 589 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 590 | read_bin_parser = argparse.ArgumentParser() |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 591 | read_bin_parser.add_argument( |
| 592 | '--offset', type=int, default=0, help='Byte offset for start of read') |
| 593 | read_bin_parser.add_argument( |
| 594 | '--length', type=int, help='Number of bytes to read') |
| 595 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 596 | @cmd2.with_argparser(read_bin_parser) |
| 597 | def do_read_binary(self, opts): |
| 598 | """Read binary data from a transparent EF""" |
Harald Welte | a6c0f88 | 2022-07-17 14:23:17 +0200 | [diff] [blame] | 599 | (data, sw) = self._cmd.lchan.read_binary(opts.length, opts.offset) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 600 | self._cmd.poutput(data) |
| 601 | |
Harald Welte | bcad86c | 2021-04-06 20:08:39 +0200 | [diff] [blame] | 602 | read_bin_dec_parser = argparse.ArgumentParser() |
| 603 | read_bin_dec_parser.add_argument('--oneline', action='store_true', |
| 604 | help='No JSON pretty-printing, dump as a single line') |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 605 | |
Harald Welte | bcad86c | 2021-04-06 20:08:39 +0200 | [diff] [blame] | 606 | @cmd2.with_argparser(read_bin_dec_parser) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 607 | def do_read_binary_decoded(self, opts): |
| 608 | """Read + decode data from a transparent EF""" |
Harald Welte | a6c0f88 | 2022-07-17 14:23:17 +0200 | [diff] [blame] | 609 | (data, sw) = self._cmd.lchan.read_binary_dec() |
Harald Welte | 1748b93 | 2021-04-06 21:12:25 +0200 | [diff] [blame] | 610 | self._cmd.poutput_json(data, opts.oneline) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 611 | |
| 612 | upd_bin_parser = argparse.ArgumentParser() |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 613 | upd_bin_parser.add_argument( |
| 614 | '--offset', type=int, default=0, help='Byte offset for start of read') |
| 615 | upd_bin_parser.add_argument( |
| 616 | 'data', help='Data bytes (hex format) to write') |
| 617 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 618 | @cmd2.with_argparser(upd_bin_parser) |
| 619 | def do_update_binary(self, opts): |
| 620 | """Update (Write) data of a transparent EF""" |
Harald Welte | a6c0f88 | 2022-07-17 14:23:17 +0200 | [diff] [blame] | 621 | (data, sw) = self._cmd.lchan.update_binary(opts.data, opts.offset) |
Philipp Maier | e6bc4f9 | 2021-03-11 17:13:46 +0100 | [diff] [blame] | 622 | if data: |
| 623 | self._cmd.poutput(data) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 624 | |
| 625 | upd_bin_dec_parser = argparse.ArgumentParser() |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 626 | upd_bin_dec_parser.add_argument( |
| 627 | 'data', help='Abstract data (JSON format) to write') |
Harald Welte | 0d4e98a | 2021-04-07 00:14:40 +0200 | [diff] [blame] | 628 | upd_bin_dec_parser.add_argument('--json-path', type=str, |
| 629 | help='JSON path to modify specific element of file only') |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 630 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 631 | @cmd2.with_argparser(upd_bin_dec_parser) |
| 632 | def do_update_binary_decoded(self, opts): |
| 633 | """Encode + Update (Write) data of a transparent EF""" |
Harald Welte | 0d4e98a | 2021-04-07 00:14:40 +0200 | [diff] [blame] | 634 | if opts.json_path: |
Harald Welte | a6c0f88 | 2022-07-17 14:23:17 +0200 | [diff] [blame] | 635 | (data_json, sw) = self._cmd.lchan.read_binary_dec() |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 636 | js_path_modify(data_json, opts.json_path, |
| 637 | json.loads(opts.data)) |
Harald Welte | 0d4e98a | 2021-04-07 00:14:40 +0200 | [diff] [blame] | 638 | else: |
| 639 | data_json = json.loads(opts.data) |
Harald Welte | a6c0f88 | 2022-07-17 14:23:17 +0200 | [diff] [blame] | 640 | (data, sw) = self._cmd.lchan.update_binary_dec(data_json) |
Philipp Maier | e6bc4f9 | 2021-03-11 17:13:46 +0100 | [diff] [blame] | 641 | if data: |
Harald Welte | 1748b93 | 2021-04-06 21:12:25 +0200 | [diff] [blame] | 642 | self._cmd.poutput_json(data) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 643 | |
Harald Welte | 4145d3c | 2021-04-08 20:34:13 +0200 | [diff] [blame] | 644 | def do_edit_binary_decoded(self, opts): |
| 645 | """Edit the JSON representation of the EF contents in an editor.""" |
Harald Welte | a6c0f88 | 2022-07-17 14:23:17 +0200 | [diff] [blame] | 646 | (orig_json, sw) = self._cmd.lchan.read_binary_dec() |
Harald Welte | 4145d3c | 2021-04-08 20:34:13 +0200 | [diff] [blame] | 647 | with tempfile.TemporaryDirectory(prefix='pysim_') as dirname: |
| 648 | filename = '%s/file' % dirname |
| 649 | # write existing data as JSON to file |
| 650 | with open(filename, 'w') as text_file: |
| 651 | json.dump(orig_json, text_file, indent=4) |
| 652 | # run a text editor |
Harald Welte | e126872 | 2023-06-24 07:57:08 +0200 | [diff] [blame] | 653 | self._cmd.run_editor(filename) |
Harald Welte | 4145d3c | 2021-04-08 20:34:13 +0200 | [diff] [blame] | 654 | with open(filename, 'r') as text_file: |
| 655 | edited_json = json.load(text_file) |
| 656 | if edited_json == orig_json: |
| 657 | self._cmd.poutput("Data not modified, skipping write") |
| 658 | else: |
Harald Welte | a6c0f88 | 2022-07-17 14:23:17 +0200 | [diff] [blame] | 659 | (data, sw) = self._cmd.lchan.update_binary_dec(edited_json) |
Harald Welte | 4145d3c | 2021-04-08 20:34:13 +0200 | [diff] [blame] | 660 | if data: |
| 661 | self._cmd.poutput_json(data) |
| 662 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 663 | def __init__(self, fid: str, sfid: str = None, name: str = None, desc: str = None, parent: CardDF = None, |
Harald Welte | 13edf30 | 2022-07-21 15:19:23 +0200 | [diff] [blame] | 664 | size: Size = (1, None), **kwargs): |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 665 | """ |
| 666 | Args: |
| 667 | fid : File Identifier (4 hex digits) |
| 668 | sfid : Short File Identifier (2 hex digits, optional) |
| 669 | name : Brief name of the file, lik EF_ICCID |
Harald Welte | c9cdce3 | 2021-04-11 10:28:28 +0200 | [diff] [blame] | 670 | desc : Description of the file |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 671 | parent : Parent CardFile object within filesystem hierarchy |
| 672 | size : tuple of (minimum_size, recommended_size) |
| 673 | """ |
Harald Welte | 9170fbf | 2022-02-11 21:54:37 +0100 | [diff] [blame] | 674 | super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, parent=parent, **kwargs) |
Harald Welte | 2db5cfb | 2021-04-10 19:05:37 +0200 | [diff] [blame] | 675 | self._construct = None |
Harald Welte | fb50621 | 2021-05-29 21:28:24 +0200 | [diff] [blame] | 676 | self._tlv = None |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 677 | self.size = size |
| 678 | self.shell_commands = [self.ShellCommands()] |
| 679 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 680 | def decode_bin(self, raw_bin_data: bytearray) -> dict: |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 681 | """Decode raw (binary) data into abstract representation. |
| 682 | |
| 683 | A derived class would typically provide a _decode_bin() or _decode_hex() method |
| 684 | for implementing this specifically for the given file. This function checks which |
| 685 | of the method exists, add calls them (with conversion, as needed). |
| 686 | |
| 687 | Args: |
| 688 | raw_bin_data : binary encoded data |
| 689 | Returns: |
| 690 | abstract_data; dict representing the decoded data |
| 691 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 692 | method = getattr(self, '_decode_bin', None) |
| 693 | if callable(method): |
| 694 | return method(raw_bin_data) |
| 695 | method = getattr(self, '_decode_hex', None) |
| 696 | if callable(method): |
| 697 | return method(b2h(raw_bin_data)) |
Harald Welte | 2db5cfb | 2021-04-10 19:05:37 +0200 | [diff] [blame] | 698 | if self._construct: |
Harald Welte | 07c7b1f | 2021-05-28 22:01:29 +0200 | [diff] [blame] | 699 | return parse_construct(self._construct, raw_bin_data) |
Harald Welte | fb50621 | 2021-05-29 21:28:24 +0200 | [diff] [blame] | 700 | elif self._tlv: |
Harald Welte | ca60ac2 | 2022-02-10 18:01:02 +0100 | [diff] [blame] | 701 | t = self._tlv() if inspect.isclass(self._tlv) else self._tlv |
Harald Welte | 944cd2f | 2022-01-21 16:01:29 +0100 | [diff] [blame] | 702 | t.from_tlv(raw_bin_data) |
| 703 | return t.to_dict() |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 704 | return {'raw': raw_bin_data.hex()} |
| 705 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 706 | def decode_hex(self, raw_hex_data: str) -> dict: |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 707 | """Decode raw (hex string) data into abstract representation. |
| 708 | |
| 709 | A derived class would typically provide a _decode_bin() or _decode_hex() method |
| 710 | for implementing this specifically for the given file. This function checks which |
| 711 | of the method exists, add calls them (with conversion, as needed). |
| 712 | |
| 713 | Args: |
| 714 | raw_hex_data : hex-encoded data |
| 715 | Returns: |
| 716 | abstract_data; dict representing the decoded data |
| 717 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 718 | method = getattr(self, '_decode_hex', None) |
| 719 | if callable(method): |
| 720 | return method(raw_hex_data) |
| 721 | raw_bin_data = h2b(raw_hex_data) |
| 722 | method = getattr(self, '_decode_bin', None) |
| 723 | if callable(method): |
| 724 | return method(raw_bin_data) |
Harald Welte | 2db5cfb | 2021-04-10 19:05:37 +0200 | [diff] [blame] | 725 | if self._construct: |
Harald Welte | 07c7b1f | 2021-05-28 22:01:29 +0200 | [diff] [blame] | 726 | return parse_construct(self._construct, raw_bin_data) |
Harald Welte | fb50621 | 2021-05-29 21:28:24 +0200 | [diff] [blame] | 727 | elif self._tlv: |
Harald Welte | ca60ac2 | 2022-02-10 18:01:02 +0100 | [diff] [blame] | 728 | t = self._tlv() if inspect.isclass(self._tlv) else self._tlv |
Harald Welte | 944cd2f | 2022-01-21 16:01:29 +0100 | [diff] [blame] | 729 | t.from_tlv(raw_bin_data) |
| 730 | return t.to_dict() |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 731 | return {'raw': raw_bin_data.hex()} |
| 732 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 733 | def encode_bin(self, abstract_data: dict) -> bytearray: |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 734 | """Encode abstract representation into raw (binary) data. |
| 735 | |
| 736 | A derived class would typically provide an _encode_bin() or _encode_hex() method |
| 737 | for implementing this specifically for the given file. This function checks which |
| 738 | of the method exists, add calls them (with conversion, as needed). |
| 739 | |
| 740 | Args: |
| 741 | abstract_data : dict representing the decoded data |
| 742 | Returns: |
| 743 | binary encoded data |
| 744 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 745 | method = getattr(self, '_encode_bin', None) |
| 746 | if callable(method): |
| 747 | return method(abstract_data) |
| 748 | method = getattr(self, '_encode_hex', None) |
| 749 | if callable(method): |
| 750 | return h2b(method(abstract_data)) |
Harald Welte | 2db5cfb | 2021-04-10 19:05:37 +0200 | [diff] [blame] | 751 | if self._construct: |
Harald Welte | a5eb924 | 2023-12-23 10:20:20 +0100 | [diff] [blame] | 752 | return build_construct(self._construct, abstract_data) |
Harald Welte | fb50621 | 2021-05-29 21:28:24 +0200 | [diff] [blame] | 753 | elif self._tlv: |
Harald Welte | ca60ac2 | 2022-02-10 18:01:02 +0100 | [diff] [blame] | 754 | t = self._tlv() if inspect.isclass(self._tlv) else self._tlv |
Harald Welte | 944cd2f | 2022-01-21 16:01:29 +0100 | [diff] [blame] | 755 | t.from_dict(abstract_data) |
| 756 | return t.to_tlv() |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 757 | raise NotImplementedError( |
| 758 | "%s encoder not yet implemented. Patches welcome." % self) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 759 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 760 | def encode_hex(self, abstract_data: dict) -> str: |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 761 | """Encode abstract representation into raw (hex string) data. |
| 762 | |
| 763 | A derived class would typically provide an _encode_bin() or _encode_hex() method |
| 764 | for implementing this specifically for the given file. This function checks which |
| 765 | of the method exists, add calls them (with conversion, as needed). |
| 766 | |
| 767 | Args: |
| 768 | abstract_data : dict representing the decoded data |
| 769 | Returns: |
| 770 | hex string encoded data |
| 771 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 772 | method = getattr(self, '_encode_hex', None) |
| 773 | if callable(method): |
| 774 | return method(abstract_data) |
| 775 | method = getattr(self, '_encode_bin', None) |
| 776 | if callable(method): |
| 777 | raw_bin_data = method(abstract_data) |
| 778 | return b2h(raw_bin_data) |
Harald Welte | 2db5cfb | 2021-04-10 19:05:37 +0200 | [diff] [blame] | 779 | if self._construct: |
Harald Welte | a5eb924 | 2023-12-23 10:20:20 +0100 | [diff] [blame] | 780 | return b2h(build_construct(self._construct, abstract_data)) |
Harald Welte | fb50621 | 2021-05-29 21:28:24 +0200 | [diff] [blame] | 781 | elif self._tlv: |
Harald Welte | ca60ac2 | 2022-02-10 18:01:02 +0100 | [diff] [blame] | 782 | t = self._tlv() if inspect.isclass(self._tlv) else self._tlv |
Harald Welte | 944cd2f | 2022-01-21 16:01:29 +0100 | [diff] [blame] | 783 | t.from_dict(abstract_data) |
| 784 | return b2h(t.to_tlv()) |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 785 | raise NotImplementedError( |
| 786 | "%s encoder not yet implemented. Patches welcome." % self) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 787 | |
| 788 | |
| 789 | class LinFixedEF(CardEF): |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 790 | """Linear Fixed EF (Entry File) in the smart card filesystem. |
| 791 | |
| 792 | Linear Fixed EFs are record oriented files. They consist of a number of fixed-size |
| 793 | records. The records can be individually read/updated.""" |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 794 | |
| 795 | @with_default_category('Linear Fixed EF Commands') |
| 796 | class ShellCommands(CommandSet): |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 797 | """Shell commands specific for Linear Fixed EFs.""" |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 798 | |
Harald Welte | 9170fbf | 2022-02-11 21:54:37 +0100 | [diff] [blame] | 799 | def __init__(self, **kwargs): |
| 800 | super().__init__(**kwargs) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 801 | |
Harald Welte | aefd064 | 2022-02-25 15:26:37 +0100 | [diff] [blame] | 802 | dec_hex_parser = argparse.ArgumentParser() |
| 803 | dec_hex_parser.add_argument('--oneline', action='store_true', |
| 804 | help='No JSON pretty-printing, dump as a single line') |
| 805 | dec_hex_parser.add_argument('HEXSTR', help='Hex-string of encoded data to decode') |
| 806 | |
| 807 | @cmd2.with_argparser(dec_hex_parser) |
| 808 | def do_decode_hex(self, opts): |
| 809 | """Decode command-line provided hex-string as if it was read from the file.""" |
Harald Welte | a6c0f88 | 2022-07-17 14:23:17 +0200 | [diff] [blame] | 810 | data = self._cmd.lchan.selected_file.decode_record_hex(opts.HEXSTR) |
Harald Welte | aefd064 | 2022-02-25 15:26:37 +0100 | [diff] [blame] | 811 | self._cmd.poutput_json(data, opts.oneline) |
| 812 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 813 | read_rec_parser = argparse.ArgumentParser() |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 814 | read_rec_parser.add_argument( |
| 815 | 'record_nr', type=int, help='Number of record to be read') |
| 816 | read_rec_parser.add_argument( |
| 817 | '--count', type=int, default=1, help='Number of records to be read, beginning at record_nr') |
| 818 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 819 | @cmd2.with_argparser(read_rec_parser) |
| 820 | def do_read_record(self, opts): |
Philipp Maier | 4155573 | 2021-02-25 16:52:08 +0100 | [diff] [blame] | 821 | """Read one or multiple records from a record-oriented EF""" |
| 822 | for r in range(opts.count): |
| 823 | recnr = opts.record_nr + r |
Harald Welte | a6c0f88 | 2022-07-17 14:23:17 +0200 | [diff] [blame] | 824 | (data, sw) = self._cmd.lchan.read_record(recnr) |
Philipp Maier | 4155573 | 2021-02-25 16:52:08 +0100 | [diff] [blame] | 825 | if (len(data) > 0): |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 826 | recstr = str(data) |
Philipp Maier | 4155573 | 2021-02-25 16:52:08 +0100 | [diff] [blame] | 827 | else: |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 828 | recstr = "(empty)" |
Philipp Maier | 4155573 | 2021-02-25 16:52:08 +0100 | [diff] [blame] | 829 | self._cmd.poutput("%03d %s" % (recnr, recstr)) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 830 | |
| 831 | read_rec_dec_parser = argparse.ArgumentParser() |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 832 | read_rec_dec_parser.add_argument( |
| 833 | 'record_nr', type=int, help='Number of record to be read') |
Harald Welte | bcad86c | 2021-04-06 20:08:39 +0200 | [diff] [blame] | 834 | read_rec_dec_parser.add_argument('--oneline', action='store_true', |
| 835 | help='No JSON pretty-printing, dump as a single line') |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 836 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 837 | @cmd2.with_argparser(read_rec_dec_parser) |
| 838 | def do_read_record_decoded(self, opts): |
| 839 | """Read + decode a record from a record-oriented EF""" |
Harald Welte | a6c0f88 | 2022-07-17 14:23:17 +0200 | [diff] [blame] | 840 | (data, sw) = self._cmd.lchan.read_record_dec(opts.record_nr) |
Harald Welte | 1748b93 | 2021-04-06 21:12:25 +0200 | [diff] [blame] | 841 | self._cmd.poutput_json(data, opts.oneline) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 842 | |
Harald Welte | 850b72a | 2021-04-07 09:33:03 +0200 | [diff] [blame] | 843 | read_recs_parser = argparse.ArgumentParser() |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 844 | |
Harald Welte | 850b72a | 2021-04-07 09:33:03 +0200 | [diff] [blame] | 845 | @cmd2.with_argparser(read_recs_parser) |
| 846 | def do_read_records(self, opts): |
| 847 | """Read all records from a record-oriented EF""" |
Harald Welte | a6c0f88 | 2022-07-17 14:23:17 +0200 | [diff] [blame] | 848 | num_of_rec = self._cmd.lchan.selected_file_num_of_rec() |
Harald Welte | 850b72a | 2021-04-07 09:33:03 +0200 | [diff] [blame] | 849 | for recnr in range(1, 1 + num_of_rec): |
Harald Welte | a6c0f88 | 2022-07-17 14:23:17 +0200 | [diff] [blame] | 850 | (data, sw) = self._cmd.lchan.read_record(recnr) |
Harald Welte | 850b72a | 2021-04-07 09:33:03 +0200 | [diff] [blame] | 851 | if (len(data) > 0): |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 852 | recstr = str(data) |
Harald Welte | 850b72a | 2021-04-07 09:33:03 +0200 | [diff] [blame] | 853 | else: |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 854 | recstr = "(empty)" |
Harald Welte | 850b72a | 2021-04-07 09:33:03 +0200 | [diff] [blame] | 855 | self._cmd.poutput("%03d %s" % (recnr, recstr)) |
| 856 | |
| 857 | read_recs_dec_parser = argparse.ArgumentParser() |
| 858 | read_recs_dec_parser.add_argument('--oneline', action='store_true', |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 859 | help='No JSON pretty-printing, dump as a single line') |
| 860 | |
Harald Welte | 850b72a | 2021-04-07 09:33:03 +0200 | [diff] [blame] | 861 | @cmd2.with_argparser(read_recs_dec_parser) |
| 862 | def do_read_records_decoded(self, opts): |
| 863 | """Read + decode all records from a record-oriented EF""" |
Harald Welte | a6c0f88 | 2022-07-17 14:23:17 +0200 | [diff] [blame] | 864 | num_of_rec = self._cmd.lchan.selected_file_num_of_rec() |
Harald Welte | 850b72a | 2021-04-07 09:33:03 +0200 | [diff] [blame] | 865 | # collect all results in list so they are rendered as JSON list when printing |
| 866 | data_list = [] |
| 867 | for recnr in range(1, 1 + num_of_rec): |
Harald Welte | a6c0f88 | 2022-07-17 14:23:17 +0200 | [diff] [blame] | 868 | (data, sw) = self._cmd.lchan.read_record_dec(recnr) |
Harald Welte | 850b72a | 2021-04-07 09:33:03 +0200 | [diff] [blame] | 869 | data_list.append(data) |
| 870 | self._cmd.poutput_json(data_list, opts.oneline) |
| 871 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 872 | upd_rec_parser = argparse.ArgumentParser() |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 873 | upd_rec_parser.add_argument( |
| 874 | 'record_nr', type=int, help='Number of record to be read') |
| 875 | upd_rec_parser.add_argument( |
| 876 | 'data', help='Data bytes (hex format) to write') |
| 877 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 878 | @cmd2.with_argparser(upd_rec_parser) |
| 879 | def do_update_record(self, opts): |
| 880 | """Update (write) data to a record-oriented EF""" |
Harald Welte | a6c0f88 | 2022-07-17 14:23:17 +0200 | [diff] [blame] | 881 | (data, sw) = self._cmd.lchan.update_record(opts.record_nr, opts.data) |
Philipp Maier | e6bc4f9 | 2021-03-11 17:13:46 +0100 | [diff] [blame] | 882 | if data: |
| 883 | self._cmd.poutput(data) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 884 | |
| 885 | upd_rec_dec_parser = argparse.ArgumentParser() |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 886 | upd_rec_dec_parser.add_argument( |
| 887 | 'record_nr', type=int, help='Number of record to be read') |
| 888 | upd_rec_dec_parser.add_argument( |
| 889 | 'data', help='Abstract data (JSON format) to write') |
Harald Welte | 0d4e98a | 2021-04-07 00:14:40 +0200 | [diff] [blame] | 890 | upd_rec_dec_parser.add_argument('--json-path', type=str, |
| 891 | help='JSON path to modify specific element of record only') |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 892 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 893 | @cmd2.with_argparser(upd_rec_dec_parser) |
| 894 | def do_update_record_decoded(self, opts): |
| 895 | """Encode + Update (write) data to a record-oriented EF""" |
Harald Welte | 0d4e98a | 2021-04-07 00:14:40 +0200 | [diff] [blame] | 896 | if opts.json_path: |
Harald Welte | a6c0f88 | 2022-07-17 14:23:17 +0200 | [diff] [blame] | 897 | (data_json, sw) = self._cmd.lchan.read_record_dec(opts.record_nr) |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 898 | js_path_modify(data_json, opts.json_path, |
| 899 | json.loads(opts.data)) |
Harald Welte | 0d4e98a | 2021-04-07 00:14:40 +0200 | [diff] [blame] | 900 | else: |
| 901 | data_json = json.loads(opts.data) |
Harald Welte | a6c0f88 | 2022-07-17 14:23:17 +0200 | [diff] [blame] | 902 | (data, sw) = self._cmd.lchan.update_record_dec( |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 903 | opts.record_nr, data_json) |
Philipp Maier | e6bc4f9 | 2021-03-11 17:13:46 +0100 | [diff] [blame] | 904 | if data: |
| 905 | self._cmd.poutput(data) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 906 | |
Harald Welte | 4145d3c | 2021-04-08 20:34:13 +0200 | [diff] [blame] | 907 | edit_rec_dec_parser = argparse.ArgumentParser() |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 908 | edit_rec_dec_parser.add_argument( |
| 909 | 'record_nr', type=int, help='Number of record to be edited') |
| 910 | |
Harald Welte | 4145d3c | 2021-04-08 20:34:13 +0200 | [diff] [blame] | 911 | @cmd2.with_argparser(edit_rec_dec_parser) |
| 912 | def do_edit_record_decoded(self, opts): |
| 913 | """Edit the JSON representation of one record in an editor.""" |
Harald Welte | a6c0f88 | 2022-07-17 14:23:17 +0200 | [diff] [blame] | 914 | (orig_json, sw) = self._cmd.lchan.read_record_dec(opts.record_nr) |
Vadim Yanitskiy | 895fa6f | 2021-05-02 02:36:44 +0200 | [diff] [blame] | 915 | with tempfile.TemporaryDirectory(prefix='pysim_') as dirname: |
Harald Welte | 4145d3c | 2021-04-08 20:34:13 +0200 | [diff] [blame] | 916 | filename = '%s/file' % dirname |
| 917 | # write existing data as JSON to file |
| 918 | with open(filename, 'w') as text_file: |
| 919 | json.dump(orig_json, text_file, indent=4) |
| 920 | # run a text editor |
Harald Welte | e126872 | 2023-06-24 07:57:08 +0200 | [diff] [blame] | 921 | self._cmd.run_editor(filename) |
Harald Welte | 4145d3c | 2021-04-08 20:34:13 +0200 | [diff] [blame] | 922 | with open(filename, 'r') as text_file: |
| 923 | edited_json = json.load(text_file) |
| 924 | if edited_json == orig_json: |
| 925 | self._cmd.poutput("Data not modified, skipping write") |
| 926 | else: |
Harald Welte | a6c0f88 | 2022-07-17 14:23:17 +0200 | [diff] [blame] | 927 | (data, sw) = self._cmd.lchan.update_record_dec( |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 928 | opts.record_nr, edited_json) |
Harald Welte | 4145d3c | 2021-04-08 20:34:13 +0200 | [diff] [blame] | 929 | if data: |
| 930 | self._cmd.poutput_json(data) |
Harald Welte | 4145d3c | 2021-04-08 20:34:13 +0200 | [diff] [blame] | 931 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 932 | def __init__(self, fid: str, sfid: str = None, name: str = None, desc: str = None, |
Philipp Maier | 37e57e0 | 2023-09-07 12:43:12 +0200 | [diff] [blame] | 933 | parent: Optional[CardDF] = None, rec_len: Size = (1, None), leftpad: bool = False, **kwargs): |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 934 | """ |
| 935 | Args: |
| 936 | fid : File Identifier (4 hex digits) |
| 937 | sfid : Short File Identifier (2 hex digits, optional) |
| 938 | name : Brief name of the file, lik EF_ICCID |
Harald Welte | c9cdce3 | 2021-04-11 10:28:28 +0200 | [diff] [blame] | 939 | desc : Description of the file |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 940 | parent : Parent CardFile object within filesystem hierarchy |
Harald Welte | 99e4cc0 | 2022-07-21 15:25:47 +0200 | [diff] [blame] | 941 | rec_len : Tuple of (minimum_length, recommended_length) |
Philipp Maier | 37e57e0 | 2023-09-07 12:43:12 +0200 | [diff] [blame] | 942 | leftpad: On write, data must be padded from the left to fit pysical record length |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 943 | """ |
Harald Welte | 9170fbf | 2022-02-11 21:54:37 +0100 | [diff] [blame] | 944 | super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, parent=parent, **kwargs) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 945 | self.rec_len = rec_len |
Philipp Maier | 37e57e0 | 2023-09-07 12:43:12 +0200 | [diff] [blame] | 946 | self.leftpad = leftpad |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 947 | self.shell_commands = [self.ShellCommands()] |
Harald Welte | 2db5cfb | 2021-04-10 19:05:37 +0200 | [diff] [blame] | 948 | self._construct = None |
Harald Welte | fb50621 | 2021-05-29 21:28:24 +0200 | [diff] [blame] | 949 | self._tlv = None |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 950 | |
Harald Welte | caa94b5 | 2023-01-31 16:43:34 +0100 | [diff] [blame] | 951 | def decode_record_hex(self, raw_hex_data: str, record_nr: int = 1) -> dict: |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 952 | """Decode raw (hex string) data into abstract representation. |
| 953 | |
| 954 | A derived class would typically provide a _decode_record_bin() or _decode_record_hex() |
| 955 | method for implementing this specifically for the given file. This function checks which |
| 956 | of the method exists, add calls them (with conversion, as needed). |
| 957 | |
| 958 | Args: |
| 959 | raw_hex_data : hex-encoded data |
Harald Welte | f6b37af | 2023-01-24 15:42:26 +0100 | [diff] [blame] | 960 | record_nr : record number (1 for first record, ...) |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 961 | Returns: |
| 962 | abstract_data; dict representing the decoded data |
| 963 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 964 | method = getattr(self, '_decode_record_hex', None) |
| 965 | if callable(method): |
Harald Welte | f6b37af | 2023-01-24 15:42:26 +0100 | [diff] [blame] | 966 | return method(raw_hex_data, record_nr=record_nr) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 967 | raw_bin_data = h2b(raw_hex_data) |
| 968 | method = getattr(self, '_decode_record_bin', None) |
| 969 | if callable(method): |
Harald Welte | f6b37af | 2023-01-24 15:42:26 +0100 | [diff] [blame] | 970 | return method(raw_bin_data, record_nr=record_nr) |
Harald Welte | 2db5cfb | 2021-04-10 19:05:37 +0200 | [diff] [blame] | 971 | if self._construct: |
Harald Welte | 07c7b1f | 2021-05-28 22:01:29 +0200 | [diff] [blame] | 972 | return parse_construct(self._construct, raw_bin_data) |
Harald Welte | fb50621 | 2021-05-29 21:28:24 +0200 | [diff] [blame] | 973 | elif self._tlv: |
Harald Welte | ca60ac2 | 2022-02-10 18:01:02 +0100 | [diff] [blame] | 974 | t = self._tlv() if inspect.isclass(self._tlv) else self._tlv |
Harald Welte | 944cd2f | 2022-01-21 16:01:29 +0100 | [diff] [blame] | 975 | t.from_tlv(raw_bin_data) |
| 976 | return t.to_dict() |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 977 | return {'raw': raw_bin_data.hex()} |
| 978 | |
Harald Welte | f6b37af | 2023-01-24 15:42:26 +0100 | [diff] [blame] | 979 | def decode_record_bin(self, raw_bin_data: bytearray, record_nr: int) -> dict: |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 980 | """Decode raw (binary) data into abstract representation. |
| 981 | |
| 982 | A derived class would typically provide a _decode_record_bin() or _decode_record_hex() |
| 983 | method for implementing this specifically for the given file. This function checks which |
| 984 | of the method exists, add calls them (with conversion, as needed). |
| 985 | |
| 986 | Args: |
| 987 | raw_bin_data : binary encoded data |
Harald Welte | f6b37af | 2023-01-24 15:42:26 +0100 | [diff] [blame] | 988 | record_nr : record number (1 for first record, ...) |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 989 | Returns: |
| 990 | abstract_data; dict representing the decoded data |
| 991 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 992 | method = getattr(self, '_decode_record_bin', None) |
| 993 | if callable(method): |
Harald Welte | f6b37af | 2023-01-24 15:42:26 +0100 | [diff] [blame] | 994 | return method(raw_bin_data, record_nr=record_nr) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 995 | raw_hex_data = b2h(raw_bin_data) |
| 996 | method = getattr(self, '_decode_record_hex', None) |
| 997 | if callable(method): |
Harald Welte | f6b37af | 2023-01-24 15:42:26 +0100 | [diff] [blame] | 998 | return method(raw_hex_data, record_nr=record_nr) |
Harald Welte | 2db5cfb | 2021-04-10 19:05:37 +0200 | [diff] [blame] | 999 | if self._construct: |
Harald Welte | 07c7b1f | 2021-05-28 22:01:29 +0200 | [diff] [blame] | 1000 | return parse_construct(self._construct, raw_bin_data) |
Harald Welte | fb50621 | 2021-05-29 21:28:24 +0200 | [diff] [blame] | 1001 | elif self._tlv: |
Harald Welte | ca60ac2 | 2022-02-10 18:01:02 +0100 | [diff] [blame] | 1002 | t = self._tlv() if inspect.isclass(self._tlv) else self._tlv |
Harald Welte | 944cd2f | 2022-01-21 16:01:29 +0100 | [diff] [blame] | 1003 | t.from_tlv(raw_bin_data) |
| 1004 | return t.to_dict() |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1005 | return {'raw': raw_hex_data} |
| 1006 | |
Harald Welte | f6b37af | 2023-01-24 15:42:26 +0100 | [diff] [blame] | 1007 | def encode_record_hex(self, abstract_data: dict, record_nr: int) -> str: |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 1008 | """Encode abstract representation into raw (hex string) data. |
| 1009 | |
| 1010 | A derived class would typically provide an _encode_record_bin() or _encode_record_hex() |
| 1011 | method for implementing this specifically for the given file. This function checks which |
| 1012 | of the method exists, add calls them (with conversion, as needed). |
| 1013 | |
| 1014 | Args: |
| 1015 | abstract_data : dict representing the decoded data |
Harald Welte | f6b37af | 2023-01-24 15:42:26 +0100 | [diff] [blame] | 1016 | record_nr : record number (1 for first record, ...) |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 1017 | Returns: |
| 1018 | hex string encoded data |
| 1019 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1020 | method = getattr(self, '_encode_record_hex', None) |
| 1021 | if callable(method): |
Harald Welte | f6b37af | 2023-01-24 15:42:26 +0100 | [diff] [blame] | 1022 | return method(abstract_data, record_nr=record_nr) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1023 | method = getattr(self, '_encode_record_bin', None) |
| 1024 | if callable(method): |
Harald Welte | f6b37af | 2023-01-24 15:42:26 +0100 | [diff] [blame] | 1025 | raw_bin_data = method(abstract_data, record_nr=record_nr) |
Harald Welte | 1e45657 | 2021-04-02 17:16:30 +0200 | [diff] [blame] | 1026 | return b2h(raw_bin_data) |
Harald Welte | 2db5cfb | 2021-04-10 19:05:37 +0200 | [diff] [blame] | 1027 | if self._construct: |
Harald Welte | a5eb924 | 2023-12-23 10:20:20 +0100 | [diff] [blame] | 1028 | return b2h(build_construct(self._construct, abstract_data)) |
Harald Welte | fb50621 | 2021-05-29 21:28:24 +0200 | [diff] [blame] | 1029 | elif self._tlv: |
Harald Welte | ca60ac2 | 2022-02-10 18:01:02 +0100 | [diff] [blame] | 1030 | t = self._tlv() if inspect.isclass(self._tlv) else self._tlv |
Harald Welte | 944cd2f | 2022-01-21 16:01:29 +0100 | [diff] [blame] | 1031 | t.from_dict(abstract_data) |
| 1032 | return b2h(t.to_tlv()) |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1033 | raise NotImplementedError( |
| 1034 | "%s encoder not yet implemented. Patches welcome." % self) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1035 | |
Harald Welte | f6b37af | 2023-01-24 15:42:26 +0100 | [diff] [blame] | 1036 | def encode_record_bin(self, abstract_data: dict, record_nr : int) -> bytearray: |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 1037 | """Encode abstract representation into raw (binary) data. |
| 1038 | |
| 1039 | A derived class would typically provide an _encode_record_bin() or _encode_record_hex() |
| 1040 | method for implementing this specifically for the given file. This function checks which |
| 1041 | of the method exists, add calls them (with conversion, as needed). |
| 1042 | |
| 1043 | Args: |
| 1044 | abstract_data : dict representing the decoded data |
Harald Welte | f6b37af | 2023-01-24 15:42:26 +0100 | [diff] [blame] | 1045 | record_nr : record number (1 for first record, ...) |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 1046 | Returns: |
| 1047 | binary encoded data |
| 1048 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1049 | method = getattr(self, '_encode_record_bin', None) |
| 1050 | if callable(method): |
Harald Welte | f6b37af | 2023-01-24 15:42:26 +0100 | [diff] [blame] | 1051 | return method(abstract_data, record_nr=record_nr) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1052 | method = getattr(self, '_encode_record_hex', None) |
| 1053 | if callable(method): |
Harald Welte | f6b37af | 2023-01-24 15:42:26 +0100 | [diff] [blame] | 1054 | return h2b(method(abstract_data, record_nr=record_nr)) |
Harald Welte | 2db5cfb | 2021-04-10 19:05:37 +0200 | [diff] [blame] | 1055 | if self._construct: |
Harald Welte | a5eb924 | 2023-12-23 10:20:20 +0100 | [diff] [blame] | 1056 | return build_construct(self._construct, abstract_data) |
Harald Welte | fb50621 | 2021-05-29 21:28:24 +0200 | [diff] [blame] | 1057 | elif self._tlv: |
Harald Welte | ca60ac2 | 2022-02-10 18:01:02 +0100 | [diff] [blame] | 1058 | t = self._tlv() if inspect.isclass(self._tlv) else self._tlv |
Harald Welte | 944cd2f | 2022-01-21 16:01:29 +0100 | [diff] [blame] | 1059 | t.from_dict(abstract_data) |
| 1060 | return t.to_tlv() |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1061 | raise NotImplementedError( |
| 1062 | "%s encoder not yet implemented. Patches welcome." % self) |
| 1063 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1064 | |
| 1065 | class CyclicEF(LinFixedEF): |
| 1066 | """Cyclic EF (Entry File) in the smart card filesystem""" |
| 1067 | # we don't really have any special support for those; just recycling LinFixedEF here |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1068 | |
| 1069 | def __init__(self, fid: str, sfid: str = None, name: str = None, desc: str = None, parent: CardDF = None, |
Harald Welte | 99e4cc0 | 2022-07-21 15:25:47 +0200 | [diff] [blame] | 1070 | rec_len: Size = (1, None), **kwargs): |
Harald Welte | 9170fbf | 2022-02-11 21:54:37 +0100 | [diff] [blame] | 1071 | super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, parent=parent, rec_len=rec_len, **kwargs) |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1072 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1073 | |
| 1074 | class TransRecEF(TransparentEF): |
| 1075 | """Transparent EF (Entry File) containing fixed-size records. |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 1076 | |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1077 | These are the real odd-balls and mostly look like mistakes in the specification: |
| 1078 | Specified as 'transparent' EF, but actually containing several fixed-length records |
| 1079 | inside. |
| 1080 | We add a special class for those, so the user only has to provide encoder/decoder functions |
| 1081 | for a record, while this class takes care of split / merge of records. |
| 1082 | """ |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1083 | |
| 1084 | def __init__(self, fid: str, rec_len: int, sfid: str = None, name: str = None, desc: str = None, |
Harald Welte | 13edf30 | 2022-07-21 15:19:23 +0200 | [diff] [blame] | 1085 | parent: Optional[CardDF] = None, size: Size = (1, None), **kwargs): |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 1086 | """ |
| 1087 | Args: |
| 1088 | fid : File Identifier (4 hex digits) |
| 1089 | sfid : Short File Identifier (2 hex digits, optional) |
Harald Welte | c9cdce3 | 2021-04-11 10:28:28 +0200 | [diff] [blame] | 1090 | name : Brief name of the file, like EF_ICCID |
| 1091 | desc : Description of the file |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 1092 | parent : Parent CardFile object within filesystem hierarchy |
| 1093 | rec_len : Length of the fixed-length records within transparent EF |
| 1094 | size : tuple of (minimum_size, recommended_size) |
| 1095 | """ |
Harald Welte | 9170fbf | 2022-02-11 21:54:37 +0100 | [diff] [blame] | 1096 | super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, parent=parent, size=size, **kwargs) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1097 | self.rec_len = rec_len |
| 1098 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1099 | def decode_record_hex(self, raw_hex_data: str) -> dict: |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 1100 | """Decode raw (hex string) data into abstract representation. |
| 1101 | |
| 1102 | A derived class would typically provide a _decode_record_bin() or _decode_record_hex() |
| 1103 | method for implementing this specifically for the given file. This function checks which |
| 1104 | of the method exists, add calls them (with conversion, as needed). |
| 1105 | |
| 1106 | Args: |
| 1107 | raw_hex_data : hex-encoded data |
| 1108 | Returns: |
| 1109 | abstract_data; dict representing the decoded data |
| 1110 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1111 | method = getattr(self, '_decode_record_hex', None) |
| 1112 | if callable(method): |
| 1113 | return method(raw_hex_data) |
Harald Welte | 2db5cfb | 2021-04-10 19:05:37 +0200 | [diff] [blame] | 1114 | raw_bin_data = h2b(raw_hex_data) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1115 | method = getattr(self, '_decode_record_bin', None) |
| 1116 | if callable(method): |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1117 | return method(raw_bin_data) |
Harald Welte | 2db5cfb | 2021-04-10 19:05:37 +0200 | [diff] [blame] | 1118 | if self._construct: |
Harald Welte | 07c7b1f | 2021-05-28 22:01:29 +0200 | [diff] [blame] | 1119 | return parse_construct(self._construct, raw_bin_data) |
Harald Welte | fb50621 | 2021-05-29 21:28:24 +0200 | [diff] [blame] | 1120 | elif self._tlv: |
Harald Welte | ca60ac2 | 2022-02-10 18:01:02 +0100 | [diff] [blame] | 1121 | t = self._tlv() if inspect.isclass(self._tlv) else self._tlv |
Harald Welte | 944cd2f | 2022-01-21 16:01:29 +0100 | [diff] [blame] | 1122 | t.from_tlv(raw_bin_data) |
| 1123 | return t.to_dict() |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1124 | return {'raw': raw_hex_data} |
| 1125 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1126 | def decode_record_bin(self, raw_bin_data: bytearray) -> dict: |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 1127 | """Decode raw (binary) data into abstract representation. |
| 1128 | |
| 1129 | A derived class would typically provide a _decode_record_bin() or _decode_record_hex() |
| 1130 | method for implementing this specifically for the given file. This function checks which |
| 1131 | of the method exists, add calls them (with conversion, as needed). |
| 1132 | |
| 1133 | Args: |
| 1134 | raw_bin_data : binary encoded data |
| 1135 | Returns: |
| 1136 | abstract_data; dict representing the decoded data |
| 1137 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1138 | method = getattr(self, '_decode_record_bin', None) |
| 1139 | if callable(method): |
| 1140 | return method(raw_bin_data) |
| 1141 | raw_hex_data = b2h(raw_bin_data) |
| 1142 | method = getattr(self, '_decode_record_hex', None) |
| 1143 | if callable(method): |
| 1144 | return method(raw_hex_data) |
Harald Welte | 2db5cfb | 2021-04-10 19:05:37 +0200 | [diff] [blame] | 1145 | if self._construct: |
Harald Welte | 07c7b1f | 2021-05-28 22:01:29 +0200 | [diff] [blame] | 1146 | return parse_construct(self._construct, raw_bin_data) |
Harald Welte | fb50621 | 2021-05-29 21:28:24 +0200 | [diff] [blame] | 1147 | elif self._tlv: |
Harald Welte | ca60ac2 | 2022-02-10 18:01:02 +0100 | [diff] [blame] | 1148 | t = self._tlv() if inspect.isclass(self._tlv) else self._tlv |
Harald Welte | 944cd2f | 2022-01-21 16:01:29 +0100 | [diff] [blame] | 1149 | t.from_tlv(raw_bin_data) |
| 1150 | return t.to_dict() |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1151 | return {'raw': raw_hex_data} |
| 1152 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1153 | def encode_record_hex(self, abstract_data: dict) -> str: |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 1154 | """Encode abstract representation into raw (hex string) data. |
| 1155 | |
| 1156 | A derived class would typically provide an _encode_record_bin() or _encode_record_hex() |
| 1157 | method for implementing this specifically for the given file. This function checks which |
| 1158 | of the method exists, add calls them (with conversion, as needed). |
| 1159 | |
| 1160 | Args: |
| 1161 | abstract_data : dict representing the decoded data |
| 1162 | Returns: |
| 1163 | hex string encoded data |
| 1164 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1165 | method = getattr(self, '_encode_record_hex', None) |
| 1166 | if callable(method): |
| 1167 | return method(abstract_data) |
| 1168 | method = getattr(self, '_encode_record_bin', None) |
| 1169 | if callable(method): |
Harald Welte | 1e45657 | 2021-04-02 17:16:30 +0200 | [diff] [blame] | 1170 | return b2h(method(abstract_data)) |
Harald Welte | 2db5cfb | 2021-04-10 19:05:37 +0200 | [diff] [blame] | 1171 | if self._construct: |
Harald Welte | a5eb924 | 2023-12-23 10:20:20 +0100 | [diff] [blame] | 1172 | return b2h(filter_dict(build_construct(self._construct, abstract_data))) |
Harald Welte | fb50621 | 2021-05-29 21:28:24 +0200 | [diff] [blame] | 1173 | elif self._tlv: |
Harald Welte | ca60ac2 | 2022-02-10 18:01:02 +0100 | [diff] [blame] | 1174 | t = self._tlv() if inspect.isclass(self._tlv) else self._tlv |
Harald Welte | 944cd2f | 2022-01-21 16:01:29 +0100 | [diff] [blame] | 1175 | t.from_dict(abstract_data) |
| 1176 | return b2h(t.to_tlv()) |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1177 | raise NotImplementedError( |
| 1178 | "%s encoder not yet implemented. Patches welcome." % self) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1179 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1180 | def encode_record_bin(self, abstract_data: dict) -> bytearray: |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 1181 | """Encode abstract representation into raw (binary) data. |
| 1182 | |
| 1183 | A derived class would typically provide an _encode_record_bin() or _encode_record_hex() |
| 1184 | method for implementing this specifically for the given file. This function checks which |
| 1185 | of the method exists, add calls them (with conversion, as needed). |
| 1186 | |
| 1187 | Args: |
| 1188 | abstract_data : dict representing the decoded data |
| 1189 | Returns: |
| 1190 | binary encoded data |
| 1191 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1192 | method = getattr(self, '_encode_record_bin', None) |
| 1193 | if callable(method): |
| 1194 | return method(abstract_data) |
| 1195 | method = getattr(self, '_encode_record_hex', None) |
| 1196 | if callable(method): |
| 1197 | return h2b(method(abstract_data)) |
Harald Welte | 2db5cfb | 2021-04-10 19:05:37 +0200 | [diff] [blame] | 1198 | if self._construct: |
Harald Welte | a5eb924 | 2023-12-23 10:20:20 +0100 | [diff] [blame] | 1199 | return filter_dict(build_construct(self._construct, abstract_data)) |
Harald Welte | fb50621 | 2021-05-29 21:28:24 +0200 | [diff] [blame] | 1200 | elif self._tlv: |
Harald Welte | ca60ac2 | 2022-02-10 18:01:02 +0100 | [diff] [blame] | 1201 | t = self._tlv() if inspect.isclass(self._tlv) else self._tlv |
Harald Welte | 944cd2f | 2022-01-21 16:01:29 +0100 | [diff] [blame] | 1202 | t.from_dict(abstract_data) |
| 1203 | return t.to_tlv() |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1204 | raise NotImplementedError( |
| 1205 | "%s encoder not yet implemented. Patches welcome." % self) |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1206 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1207 | def _decode_bin(self, raw_bin_data: bytearray): |
| 1208 | chunks = [raw_bin_data[i:i+self.rec_len] |
| 1209 | for i in range(0, len(raw_bin_data), self.rec_len)] |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1210 | return [self.decode_record_bin(x) for x in chunks] |
| 1211 | |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 1212 | def _encode_bin(self, abstract_data) -> bytes: |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1213 | chunks = [self.encode_record_bin(x) for x in abstract_data] |
| 1214 | # FIXME: pad to file size |
| 1215 | return b''.join(chunks) |
| 1216 | |
| 1217 | |
Harald Welte | 917d98c | 2021-04-21 11:51:25 +0200 | [diff] [blame] | 1218 | class BerTlvEF(CardEF): |
Harald Welte | 2788162 | 2021-04-21 11:16:31 +0200 | [diff] [blame] | 1219 | """BER-TLV EF (Entry File) in the smart card filesystem. |
| 1220 | A BER-TLV EF is a binary file with a BER (Basic Encoding Rules) TLV structure |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1221 | |
Harald Welte | 2788162 | 2021-04-21 11:16:31 +0200 | [diff] [blame] | 1222 | NOTE: We currently don't really support those, this class is simply a wrapper |
| 1223 | around TransparentEF as a place-holder, so we can already define EFs of BER-TLV |
| 1224 | type without fully supporting them.""" |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1225 | |
Harald Welte | 917d98c | 2021-04-21 11:51:25 +0200 | [diff] [blame] | 1226 | @with_default_category('BER-TLV EF Commands') |
| 1227 | class ShellCommands(CommandSet): |
| 1228 | """Shell commands specific for BER-TLV EFs.""" |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1229 | |
Harald Welte | 917d98c | 2021-04-21 11:51:25 +0200 | [diff] [blame] | 1230 | def __init__(self): |
| 1231 | super().__init__() |
| 1232 | |
| 1233 | retrieve_data_parser = argparse.ArgumentParser() |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1234 | retrieve_data_parser.add_argument( |
| 1235 | 'tag', type=auto_int, help='BER-TLV Tag of value to retrieve') |
| 1236 | |
Harald Welte | 917d98c | 2021-04-21 11:51:25 +0200 | [diff] [blame] | 1237 | @cmd2.with_argparser(retrieve_data_parser) |
| 1238 | def do_retrieve_data(self, opts): |
| 1239 | """Retrieve (Read) data from a BER-TLV EF""" |
Harald Welte | a6c0f88 | 2022-07-17 14:23:17 +0200 | [diff] [blame] | 1240 | (data, sw) = self._cmd.lchan.retrieve_data(opts.tag) |
Harald Welte | 917d98c | 2021-04-21 11:51:25 +0200 | [diff] [blame] | 1241 | self._cmd.poutput(data) |
| 1242 | |
| 1243 | def do_retrieve_tags(self, opts): |
| 1244 | """List tags available in a given BER-TLV EF""" |
Harald Welte | a6c0f88 | 2022-07-17 14:23:17 +0200 | [diff] [blame] | 1245 | tags = self._cmd.lchan.retrieve_tags() |
Harald Welte | 917d98c | 2021-04-21 11:51:25 +0200 | [diff] [blame] | 1246 | self._cmd.poutput(tags) |
| 1247 | |
| 1248 | set_data_parser = argparse.ArgumentParser() |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1249 | set_data_parser.add_argument( |
| 1250 | 'tag', type=auto_int, help='BER-TLV Tag of value to set') |
| 1251 | set_data_parser.add_argument( |
| 1252 | 'data', help='Data bytes (hex format) to write') |
| 1253 | |
Harald Welte | 917d98c | 2021-04-21 11:51:25 +0200 | [diff] [blame] | 1254 | @cmd2.with_argparser(set_data_parser) |
| 1255 | def do_set_data(self, opts): |
| 1256 | """Set (Write) data for a given tag in a BER-TLV EF""" |
Harald Welte | a6c0f88 | 2022-07-17 14:23:17 +0200 | [diff] [blame] | 1257 | (data, sw) = self._cmd.lchan.set_data(opts.tag, opts.data) |
Harald Welte | 917d98c | 2021-04-21 11:51:25 +0200 | [diff] [blame] | 1258 | if data: |
| 1259 | self._cmd.poutput(data) |
| 1260 | |
| 1261 | del_data_parser = argparse.ArgumentParser() |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1262 | del_data_parser.add_argument( |
| 1263 | 'tag', type=auto_int, help='BER-TLV Tag of value to set') |
| 1264 | |
Harald Welte | 917d98c | 2021-04-21 11:51:25 +0200 | [diff] [blame] | 1265 | @cmd2.with_argparser(del_data_parser) |
| 1266 | def do_delete_data(self, opts): |
| 1267 | """Delete data for a given tag in a BER-TLV EF""" |
Harald Welte | a6c0f88 | 2022-07-17 14:23:17 +0200 | [diff] [blame] | 1268 | (data, sw) = self._cmd.lchan.set_data(opts.tag, None) |
Harald Welte | 917d98c | 2021-04-21 11:51:25 +0200 | [diff] [blame] | 1269 | if data: |
| 1270 | self._cmd.poutput(data) |
| 1271 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1272 | def __init__(self, fid: str, sfid: str = None, name: str = None, desc: str = None, parent: CardDF = None, |
Harald Welte | 13edf30 | 2022-07-21 15:19:23 +0200 | [diff] [blame] | 1273 | size: Size = (1, None), **kwargs): |
Harald Welte | 917d98c | 2021-04-21 11:51:25 +0200 | [diff] [blame] | 1274 | """ |
| 1275 | Args: |
| 1276 | fid : File Identifier (4 hex digits) |
| 1277 | sfid : Short File Identifier (2 hex digits, optional) |
| 1278 | name : Brief name of the file, lik EF_ICCID |
| 1279 | desc : Description of the file |
| 1280 | parent : Parent CardFile object within filesystem hierarchy |
| 1281 | size : tuple of (minimum_size, recommended_size) |
| 1282 | """ |
Harald Welte | 9170fbf | 2022-02-11 21:54:37 +0100 | [diff] [blame] | 1283 | super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, parent=parent, **kwargs) |
Harald Welte | 917d98c | 2021-04-21 11:51:25 +0200 | [diff] [blame] | 1284 | self._construct = None |
| 1285 | self.size = size |
| 1286 | self.shell_commands = [self.ShellCommands()] |
| 1287 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1288 | def interpret_sw(sw_data: dict, sw: str): |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 1289 | """Interpret a given status word. |
| 1290 | |
| 1291 | Args: |
| 1292 | sw_data : Hierarchical dict of status word matches |
| 1293 | sw : status word to match (string of 4 hex digits) |
| 1294 | Returns: |
| 1295 | tuple of two strings (class_string, description) |
| 1296 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1297 | for class_str, swdict in sw_data.items(): |
| 1298 | # first try direct match |
| 1299 | if sw in swdict: |
| 1300 | return (class_str, swdict[sw]) |
| 1301 | # next try wildcard matches |
| 1302 | for pattern, descr in swdict.items(): |
| 1303 | if sw_match(sw, pattern): |
| 1304 | return (class_str, descr) |
| 1305 | return None |
| 1306 | |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1307 | |
Vadim Yanitskiy | 04b5d9d | 2022-07-07 03:05:30 +0700 | [diff] [blame] | 1308 | class CardApplication: |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1309 | """A card application is represented by an ADF (with contained hierarchy) and optionally |
| 1310 | some SW definitions.""" |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1311 | |
| 1312 | 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] | 1313 | """ |
| 1314 | Args: |
| 1315 | adf : ADF name |
| 1316 | sw : Dict of status word conversions |
| 1317 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1318 | self.name = name |
| 1319 | self.adf = adf |
Vadim Yanitskiy | 98f872b | 2021-03-27 01:25:46 +0100 | [diff] [blame] | 1320 | self.sw = sw or dict() |
Harald Welte | 5ce3524 | 2021-04-02 20:27:05 +0200 | [diff] [blame] | 1321 | # back-reference from ADF to Applicaiton |
| 1322 | if self.adf: |
| 1323 | self.aid = aid or self.adf.aid |
| 1324 | self.adf.application = self |
| 1325 | else: |
| 1326 | self.aid = aid |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1327 | |
| 1328 | def __str__(self): |
| 1329 | return "APP(%s)" % (self.name) |
| 1330 | |
| 1331 | def interpret_sw(self, sw): |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 1332 | """Interpret a given status word within the application. |
| 1333 | |
| 1334 | Args: |
Harald Welte | c9cdce3 | 2021-04-11 10:28:28 +0200 | [diff] [blame] | 1335 | sw : Status word as string of 4 hex digits |
Harald Welte | ee3501f | 2021-04-02 13:00:18 +0200 | [diff] [blame] | 1336 | |
| 1337 | Returns: |
| 1338 | Tuple of two strings |
| 1339 | """ |
Harald Welte | b2edd14 | 2021-01-08 23:29:35 +0100 | [diff] [blame] | 1340 | return interpret_sw(self.sw, sw) |
| 1341 | |
Harald Welte | f44256c | 2021-10-14 15:53:39 +0200 | [diff] [blame] | 1342 | |
| 1343 | class CardModel(abc.ABC): |
Harald Welte | 4c1dca0 | 2021-10-14 17:48:25 +0200 | [diff] [blame] | 1344 | """A specific card model, typically having some additional vendor-specific files. All |
| 1345 | you need to do is to define a sub-class with a list of ATRs or an overridden match |
| 1346 | method.""" |
Harald Welte | f44256c | 2021-10-14 15:53:39 +0200 | [diff] [blame] | 1347 | _atrs = [] |
| 1348 | |
| 1349 | @classmethod |
| 1350 | @abc.abstractmethod |
Harald Welte | 531894d | 2023-07-11 19:11:11 +0200 | [diff] [blame] | 1351 | def add_files(cls, rs: 'RuntimeState'): |
Harald Welte | f44256c | 2021-10-14 15:53:39 +0200 | [diff] [blame] | 1352 | """Add model specific files to given RuntimeState.""" |
| 1353 | |
| 1354 | @classmethod |
Harald Welte | c91085e | 2022-02-10 18:05:45 +0100 | [diff] [blame] | 1355 | def match(cls, scc: SimCardCommands) -> bool: |
Harald Welte | f44256c | 2021-10-14 15:53:39 +0200 | [diff] [blame] | 1356 | """Test if given card matches this model.""" |
| 1357 | card_atr = scc.get_atr() |
| 1358 | for atr in cls._atrs: |
| 1359 | atr_bin = toBytes(atr) |
| 1360 | if atr_bin == card_atr: |
| 1361 | print("Detected CardModel:", cls.__name__) |
| 1362 | return True |
| 1363 | return False |
| 1364 | |
| 1365 | @staticmethod |
Harald Welte | 531894d | 2023-07-11 19:11:11 +0200 | [diff] [blame] | 1366 | def apply_matching_models(scc: SimCardCommands, rs: 'RuntimeState'): |
Harald Welte | 4c1dca0 | 2021-10-14 17:48:25 +0200 | [diff] [blame] | 1367 | """Check if any of the CardModel sub-classes 'match' the currently inserted card |
| 1368 | (by ATR or overriding the 'match' method). If so, call their 'add_files' |
| 1369 | method.""" |
Harald Welte | f44256c | 2021-10-14 15:53:39 +0200 | [diff] [blame] | 1370 | for m in CardModel.__subclasses__(): |
| 1371 | if m.match(scc): |
| 1372 | m.add_files(rs) |