ospab
/
ostp
mirror of https://github.com/ospab/ostp.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: simplify README and fix keep-alive/config validation

This commit is contained in:
ospab 2026-05-16 19:05:09 +03:00
parent dcb3c1c5e4
commit acf81527b6
3 changed files with 76 additions and 164 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

124
README.md
View File

@ -1,145 +1,93 @@
# OSTP (Ospab Stealth Transport Protocol) # OSTP (Ospab Stealth Transport Protocol)
OSTP is a high-throughput, robust, and multiplexed transport protocol engineered for secure, distributed industrial telemetry replication and real-time metric synchronization over unreliable, lossy networks. By implementing granular keystream scrambling and adaptive block framing, OSTP ensures absolute structural integrity and uniform entropy across all transmitted grid data, eliminating distinct traffic signatures and protecting assets against unauthorized analysis. OSTP is a simple and fast tunnel protocol designed to bypass network restrictions. It hides your traffic and makes it look like random noise, making it hard to block.
--- ---
## Industrial Architecture ## Main Features
The pipeline utilizes a highly optimized modular framework: - **Traffic Masking**: Hides your data so it doesn't look like a VPN or proxy.
- **ostp-core**: The foundational grid synchronization library hosting core transport primitives, keystream scrambling pipelines, Noise Protocol Framework cryptography, and zero-copy framed processing. - **Fast & Reliable**: Works well on unstable networks (like mobile data).
- **ostp**: The consolidated cross-platform node daemon configured either as a telemetry collector (`server`) or relay bridge (`client`). - **Easy Setup**: Simple config files and one-click installers.
- **ostp-jni**: Consolidated bindings allowing secure deployment of telemetry nodes across Android-embedded field equipment. - **Universal**: Works on Windows, Linux, and Android.
- **SOCKS5/HTTP**: Supports standard proxy modes.
- **TUN Mode**: Can act as a full VPN for your entire system.
--- ---
## Feature Specification ## Quick Install
- **Keystream Scrambling (Entropy Masking)**: Internal packet fields are processed via high-entropy masking derived dynamically per session, ensuring absolute payload uniformity. This makes active traffic fully transparent to statistical network analyzers.
- **Persistent Connection Multiplexing**: Enables high-fidelity continuous data channels, supporting parallel session structures and maintaining state persistence across volatile network interface rotations.
- **Resilient Network Handoff**: Automatically detects and preserves active TCP pipelines when node endpoints experience topological shifts (e.g., cellular to fiber gateways) without interrupting upper-tier protocols.
- **Pre-Shared Cryptographic Handshake**: Employs `Noise_NNpsk0_25519_ChaChaPoly_BLAKE2s` to validate remote nodes, establishing authentic channels instantly with post-quantum grade forward secrecy.
- **Gateway Routing Protocol Support**: Standard dual-mode interfaces for legacy application routing via industrial SOCKS5/HTTP-CONNECT translation models.
- **Static/Adaptive Block Shaping**: Eliminates behavioral data leaks through cryptographically randomized block-alignment schemes to maintain constant channel densities.
---
## Provisioning and Configuration
### Automated Linux Host Deployment
For rapid, interactive provisioning on standard Linux host environments (x64/ARM), execute the unified installer via a single command:
### Linux (Server or Client)
Run this command to install OSTP and set it up as a service:
```bash ```bash
bash <(curl -Ls https://raw.githubusercontent.com/ospab/ostp/master/scripts/install.sh) bash <(curl -Ls https://raw.githubusercontent.com/ospab/ostp/master/scripts/install.sh)
``` ```
*This routine autonomously fetches the correct stable release, registers a resilient systemd daemon, protects active user credentials during upgrades, and provides an interactive node setup.* ### Windows (Client)
Run this in **PowerShell as Administrator**:
### Automated Windows Host Deployment
To perform quick installations, automated hot-swap updates, and set up global environment routes on Windows (x64/ARM64), run the following one-liner from an **elevated PowerShell console** (Run as Administrator):
```powershell ```powershell
irm https://raw.githubusercontent.com/ospab/ostp/master/scripts/install.ps1 | iex irm https://raw.githubusercontent.com/ospab/ostp/master/scripts/install.ps1 | iex
``` ```
*This native script deploys the runtime directly to `C:\opt\ostp`, performs dynamic JSON template integrations, transparently handles active binary locks, and maps the node to the system environment PATH.* ---
### Manual Node Initialization ## How to Use
The consolidated `ostp` daemon automates node certificate generation and base configuration templating. The `ostp` program can work in two modes: **Server** (on your VPS) and **Client** (on your local computer).
**Provision Collector Node (Server):** ### 1. Create a Config File
Run the program with the `--init` flag to generate a template:
**On Server:**
```bash ```bash
./ostp --init server ./ostp --init server
``` ```
*This provisions `config.json` bound to an automated listening grid port with randomized secure node validation keys.*
**Provision Relay Node (Client):** **On Client:**
```bash ```bash
./ostp --init client ./ostp --init client
``` ```
### Node Integration Config ### 2. Configure
Configuration parameters are defined within `config.json` aligned adjacent to the service binary. #### Server (`config.json`)
#### Telemetry Collector Configuration (`config.json`)
```json ```json
{ {
"mode": "server", "mode": "server",
"listen": "0.0.0.0:50000", "listen": "0.0.0.0:50000",
"access_keys": [ "access_keys": [
"secure_node_registration_key_here" "your-secret-key-here"
], ]
"debug": false
} }
``` ```
#### Relay Bridge Configuration (`config.json`) #### Client (`config.json`)
```json ```json
{ {
"mode": "client", "mode": "client",
"server": "COLLECTOR_ENDPOINT_IP:50000", "server": "YOUR_SERVER_IP:50000",
"access_key": "secure_node_registration_key_here", "access_key": "your-secret-key-here",
"socks5_bind": "127.0.0.1:1088", "socks5_bind": "127.0.0.1:1088",
"tun": { "tun": {
"enable": false, "enable": false
"wintun_path": "./wintun.dll",
"ipv4_address": "10.1.0.2/24"
},
"exclude": {
"domains": [
"internal-system.lan",
"local.lan"
],
"ips": [
"192.168.1.0/24",
"10.0.0.0/8"
],
"processes": [
"local_monitoring.exe"
]
},
"mux": {
"enabled": true,
"sessions": 2
} }
} }
``` ```
> [!IMPORTANT] ### 3. Start
> **TUN Mode & Privileges** Run the program using your config:
> To route all global operating system traffic through OSTP, change `"enable": false` to `true` in the `tun` object.
> - **Windows**: Requires running `ostp` as Administrator. The pre-packaged `tun2socks.exe` dependency must be located next to the `ostp` binary.
> - **Linux**: Requires running `ostp` as root. The `tun2socks` and `iproute2` packages must be available in the system PATH or alongside the binary.
### Execution Parameters
Initiate telemetry processing by assigning the active configuration target:
```bash ```bash
./ostp --config config.json ./ostp --config config.json
``` ```
--- ---
## Operation & Reliability Metrics ## TUN Mode (VPN for whole system)
To route all your traffic through OSTP, set `"enable": true` in the `tun` section of your client config.
### Stream Multiplexing (Mux) - **Windows**: Requires Administrator rights.
> [!IMPORTANT] - **Linux**: Requires Root rights.
> **Parallel multiplexing is fully supported.**
> The pipeline executes parallel handshake processes seamlessly, routing independent stream structures via separate cryptographic tunnels to maximize throughput.
### Exclusion Engines (Bypass Modules)
> [!NOTE]
> Real-time exclusion engines are fully operational. Configured IP subnets, local domains, and internal processes correctly route traffic natively to prevent local loop latencies.
--- ---
## License ## License
OSTP is licensed under the Business Source License 1.1. It is free for personal and non-commercial use. It becomes MIT License on May 14, 2030.
OSTP is published under the Business Source License 1.1 (BSL), permitting unrestricted personal, non-commercial, and private utility deployments. This license automatically transitions to the permissive MIT License on May 14, 2030.
For full licensing terms, refer to the accompanying [LICENSE](LICENSE) file or the official repository at [https://github.com/ospab/ostp](https://github.com/ospab/ostp).

116
README.ru.md
View File

@ -1,129 +1,93 @@
# OSTP (Ospab Stealth Transport Protocol) # OSTP (Ospab Stealth Transport Protocol)
OSTP — это высокопроизводительный, надежный мультиплексируемый транспортный протокол, спроектированный для безопасной распределенной репликации промышленной телеметрии и синхронизации системных метрик реального времени в условиях нестабильных и зашумленных сетей передачи данных. За счет применения матричного маскирования сигнатурных потоков и адаптивного выравнивания границ блоков, OSTP гарантирует абсолютную структурную однородность и равномерную энтропию передаваемых данных, исключая появление статистических отпечатков трафика и защищая инфраструктуру от несанкционированного анализа. OSTP — это простой и быстрый протокол для создания защищенных туннелей и обхода сетевых ограничений. Он маскирует ваш трафик под случайный шум, что делает его крайне сложным для блокировки.
--- ---
## Архитектура системы ## Основные возможности
Платформа построена на базе высокооптимизированного модульного каркаса: - **Маскировка трафика**: Скрывает данные, делая их непохожими на VPN или прокси.
- **ostp-core**: Базовая библиотека синхронизации, обеспечивающая логику транспорта, алгоритмы маскирования энтропии, криптографическую обвязку на базе Noise Protocol Framework и потоковую обработку без копирования данных. - **Скорость и надежность**: Отлично работает на нестабильных сетях (например, мобильный интернет).
- **ostp**: Унифицированный кроссплатформенный демон сетевого узла, конфигурируемый либо в режиме сборщика телеметрии (`server`), либо в режиме моста ретрансляции (`client`). - **Простая настройка**: Понятные конфиги и установка одной командой.
- **ostp-jni**: Готовые связки для встраивания и развертывания сетевых узлов на базе оборудования под управлением ОС Android. - **Универсальность**: Работает на Windows, Linux и Android.
- **SOCKS5/HTTP**: Поддерживает стандартные режимы прокси.
- **TUN режим**: Работает как полноценный VPN для всей системы.
--- ---
## Технические спецификации ## Быстрая установка
- **Маскирование энтропии (Скрытие сигнатур)**: Внутренние поля пакетов проходят динамическую высокоэнтропийную потоковую обработку на каждом сеансе связи, обеспечивая предельную однородность трафика. Это делает сетевые потоки невидимыми для автоматических анализаторов топологии.
- **Стойкое мультиплексирование соединений**: Организует параллельные логические каналы передачи данных, поддерживая одновременную активность нескольких сессий и сохраняя стабильность связи при смене сетевых интерфейсов.
- **Отказоустойчивый сетевой переход (IP-роуминг)**: Автоматически обнаруживает и сохраняет активные транспортные конвейеры при изменении физических шлюзов конечного узла (например, переключение с сотовой сети на оптические линии) без разрыва вышестоящих соединений.
- **Безопасное рукопожатие (PSK Handshake)**: Использует схему `Noise_NNpsk0_25519_ChaChaPoly_BLAKE2s` для аутентификации удаленных узлов, обеспечивая мгновенный запуск защищенного канала с гарантиями совершенной прямой секретности (Forward Secrecy).
- **Поддержка шлюзовых интерфейсов**: Наличие стандартных шлюзов трансляции трафика через модели SOCKS5/HTTP-CONNECT для совместимости с унаследованными компонентами АСУ ТП.
- **Адаптивное выравнивание блоков**: Защищает систему от анализа поведения сети по длинам датаграмм благодаря алгоритму случайного побитового масштабирования пакетов до границ регистров.
---
## Развертывание и настройка
### Автоматическая установка на Linux (Рекомендуется)
Для быстрого интерактивного развертывания узла в стандартных серверных средах Linux выполните команду установки непосредственно в консоли терминала:
### Linux (Сервер или Клиент)
Выполните эту команду для автоматической установки и настройки как сервиса:
```bash ```bash
bash <(curl -Ls https://raw.githubusercontent.com/ospab/ostp/master/scripts/install.sh) bash <(curl -Ls https://raw.githubusercontent.com/ospab/ostp/master/scripts/install.sh)
``` ```
*Данный сценарий автономно загружает подходящий бинарный релиз, регистрирует системную службу демона в операционной системе и интерактивно настраивает конфигурационные шаблоны с помощью встроенных инструментов компиляции.* ### Windows (Клиент)
Запустите в **PowerShell от имени администратора**:
```powershell
irm https://raw.githubusercontent.com/ospab/ostp/master/scripts/install.ps1 | iex
```
### Ручная инициализация узла ---
Унифицированное приложение `ostp` способно самостоятельно генерировать шаблоны настроек и идентификационные ключи безопасности. ## Как пользоваться
**Инициализация узла сборщика (Сервер):** Программа `ostp` работает в двух режимах: **Сервер** (ставится на ваш VPS) и **Клиент** (ставится на ваш компьютер).
### 1. Создание конфига
Запустите программу с флагом `--init`, чтобы создать шаблон:
**На сервере:**
```bash ```bash
./ostp --init server ./ostp --init server
``` ```
*Эта команда создает файл `config.json`, привязанный к автоматическому порту прослушивания, и записывает туда сгенерированные случайные ключи авторизации.*
**Инициализация узла моста (Клиент):** **На клиенте:**
```bash ```bash
./ostp --init client ./ostp --init client
``` ```
### Конфигурация интеграции ### 2. Настройка
Рабочие параметры узла задаются в файле `config.json`, расположенном рядом с исполняемым файлом демона. #### Сервер (`config.json`)
#### Конфигурация сборщика телеметрии (`config.json`)
```json ```json
{ {
"mode": "server", "mode": "server",
"listen": "0.0.0.0:50000", "listen": "0.0.0.0:50000",
"access_keys": [ "access_keys": [
"secure_node_registration_key_here" "ваш-секретный-ключ"
], ]
"debug": false
} }
``` ```
#### Конфигурация моста ретрансляции (`config.json`) #### Клиент (`config.json`)
```json ```json
{ {
"mode": "client", "mode": "client",
"server": "COLLECTOR_ENDPOINT_IP:50000", "server": "IP_ВАШЕГО_СЕРВЕРА:50000",
"access_key": "secure_node_registration_key_here", "access_key": "ваш-секретный-ключ",
"socks5_bind": "127.0.0.1:1088", "socks5_bind": "127.0.0.1:1088",
"tun": { "tun": {
"enable": false, "enable": false
"wintun_path": "./wintun.dll",
"ipv4_address": "10.1.0.2/24"
},
"exclude": {
"domains": [
"internal-system.lan",
"local.lan"
],
"ips": [
"192.168.1.0/24",
"10.0.0.0/8"
],
"processes": [
"local_monitoring.exe"
]
},
"mux": {
"enabled": true,
"sessions": 2
} }
} }
``` ```
### Запуск узла ### 3. Запуск
Запустите программу, указав файл конфигурации:
Для активации процессов обмена телеметрией запустите приложение с указанием пути к активному файлу параметров:
```bash ```bash
./ostp --config config.json ./ostp --config config.json
``` ```
--- ---
## Метрики стабильности и производительности ## TUN режим (VPN для всей системы)
Чтобы направить весь интернет-трафик через OSTP, установите `"enable": true` в секции `tun` вашего клиентского конфига.
### Мультиплексирование потоков (Mux) - **Windows**: Требуются права Администратора.
> [!IMPORTANT] - **Linux**: Требуются права Root.
> **Параллельное мультиплексирование полностью поддерживается.**
> Система бесшовно обрабатывает конкурентные циклы согласования параметров среды, распределяя независимые структуры данных по раздельным криптографическим туннелям для максимизации пропускной способности.
### Модули исключений (Bypass Engines)
> [!NOTE]
> Механизмы маршрутизации в обход шины передачи полностью готовы к эксплуатации. Указанные в конфигурации IP-подсети, локальные доменные зоны и процессы корректно направляются напрямую через штатный сетевой стек ОС, исключая дополнительные задержки маршрутов.
--- ---
## Лицензия ## Лицензия
OSTP распространяется под лицензией Business Source License 1.1. Бесплатно для личного и некоммерческого использования. 14 мая 2030 года лицензия изменится на MIT.
OSTP публикуется на условиях лицензии Business Source License 1.1 (BSL), которая разрешает неограниченное личное, некоммерческое и частное использование протокола. С 14 мая 2030 года лицензия автоматически переходит в категорию открытого ПО с разрешительной лицензией MIT.
С полным текстом лицензионного соглашения можно ознакомиться в приложенном файле [LICENSE](LICENSE) или в официальном репозитории проекта по адресу [https://github.com/ospab/ostp](https://github.com/ospab/ostp).

BIN
test_tun/tun2socks-linux-amd64
View File

Binary file not shown.