中文文档 日本語ドキュメント

OpenGFW is your very own DIY Great Firewall of China (https://en.wikipedia.org/wiki/Great_Firewall), available as a flexible, easy-to-use open source program on Linux. Why let the powers that be have all the fun? It's time to give power to the people and democratize censorship. Bring the thrill of cyber-sovereignty right into your home router and start filtering like a pro - you too can play Big Brother.

Documentation site: https://gfw.dev/

Telegram group: https://t.me/OpGFW

Caution

This project is still in very early stages of development. Use at your own risk. We are looking for contributors to help us improve and expand the project.

Features

• Full IP/TCP reassembly, various protocol analyzers
  • HTTP, TLS, QUIC, DNS, SSH, SOCKS4/5, WireGuard, OpenVPN, and many more to come
  • "Fully encrypted traffic" detection for Shadowsocks, VMess, etc. (https://gfw.report/publications/usenixsecurity23/en/)
  • Trojan (proxy protocol) detection
  • [WIP] Machine learning based traffic classification
• Full IPv4 and IPv6 support
• Flow-based multicore load balancing
• Connection offloading
• Powerful rule engine based on expr
• Hot-reloadable rules (send SIGHUP to reload)
• Flexible analyzer & modifier framework
• Extensible IO implementation (only NFQueue for now)
• Web UI with live traffic dashboard and rule editor

Web UI

OpenGFW ships with an optional web dashboard: live traffic statistics, a real-time event feed with per-stream analyzer properties, and a rule editor that validates and hot reloads the ruleset. It works on phones as well as on desktops.

Rules can be written as a list of conditions — pick a field (SNI, DNS name, HTTP host, IP, port, detected protocol), an operator (wildcard, CIDR, GeoIP country, GeoSite category, range, regex) and one or more values — or as raw expr expressions and YAML. Countries and site categories are picked from the geo databases the engine loaded.

Enable it in your config file:

web:
  enabled: true
  listen: :8080
  secret: your-password-here # generated and logged on startup if left empty
  # cert: /path/to/fullchain.pem
  # key: /path/to/privkey.pem

The UI is embedded in the binary, so no extra files need to be deployed. Only expose it to trusted networks — anyone with the password can change your rules. See web/README.md for development instructions.

Use cases

• Ad blocking
• Parental control
• Malware protection
• Abuse prevention for VPN/proxy services
• Traffic analysis (log only mode)
• Help you fulfill your dictatorial ambitions