annotate README @ 22:f893cdde97a4

updated top-level README added
author Mychaela Falconia <falcon@freecalypso.org>
date Sun, 14 Mar 2021 08:20:20 +0000
parents
children 0299c16f2ab1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
22
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
1 This code repository contains current versions of FreeCalypso SIM card
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
2 manipulation utilities fc-simtool and fc-uicc-tool; the old versions which were
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
3 previously maintained in freecalypso-hwlab and fc-pcsc-tools Hg repositories
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
4 are now deprecated and no longer maintained.
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
5
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
6 The present version has been refactored to allow other card communication back
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
7 ends besides libpcsclite: the tools can now operate on SIM cards that sit inside
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
8 Calypso phones or development boards (the necessary simagent back end lives in
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
9 the freecalypso-tools Hg repository), and it would be easy to add support for
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
10 Phoenix-style serial SIM readers if someone were to either send me one or point
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
11 me to a place where I can buy one. All libpcsclite compile-time dependencies
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
12 have been factored out into the pcsc back end; if you don't have a pcsc-lite
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
13 based reader and don't need that support, you can exclude this back end from
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
14 your build and thus eliminate that compile-time dependency.
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
15
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
16 fc-simtool is the utility of primary interest. It speaks the classic GSM 11.11
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
17 SIM protocol to the card (as opposed to the unwanted-innovation UICC protocol),
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
18 and it is intended to be useful to end users of regular operator-issued SIM
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
19 cards without admin privileges. High-level user-friendly commands include
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
20 manipulating PINs and phonebooks; low-level commands allow you to SELECT any
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
21 arbitrary file (MF/DF/EF) and to perform READ and UPDATE commands on any EF
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
22 (BINARY or RECORD as appropriate) as the card will allow, given your access
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
23 level. We (FreeCalypso core team) are also doing some experiments with
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
24 programmable SIM cards, hoping to some day be able to issue our own SIMs, but
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
25 this work is currently very experimental and not ready for consumption.
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
26
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
27 fc-uicc-tool is currently a very minimal tool for a few narrow use cases. It
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
28 implements a small subset of fc-simtool commands (basic low-level ones), but
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
29 speaking the new UICC protocol to the card - as well as new SELECT by AID
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
30 commands that are only possible with this new protocol, granting access to ADFs
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
31 for USIM and ISIM. The tool's only useful functions right now are (1) testing
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
32 whether or not a given card has USIM/ISIM functionality present, and (2)
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
33 manually exploring the file system under ADF.USIM or ADF.ISIM which cannot be
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
34 accessed in any other way. fc-uicc-tool does NOT currently replicate any of
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
35 the high-level end-user-oriented functionality of fc-simtool!