【WIP】CLI バージョンを作成

[kakira9618]

概要

PacketProxy の CLI 版を作成。

機能

• PacketProxy の CLI Server を作成
  • GUI ではなくCUI で Server が起動します。指定したポートで REST API をホストし、curlなどの別クライアントから情報を取得・操作することが可能です。
• PacketProxy の CLI Client を作成
  • エンコーダーモジュールを用いて、標準入力のデータを encode / decode して標準出力に出力することが出来ます。
• 必要なロジックテストを追加

使用方法

詳しくは docs/cli.md を参照してください。

CLI Server / CLI Client 共通

• ビルド

$ ./gradlew installDist

CLI Server

• 起動 (8888番ポート)

$ BIN=build/install/PacketProxy/bin/PacketProxy
$ $BIN server --api-port 8888 --api-key mytoken

デフォルトでは、GUI 版で最後に使った DB / 設定で起動します。

• ステータス確認

$ curl -s -H "Authorization: Bearer mytoken" http://localhost:8888/api/status | jq .
{
  "status": "READY",
  "startedAt": 1781002189458,
  "readyAt": 1781002201145,
  "uptimeSec": 106
}

• パケット一覧取得（先着n件）

$ curl -s -H "Authorization: Bearer mytoken" http://localhost:8888/api/packets\?limit\=2 | jq .
{
  "data": [
    {
      "id": 1,
      "direction": "CLIENT",
      "listenPort": 0,
      "clientIp": "127.0.0.1",
      "serverIp": "216.239.38.223",
      "serverPort": 443,
      "serverName": "play.googleapis.com",
      "encoderName": "HTTP",
      "modified": false,
      "resend": false,
      "date": 1772765941307
    },
    {
      "id": 2,
      "direction": "CLIENT",
      "listenPort": 0,
      "clientIp": "127.0.0.1",
      "serverIp": "104.16.5.34",
      "serverPort": 443,
      "serverName": "registry.npmjs.org",
      "encoderName": "HTTP",
      "modified": false,
      "resend": false,
      "date": 1772765941352
    }
  ],
  "offset": 0,
  "limit": 2
}

他のAPIは docs/cli.md を参照してください。

• ステータス確認 (GET /api/status)
• パケット履歴 (GET /api/packets)
• パケット詳細 (GET /api/packets/{id})
• 再送 (POST /api/packets/{id}/resend)
• バルク送信 (POST /api/packets/{id}/bulk-send)
• VulCheck チェッカー取得 (GET /api/vulcheckers)
• VulCheck 実行 (POST /api/vulcheckers/{name}/run)
• 設定取得 (GET /api/config)
• 設定変更 (PUT /api/config)
• DB バックアップ (GET /api/db)

CLI Client

• 標準入力の内容をエンコーダーモジュールを利用してdecodeして標準出力に出力する

$ echo 'hello' | $BIN decode --encoder "Sample UpperCase" --text >decoded.txt
$ cat decoded.txt
HELLO

• 標準入力の内容をエンコーダーモジュールを利用してencodeして標準出力に出力する

$ echo 'HELLO' | $BIN decode --encoder "Sample UpperCase" --text >encoded.txt
$ cat encoded.txt
hello

• By placing an "x" in the box, I hereby understand, accept and agree to be bound by the terms and conditions of the Contribution License Agreement.