Files
otaman/README.md
T

13 KiB
Raw Blame History

OTAMan — APDU Helper & Secured Packet Builder, SIM OTA in PWA

Standalone offline HTML/JS tool for building APDU commands for SIM, USIM, and GlobalPlatform RAM, assembling secure packets per ETSI TS 102 225, and constructing BER-TLV command scripts per ETSI TS 102 226.

Open index.html in any modern browser. No server required.

Demo: otaman.atroshin.ru

Build

Tailwind CSS is used for styling. After cloning, rebuild the CSS:

npm install
npm run build

Interface

Six tabs, each with a form and a "Сгенерировать" button.


SIM RFM Tab

CLA = A0 (GSM 11.11 / ISO 7816-4).

Commands

Command INS Description
SELECT A4 Select EF/DF by FID, path, dfname, or chain
UPDATE RECORD DC Update a record in a record-oriented EF
UPDATE BINARY D6 Update binary content at an offset
READ RECORD B2 Read a record
READ BINARY B0 Read binary content
ERASE BINARY 0E Erase binary at an offset
ACTIVATE FILE 44 Activate a file
DEACTIVATE FILE 04 Deactivate a file
VERIFY PIN 20 Verify PIN1 or PIN2
CHANGE PIN 24 Change PIN1 or PIN2

SELECT methods

Method P1 P2 Input
По FID 00 00 2-byte FID (4 hex)
По полному пути от MF 08 00 Full path hex from MF
По DF name / AID 04 00 AID (application ID)
ADF RFM цепочка 00 00 Comma-separated FIDs, each selected in turn

Options

  • Начать с SELECT — checkbox to prepend a SELECT command before the operation. When unchecked, the operation is sent standalone with CLA.
  • Режим выборки (P2) — for record commands: Absolute (04), Next (06), Previous (02).
  • Размер записи — pad/truncate data to the specified byte count.
  • Переопределить P1/P2 — checkbox to enable manual override of P1/P2 bytes.

Conversion sidebar

A conversion panel is embedded in the right-hand column, supporting IMSI, MSISDN, ICCID, SPN, PLMN, and Nibble swap conversions.

References

  • ISO/IEC 7816-4: Organization, security and commands for interchange
  • ETSI TS 102 226: Remote APDU structure for UICC based applications
  • GSM 11.11: SIM-ME Interface

USIM RFM Tab

CLA = 00 (ETSI TS 102 221). Same commands as SIM, but SELECT uses P1=09, P2=0C (by FID from current directory).

References

  • ETSI TS 102 221: UICC-Terminal Interface; Physical and Logical Characteristics
  • ETSI TS 102 226: Remote APDU structure for UICC based applications

BER-TLV Tab

Builds Expanded Remote Application data format per ETSI TS 102 226 §5.2.1.

Format

Two encoding variants:

  • Definite (AA): AA + length + Command TLVs
  • Indefinite (AE): AE + 80 + Command TLVs + 00 00

Command TLVs

Type Tag Description
C-APDU 22 Raw APDU hex
Immediate Action 81 Proactive command or action indicator
Error Action 82 Proactive command on error
Script Chaining 83 Chaining data for multi-packet scripts

Immediate Action builder

When the type is set to Immediate Action, the tool provides a structured builder for:

  • Action indicator: 81 (Proactive session indication) / 82 (Early response)
  • Proactive command: REFRESH, DISPLAY TEXT, or PLAY TONE — with auto-generated COMPREHENSION-TLV data objects (command details, device identities, text string, tone, etc.)
  • Custom hex: freeform input for manual TLV construction

Error Action supports the same builder (DISPLAY TEXT, PLAY TONE).

References

  • ETSI TS 102 226 V13.0.0 §5.2.1: Expanded Remote Application data format
  • ETSI TS 102 223: Card Application Toolkit (CAT) — proactive command structure
  • ETSI TS 101 220: BER-TLV tag assignments

RAM Tab

CLA = 80 (GlobalPlatform Card Specification v2.3.1). Remote Application Management commands for card content management.

Commands

Command INS P1 Description
INSTALL [for load] E6 02 Register a load file for loading
INSTALL [for install] E6 0C Install an application or SD
INSTALL [for make selectable] E6 10 Make an application selectable
INSTALL [for registry update] E6 01 Update registry entries
INSTALL [for extradition] E6 04 Extradition (move between SDs)
LOAD E8 00 Load executable code blocks
DELETE E4 00/80 Delete application or SD
GET STATUS F2 80/40/20/10 Get card status
GET DATA CA tag Read card data objects
STORE DATA E2 00/40/80/C0 Store data (key, certificate, etc.)
SET STATUS F0 80/40/60 Lifecycle state management
EXTERNAL AUTHENTICATE 82 00 SCP host authentication
INTERNAL AUTHENTICATE 88 00 Card challenge-response

INSTALL [for install] — Privilege Builder

Tag C7 in the INSTALL data field. Built from 3 privilege bytes (GP spec Tables 11-7, 11-8, 11-9):

Byte 1 (bits):

Bit Privilege
b8 Security Domain
b7 DAP Verification
b6 Delegated Management
b5 Card Lock
b4 Card Terminate
b3 Card Reset
b2 CVM Management

Byte 2 (bits):

Bit Privilege
b8 Trusted Path
b7 Authorized Management
b6 Token Verification
b5 Global Delete
b4 Global Lock
b3 Global Registry
b2 Final Application

Byte 3 (bits):

Bit Privilege
b8 Receipt Generation

INSTALL [for install] — SIM/UICC Toolkit Parameters

Optional TLV objects appended to the INSTALL data field:

  • Tag CA (SIM Toolkit): Priority, Timers, Text Length, Menu Entries, Menu Positions, Channels, MSL, TAR, Access Domain
  • Tag 80 (UICC Toolkit, inside EA): Same fields minus Access Domain

MSL (Minimum Security Level) — SPI1 byte per TS 102 225:

Value Meaning
00 No check
11 RC/CC/DS
12 RC/DS/CC
15 RC/DS/CC + MAC
16 RC/DS/CC + MAC + Cipher
19 RC/DS/CC + MAC + Cipher + DS

GET STATUS P1 values

Value Meaning
80 Issuer Security Domain (ISD)
40 Applications and Supplementary Security Domains
20 Executable Load Files
10 ELF and their Executable Modules

GET STATUS P2 values

Value Meaning
40 First/all occurrences, GP TLV format (default)
42 Next occurrence, GP TLV format
00 First/all, old format (deprecated)
02 Next, old format (deprecated)

GET DATA tag values

Tag Data Object
42 Issuer Identification Number (IIN)
45 Card Image Number (CIN)
66 Card Data / SD Management Data
67 Card Capability Information
E0 Key Information Template
D3 Current Security Level
2F00 List of Applications (ISO 7816-4)
FF21 Extended Card Resources Info
5F50 SD Manager URL
C1 Sequence Counter (SCP02/03)
C2 Confirmation Counter
7F21 Certificate (SD public key)
5031 Certificate info (EF.OD)

DELETE P1 values

Value Meaning
00 By AID
80 Delete associated objects

STORE DATA P1 values

Value Meaning
00 Last block, no encryption
40 More blocks, no encryption
80 Last block, encrypted
C0 More blocks, encrypted

SET STATUS parameters

P1 (Status Type):

Value Target
80 Issuer Security Domain
40 Application or Supplementary Security Domain
60 Security Domain and its associated Applications

P2 (State):

Value Action
00 Unlock (return to previous state)
80 Lock (LOCKED state)

References

  • GlobalPlatform Card Specification v2.3.1 (GPC_Spec_v2.3.1): Commands, Privileges, TLV structures
  • ETSI TS 102 226 V13.0.0 §8.2.1.3.2: SIM/UICC Toolkit parameters, MSL, TAR, Access Domain

Secured Packet Tab

Assembles secured packets per ETSI TS 102 225.

Packet structure

Field Size Description
CPI 1 Command Packet Identifier (02)
CPL 1 Command Packet Length
CHI 1 Command Header Identifier (01)
CHL 1 Command Header Length
SPI 2 Security Parameter Indicator
KIc 1 Key Identifier for ciphering
KID 1 Key Identifier for MAC
TAR 3 Toolkit Application Reference
CNTR 5 Replay counter
PCNTR 1 Padding counter
RC/CC/DS 8 Cryptographic Checksum / MAC
Secured Data variable Padded APDU (encrypted if required)

SPI1 (Security Level)

Value Security Ciphering Counter
00 None No None
01 RC No None
02 CC/MAC No None
06 CC/MAC Yes None
12 CC/MAC No Available
16 CC/MAC Yes Available
22 CC/MAC No Check higher
26 CC/MAC Yes Check higher
32 CC/MAC No Check +1
36 CC/MAC Yes Check +1

SPI2 (PoR settings)

Value Mode Security Cipher
00 No PoR No
01 PoR required None No
05 PoR required RC No
09 PoR required CC No
0D PoR required DS No
11 PoR required None Yes
02 PoR on error None No
06 PoR on error RC No

Crypto

  • 3DES-CBC encryption (zero ICV), supporting 8, 16, and 24 byte keys
  • Retail MAC (ISO 9797-1 MAC algorithm 3) for cryptographic checksum
  • Padding byte configurable (00 per TS 102 225 default, or FF)

References

  • ETSI TS 102 225 V13.0.0: Secured packet structure for UICC based applications
  • ETSI TS 102 226: Remote APDU structure for UICC based applications
  • ISO 9797-1: MAC algorithms

Conversion (SIM/USIM sidebars)

Value encoding conversions embedded in the SIM RFM and USIM RFM tabs.

IMSI → EF.IMSI

Per TS 31.102 §4.2.3. Encodes a 15-digit IMSI into the 9-byte EF.IMSI format:

  • Byte 0: number of subsequent bytes (8)
  • Odd/even indicator nibble in the last byte
  • BCD digits, swapped nibble pairs per identity

Input: 15 decimal digits. Output: 18 hex characters.

MSISDN → BCD

Strips leading +, pads odd length with f, swaps nibble pairs.

ICCID → hex

Swaps nibble pairs of the ICCID string.

Provider Name → SPN

Per 3GPP TS 31.102 §4.2.5 (EF_SPN). Three encoding paths:

  1. GSM 7-bit packed (all chars in GSM 7-bit default alphabet): prefix 01, DCS byte (spare bits), packed septets, 0xFF padding to 16 bytes.
  2. UCS2 non-BMP (emoji / chars > U+FFFF): prefix 00, DCS 80, UTF-16BE, 0xFF padding to 16 bytes.
  3. UCS2 BMP non-GSM7 (Cyrillic, etc.): prefix 00, DCS 81, base byte, per-char offsets, 0xFF padding to 16 bytes.

GSM 7-bit alphabet per 3GPP TS 23.038. Full extension table supported.

PLMN → EF_PLMNsel / PLMNwAcT

Per TS 31.102 §4.2.3. 3-byte BCD encoding for PLMN, plus optional 2-byte Access Technology selector.

Nibble swap

Swaps nibble pairs of an even-length hex string.

References

  • 3GPP TS 31.102: Characteristics of the USIM Application
  • 3GPP TS 23.038: Alphabets and language information
  • ETSI TS 102 225: Secured packet structure for (U)SIM toolkit
  • pySim: enc_imsi() implementation

Card Reader (pySim integration)

Connects to a local pysim-otaman-server for live card operations.

File Browser

Browse the UICC filesystem in a tree view. Files are shown with names, FIDs, and AIDs (for ADFs). Click to read contents.

  • Read — reads the selected file (auto-detects transparent vs record files)
  • Edit — switch to edit mode, modify hex data, click Save to write back
  • Raw / Decoded — toggle between hex dump and pysim-decoded JSON view

Custom Files

Files not in pysim's model can be added manually:

  1. Switch to the Custom files sub-tab
  2. Enter the file path (e.g., 3F00/6F46) and an alias (e.g., EF.SPN)
  3. Click Add — the file appears in the tree in italics (unverified)
  4. Click the file to verify existence — on success, it behaves like a model file

Custom files persist in localStorage across sessions. Export/import as JSON for sharing.

Command Hints

Type a command name in the pySim command line input. Usage hints appear as a tooltip after 300ms. Command autocomplete suggestions appear above the input.

PWA

OTAMan is a Progressive Web App and can be installed for offline use. Use the INSTALL PWA button in the header, or use the browser's install prompt.

  • Service worker pre-caches all assets on first visit
  • App icons at 192×192 and 512×512

Theme

Dark theme is supported. The app follows the OS preference on first visit, and a manual toggle button (🌙/☀️) at the top-right corner persists the choice in localStorage.

Localisation

The UI is in English with Russian language support. Language is detected from the browser's navigator.language preference. A manual toggle button (EN/RU) in the header persists the choice in localStorage.

Version compatibility

PWA (OTAMan) Server Status
1.x.x 1.x.x Compatible
1.x.x 0.x.x Outdated — update server
1.x.x 2.x.x+ ⚠️ Server newer — update PWA

The PWA checks the server version on connect via GET /api/version and warns if versions are incompatible.