summaryrefslogtreecommitdiffhomepage
path: root/dpibreak.1.md
blob: 207772da2018932f5bbe4c15fbb1b2a4d3224c0a (plain)
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
157
158
159
## NAME

dpibreak - circumventing deep packet inspection

## SYNOPSIS

**dpibreak** \[*OPTIONS*\]

## DESCRIPTION

**DPIBreak** is a tool for circumventing Deep Packet Inspection (DPI) on
HTTPS connections. It is only applied locally and no other external
connection is needed.

Mainly it fragments the TCP packet carrying the TLS ClientHello so that
certain DPI devices cannot extract the Server Name Indication (SNI)
field and identify the destination site. Other method can also be used
along with it, and it is described in the **OPTIONS** section.

DPIBreak registers firewall rules to handle inbound and outbound
packets. The rules are automatically added on startup and removed on
exit, making it effective system-wide without manual intervention.
Firewall rule cleanup relies on **SIGTERM**/**SIGINT**. If the process
is killed with **SIGKILL**, cleanup will not occur. However, the
registered nfqueue rules simply pass packets through when no process is
consuming the queue, so this is not a concern in practice. In that case,
restarting and gracefully stopping DPIBreak will clean up the leftover
rules.

To register firewall rules and verdict packets, root privilege is
required on Linux (**nft**(8) or **iptables**(8)/**ip6tables**(8) with
**xt_u32** must be available); administrator privilege is required on
Windows (WinDivert64.sys and WinDivert.dll must be in the same directory
as dpibreak.exe).

This only applies to TLS-based connections (HTTPS). UDP/QUIC (**RFC**
9000) is not affected.

## OPTIONS

**-D**, **--daemon**  
Run as a background daemon. Logs are written to
**/var/log/dpibreak.log.** If a daemon is already running, it will fail
with "unable to lock pid file". To stop it, run **kill \`cat
/run/dpibreak.pid\`** as root.

On Windows, this option enters the service controller entry point.
Example: **sc create dpibreak binPath= "dpibreak.exe -D" start= auto; sc
start dpibreak**

**--delay-ms *\<u64\>***  
Delay in milliseconds to apply between fragmented pieces of the
ClientHello. Typical values are 0–1000; larger values may increase
handshake latency. (Default: 0)

**--fake**  
Enable **fake** ClientHello packet injection before sending each packet
fragmented. TCP/IP header fields follow the original packet unless you
override it using the **--fake-\*** options described below. Packets are
transmitted in an interleaved order: (fake 1), (orig 1), (fake 2), (orig
2), ...

**--fake-ttl *\<u8\>***  
Override ttl (IPv4) / hop_limit (IPv6) of **fake** packet. Implicitly
enables **--fake**. (Default: 8)

**--fake-autottl**  
Automatically infer the hop count (TTL/Hop Limit) to the destination by
analyzing the SYN/ACK packet. It assumes the server's initial TTL is
either 64, 128, or 255. The inferred value is used for **fake** packet
transmission to ensure they reach the censor but not the destination. By
default, it uses a delta of 1. If the hop count cannot be determined, it
falls back to the value specified by **--fake-ttl**. Implicitly enables
**--fake**.

**--fake-badsum**  
Corrupts the TCP checksum of **fake** packets. When enabled, **fake**
packets cannot pass through most routers and will not behave as
expected. It can be useful if your router/firewall provides an option to
disable TCP checksum verification. Implicitly enables **--fake**.

**--queue-num *\<u16\>***  

NFQUEUE number to attach to. The same queue number is used for IPv4 and
IPv6. (Default: 1)

**--nft-command *\<string\>***  

Custom nftables command to be executed. (Default: nft)

**--log-level *\<debug\|info\|warning\|error\>***  
Set the logging level (Default: warning). Aliases: **warn** -\>
**warning**, **err** -\> **error**.

**--no-splash**  
Disable splash messages at startup.

**-h**, **--help**  
Show usage information and exit.

## EXIT STATUS

**0**  
Successfully terminated.

**non-zero**  
The program encountered an error during initialization or runtime,
resulting in an abnormal exit.

## EXAMPLES

Run with default options:

> **dpibreak**

Run as daemon with fake ClientHello injection:

> **dpibreak -D --fake-autottl**

Run with a 10 ms delay between fragmanted packets and verbose logging:

> **dpibreak --delay-ms 10 --log-level debug**

Use a custom NFQUEUE on Linux:

> **dpibreak --queue-num 3**

## FILES

*/run/dpibreak.pid*  
Whether running as a daemon or not, DPIBreak will fail through this file
if another instance is already running on the system.

*/var/log/dpibreak.log*  
Only for daemon. log goes here.

## BUGS

There are two types of bugs:

> a\. DPIBreak does not work as described in the manual.  
> b. It works as described but fails to bypass the DPI.

Reporting both cases to the bug tracker helps improve the program. For
case (b), it would be helpful if you could include information such as
your region and ISP.

Any other minor improvements or suggestions are also welcome.

You can view the known bugs list and submit reports at:  
*https://github.com/dilluti0n/dpibreak/issues*

## SEE ALSO

**nft**(8), **iptables**(8), **ip6tables**(8)

## AUTHOR

Written by Dilluti0n \<[email protected]\>.