comparison README @ 51:0299c16f2ab1

README: update for current state
author Mychaela Falconia <falcon@freecalypso.org>
date Sun, 21 Mar 2021 08:25:48 +0000
parents f893cdde97a4
children
comparison
equal deleted inserted replaced
50:d73fddc64485 51:0299c16f2ab1
1 This code repository contains current versions of FreeCalypso SIM card 1 This code repository contains current versions of FreeCalypso SIM card
2 manipulation utilities fc-simtool and fc-uicc-tool; the old versions which were 2 manipulation utilities fc-simtool and fc-uicc-tool; the old versions which were
3 previously maintained in freecalypso-hwlab and fc-pcsc-tools Hg repositories 3 previously maintained in freecalypso-hwlab and fc-pcsc-tools Hg repositories
4 are now deprecated and no longer maintained. 4 are now deprecated and no longer maintained.
5 5
6 The present version has been refactored to allow other card communication back 6 What are the tools?
7 ends besides libpcsclite: the tools can now operate on SIM cards that sit inside 7 ===================
8 Calypso phones or development boards (the necessary simagent back end lives in
9 the freecalypso-tools Hg repository), and it would be easy to add support for
10 Phoenix-style serial SIM readers if someone were to either send me one or point
11 me to a place where I can buy one. All libpcsclite compile-time dependencies
12 have been factored out into the pcsc back end; if you don't have a pcsc-lite
13 based reader and don't need that support, you can exclude this back end from
14 your build and thus eliminate that compile-time dependency.
15 8
16 fc-simtool is the utility of primary interest. It speaks the classic GSM 11.11 9 fc-simtool is the utility of primary interest. It speaks the classic GSM 11.11
17 SIM protocol to the card (as opposed to the unwanted-innovation UICC protocol), 10 SIM protocol to the card (as opposed to the unwanted-innovation UICC protocol),
18 and it is intended to be useful to end users of regular operator-issued SIM 11 and it is intended to be useful to end users of regular operator-issued SIM
19 cards without admin privileges. High-level user-friendly commands include 12 cards without admin privileges. High-level user-friendly commands include
20 manipulating PINs and phonebooks; low-level commands allow you to SELECT any 13 manipulating PINs and phonebooks; low-level commands allow you to SELECT any
21 arbitrary file (MF/DF/EF) and to perform READ and UPDATE commands on any EF 14 arbitrary file (MF/DF/EF) and to perform READ and UPDATE commands on any EF
22 (BINARY or RECORD as appropriate) as the card will allow, given your access 15 (BINARY or RECORD as appropriate) as the card will allow, given your access
23 level. We (FreeCalypso core team) are also doing some experiments with 16 level. As the next level up in advanced functionality, if you are working with
24 programmable SIM cards, hoping to some day be able to issue our own SIMs, but 17 a programmable SIM (supported card models are our own FCSIM1 and Sysmocom
25 this work is currently very experimental and not ready for consumption. 18 webshop cards sysmoUSIM-SJS1 and sysmoISIM-SJA2), fc-simtool provides the
19 necessary support for fully programming these SIMs.
26 20
27 fc-uicc-tool is currently a very minimal tool for a few narrow use cases. It 21 fc-uicc-tool is currently a very minimal tool for a few narrow use cases. It
28 implements a small subset of fc-simtool commands (basic low-level ones), but 22 implements a small subset of fc-simtool commands (basic low-level ones), but
29 speaking the new UICC protocol to the card - as well as new SELECT by AID 23 speaking the new UICC protocol to the card - as well as new SELECT by AID
30 commands that are only possible with this new protocol, granting access to ADFs 24 commands that are only possible with this new protocol, granting access to ADFs
31 for USIM and ISIM. The tool's only useful functions right now are (1) testing 25 for USIM and ISIM. The tool's only useful functions right now are (1) testing
32 whether or not a given card has USIM/ISIM functionality present, and (2) 26 whether or not a given card has USIM/ISIM functionality present, and (2)
33 manually exploring the file system under ADF.USIM or ADF.ISIM which cannot be 27 manually exploring the file system under ADF.USIM or ADF.ISIM which cannot be
34 accessed in any other way. fc-uicc-tool does NOT currently replicate any of 28 accessed in any other way. fc-uicc-tool does NOT currently replicate any of
35 the high-level end-user-oriented functionality of fc-simtool! 29 the high-level end-user-oriented functionality of fc-simtool!
30
31 Supported card access methods
32 =============================
33
34 fc-simtool and fc-uicc-tool are high-level protocol tools: they form command
35 APDUs to be sent to the card, but they don't contain any hardware interfacing
36 code - instead the job of actually accessing the card and exchanging APDUs with
37 it is deferred to back end programs. Three card access back ends are included
38 in the FC SIM tools package: one for pcsc-lite, one for serial SIM readers, and
39 one for SIM cards inside Calypso GSM devices.