sim-card
/
pysim
mirror of https://gerrit.osmocom.org/pysim
10
0
Fork 1
Code Issues Releases Wiki Activity
pysim/docs/library.rst

112 lines
2.3 KiB
ReStructuredText
Raw Normal View History

Use sphinx for generating documentation This adds sphinx based documentation generation. For now, this manily renders some introduction and the autodoc-genreated class/method reference from the source code for our libraries. Actual user-level documentation for pySim-{prog,shell,read} remains to be added separately Change-Id: I52603e93c2c129a9e79687da6c534fa56a40a649
2021-04-02 11:38:00 +00:00
pySim library
=============
pySim filesystem abstraction
----------------------------
.. automodule:: pySim.filesystem
:members:
pySim commands abstraction
--------------------------
.. automodule:: pySim.commands
:members:
pySim Transport
---------------
The pySim.transport classes implement specific ways how to
communicate with a SIM card. A "transport" provides ways
to transceive APDUs with the card.
The most commonly used transport uses the PC/SC interface to
utilize a variety of smart card interfaces ("readers").
Transport base class
~~~~~~~~~~~~~~~~~~~~
.. automodule:: pySim.transport
:members:
calypso / OsmocomBB transport
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
fix various typos all over the code Change-Id: Ic8392a951bf94f67b51e35bed95d0e856f7a9250
2021-04-11 08:28:28 +00:00
This allows the use of the SIM slot of an OsmocomBB compatible phone with the TI Calypso chipset,
Use sphinx for generating documentation This adds sphinx based documentation generation. For now, this manily renders some introduction and the autodoc-genreated class/method reference from the source code for our libraries. Actual user-level documentation for pySim-{prog,shell,read} remains to be added separately Change-Id: I52603e93c2c129a9e79687da6c534fa56a40a649
2021-04-02 11:38:00 +00:00
using the L1CTL interface to talk to the layer1.bin firmware on the phone.
.. automodule:: pySim.transport.calypso
:members:
AT-command Modem transport
~~~~~~~~~~~~~~~~~~~~~~~~~~
This transport uses AT commands of a cellular modem in order to get access to the SIM card inserted
in such a modem.
.. automodule:: pySim.transport.modem_atcmd
:members:
PC/SC transport
~~~~~~~~~~~~~~~
PC/SC is the standard API for accessing smart card interfaces
on all major operating systems, including the MS Windows Family,
OS X as well as Linux / Unix OSs.
.. automodule:: pySim.transport.pcsc
:members:
Serial/UART transport
~~~~~~~~~~~~~~~~~~~~~
This transport implements interfacing smart cards via
very simplistic UART readers. These readers basically
wire together the Rx+Tx pins of a RS232 UART, provide
fix various typos all over the code Change-Id: Ic8392a951bf94f67b51e35bed95d0e856f7a9250
2021-04-11 08:28:28 +00:00
a fixed crystal oscillator for clock, and operate the UART
Use sphinx for generating documentation This adds sphinx based documentation generation. For now, this manily renders some introduction and the autodoc-genreated class/method reference from the source code for our libraries. Actual user-level documentation for pySim-{prog,shell,read} remains to be added separately Change-Id: I52603e93c2c129a9e79687da6c534fa56a40a649
2021-04-02 11:38:00 +00:00
at 9600 bps. These readers are sometimes called `Phoenix`.
.. automodule:: pySim.transport.serial
:members:
integrate 'construct' python library 'construct' is a declarative symmetric encoder/decoder for user specified binary formats. It should come in extremely handy in tools like pySim. We start the integration by adding transport methods for transceiving APDUs with built-in encoding of the command data and decoding of the response data. Change-Id: Ibf457aa8b9480a8db5979defcfafd67674303f6c
2021-04-10 15:22:35 +00:00
pySim construct utilities
-------------------------
.. automodule:: pySim.construct
:members:
Introduce new object-oriented TLV parser/decoder/encoder This introduces a new TLV library that heavily builds upon python object oriented concepts. Contrary to classic TLV parsers it doesn't focus on the structure of Tag, Length and binary Value only, but it supports actual decoding/interpretation of the value part into some kind of JSON serializable dict. The latter can be achieved by imperative encode/decode methods, or by using our existing declarative 'construct' based approach. The TLV library supports both BER-TLV and COMPREHENSION-TLV for both nested and non-nested TLV definitions. As an example we include TLV definitions for a number of CAT (Card Application Toolkit) IEs. Change-Id: I7fc1699443bc9d8a4e7cdd2687af9af7cc03c30e
2021-05-24 21:15:54 +00:00
pySim TLV utilities
-------------------
.. automodule:: pySim.tlv
:members:
integrate 'construct' python library 'construct' is a declarative symmetric encoder/decoder for user specified binary formats. It should come in extremely handy in tools like pySim. We start the integration by adding transport methods for transceiving APDUs with built-in encoding of the command data and decoding of the response data. Change-Id: Ibf457aa8b9480a8db5979defcfafd67674303f6c
2021-04-10 15:22:35 +00:00
Use sphinx for generating documentation This adds sphinx based documentation generation. For now, this manily renders some introduction and the autodoc-genreated class/method reference from the source code for our libraries. Actual user-level documentation for pySim-{prog,shell,read} remains to be added separately Change-Id: I52603e93c2c129a9e79687da6c534fa56a40a649
2021-04-02 11:38:00 +00:00
pySim utility functions
-----------------------
.. automodule:: pySim.utils
:members:
pySim exceptions
----------------
.. automodule:: pySim.exceptions
:members:
pySim card_handler
------------------
.. automodule:: pySim.card_handler
:members:
card_key_provider: Documentation with sphinx / autodoc * move existing docs to sphinx / autodoc * add more api documentation * improve wording on some exception strings Change-Id: Ia41e14d643d452d92fc8d3c2fb9c4ac9021402e9
2021-04-03 07:19:11 +00:00
pySim card_key_provider
-----------------------
.. automodule:: pySim.card_key_provider
:members: