智能家居>> pysim>> 返回
项目作者： osmocom

项目描述 ：
A python tool to program SIMs / USIMs / ISIMs
高级语言： Python
项目地址: git://github.com/osmocom/pysim.git
创建时间： 2016-01-18T08:48:09Z
项目社区：https://github.com/osmocom/pysim
开源协议：GNU General Public License v2.0
下载


pySim - Tools for reading, decoding, browsing SIM/USIM/ISIM/HPSIM/eUICC Cards

This repository contains a number of Python programs related to working with
subscriber identity modules of cellular networks, including but not limited
to SIM, UICC, USIM, ISIM, HPSIMs and eUICCs.

  • pySim-shell.py can be used to interactively explore, read and decode contents
    of any of the supported card models / card applications. Furthermore, if
    you have the credentials to your card (ADM PIN), you can also write to the card,
    i.e. edit its contents.
  • pySim-read.py and pySim-prog.py are legacy tools for batch programming
    some very common parameters to an entire batch of programmable cards
  • pySim-trace.py is a tool to do an in-depth decode of SIM card protocol traces
    such as those obtained by Osmocom SIMtrace2
    or osmo-qcdiag.
  • osmo-smdpp.py is a proof-of-concept GSMA SGP.22 Consumer eSIM SM-DP+ for lab/research
  • there are more related tools, particularly in the contrib directory.

Note that the access control configuration of normal production cards
issue by operators will restrict significantly which files a normal
user can read, and particularly write to.

The full functionality of pySim hence can only be used with on so-called
programmable SIM/USIM/ISIM/HPSIM cards, such as the various
sysmocom programmable card products.

Such SIM/USIM/ISIM/HPSIM 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 configure your own SIM/USIM/ISIM/HPSIM cards for
that network.

Homepage

Please visit the official homepage
for usage instructions, manual and examples.

Documentation

The pySim user manual can be built from this very source code by means
of sphinx (with sphinxcontrib-napoleon and sphinx-argparse). See the
Makefile in the ‘docs’ directory.

A pre-rendered HTML user manual of the current pySim ‘git master’ is
available from https://downloads.osmocom.org/docs/latest/pysim and
a downloadable PDF version is published at
https://downloads.osmocom.org/docs/latest/osmopysim-usermanual.pdf.

A slightly dated video presentation about pySim-shell can be found at
https://media.ccc.de/v/osmodevcall-20210409-laforge-pysim-shell.

pySim-shell vs. legacy tools

While you will find a lot of online resources still describing the use of
pySim-prog.py and pySim-read.py, those tools are considered legacy by
now and have by far been superseded by the much more capable
pySim-shell.py. We strongly encourage users to adopt pySim-shell, unless
they have very specific requirements like batch programming of large
quantities of cards, which is about the only remaining use case for the
legacy tools.

Git Repository

You can clone from the official Osmocom git repository using

  1. git clone https://gitea.osmocom.org/sim-card/pysim.git

There is a web interface at https://gitea.osmocom.org/sim-card/pysim.

Installation

Please install the following dependencies:

  • bidict
  • cmd2 >= 1.5.0
  • colorlog
  • construct >= 2.9.51
  • pyosmocom
  • jsonpath-ng
  • packaging
  • pycryptodomex
  • pyscard
  • pyserial
  • pytlv
  • pyyaml >= 5.1
  • smpp.pdu (from github.com/hologram-io/smpp.pdu)
  • termcolor

Example for Debian:

  1. sudo apt-get install --no-install-recommends \
  2.     pcscd libpcsclite-dev \
  3.     python3 \
  4.     python3-setuptools \
  5.     python3-pycryptodome \
  6.     python3-pyscard \
  7.     python3-pip
  8. pip3 install --user -r requirements.txt

After installing all dependencies, the pySim applications pySim-read.py, pySim-prog.py and pySim-shell.py may be started directly from the cloned repository.

In addition to the dependencies above pySim-trace.py requires tshark and the python package pyshark to be installed. It is known that the tshark package
in Debian versions before 11 may not work with pyshark.

Archlinux Package

Archlinux users may install the package python-pysim-git

from the Arch User Repository (AUR).
The most convenient way is the use of an AUR Helper,
e.g. yay or pacaur.
The following example shows the installation with yay.

  1. # Install
  2. yay -Sy python-pysim-git
  4. # Uninstall
  5. sudo pacman -Rs python-pysim-git

Forum

We welcome any pySim related discussions in the
SIM Card Technology
section of the osmocom discourse (web based Forum).

Mailing List

There is no separate mailing list for this project. However,
discussions related to pySim are happening on the simtrace
simtrace@lists.osmocom.org mailing list, please see
https://lists.osmocom.org/mailman/listinfo/simtrace for subscription
options and the list archive.

Please observe the Osmocom Mailing List
Rules
when posting.

Issue Tracker

We use the issue tracker of the pysim project on osmocom.org for
tracking the state of bug reports and feature requests. Feel free to submit any issues you may find, or help
us out by resolving existing issues.

Contributing

Our coding standards are described at
https://osmocom.org/projects/cellular-infrastructure/wiki/Coding_standards

We are using a gerrit-based patch review process explained at
https://osmocom.org/projects/cellular-infrastructure/wiki/Gerrit