From 42b6be87477677fd7c7a241dac88f60294a4082a Mon Sep 17 00:00:00 2001 From: Harald Welte Date: Fri, 17 Mar 2017 18:08:09 +0100 Subject: [PATCH] Update README with general project information and convert to Markdown --- README | 38 ----------------------- README.md | 91 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 91 insertions(+), 38 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index 71081db5..00000000 --- a/README +++ /dev/null @@ -1,38 +0,0 @@ -This utility allows to : - - * Program customizable SIMs. Two modes are possible: - - - one where you specify every parameter manually : - -./pySim-prog.py -n 26C3 -c 49 -x 262 -y 42 -i -s - - - - one where they are generated from some minimal set : - -./pySim-prog.py -n 26C3 -c 49 -x 262 -y 42 -z -j - - With and , the soft will generate - 'predictable' IMSI and ICCID, so make sure you choose them so as not to - conflict with anyone. (for eg. your name as and - 0 1 2 ... for ). - - You also need to enter some parameters to select the device : - -t TYPE : type of card (supersim, magicsim, fakemagicsim or try 'auto') - -d DEV : Serial port device (default /dev/ttyUSB0) - -b BAUD : Baudrate (default 9600) - - * Interact with SIMs from a python interactive shell (ipython for eg :) - -from pySim.transport.serial import SerialSimLink -from pySim.commands import SimCardCommands - -sl = SerialSimLink(device='/dev/ttyUSB0', baudrate=9600) -sc = SimCardCommands(sl) - -sl.wait_for_card() - - # Print IMSI -print sc.read_binary(['3f00', '7f20', '6f07']) - - # Run A3/A8 -print sc.run_gsm('00112233445566778899aabbccddeeff') diff --git a/README.md b/README.md new file mode 100644 index 00000000..9624777e --- /dev/null +++ b/README.md @@ -0,0 +1,91 @@ +pySim-prog - Utility for programmable SIM/USIM-Cards +==================================================== + +This repository contains a Python-language program that can be used +to program (write) certain fields/parameters on so-called programmable +SIM/USIM cards. + +Such SIM/USIM cards are special cards, which - unlike those issued by +regular commercial operators - come with the kind of keys that allow you +to write the files/fields that normally only an operator can program. + +This is useful particularly if you are running your own cellular +network, and want to issue your own SIM/USIM cards for that network. + + +Homepage +-------- + +The official homepage of the project is +http://osmocom.org/projects/pysim/wiki + +GIT Repository +-------------- + +You can clone from the official libosmocore.git repository using + + git clone git://git.osmocom.org/pysim.git + +There is a cgit interface at http://git.osmocom.org/pysim/ + +Mailing List +------------ + +There is no separate mailing list for this project. However, +discussions related to pysim-prog 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. + +Contributing +------------ + +Our coding standards are described at +https://osmocom.org/projects/cellular-infrastructure/wiki/Coding_standards + +We are currently accepting patches by e-mail to the above-mentioned +mailing list. + +Usage +----- + + * Program customizable SIMs. Two modes are possible: + + - one where you specify every parameter manually : + +./pySim-prog.py -n 26C3 -c 49 -x 262 -y 42 -i -s + + + - one where they are generated from some minimal set : + +./pySim-prog.py -n 26C3 -c 49 -x 262 -y 42 -z -j + + With and , the soft will generate + 'predictable' IMSI and ICCID, so make sure you choose them so as not to + conflict with anyone. (for eg. your name as and + 0 1 2 ... for ). + + You also need to enter some parameters to select the device : + -t TYPE : type of card (supersim, magicsim, fakemagicsim or try 'auto') + -d DEV : Serial port device (default /dev/ttyUSB0) + -b BAUD : Baudrate (default 9600) + + * Interact with SIMs from a python interactive shell (ipython for eg :) + +from pySim.transport.serial import SerialSimLink +from pySim.commands import SimCardCommands + +sl = SerialSimLink(device='/dev/ttyUSB0', baudrate=9600) +sc = SimCardCommands(sl) + +sl.wait_for_card() + + # Print IMSI +print sc.read_binary(['3f00', '7f20', '6f07']) + + # Run A3/A8 +print sc.run_gsm('00112233445566778899aabbccddeeff')