| Harald Welte | 94e8735 | 2021-04-02 13:38:00 +0200 | [diff] [blame] | 1 | pySim library |
| 2 | ============= |
| 3 | |
| 4 | pySim filesystem abstraction |
| 5 | ---------------------------- |
| 6 | |
| 7 | .. automodule:: pySim.filesystem |
| 8 | :members: |
| 9 | |
| 10 | pySim commands abstraction |
| 11 | -------------------------- |
| 12 | |
| 13 | .. automodule:: pySim.commands |
| 14 | :members: |
| 15 | |
| 16 | pySim Transport |
| 17 | --------------- |
| 18 | |
| 19 | The pySim.transport classes implement specific ways how to |
| 20 | communicate with a SIM card. A "transport" provides ways |
| 21 | to transceive APDUs with the card. |
| 22 | |
| 23 | The most commonly used transport uses the PC/SC interface to |
| 24 | utilize a variety of smart card interfaces ("readers"). |
| 25 | |
| 26 | Transport base class |
| 27 | ~~~~~~~~~~~~~~~~~~~~ |
| 28 | |
| 29 | .. automodule:: pySim.transport |
| 30 | :members: |
| 31 | |
| 32 | |
| 33 | calypso / OsmocomBB transport |
| 34 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 35 | |
| Harald Welte | c9cdce3 | 2021-04-11 10:28:28 +0200 | [diff] [blame] | 36 | This allows the use of the SIM slot of an OsmocomBB compatible phone with the TI Calypso chipset, |
| Harald Welte | 94e8735 | 2021-04-02 13:38:00 +0200 | [diff] [blame] | 37 | using the L1CTL interface to talk to the layer1.bin firmware on the phone. |
| 38 | |
| 39 | .. automodule:: pySim.transport.calypso |
| 40 | :members: |
| 41 | |
| 42 | |
| 43 | AT-command Modem transport |
| 44 | ~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 45 | |
| 46 | This transport uses AT commands of a cellular modem in order to get access to the SIM card inserted |
| 47 | in such a modem. |
| 48 | |
| 49 | .. automodule:: pySim.transport.modem_atcmd |
| 50 | :members: |
| 51 | |
| 52 | |
| 53 | PC/SC transport |
| 54 | ~~~~~~~~~~~~~~~ |
| 55 | |
| 56 | PC/SC is the standard API for accessing smart card interfaces |
| 57 | on all major operating systems, including the MS Windows Family, |
| 58 | OS X as well as Linux / Unix OSs. |
| 59 | |
| 60 | .. automodule:: pySim.transport.pcsc |
| 61 | :members: |
| 62 | |
| 63 | |
| 64 | Serial/UART transport |
| 65 | ~~~~~~~~~~~~~~~~~~~~~ |
| 66 | |
| 67 | This transport implements interfacing smart cards via |
| 68 | very simplistic UART readers. These readers basically |
| 69 | wire together the Rx+Tx pins of a RS232 UART, provide |
| Harald Welte | c9cdce3 | 2021-04-11 10:28:28 +0200 | [diff] [blame] | 70 | a fixed crystal oscillator for clock, and operate the UART |
| Harald Welte | 94e8735 | 2021-04-02 13:38:00 +0200 | [diff] [blame] | 71 | at 9600 bps. These readers are sometimes called `Phoenix`. |
| 72 | |
| 73 | .. automodule:: pySim.transport.serial |
| 74 | :members: |
| 75 | |
| Harald Welte | e0f9ef1 | 2021-04-10 17:22:35 +0200 | [diff] [blame] | 76 | |
| 77 | pySim construct utilities |
| 78 | ------------------------- |
| 79 | |
| 80 | .. automodule:: pySim.construct |
| 81 | :members: |
| 82 | |
| 83 | |
| Harald Welte | 94e8735 | 2021-04-02 13:38:00 +0200 | [diff] [blame] | 84 | pySim utility functions |
| 85 | ----------------------- |
| 86 | |
| 87 | .. automodule:: pySim.utils |
| 88 | :members: |
| 89 | |
| 90 | pySim exceptions |
| 91 | ---------------- |
| 92 | |
| 93 | .. automodule:: pySim.exceptions |
| 94 | :members: |
| 95 | |
| 96 | pySim card_handler |
| 97 | ------------------ |
| 98 | |
| 99 | .. automodule:: pySim.card_handler |
| 100 | :members: |
| Harald Welte | 9d0f1f0 | 2021-04-03 09:19:11 +0200 | [diff] [blame] | 101 | |
| 102 | pySim card_key_provider |
| 103 | ----------------------- |
| 104 | |
| 105 | .. automodule:: pySim.card_key_provider |
| 106 | :members: |