annotate README @ 93:6041c601304d

fcsim1-mkprov: revert OTA key addition It appears that GrcardSIM2 cards (which is what we got for FCSIM1) do not support OTA after all, contrary to what we were previously led to believe by some tech support emails from Grcard - apparently those support emails and OTA descriptions referred to some other card model(s).
author Mychaela Falconia <falcon@freecalypso.org>
date Wed, 21 Apr 2021 05:38:39 +0000
parents 0299c16f2ab1
children
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
51
0299c16f2ab1 README: update for current state
Mychaela Falconia <falcon@freecalypso.org>
parents: 22
diff changeset
6 What are the tools?
0299c16f2ab1 README: update for current state
Mychaela Falconia <falcon@freecalypso.org>
parents: 22
diff changeset
7 ===================
22
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
8
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
9 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
10 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
11 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
12 cards without admin privileges. High-level user-friendly commands include
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
13 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
14 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
15 (BINARY or RECORD as appropriate) as the card will allow, given your access
51
0299c16f2ab1 README: update for current state
Mychaela Falconia <falcon@freecalypso.org>
parents: 22
diff changeset
16 level. As the next level up in advanced functionality, if you are working with
0299c16f2ab1 README: update for current state
Mychaela Falconia <falcon@freecalypso.org>
parents: 22
diff changeset
17 a programmable SIM (supported card models are our own FCSIM1 and Sysmocom
0299c16f2ab1 README: update for current state
Mychaela Falconia <falcon@freecalypso.org>
parents: 22
diff changeset
18 webshop cards sysmoUSIM-SJS1 and sysmoISIM-SJA2), fc-simtool provides the
0299c16f2ab1 README: update for current state
Mychaela Falconia <falcon@freecalypso.org>
parents: 22
diff changeset
19 necessary support for fully programming these SIMs.
22
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
20
f893cdde97a4 updated top-level README added
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
21 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
22 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
23 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
24 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
25 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
26 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
27 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
28 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
29 the high-level end-user-oriented functionality of fc-simtool!
51
0299c16f2ab1 README: update for current state
Mychaela Falconia <falcon@freecalypso.org>
parents: 22
diff changeset
30
0299c16f2ab1 README: update for current state
Mychaela Falconia <falcon@freecalypso.org>
parents: 22
diff changeset
31 Supported card access methods
0299c16f2ab1 README: update for current state
Mychaela Falconia <falcon@freecalypso.org>
parents: 22
diff changeset
32 =============================
0299c16f2ab1 README: update for current state
Mychaela Falconia <falcon@freecalypso.org>
parents: 22
diff changeset
33
0299c16f2ab1 README: update for current state
Mychaela Falconia <falcon@freecalypso.org>
parents: 22
diff changeset
34 fc-simtool and fc-uicc-tool are high-level protocol tools: they form command
0299c16f2ab1 README: update for current state
Mychaela Falconia <falcon@freecalypso.org>
parents: 22
diff changeset
35 APDUs to be sent to the card, but they don't contain any hardware interfacing
0299c16f2ab1 README: update for current state
Mychaela Falconia <falcon@freecalypso.org>
parents: 22
diff changeset
36 code - instead the job of actually accessing the card and exchanging APDUs with
0299c16f2ab1 README: update for current state
Mychaela Falconia <falcon@freecalypso.org>
parents: 22
diff changeset
37 it is deferred to back end programs. Three card access back ends are included
0299c16f2ab1 README: update for current state
Mychaela Falconia <falcon@freecalypso.org>
parents: 22
diff changeset
38 in the FC SIM tools package: one for pcsc-lite, one for serial SIM readers, and
0299c16f2ab1 README: update for current state
Mychaela Falconia <falcon@freecalypso.org>
parents: 22
diff changeset
39 one for SIM cards inside Calypso GSM devices.