A fast, custom encrypted transport protocol written in Rust.
Go to file
ospab 2819a14189 fix(installer): use rename trick to bypass file locks and ensure all bundled files (tun2socks, wintun) are copied 2026-05-15 20:24:01 +03:00
.github/workflows fix: address final analysis issues including Nonce exhaustion, TUN pre-flight checks, dead code, and proper TURN channel framing. Also fix CI packaging of tun2socks 2026-05-15 19:23:50 +03:00
docs docs: add official specifications for OSTP 2026-05-15 18:51:13 +03:00
ostp fix: prevent console window closure on fatal errors via user prompt pause 2026-05-15 16:10:47 +03:00
ostp-client fix: resolve asymmetric packet loss (zero upload) by enforcing strict MTU caps and reducing TUN interface MTU to 1300 to prevent UDP fragmentation on outbound traffic 2026-05-15 19:54:07 +03:00
ostp-core fix: throw error on ARQ max_retries exceeded to prevent silent deadlock that caused infinite upload timeouts 2026-05-15 20:04:07 +03:00
ostp-jni Refactor: Integrate portable-atomic to transparently emulate 64-bit atomics on 32-bit router architectures like MIPS and ensure absolute hardware-independent metrics tracking 2026-05-15 00:11:28 +03:00
ostp-server feat: resolve flow control, tun crash route cleanup, log pollution, padding caps 2026-05-15 18:34:32 +03:00
scripts fix(installer): use rename trick to bypass file locks and ensure all bundled files (tun2socks, wintun) are copied 2026-05-15 20:24:01 +03:00
.gitattributes chore: enforce LF line endings on bash scripts via gitattributes to fix 'bad interpreter' on Linux 2026-05-15 19:08:03 +03:00
.gitignore chore: remove junk files, update .gitignore for temp dirs and archives 2026-05-15 18:27:45 +03:00
Cargo.lock feat: resolve flow control, tun crash route cleanup, log pollution, padding caps 2026-05-15 18:34:32 +03:00
Cargo.toml CI/CD: release version v0.1.39 2026-05-15 20:05:27 +03:00
Cross.toml CI/CD: Resolve MIPS Tier-3 compilation by instructing Cross to dynamically build-std library from source 2026-05-14 23:57:19 +03:00
LICENSE Initial public release: Ospab Stealth Transport Protocol v0.1.0 2026-05-14 21:41:54 +03:00
README.md feat: resolve flow control, tun crash route cleanup, log pollution, padding caps 2026-05-15 18:34:32 +03:00
README.ru.md Fix: Update raw installation URLs from main to master branch in READMEs 2026-05-14 22:44:57 +03:00

README.md

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.


Industrial Architecture

The pipeline utilizes a highly optimized modular framework:

  • ostp-core: The foundational grid synchronization library hosting core transport primitives, keystream scrambling pipelines, Noise Protocol Framework cryptography, and zero-copy framed processing.
  • ostp: The consolidated cross-platform node daemon configured either as a telemetry collector (server) or relay bridge (client).
  • ostp-jni: Consolidated bindings allowing secure deployment of telemetry nodes across Android-embedded field equipment.

Feature Specification

  • 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:

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.

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):

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

The consolidated ostp daemon automates node certificate generation and base configuration templating.

Provision Collector Node (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):

./ostp --init client

Node Integration Config

Configuration parameters are defined within config.json aligned adjacent to the service binary.

Telemetry Collector Configuration (config.json)

{
  "mode": "server",
  "listen": "0.0.0.0:50000",
  "access_keys": [
    "secure_node_registration_key_here"
  ],
  "debug": false
}

Relay Bridge Configuration (config.json)

{
  "mode": "client",
  "server": "COLLECTOR_ENDPOINT_IP:50000",
  "access_key": "secure_node_registration_key_here",
  "socks5_bind": "127.0.0.1:1088",
  "tun": {
    "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] TUN Mode & Privileges 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:

./ostp --config config.json

Operation & Reliability Metrics

Stream Multiplexing (Mux)

[!IMPORTANT] 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

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 file or the official repository at https://github.com/ospab/ostp.