Harald Welte | 94e8735 | 2021-04-02 13:38:00 +0200 | [diff] [blame] | 1 | pySim-shell |
| 2 | =========== |
Harald Welte | be9516f | 2021-04-03 11:30:10 +0200 | [diff] [blame] | 3 | |
| 4 | pySim-shell is an interactive command line shell for all kind of interactions with SIM cards. |
| 5 | |
| 6 | The interactive shell provides command for |
| 7 | |
| 8 | * navigating the on-card filesystem hierarchy |
| 9 | * authenticating with PINs such as ADM1 |
| 10 | * CHV/PIN management (VERIFY, ENABLE, DISABLE, UNBLOCK) |
| 11 | * decoding of SELECT response (file control parameters) |
| 12 | * reading and writing of files and records in raw, hex-encoded binary format |
| 13 | * for some files where related support has been developed: |
| 14 | |
| 15 | * decoded reading (display file data in JSON format) |
| 16 | * decoded writing (encode from JSON to binary format, then write) |
| 17 | |
| 18 | By means of using the python ``cmd2`` module, various useful features improve usability: |
| 19 | |
| 20 | * history of commands (persistent across restarts) |
| 21 | * output re-direction to files on your computer |
| 22 | * output piping through external tools like 'grep' |
| 23 | * tab completion of commands and SELECT-able files/directories |
| 24 | * interactive help for all commands |
| 25 | |
Harald Welte | f2e761c | 2021-04-11 11:56:44 +0200 | [diff] [blame] | 26 | Running pySim-shell |
| 27 | ------------------- |
| 28 | |
| 29 | pySim-shell has a variety of command line arguments to control |
| 30 | |
| 31 | * which transport to use (how to use a reader to talk to the SIM card) |
| 32 | * whether to automatically verify an ADM pin (and in which format) |
| 33 | * whether to execute a start-up script |
| 34 | |
| 35 | .. argparse:: |
| 36 | :module: pySim-shell |
| 37 | :func: option_parser |
| 38 | |
| 39 | |
Harald Welte | be9516f | 2021-04-03 11:30:10 +0200 | [diff] [blame] | 40 | |
| 41 | cmd2 basics |
| 42 | ----------- |
| 43 | |
| 44 | FIXME |
| 45 | |
| 46 | |
| 47 | |
| 48 | ISO7816 commands |
| 49 | ---------------- |
| 50 | |
| 51 | This category of commands relates to commands that originate in the ISO 7861-4 specifications, |
| 52 | most of them have a 1:1 resemblance in the specification. |
| 53 | |
| 54 | select |
| 55 | ~~~~~~ |
| 56 | |
| 57 | The ``select`` command is used to select a file, either by its FID, AID or by its symbolic name. |
| 58 | |
| 59 | Try ``select`` with tab-completion to get a list of all current selectable items: |
| 60 | |
| 61 | :: |
| 62 | |
| 63 | pySIM-shell (MF)> select |
| 64 | .. 2fe2 a0000000871004 EF.ARR MF |
| 65 | 2f00 3f00 ADF.ISIM EF.DIR |
| 66 | 2f05 7f10 ADF.USIM EF.ICCID |
| 67 | 2f06 7f20 DF.GSM EF.PL |
| 68 | 2f08 a0000000871002 DF.TELECOM EF.UMPC |
| 69 | |
| 70 | Use ``select`` with a specific FID or name to select the new file. |
| 71 | |
| 72 | This will |
| 73 | |
| 74 | * output the [JSON decoded, if possible] select response |
| 75 | * change the prompt to the newly selected file |
| 76 | * enable any commands specific to the newly-selected file |
| 77 | |
| 78 | :: |
| 79 | |
| 80 | pySIM-shell (MF)> select ADF.USIM |
| 81 | { |
| 82 | "file_descriptor": { |
| 83 | "shareable": true, |
| 84 | "file_type": "df", |
| 85 | "structure": "no_info_given" |
| 86 | }, |
| 87 | "df_name": "A0000000871002FFFFFFFF8907090000", |
| 88 | "proprietary_info": { |
| 89 | "uicc_characteristics": "71", |
| 90 | "available_memory": 101640 |
| 91 | }, |
| 92 | "life_cycle_status_int": "operational_activated", |
| 93 | "security_attrib_compact": "00", |
| 94 | "pin_status_template_do": "90017083010183018183010A83010B" |
| 95 | } |
| 96 | pySIM-shell (MF/ADF.USIM)> |
| 97 | |
| 98 | |
| 99 | |
| 100 | change_chv |
| 101 | ~~~~~~~~~~ |
Harald Welte | d36f694 | 2021-04-04 14:37:55 +0200 | [diff] [blame] | 102 | .. argparse:: |
| 103 | :module: pySim-shell |
| 104 | :func: Iso7816Commands.change_chv_parser |
Harald Welte | be9516f | 2021-04-03 11:30:10 +0200 | [diff] [blame] | 105 | |
| 106 | |
| 107 | disable_chv |
| 108 | ~~~~~~~~~~~ |
Harald Welte | d36f694 | 2021-04-04 14:37:55 +0200 | [diff] [blame] | 109 | .. argparse:: |
| 110 | :module: pySim-shell |
| 111 | :func: Iso7816Commands.disable_chv_parser |
Harald Welte | be9516f | 2021-04-03 11:30:10 +0200 | [diff] [blame] | 112 | |
Harald Welte | be9516f | 2021-04-03 11:30:10 +0200 | [diff] [blame] | 113 | |
| 114 | enable_chv |
| 115 | ~~~~~~~~~~ |
Harald Welte | d36f694 | 2021-04-04 14:37:55 +0200 | [diff] [blame] | 116 | .. argparse:: |
| 117 | :module: pySim-shell |
| 118 | :func: Iso7816Commands.enable_chv_parser |
Harald Welte | be9516f | 2021-04-03 11:30:10 +0200 | [diff] [blame] | 119 | |
| 120 | |
| 121 | unblock_chv |
| 122 | ~~~~~~~~~~~ |
Harald Welte | d36f694 | 2021-04-04 14:37:55 +0200 | [diff] [blame] | 123 | .. argparse:: |
| 124 | :module: pySim-shell |
| 125 | :func: Iso7816Commands.unblock_chv_parser |
Harald Welte | be9516f | 2021-04-03 11:30:10 +0200 | [diff] [blame] | 126 | |
Harald Welte | be9516f | 2021-04-03 11:30:10 +0200 | [diff] [blame] | 127 | |
| 128 | verify_chv |
| 129 | ~~~~~~~~~~ |
Harald Welte | be9516f | 2021-04-03 11:30:10 +0200 | [diff] [blame] | 130 | This command allows you to verify a CHV (PIN), which is how the specifications call |
| 131 | it if you authenticate yourself with the said CHV/PIN. |
| 132 | |
Harald Welte | d36f694 | 2021-04-04 14:37:55 +0200 | [diff] [blame] | 133 | .. argparse:: |
| 134 | :module: pySim-shell |
| 135 | :func: Iso7816Commands.verify_chv_parser |
| 136 | |
Harald Welte | a463161 | 2021-04-10 18:17:55 +0200 | [diff] [blame] | 137 | deactivate_file |
| 138 | ~~~~~~~~~~~~~~~ |
| 139 | Deactivate the currently selected file. This used to be called INVALIDATE in TS 11.11. |
| 140 | |
| 141 | |
| 142 | activate_file |
| 143 | ~~~~~~~~~~~~~ |
| 144 | Activate the currently selected file. This used to be called REHABILITATE in TS 11.11. |
Harald Welte | be9516f | 2021-04-03 11:30:10 +0200 | [diff] [blame] | 145 | |
Harald Welte | 703f933 | 2021-04-10 18:39:32 +0200 | [diff] [blame] | 146 | open_channel |
| 147 | ~~~~~~~~~~~~ |
| 148 | .. argparse:: |
| 149 | :module: pySim-shell |
| 150 | :func: Iso7816Commands.open_chan_parser |
| 151 | |
| 152 | close_channel |
| 153 | ~~~~~~~~~~~~~ |
| 154 | .. argparse:: |
| 155 | :module: pySim-shell |
| 156 | :func: Iso7816Commands.close_chan_parser |
| 157 | |
Harald Welte | be9516f | 2021-04-03 11:30:10 +0200 | [diff] [blame] | 158 | |
| 159 | pySim commands |
| 160 | -------------- |
| 161 | |
| 162 | Commands in this category are pySim specific; they do not have a 1:1 correspondence to ISO 7816 |
| 163 | or 3GPP commands. Mostly they will operate either only on local (in-memory) state, or execute |
| 164 | a complex sequence of card-commands. |
| 165 | |
| 166 | desc |
| 167 | ~~~~ |
| 168 | |
| 169 | Display human readable file description for the currently selected file. |
| 170 | |
| 171 | |
| 172 | dir |
| 173 | ~~~ |
Harald Welte | d36f694 | 2021-04-04 14:37:55 +0200 | [diff] [blame] | 174 | .. argparse:: |
| 175 | :module: pySim-shell |
| 176 | :func: PySimCommands.dir_parser |
Harald Welte | be9516f | 2021-04-03 11:30:10 +0200 | [diff] [blame] | 177 | |
| 178 | |
| 179 | export |
| 180 | ~~~~~~ |
Harald Welte | d36f694 | 2021-04-04 14:37:55 +0200 | [diff] [blame] | 181 | .. argparse:: |
| 182 | :module: pySim-shell |
| 183 | :func: PySimCommands.export_parser |
| 184 | |
Harald Welte | be9516f | 2021-04-03 11:30:10 +0200 | [diff] [blame] | 185 | |
| 186 | tree |
| 187 | ~~~~ |
Harald Welte | d36f694 | 2021-04-04 14:37:55 +0200 | [diff] [blame] | 188 | FIXME |
| 189 | |
Harald Welte | be9516f | 2021-04-03 11:30:10 +0200 | [diff] [blame] | 190 | |
| 191 | verify_adm |
| 192 | ~~~~~~~~~~ |
Harald Welte | d36f694 | 2021-04-04 14:37:55 +0200 | [diff] [blame] | 193 | FIXME |
Harald Welte | be9516f | 2021-04-03 11:30:10 +0200 | [diff] [blame] | 194 | |
| 195 | |
Harald Welte | daf2b39 | 2021-05-03 23:17:29 +0200 | [diff] [blame] | 196 | reset |
| 197 | ~~~~~ |
| 198 | |
| 199 | Perform card reset and display the card ATR. |
| 200 | |
| 201 | |
Harald Welte | be9516f | 2021-04-03 11:30:10 +0200 | [diff] [blame] | 202 | Linear Fixed EF commands |
| 203 | ------------------------ |
| 204 | |
| 205 | These commands become enabled only when your currently selected file is of *Linear Fixed EF* type. |
| 206 | |
| 207 | read_record |
| 208 | ~~~~~~~~~~~ |
Harald Welte | d36f694 | 2021-04-04 14:37:55 +0200 | [diff] [blame] | 209 | .. argparse:: |
| 210 | :module: pySim.filesystem |
| 211 | :func: LinFixedEF.ShellCommands.read_rec_parser |
| 212 | |
Harald Welte | be9516f | 2021-04-03 11:30:10 +0200 | [diff] [blame] | 213 | |
| 214 | read_record_decoded |
| 215 | ~~~~~~~~~~~~~~~~~~~ |
Harald Welte | d36f694 | 2021-04-04 14:37:55 +0200 | [diff] [blame] | 216 | .. argparse:: |
| 217 | :module: pySim.filesystem |
| 218 | :func: LinFixedEF.ShellCommands.read_rec_dec_parser |
| 219 | |
Harald Welte | be9516f | 2021-04-03 11:30:10 +0200 | [diff] [blame] | 220 | |
Harald Welte | 850b72a | 2021-04-07 09:33:03 +0200 | [diff] [blame] | 221 | read_records |
| 222 | ~~~~~~~~~~~~ |
| 223 | .. argparse:: |
| 224 | :module: pySim.filesystem |
| 225 | :func: LinFixedEF.ShellCommands.read_recs_parser |
| 226 | |
| 227 | |
| 228 | read_records_decoded |
| 229 | ~~~~~~~~~~~~~~~~~~~~ |
| 230 | .. argparse:: |
| 231 | :module: pySim.filesystem |
| 232 | :func: LinFixedEF.ShellCommands.read_recs_dec_parser |
| 233 | |
| 234 | |
Harald Welte | be9516f | 2021-04-03 11:30:10 +0200 | [diff] [blame] | 235 | update_record |
| 236 | ~~~~~~~~~~~~~ |
Harald Welte | d36f694 | 2021-04-04 14:37:55 +0200 | [diff] [blame] | 237 | .. argparse:: |
| 238 | :module: pySim.filesystem |
| 239 | :func: LinFixedEF.ShellCommands.upd_rec_parser |
| 240 | |
Harald Welte | be9516f | 2021-04-03 11:30:10 +0200 | [diff] [blame] | 241 | |
| 242 | update_record_decoded |
| 243 | ~~~~~~~~~~~~~~~~~~~~~ |
Harald Welte | d36f694 | 2021-04-04 14:37:55 +0200 | [diff] [blame] | 244 | .. argparse:: |
| 245 | :module: pySim.filesystem |
| 246 | :func: LinFixedEF.ShellCommands.upd_rec_dec_parser |
Harald Welte | be9516f | 2021-04-03 11:30:10 +0200 | [diff] [blame] | 247 | |
| 248 | |
Harald Welte | 4145d3c | 2021-04-08 20:34:13 +0200 | [diff] [blame] | 249 | edit_record_decoded |
| 250 | ~~~~~~~~~~~~~~~~~~~ |
| 251 | .. argparse:: |
| 252 | :module: pySim.filesystem |
| 253 | :func: LinFixedEF.ShellCommands.edit_rec_dec_parser |
| 254 | |
| 255 | This command will read the selected record, decode it to its JSON representation, save |
| 256 | that JSON to a temporary file on your computer, and launch your configured text editor. |
| 257 | |
| 258 | You may then perform whatever modifications to the JSON representation, save + leave your |
| 259 | text editor. |
| 260 | |
| 261 | Afterwards, the modified JSON will be re-encoded to the binary format, and the result written |
| 262 | back to the record on the SIM card. |
| 263 | |
| 264 | This allows for easy interactive modification of records. |
| 265 | |
| 266 | |
Harald Welte | be9516f | 2021-04-03 11:30:10 +0200 | [diff] [blame] | 267 | |
| 268 | Transparent EF commands |
| 269 | ----------------------- |
| 270 | |
| 271 | These commands become enabled only when your currently selected file is of *Transparent EF* type. |
| 272 | |
| 273 | |
| 274 | read_binary |
| 275 | ~~~~~~~~~~~ |
Harald Welte | d36f694 | 2021-04-04 14:37:55 +0200 | [diff] [blame] | 276 | .. argparse:: |
| 277 | :module: pySim.filesystem |
| 278 | :func: TransparentEF.ShellCommands.read_bin_parser |
| 279 | |
Harald Welte | be9516f | 2021-04-03 11:30:10 +0200 | [diff] [blame] | 280 | |
| 281 | read_binary_decoded |
| 282 | ~~~~~~~~~~~~~~~~~~~ |
Harald Welte | d36f694 | 2021-04-04 14:37:55 +0200 | [diff] [blame] | 283 | .. argparse:: |
| 284 | :module: pySim.filesystem |
| 285 | :func: TransparentEF.ShellCommands.read_bin_dec_parser |
| 286 | |
Harald Welte | be9516f | 2021-04-03 11:30:10 +0200 | [diff] [blame] | 287 | |
| 288 | update_binary |
| 289 | ~~~~~~~~~~~~~ |
Harald Welte | d36f694 | 2021-04-04 14:37:55 +0200 | [diff] [blame] | 290 | .. argparse:: |
| 291 | :module: pySim.filesystem |
| 292 | :func: TransparentEF.ShellCommands.upd_bin_parser |
| 293 | |
Harald Welte | be9516f | 2021-04-03 11:30:10 +0200 | [diff] [blame] | 294 | |
| 295 | update_binary_decoded |
| 296 | ~~~~~~~~~~~~~~~~~~~~~ |
Harald Welte | d36f694 | 2021-04-04 14:37:55 +0200 | [diff] [blame] | 297 | .. argparse:: |
| 298 | :module: pySim.filesystem |
| 299 | :func: TransparentEF.ShellCommands.upd_bin_dec_parser |
Harald Welte | be9516f | 2021-04-03 11:30:10 +0200 | [diff] [blame] | 300 | |
Harald Welte | 0d4e98a | 2021-04-07 00:14:40 +0200 | [diff] [blame] | 301 | In normal operation, update_binary_decoded needs a JSON document representing the entire file contents as |
| 302 | input. This can be inconvenient if you want to keep 99% of the content but just toggle one specific |
| 303 | parameter. That's where the JSONpath support comes in handy: You can specify a JSONpath to an element |
| 304 | inside the document as well as a new value for tat field: |
| 305 | |
| 306 | Th below example demonstrates this by modifying the ofm field within EF.AD: |
| 307 | |
| 308 | :: |
| 309 | |
| 310 | pySIM-shell (MF/ADF.USIM/EF.AD)> read_binary_decoded |
| 311 | { |
| 312 | "ms_operation_mode": "normal", |
| 313 | "specific_facilities": { |
| 314 | "ofm": true |
| 315 | }, |
| 316 | "len_of_mnc_in_imsi": 2 |
| 317 | } |
| 318 | pySIM-shell (MF/ADF.USIM/EF.AD)> update_binary_decoded --json-path specific_facilities.ofm false |
| 319 | pySIM-shell (MF/ADF.USIM/EF.AD)> read_binary_decoded |
| 320 | { |
| 321 | "ms_operation_mode": "normal", |
| 322 | "specific_facilities": { |
| 323 | "ofm": false |
| 324 | }, |
| 325 | "len_of_mnc_in_imsi": 2 |
| 326 | } |
| 327 | |
Harald Welte | be9516f | 2021-04-03 11:30:10 +0200 | [diff] [blame] | 328 | |
Harald Welte | 4145d3c | 2021-04-08 20:34:13 +0200 | [diff] [blame] | 329 | edit_binary_decoded |
| 330 | ~~~~~~~~~~~~~~~~~~~ |
| 331 | This command will read the selected binary EF, decode it to its JSON representation, save |
| 332 | that JSON to a temporary file on your computer, and launch your configured text editor. |
| 333 | |
| 334 | You may then perform whatever modifications to the JSON representation, save + leave your |
| 335 | text editor. |
| 336 | |
| 337 | Afterwards, the modified JSON will be re-encoded to the binary format, and the result written |
| 338 | to the SIM card. |
| 339 | |
| 340 | This allows for easy interactive modification of file contents. |
| 341 | |
Harald Welte | be9516f | 2021-04-03 11:30:10 +0200 | [diff] [blame] | 342 | |
Harald Welte | 917d98c | 2021-04-21 11:51:25 +0200 | [diff] [blame] | 343 | |
| 344 | BER-TLV EF commands |
| 345 | ------------------- |
| 346 | |
| 347 | BER-TLV EFs are files that contain BER-TLV structured data. Every file can contain any number |
| 348 | of variable-length IEs (DOs). The tag within a BER-TLV EF must be unique within the file. |
| 349 | |
| 350 | The commands below become enabled only when your currently selected file is of *BER-TLV EF* type. |
| 351 | |
| 352 | retrieve_tags |
| 353 | ~~~~~~~~~~~~~ |
| 354 | |
| 355 | Retrieve a list of all tags present in the currently selected file. |
| 356 | |
| 357 | |
| 358 | retrieve_data |
| 359 | ~~~~~~~~~~~~~ |
| 360 | .. argparse:: |
| 361 | :module: pySim.filesystem |
| 362 | :func: BerTlvEF.ShellCommands.retrieve_data_parser |
| 363 | |
| 364 | |
| 365 | set_data |
| 366 | ~~~~~~~~ |
| 367 | .. argparse:: |
| 368 | :module: pySim.filesystem |
| 369 | :func: BerTlvEF.ShellCommands.set_data_parser |
| 370 | |
| 371 | |
| 372 | del_data |
| 373 | ~~~~~~~~ |
| 374 | .. argparse:: |
| 375 | :module: pySim.filesystem |
| 376 | :func: BerTlvEF.ShellCommands.del_data_parser |
| 377 | |
| 378 | |
| 379 | |
Harald Welte | 15fae98 | 2021-04-10 10:22:27 +0200 | [diff] [blame] | 380 | USIM commands |
| 381 | ------------- |
| 382 | |
| 383 | authenticate |
| 384 | ~~~~~~~~~~~~ |
| 385 | .. argparse:: |
| 386 | :module: pySim.ts_31_102 |
| 387 | :func: ADF_USIM.AddlShellCommands.authenticate_parser |
| 388 | |
| 389 | |
| 390 | |
Harald Welte | be9516f | 2021-04-03 11:30:10 +0200 | [diff] [blame] | 391 | cmd2 settable parameters |
| 392 | ------------------------ |
| 393 | |
| 394 | ``cmd2`` has the concept of *settable parameters* which act a bit like environment variables in an OS-level |
| 395 | shell: They can be read and set, and they will influence the behavior somehow. |
| 396 | |
| 397 | conserve_write |
| 398 | ~~~~~~~~~~~~~~ |
| 399 | |
| 400 | If enabled, pySim will (when asked to write to a card) always first read the respective file/record and |
| 401 | verify if the to-be-written value differs from the current on-card value. If not, the write will be skipped. |
| 402 | Writes will only be performed if the new value is different from the current on-card value. |
| 403 | |
| 404 | If disabled, pySim will always write irrespective of the current/new value. |
| 405 | |
Harald Welte | 1748b93 | 2021-04-06 21:12:25 +0200 | [diff] [blame] | 406 | json_pretty_print |
| 407 | ~~~~~~~~~~~~~~~~~ |
| 408 | |
| 409 | This parameter determines if generated JSON output should (by default) be pretty-printed (multi-line |
| 410 | output with indent level of 4 spaces) or not. |
| 411 | |
| 412 | The default value of this parameter is 'true'. |
| 413 | |
Harald Welte | be9516f | 2021-04-03 11:30:10 +0200 | [diff] [blame] | 414 | debug |
| 415 | ~~~~~ |
| 416 | |
| 417 | If enabled, full python back-traces will be displayed in case of exceptions |
| 418 | |
Harald Welte | 7829d8a | 2021-04-10 11:28:53 +0200 | [diff] [blame] | 419 | apdu_trace |
| 420 | ~~~~~~~~~~ |
| 421 | |
| 422 | Boolean variable that determines if a hex-dump of the command + response APDU shall be printed. |
| 423 | |
Harald Welte | be9516f | 2021-04-03 11:30:10 +0200 | [diff] [blame] | 424 | numeric_path |
| 425 | ~~~~~~~~~~~~ |
| 426 | |
| 427 | Boolean variable that determines if path (e.g. in prompt) is displayed with numeric FIDs or string names. |
| 428 | |
| 429 | :: |
| 430 | |
| 431 | pySIM-shell (MF/EF.ICCID)> set numeric_path True |
| 432 | numeric_path - was: False |
| 433 | now: True |
| 434 | pySIM-shell (3f00/2fe2)> set numeric_path False |
| 435 | numeric_path - was: True |
| 436 | now: False |
| 437 | pySIM-shell (MF/EF.ICCID)> help set |