OpenGFW/README.ja.md at 5c77cede3d2d5e2b51dc6f7c7218fcc37f88cbea

mirror of https://github.com/apernet/OpenGFW.git synced 2024-11-13 13:59:24 +08:00

* feat: add cidr support for expr

* docs: add example for cidr

* minor code tweaks

---------

Co-authored-by: Toby <tobyxdd@gmail.com>

2024-02-17 14:21:12 -08:00

4.7 KiB

Raw Blame History

OpenGFW は、Linux 上の GFW の柔軟で使いやすいオープンソース実装であり、多くの点で本物より強力です。これは家庭用ルーターでできるサイバー主権です。

Caution

このプロジェクトはまだ開発の初期段階です。使用は自己責任でお願いします。

Note

私たちはこのプロジェクト、特により多くのプロトコル用のアナライザーの実装を手伝ってくれるコントリビューターを探しています！！！

特徴

フル IP/TCP 再アセンブル、各種プロトコルアナライザー
- HTTP、TLS、DNS、SSH、SOCKS4/5、WireGuard、その他多数
- Shadowsocks の「完全に暗号化されたトラフィック」の検出など (https://gfw.report/publications/usenixsecurity23/data/paper/paper.pdf)
- トロイの木馬キラー (https://github.com/XTLS/Trojan-killer) に基づくトロイの木馬 (プロキシプロトコル) 検出
- [WIP] 機械学習に基づくトラフィック分類
IPv4 と IPv6 をフルサポート
フローベースのマルチコア負荷分散
接続オフロード
expr に基づく強力なルールエンジン
ルールのホットリロード (SIGHUP を送信してリロード)
柔軟なアナライザ＆モディファイアフレームワーク
拡張可能な IO 実装 (今のところ NFQueue のみ)
[WIP] ウェブ UI

ユースケース

広告ブロック
ペアレンタルコントロール
マルウェア対策
VPN/プロキシサービスの不正利用防止
トラフィック分析（ログのみモード）

使用方法

ビルド

go build

実行

export OPENGFW_LOG_LEVEL=debug
./OpenGFW -c config.yaml rules.yaml

OpenWrt

OpenGFW は OpenWrt 23.05 で動作することがテストされています（他のバージョンも動作するはずですが、検証されていません）。

依存関係をインストールしてください：

opkg install kmod-nft-queue kmod-nf-conntrack-netlink

設定例

io:
  queueSize: 1024
  local: true # FORWARD チェーンで OpenGFW を実行したい場合は false に設定する

workers:
  count: 4
  queueSize: 16
  tcpMaxBufferedPagesTotal: 4096
  tcpMaxBufferedPagesPerConn: 64
  udpMaxStreams: 4096

# 特定のローカルGeoIP / GeoSiteデータベースファイルを読み込むためのパス。
# 設定されていない場合は、https://github.com/LoyalSoldier/v2ray-rules-dat から自動的にダウンロードされます。
# geo:
#   geoip: geoip.dat
#   geosite: geosite.dat

ルール例

アナライザーのプロパティ

式言語の構文については、Expr 言語定義を参照してください。

- name: block v2ex http
  action: block
  expr: string(http?.req?.headers?.host) endsWith "v2ex.com"

- name: block v2ex https
  action: block
  expr: string(tls?.req?.sni) endsWith "v2ex.com"

- name: block shadowsocks
  action: block
  expr: fet != nil && fet.yes

- name: block trojan
  action: block
  expr: trojan != nil && trojan.yes

- name: v2ex dns poisoning
  action: modify
  modifier:
    name: dns
    args:
      a: "0.0.0.0"
      aaaa: "::"
  expr: dns != nil && dns.qr && any(dns.questions, {.name endsWith "v2ex.com"})

- name: block google socks
  action: block
  expr: string(socks?.req?.addr) endsWith "google.com" && socks?.req?.port == 80

- name: block wireguard by handshake response
  action: drop
  expr: wireguard?.handshake_response?.receiver_index_matched == true

- name: block bilibili geosite
  action: block
  expr: geosite(string(tls?.req?.sni), "bilibili")

- name: block CN geoip
  action: block
  expr: geoip(string(ip.dst), "cn")

- name: block cidr
  action: block
  expr: cidr(string(ip.dst), "192.168.0.0/16")

サポートされるアクション

allow: 接続を許可し、それ以上の処理は行わない。
block: 接続をブロックし、それ以上の処理は行わない。
drop: UDP の場合、ルールのトリガーとなったパケットをドロップし、同じフローに含まれる以降のパケットの処理を継続する。TCP の場合は、block と同じ。
modify: UDP の場合、与えられた修飾子を使って、ルールをトリガしたパケットを修正し、同じフロー内の今後のパケットを処理し続ける。TCP の場合は、allow と同じ。

4.7 KiB Raw Blame History

特徴