diff --git a/README.md b/README.md index 3ea2a16..dee4d89 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ GSMTAP into this analyser. ![SIMtrace Analyser UI](frontend.png) -![Capture and analysis: simtrace2-pysniff (SIMtrace2 hardware) and sigrok_iso7816_stream (FX2) stream GSMTAP-SIM to the UDP :4729 listener; alternatively the server reads SIMtrace2 hardware directly over USB, and PCAP/COMPRION traces are imported from files; simtrace-analyser-server decodes and stores the traffic in SQLite and serves the web UI](architecture_en.svg) +![Capture and analysis: SIMtrace2 hardware is read by simtrace2-pysniff or the original simtrace2-sniff, and FX2 hardware by the sigrok_iso7816_stream decoder; the sniffers and the decoder stream GSMTAP-SIM to the UDP :4729 listener. The server can also read SIMtrace2 hardware directly over USB with the bundled pysniff code in-process, and imports PCAP/COMPRION traces from files. simtrace-analyser-server decodes and stores the traffic in SQLite and serves the web UI](architecture_en.svg) ## Prerequisites @@ -115,9 +115,11 @@ simtrace-analyser-server --capture gsmtap Open **http://127.0.0.1:8081/** in a browser. `Ctrl+C` stops the server. - `--capture gsmtap` (default) — listen for GSMTAP-SIM on UDP 4729, e.g. from - `simtrace2-pysniff` or `sigrok_iso7816_stream`; -- `--capture direct` — read SIMtrace2 hardware directly (needs PyUSB; Windows - also needs the driver swap, see [USB Device Access](#usb-device-access)); + `simtrace2-pysniff`, the original `simtrace2-sniff` or + `sigrok_iso7816_stream`; +- `--capture direct` — read SIMtrace2 hardware directly (the bundled sniffer + code runs inside the server and talks to the device over USB; needs PyUSB; + Windows also needs the driver swap, see [USB Device Access](#usb-device-access)); - `--capture disabled` — only browse stored captures. The full runtime guide (server options, the UI views, the capture utility) is @@ -133,10 +135,12 @@ bundled into the package on install) on the same origin. Three capture modes: ```sh -# Listen for GSMTAP from simtrace2-pysniff (or original simtrace2-sniff): +# Listen for GSMTAP from simtrace2-pysniff, the original simtrace2-sniff or +# sigrok_iso7816_stream: simtrace-analyser-server --capture gsmtap -# Capture directly from SIMtrace2 hardware (no external tool needed): +# Capture directly from SIMtrace2 hardware (the bundled sniffer code reads the +# device; no external tool, no GSMTAP): simtrace-analyser-server --capture direct # Browse/analyse existing captures without a capture backend: diff --git a/README_RUS.md b/README_RUS.md index b326965..61b7d89 100644 --- a/README_RUS.md +++ b/README_RUS.md @@ -13,7 +13,7 @@ SIM/UICC из UDP-потока GSMTAP (или импортирует файлы ![Интерфейс SIMtrace Analyser](frontend.png) -![Захват и анализ: simtrace2-pysniff (оборудование SIMtrace2) и sigrok_iso7816_stream (FX2) передают GSMTAP-SIM слушателю UDP :4729; альтернативно сервер читает оборудование SIMtrace2 напрямую по USB, а PCAP/трассы COMPRION импортируются из файлов; simtrace-analyser-server декодирует и сохраняет трафик в SQLite и раздаёт веб-интерфейс](architecture_ru.svg) +![Захват и анализ: оборудование SIMtrace2 читает simtrace2-pysniff или оригинальный simtrace2-sniff, а оборудование FX2 — декодер sigrok_iso7816_stream; оба источника передают GSMTAP-SIM слушателю UDP :4729. Сервер также может читать оборудование SIMtrace2 напрямую по USB встроенным кодом pysniff внутри сервера и импортирует трассы PCAP/COMPRION из файлов. simtrace-analyser-server декодирует и сохраняет трафик в SQLite и раздаёт веб-интерфейс](architecture_ru.svg) ## Требования @@ -117,9 +117,11 @@ simtrace-analyser-server --capture gsmtap сервер. - `--capture gsmtap` (по умолчанию) — слушать GSMTAP-SIM на UDP 4729, - например от `simtrace2-pysniff` или `sigrok_iso7816_stream`; -- `--capture direct` — читать оборудование SIMtrace2 напрямую (нужен PyUSB; в - Windows также нужна замена драйвера, см. + например от `simtrace2-pysniff`, оригинального `simtrace2-sniff` или + `sigrok_iso7816_stream`; +- `--capture direct` — читать оборудование SIMtrace2 напрямую (встроенный код + сниффера работает внутри сервера и обращается к устройству по USB; нужен + PyUSB; в Windows также нужна замена драйвера, см. [Доступ к USB-устройству](#доступ-к-usb-устройству)); - `--capture disabled` — только просмотр сохранённых захватов. @@ -136,10 +138,12 @@ simtrace-analyser-server --capture gsmtap Три режима захвата: ```sh -# Слушать GSMTAP от simtrace2-pysniff (или оригинального simtrace2-sniff): +# Слушать GSMTAP от simtrace2-pysniff, оригинального simtrace2-sniff +# или sigrok_iso7816_stream: simtrace-analyser-server --capture gsmtap -# Захват напрямую с оборудования SIMtrace2 (внешний инструмент не нужен): +# Захват напрямую с оборудования SIMtrace2 (встроенный код сниффера читает +# устройство; внешний инструмент и GSMTAP не нужны): simtrace-analyser-server --capture direct # Просмотр/анализ существующих записей без бэкенда захвата: diff --git a/architecture_en.svg b/architecture_en.svg index 4668e10..2338fbf 100644 --- a/architecture_en.svg +++ b/architecture_en.svg @@ -1,7 +1,7 @@ SIMtrace Analyser: capture and analysis - simtrace2-pysniff (SIMtrace2 hardware) and sigrok_iso7816_stream (FX2 logic analyzer) stream GSMTAP-SIM to the listener on UDP :4729; alternatively the server reads SIMtrace2 hardware directly over USB, and PCAP/COMPRION traces are imported from files. simtrace-analyser-server decodes and stores the traffic in SQLite and serves the web UI. + SIMtrace2 hardware is read by simtrace2-pysniff (bundled) or the original simtrace2-sniff, and FX2 hardware by the sigrok_iso7816_stream decoder; the sniffers and the decoder stream GSMTAP-SIM to the listener on UDP :4729. The server can also read SIMtrace2 hardware directly over USB with the bundled sniffer code, and imports PCAP/COMPRION traces from files. simtrace-analyser-server decodes and stores the traffic in SQLite and serves the web UI. @@ -10,45 +10,63 @@ capture → analyse - - simtrace2-pysniff - SIMtrace2 hardware + + + SIMtrace2 hardware + Osmocom USB sniffer - - sigrok_iso7816_stream - FX2 logic analyzer + + FX2 logic analyzer + Saleae clone - - + + - - SIMtrace2 hardware - direct USB + + + SIMtrace2 sniffers + simtrace2-pysniff + simtrace2-sniff (Osmocom) - - GSMTAP UDP :4729 - listener + + sigrok_iso7816_stream + decoder - - PCAP / COMPRION import - files + + - - - + + + GSMTAP UDP :4729 + listener - - simtrace-analyser-server - decodes · stores + + + PCAP / COMPRION + import from files - - + + - - SQLite - sessions.db + + + direct USB + pysniff code in-process - - Browser (web UI) - installable PWA + + + simtrace-analyser-server + decodes · stores + + + + + + + SQLite + sessions.db + + + Browser (web UI) + installable PWA diff --git a/architecture_ru.svg b/architecture_ru.svg index a2aa4bf..57750c0 100644 --- a/architecture_ru.svg +++ b/architecture_ru.svg @@ -1,7 +1,7 @@ SIMtrace Analyser: захват и анализ - simtrace2-pysniff (оборудование SIMtrace2) и sigrok_iso7816_stream (логический анализатор FX2) передают GSMTAP-SIM слушателю UDP :4729; альтернативно сервер читает оборудование SIMtrace2 напрямую по USB, а PCAP/трассы COMPRION импортируются из файлов. simtrace-analyser-server декодирует и сохраняет трафик в SQLite и раздаёт веб-интерфейс. + Оборудование SIMtrace2 читает simtrace2-pysniff (входит в комплект) или оригинальный simtrace2-sniff, а оборудование FX2 — декодер sigrok_iso7816_stream; оба источника передают GSMTAP-SIM слушателю UDP :4729. Сервер также может читать оборудование SIMtrace2 напрямую по USB встроенным кодом сниффера и импортирует трассы PCAP/COMPRION из файлов. simtrace-analyser-server декодирует и сохраняет трафик в SQLite и раздаёт веб-интерфейс. @@ -10,45 +10,63 @@ захват → анализ - - simtrace2-pysniff - оборудование SIMtrace2 + + + Оборудование SIMtrace2 + USB-сниффер Osmocom - - sigrok_iso7816_stream - логический анализатор FX2 + + Логический анализатор FX2 + клон Saleae - - + + - - Оборудование SIMtrace2 - прямой USB + + + Снифферы SIMtrace2 + simtrace2-pysniff + simtrace2-sniff (Osmocom) - - GSMTAP UDP :4729 - слушатель + + sigrok_iso7816_stream + декодер - - Импорт PCAP / COMPRION - файлы + + - - - + + + GSMTAP UDP :4729 + слушатель - - simtrace-analyser-server - декодирует · сохраняет + + + Импорт PCAP / COMPRION + из файлов - - + + - - SQLite - sessions.db + + + прямой USB + код pysniff внутри сервера - - Браузер (веб-интерфейс) - устанавливаемое PWA + + + simtrace-analyser-server + декодирует · сохраняет + + + + + + + SQLite + sessions.db + + + Браузер (веб-интерфейс) + устанавливаемое PWA