trojan 0.5.4

A Rust implementation of the Trojan protocol
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156

# trojan-rs

[![Crates.io](https://img.shields.io/crates/v/trojan.svg)](https://crates.io/crates/trojan)
[![Documentation](https://docs.rs/trojan/badge.svg)](https://docs.rs/trojan)
[![CI](https://github.com/trojan-rust/trojan-rust/actions/workflows/ci.yml/badge.svg)](https://github.com/trojan-rust/trojan-rust/actions/workflows/ci.yml)
[![License](https://img.shields.io/crates/l/trojan.svg)](https://github.com/trojan-rust/trojan-rust/blob/master/LICENSE)

A high-performance Rust implementation of the [Trojan](https://trojan-gfw.github.io/trojan/protocol) protocol.

## Features

- **High Performance** - Built with async Rust and Tokio for maximum throughput
- **TLS 1.3 Support** - Modern encryption with configurable TLS versions and mTLS
- **WebSocket Transport** - Optional WebSocket encapsulation for CDN compatibility
- **Multiple Auth Backends** - Memory, SQLite, PostgreSQL, and MySQL support
- **User Management** - Full CLI for managing users with traffic limits
- **Prometheus Metrics** - Built-in metrics exporter for monitoring
- **Analytics** - Connection event tracking with ClickHouse backend
- **Rate Limiting** - Per-IP connection rate limiting
- **TCP Tuning** - Configurable TCP_NODELAY, Keep-Alive, SO_REUSEPORT, TCP Fast Open
- **Fallback Server** - Configurable fallback with connection warm pool
- **Certificate Management** - Self-signed certificate generation (optional feature)
- **Self-Upgrade** - Auto-update from GitHub releases (optional feature)
- **Cross-Platform** - Linux, macOS, and Windows support

## Installation

### Pre-built Binaries

Download from [GitHub Releases](https://github.com/trojan-rust/trojan-rust/releases).

### Cargo

```bash
cargo install trojan
```

### From Source

```bash
git clone https://github.com/trojan-rust/trojan-rust
cd trojan-rs
cargo build --release
```

## Usage

### Server

```bash
# Run with config file
trojan server -c config.toml

# Run with CLI options
trojan server --listen 0.0.0.0:443 \
  --tls-cert /path/to/cert.pem \
  --tls-key /path/to/key.pem \
  --password "your-password" \
  --fallback 127.0.0.1:80
```

### Certificate Generation

```bash
# Generate a self-signed certificate
trojan cert generate \
  --domain example.com \
  --domain localhost \
  --ip 127.0.0.1 \
  --output /etc/trojan \
  --days 365
```

### User Management (SQL Backend)

```bash
# Initialize database
trojan auth init --database sqlite://users.db

# Add user
trojan auth add --database sqlite://users.db \
  --password "user-password" \
  --upload-limit 10737418240 \
  --download-limit 107374182400

# List users
trojan auth list --database sqlite://users.db

# Remove user
trojan auth remove --database sqlite://users.db --password "user-password"
```

## Configuration

Supports TOML, YAML, JSON, and JSONC formats. Create a `config.toml` file:

```toml
[server]
listen = "0.0.0.0:443"
fallback = "127.0.0.1:80"
tcp_idle_timeout_secs = 600
udp_timeout_secs = 60

[server.tcp]
no_delay = true
keepalive_secs = 300
reuse_port = false
fast_open = false

[tls]
cert = "/etc/trojan/cert.pem"
key = "/etc/trojan/key.pem"
alpn = ["http/1.1"]

[auth]
passwords = ["password1", "password2"]

[websocket]
enabled = true
mode = "mixed"
path = "/ws"

[metrics]
listen = "127.0.0.1:9100"

[logging]
level = "info"
```

For all available options, see the [`trojan-config` documentation](https://docs.rs/trojan-config).

## Supported Platforms

| Platform | Architecture |
|----------|--------------|
| Linux | x86_64, aarch64, armv7, i686 |
| Linux (musl) | x86_64, aarch64, armv7, i686 |
| macOS | x86_64, aarch64 (Apple Silicon) |
| Windows | x86_64 |

## Crates

| Crate | Description |
|-------|-------------|
| [`trojan-core`](https://docs.rs/trojan-core) | Core types and utilities |
| [`trojan-proto`](https://docs.rs/trojan-proto) | Protocol encoding/decoding |
| [`trojan-auth`](https://docs.rs/trojan-auth) | Authentication backends |
| [`trojan-config`](https://docs.rs/trojan-config) | Configuration parsing |
| [`trojan-metrics`](https://docs.rs/trojan-metrics) | Prometheus metrics |
| [`trojan-analytics`](https://docs.rs/trojan-analytics) | Connection tracking |
| [`trojan-server`](https://docs.rs/trojan-server) | Server implementation |
| [`trojan-cert`](https://docs.rs/trojan-cert) | Certificate management |

## License

GPL-3.0-only