aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md35
1 files changed, 32 insertions, 3 deletions
diff --git a/README.md b/README.md
index 597ebd8..86f35ba 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,34 @@
# Shadytel SIM Tools
+This is a version of the Shadytel Shadysim tools modified and enhanced
+for the use with the
+[sysmoUSIM-SJS1 sim cards](https://osmocom.org/projects/cellular-infrastructure/wiki/SysmoUSIM-SJS1)
+
+Contrary to the cards used by the original Shadtyel tools, the
+sysmoUSIM-SJS1 have OTA security enabled and require the use of KIC/KID
+to authenticate + encrypt the PDUs of the Remote Application Management
+(RAM).
+
+## GIT Repository
+
+You can clone from the Osmocom sim-tools.git repository using
+
+ git clone git://git.osmocom.org/sim/sim-tools.git
+
+There is a cgit interface at <http://git.osmocom.org/sim/sim-tools/>
+
+## Mailing List
+
+Discussions related to sim-tools are happening on the
+openbsc@lists.osmocom.org mailing list, please see
+<https://lists.osmocom.org/mailman/listinfo/openbsc> for subscription
+options and the list archive.
+
+Please observe the [Osmocom Mailing List
+Rules](https://osmocom.org/projects/cellular-infrastructure/wiki/Mailing_List_Rules)
+when posting.
+
+
## Creating JavaCard STK Applets
Use the hello-stk example to get started.
@@ -10,7 +39,7 @@ Use the hello-stk example to get started.
$ git clone https://git.osmocom.org/sim/hello-stk
$ cd hello-stk
$ make
-
+
To install the applet onto a SIM card, first set the type of reader you are using.
# For PCSC readers:
@@ -19,8 +48,8 @@ To install the applet onto a SIM card, first set the type of reader you are usin
# For USB-serial readers:
$ export SHADYSIM_OPTIONS="--serialport /dev/ttyUSB0"
-and follow instructions at https://osmocom.org/projects/cellular-infrastructure/wiki/Shadysimpy
-
+and follow instructions at <https://osmocom.org/projects/cellular-infrastructure/wiki/Shadysimpy>
+
The shadysim tool has lots of other options.
$ ./sim-tools/bin/shadysim --help