mirror of https://github.com/ospab/ostp.git
docs: simplify READMEs and add cross-language links
This commit is contained in:
ospab
parent
514bae94cd
commit
7e44f57c00
91
README.md
91
README.md
|
|
@ -1,83 +1,56 @@
|
||||||
# 🌌 OSTP (Ospab Stealth Transport Protocol)
|
# OSTP (Ospab Stealth Transport Protocol)
|
||||||
|
|
||||||
|
[🇷🇺 Русский язык](README.ru.md)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
**OSTP** is a next-generation, high-performance stealth transport protocol engineered for absolute privacy and network resilience. It transforms your data streams into high-entropy, featureless noise, making it virtually undetectable by statistical network analysis (DPI).
|
OSTP is a fast and secure transport protocol designed to bypass DPI and network restrictions. It masks traffic as high-entropy data, making it difficult to detect or block.
|
||||||
|
|
||||||
Whether you are navigating restrictive network environments, securing industrial telemetry, or just seeking a robust personal tunnel, OSTP provides the stability and speed you need.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## ✨ Core Features
|
## Features
|
||||||
|
|
||||||
### 🛡️ Indistinguishable Traffic (Stealth)
|
- **Traffic Obfuscation**: Hides VPN/proxy signatures from network analysis.
|
||||||
Unlike traditional VPNs (OpenVPN, WireGuard) that have distinct packet signatures, OSTP uses advanced **Keystream Scrambling** and **Adaptive Block Shaping**. Your traffic looks like random bytes, bypassing even the most aggressive firewalls.
|
- **High Performance**: Written in Rust using the gVisor network stack for low latency.
|
||||||
|
- **Reliable Connectivity**: Built-in keep-alive mechanism for stable operation on mobile networks.
|
||||||
### 🚀 Extreme Performance
|
- **Flexible Modes**: Supports SOCKS5/HTTP proxying and full-system TUN (VPN) mode.
|
||||||
Written from the ground up in **Rust** and utilizing the **gVisor network stack**, OSTP is optimized for zero-copy data processing and high-throughput multiplexing. It easily handles 1Gbps+ streams with minimal CPU overhead.
|
- **Multi-platform**: Compatible with Windows, Linux, macOS, and Android.
|
||||||
|
|
||||||
### 📱 Cross-Platform Dominance
|
|
||||||
- **Windows**: Full support for TUN mode via Wintun and SOCKS5/HTTP proxying.
|
|
||||||
- **Linux**: Native high-performance daemon with systemd integration.
|
|
||||||
- **Android**: Integrated JNI core for mobile applications.
|
|
||||||
- **macOS/FreeBSD**: Standard CLI support for proxying and routing.
|
|
||||||
|
|
||||||
### 🔄 Intelligent Multiplexing (Mux)
|
|
||||||
Handle hundreds of concurrent streams over a single connection. OSTP includes a built-in Arq-based reliable transport layer that manages retransmissions and flow control automatically.
|
|
||||||
|
|
||||||
### 🏠 Robust Liveness (Keep-Alive)
|
|
||||||
Stays connected where others fail. The intelligent heartbeat system keeps NAT mappings alive and ensures the tunnel stays active even during long periods of idle time or network handoffs.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🛠️ Architecture
|
## Installation
|
||||||
|
|
||||||
The project is organized into a modular workspace:
|
### Linux
|
||||||
- **ostp-core**: The base cryptographic and framing library.
|
Run the installer script to set up OSTP as a system service:
|
||||||
- **ostp-client**: High-level client logic, proxy servers, and TUN management.
|
|
||||||
- **ostp-server**: High-performance multi-tenant server implementation.
|
|
||||||
- **ostp**: The main CLI binary (The "Core").
|
|
||||||
- **ostp-jni**: Android/Mobile bindings.
|
|
||||||
- *Note: The experimental GUI is currently in a separate testing phase.*
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 📥 Getting Started
|
|
||||||
|
|
||||||
### 🐧 Linux (One-Line Installer)
|
|
||||||
```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 (One-Line Installer)
|
### Windows
|
||||||
|
Run the following in PowerShell as Administrator:
|
||||||
```powershell
|
```powershell
|
||||||
# Run as Administrator
|
|
||||||
irm https://raw.githubusercontent.com/ospab/ostp/master/scripts/install.ps1 | iex
|
irm https://raw.githubusercontent.com/ospab/ostp/master/scripts/install.ps1 | iex
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## ⚙️ Configuration
|
## Configuration
|
||||||
|
|
||||||
Generate your template first:
|
Initialize a default config file:
|
||||||
```bash
|
```bash
|
||||||
./ostp --init server # On VPS
|
./ostp --init server # For VPS
|
||||||
./ostp --init client # On Local PC
|
./ostp --init client # For local machine
|
||||||
```
|
```
|
||||||
|
|
||||||
### Server Example (`config.json`)
|
### Server (config.json)
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"_comment": "OSTP Server Configuration",
|
"_comment": "OSTP Server Configuration",
|
||||||
"mode": "server",
|
"mode": "server",
|
||||||
"listen": "0.0.0.0:50000",
|
"listen": "0.0.0.0:50000",
|
||||||
"access_keys": [
|
"access_keys": ["YOUR_KEY"],
|
||||||
"YOUR_GENERATED_KEY"
|
|
||||||
],
|
|
||||||
"_comment_outbound": "Optional: forward traffic to another proxy (e.g. Tor)",
|
|
||||||
"outbound": {
|
"outbound": {
|
||||||
"enabled": false,
|
"enabled": false,
|
||||||
"protocol": "socks5",
|
"protocol": "socks5",
|
||||||
|
|
@ -88,13 +61,13 @@ Generate your template first:
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### Client Example (`config.json`)
|
### Client (config.json)
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"_comment": "OSTP Client Configuration",
|
"_comment": "OSTP Client Configuration",
|
||||||
"mode": "client",
|
"mode": "client",
|
||||||
"server": "SERVER_IP:50000",
|
"server": "SERVER_IP:50000",
|
||||||
"access_key": "YOUR_GENERATED_KEY",
|
"access_key": "YOUR_KEY",
|
||||||
"socks5_bind": "127.0.0.1:1088",
|
"socks5_bind": "127.0.0.1:1088",
|
||||||
"tun": {
|
"tun": {
|
||||||
"enable": false,
|
"enable": false,
|
||||||
|
|
@ -107,11 +80,17 @@ Generate your template first:
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 📜 License & Legal
|
## Usage
|
||||||
|
|
||||||
OSTP is published under the **Business Source License 1.1 (BSL)**.
|
Start the node with your configuration:
|
||||||
- **Personal/Private use**: Free and unrestricted.
|
```bash
|
||||||
- **Commercial use**: Requires a separate agreement until the change date.
|
./ostp --config config.json
|
||||||
- **Change Date**: May 14, 2030 (converts to **MIT License**).
|
```
|
||||||
|
|
||||||
See the [LICENSE](LICENSE) file for more details.
|
For TUN mode on Windows, ensure `tun2socks.exe` and `wintun.dll` are in the same directory.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
Business Source License 1.1. Free for personal and non-commercial use. Converts to MIT License on May 14, 2030.
|
||||||
|
|
|
||||||
91
README.ru.md
91
README.ru.md
|
|
@ -1,83 +1,56 @@
|
||||||
# 🌌 OSTP (Ospab Stealth Transport Protocol)
|
# OSTP (Ospab Stealth Transport Protocol)
|
||||||
|
|
||||||
|
[🇺🇸 English](README.md)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
**OSTP** — это высокопроизводительный протокол скрытой передачи данных нового поколения, созданный для обеспечения абсолютной приватности и устойчивости связи. Он превращает ваши потоки данных в высокоэнтропийный, безликий шум, который практически невозможно обнаружить с помощью систем глубокого анализа трафика (DPI).
|
OSTP — это быстрый и безопасный транспортный протокол для обхода DPI и сетевых ограничений. Он маскирует трафик под высокоэнтропийные данные, что делает его труднообнаружимым для систем блокировки.
|
||||||
|
|
||||||
Будь то обход агрессивных сетевых ограничений, защита промышленной телеметрии или просто создание надежного личного туннеля — OSTP обеспечит стабильность и скорость, которые вам необходимы.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## ✨ Основные возможности
|
## Возможности
|
||||||
|
|
||||||
### 🛡️ Необнаруживаемый трафик (Stealth)
|
- **Обфускация трафика**: Скрывает сигнатуры VPN и прокси от сетевого анализа.
|
||||||
В отличие от традиционных VPN (OpenVPN, WireGuard), которые имеют узнаваемые сигнатуры пакетов, OSTP использует продвинутую систему **Keystream Scrambling** и **Adaptive Block Shaping**. Ваш трафик выглядит как набор случайных байтов, что позволяет обходить даже самые современные системы блокировок.
|
- **Высокая производительность**: Написан на Rust с использованием сетевого стека gVisor.
|
||||||
|
- **Стабильность**: Встроенный механизм keep-alive для надежной работы в мобильных сетях.
|
||||||
### 🚀 Экстремальная производительность
|
- **Гибкость**: Поддержка проксирования SOCKS5/HTTP и полнофункционального TUN (VPN) режима.
|
||||||
Разработанный с нуля на языке **Rust** и использующий сетевой стек **gVisor**, OSTP оптимизирован для обработки данных с нулевым копированием (zero-copy) и эффективного мультиплексирования. Протокол легко справляется с потоками в 1 Гбит/с+ при минимальной нагрузке на процессор.
|
- **Кроссплатформенность**: Работает на Windows, Linux, macOS и Android.
|
||||||
|
|
||||||
### 📱 Кроссплатформенность
|
|
||||||
- **Windows**: Полная поддержка TUN режима через Wintun и проксирование SOCKS5/HTTP.
|
|
||||||
- **Linux**: Нативный высокопроизводительный демон с интеграцией в systemd.
|
|
||||||
- **Android**: Интегрированное JNI-ядро для мобильных приложений.
|
|
||||||
- **macOS/FreeBSD**: Стандартная поддержка CLI для проксирования и маршрутизации.
|
|
||||||
|
|
||||||
### 🔄 Интеллектуальное мультиплексирование (Mux)
|
|
||||||
Передавайте сотни одновременных потоков через одно соединение. OSTP включает встроенный надежный транспортный уровень на базе Arq, который автоматически управляет повторными передачами и контролем потока.
|
|
||||||
|
|
||||||
### 🏠 Надежный Keep-Alive
|
|
||||||
Остается на связи там, где другие сдаются. Интеллектуальная система проверки связи поддерживает NAT-маппинги активными и гарантирует, что туннель не закроется даже при длительном простое или смене сетевых интерфейсов.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🛠️ Архитектура
|
## Установка
|
||||||
|
|
||||||
Проект организован как модульное рабочее пространство (workspace):
|
### Linux
|
||||||
- **ostp-core**: Базовая библиотека криптографии и фрейминга.
|
Используйте скрипт для автоматической установки и настройки сервиса:
|
||||||
- **ostp-client**: Логика клиента, прокси-серверы и управление TUN.
|
|
||||||
- **ostp-server**: Высокопроизводительная реализация сервера.
|
|
||||||
- **ostp**: Основной бинарный файл CLI (Ядро).
|
|
||||||
- **ostp-jni**: Библиотеки для Android/Mobile.
|
|
||||||
- *Примечание: Экспериментальный GUI на данный момент находится в отдельной стадии тестирования.*
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 📥 С чего начать
|
|
||||||
|
|
||||||
### 🐧 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 (Установка одной командой)
|
### Windows
|
||||||
|
Запустите в PowerShell от имени администратора:
|
||||||
```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
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## ⚙️ Настройка
|
## Настройка
|
||||||
|
|
||||||
Сначала создайте шаблон конфигурации:
|
Создайте файл конфигурации по умолчанию:
|
||||||
```bash
|
```bash
|
||||||
./ostp --init server # На VPS (сервере)
|
./ostp --init server # Для сервера (VPS)
|
||||||
./ostp --init client # На локальном ПК
|
./ostp --init client # Для клиента (ПК)
|
||||||
```
|
```
|
||||||
|
|
||||||
### Пример Сервера (`config.json`)
|
### Сервер (config.json)
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"_comment": "OSTP Server Configuration",
|
"_comment": "OSTP Server Configuration",
|
||||||
"mode": "server",
|
"mode": "server",
|
||||||
"listen": "0.0.0.0:50000",
|
"listen": "0.0.0.0:50000",
|
||||||
"access_keys": [
|
"access_keys": ["ВАШ_КЛЮЧ"],
|
||||||
"ВАШ_СЕКРЕТНЫЙ_КЛЮЧ"
|
|
||||||
],
|
|
||||||
"_comment_outbound": "Опционально: пересылка трафика через другой прокси (например, Tor)",
|
|
||||||
"outbound": {
|
"outbound": {
|
||||||
"enabled": false,
|
"enabled": false,
|
||||||
"protocol": "socks5",
|
"protocol": "socks5",
|
||||||
|
|
@ -88,13 +61,13 @@ irm https://raw.githubusercontent.com/ospab/ostp/master/scripts/install.ps1 | ie
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### Пример Клиента (`config.json`)
|
### Клиент (config.json)
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"_comment": "OSTP Client Configuration",
|
"_comment": "OSTP Client Configuration",
|
||||||
"mode": "client",
|
"mode": "client",
|
||||||
"server": "IP_СЕРВЕРА:50000",
|
"server": "IP_СЕРВЕРА:50000",
|
||||||
"access_key": "ВАШ_СЕКРЕТНЫЙ_КЛЮЧ",
|
"access_key": "ВАШ_КЛЮЧ",
|
||||||
"socks5_bind": "127.0.0.1:1088",
|
"socks5_bind": "127.0.0.1:1088",
|
||||||
"tun": {
|
"tun": {
|
||||||
"enable": false,
|
"enable": false,
|
||||||
|
|
@ -107,11 +80,17 @@ irm https://raw.githubusercontent.com/ospab/ostp/master/scripts/install.ps1 | ie
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 📜 Лицензия и правовая информация
|
## Использование
|
||||||
|
|
||||||
OSTP распространяется под лицензией **Business Source License 1.1 (BSL)**.
|
Запустите программу с вашим конфигом:
|
||||||
- **Личное/Частное использование**: Бесплатно и без ограничений.
|
```bash
|
||||||
- **Коммерческое использование**: Требует отдельного соглашения до даты изменения.
|
./ostp --config config.json
|
||||||
- **Дата изменения**: 14 мая 2030 года (переходит в лицензию **MIT**).
|
```
|
||||||
|
|
||||||
Подробности можно найти в файле [LICENSE](LICENSE).
|
Для работы TUN режима в Windows файлы `tun2socks.exe` и `wintun.dll` должны находиться в одной папке с бинарным файлом.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Лицензия
|
||||||
|
|
||||||
|
Business Source License 1.1. Бесплатно для личного и некоммерческого использования. Переходит в MIT License 14 мая 2030 года.
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue