OpenGFW/README.ja.md
2024-02-05 20:44:56 -08:00

4.0 KiB

OpenGFW

License

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

Caution

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

Note

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

特徴

  • フル IP/TCP 再アセンブル、各種プロトコルアナライザー
  • IPv4 と IPv6 をフルサポート
  • フローベースのマルチコア負荷分散
  • 接続オフロード
  • expr に基づく強力なルールエンジン
  • ルールのホットリロード (SIGHUP を送信してリロード)
  • 柔軟なアナライザ&モディファイアフレームワーク
  • 拡張可能な IO 実装 (今のところ NFQueue のみ)
  • [WIP] ウェブ UI

ユースケース

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

使用方法

ビルド

go build

実行

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

設定例

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

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

ルール例

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

式言語の構文については、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")

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

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