pfSense ログを収集する
このドキュメントでは、Bindplane を使用して pfSense ログを Google Security Operations に取り込む方法について説明します。
pfSense は、FreeBSD ベースのオープンソースのファイアウォールおよびルーター ソフトウェア ディストリビューションです。ステートフル パケット フィルタリング、VPN、トラフィック シェーピング、NAT、DHCP サーバー、DNS フォワーダー、侵入検知機能を提供し、これらはすべてウェブベースのインターフェースで管理されます。パーサーは、pfSense syslog 形式のログからフィールドを抽出します。Grok を使用してログメッセージを解析し、これらの値を統合データモデル(UDM)にマッピングします。また、イベントのソースとタイプのデフォルトのメタデータ値も設定します。
始める前に
次の前提条件を満たしていることを確認してください。
- Google SecOps インスタンス
- Windows Server 2016 以降、または
systemdを使用する Linux ホスト - プロキシの背後で実行している場合は、Bindplane エージェントの要件に従ってファイアウォール ポートが開いていることを確認します
- pfSense ウェブ インターフェースへの特権アクセス
Bindplane エージェントの Google SecOps 認証情報を取得する
Bindplane エージェントを Google SecOps に対して認証するには、次のいずれかの方法を選択します。
- 新しいデプロイ: Chronicle API(オプション 1)を使用します。
- 以前のデプロイ: 2027 年 7 月 20 日に Ingestion API が廃止されるまで、取り込み認証ファイル(オプション 2)を引き続き使用します。
オプション 1: Chronicle API のサービス アカウントを作成する(推奨)
- Google Cloud コンソールにログインし、Google SecOps インスタンスにリンクされている Google Cloud プロジェクトを選択します。
- [IAM と管理] > [サービス アカウント] に移動します。
- [サービス アカウントを作成] をクリックします。
- 次の構成情報を指定します。
- サービス アカウント名: アカウントの名前を入力します(例:
bindplane-ingest)。 - サービス アカウントの説明: 説明を入力します(例:
Bindplane agent log ingestion)。
- サービス アカウント名: アカウントの名前を入力します(例:
- [作成して続行] をクリックします。
- [このサービス アカウントにプロジェクトへのアクセスを許可する] セクションで、[ロールを選択] をクリックし、[Chronicle 編集者] を選択します。
- [続行] をクリックして [完了] をクリックします。
- 作成したサービス アカウントをクリックし、[キー] タブに移動します。
- [鍵を追加] > [新しい鍵を作成] の順にクリックします。
- [JSON] を選択し、[作成] をクリックします。鍵ファイルがパソコンにダウンロードされます。
- 鍵ファイルを
ingestion-auth.jsonとして Bindplane コレクタ ディレクトリ(Linux の場合は/opt/observiq-otel-collector/ingestion-auth.json、Windows の場合はC:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json)に保存するか、config.yamlのcreds_file_pathを更新して、保存先のパスと一致させます。 - [IAM と管理] > [設定] に移動し、[プロジェクト番号] をコピーします。これはエクスポータの構成に必要です。
オプション 2: 取り込み認証ファイルをダウンロードする(レガシー)
- Google SecOps コンソールにログインします。
- [SIEM 設定] > [収集エージェント] に移動します。
- 取り込み認証ファイルをダウンロードします。
- Bindplane エージェントがインストールされるシステムにファイルを安全に保存します。
Google SecOps のお客様 ID を取得する
- Google SecOps コンソールにログインします。
- [SIEM 設定] > [プロファイル] に移動します。
- [組織の詳細情報] セクションから [お客様 ID] をコピーして保存します。
Bindplane エージェントをインストールする
次の手順に沿って、Windows または Linux オペレーティング システムに Bindplane エージェントをインストールします。
Windows へのインストール
- 管理者として コマンド プロンプトまたは PowerShell を開きます。
次のコマンドを実行します。
msiexec /i "https://github.com/observIQ/bindplane-agent/releases/latest/download/observiq-otel-collector.msi" /quietインストールが完了するまで待ちます。
次のコマンドを実行して、インストールの内容を確認します。
sc query observiq-otel-collector
サービスは RUNNING と表示されます。
Linux へのインストール
- root 権限または sudo 権限でターミナルを開きます。
次のコマンドを実行します。
sudo sh -c "$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_unix.sh)" install_unix.shインストールが完了するまで待ちます。
次のコマンドを実行して、インストールの内容を確認します。
sudo systemctl status observiq-otel-collector
サービスは active (running) と表示されます。
その他のインストール リソース
その他のインストール オプションとトラブルシューティングについては、Bindplane エージェントのインストール ガイドをご覧ください。
Syslog を取り込んで Google SecOps に送信するように Bindplane エージェントを構成する
構成ファイルを探します。
Linux:
sudo nano /opt/observiq-otel-collector/config.yamlWindows:
notepad "C:\Program Files\observIQ OpenTelemetry Collector\config.yaml"
構成ファイルを編集します。
config.yamlの内容全体を次の構成に置き換えます。receivers: udplog: listen_address: "0.0.0.0:514" exporters: chronicle/chronicle_w_labels: protocol: https # Region of your instance, for example us, europe, asia-southeast1 location: <LOCATION> # Project number of the Google Cloud project linked to the instance project: '<PROJECT_NUMBER>' compression: gzip creds_file_path: '/path/to/ingestion-authentication-file.json' customer_id: 'YOUR_CUSTOMER_ID' endpoint: chronicle.googleapis.com log_type: 'PFSENSE' raw_log_field: body ingestion_labels: service: pipelines: logs/source0__chronicle_w_labels-0: receivers: - udplog exporters: - chronicle/chronicle_w_labels
構成パラメータ
各プレースホルダを次のように置き換えます。
レシーバーの構成:
udplog: UDP syslog の場合はudplog、TCP syslog の場合はtcplogを使用します。0.0.0.0: リッスンする IP アドレス(すべてのインターフェースでリッスンする場合は0.0.0.0)514: リッスンするポート番号(標準の syslog ポート)
エクスポータの構成:
creds_file_path: サービス アカウントの JSON キーファイルのフルパス(オプション 1):- Linux:
/opt/observiq-otel-collector/ingestion-auth.json - Windows:
C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json
- Linux:
YOUR_CUSTOMER_ID: 「お客様 ID を取得する」セクションのお客様 IDlocation:<LOCATION>を Google SecOps インスタンスのリージョン(us、europe、asia-southeast1など)に置き換えます。エクスポートでは、この値がchronicle.googleapis.comの前に付加されます。完全なリストについては、リージョン エンドポイントをご覧ください。project:<PROJECT_NUMBER>を [IAM と管理] > [設定] のプロジェクト番号に置き換えます。endpoint:chronicle.googleapis.comに設定したままにします。log_type: Chronicle に表示されるログタイプ(PFSENSE)
以前の Ingestion API エクスポータ
オプション 2 の取り込み認証ファイルを使用する場合は、
exportersブロックを次のように置き換えます。creds_file_pathを取り込み認証ファイルのパスに設定します。インスタンスが米国以外にある場合は、malachiteingestion-pa.googleapis.comをリージョン エンドポイント(例:europe-malachiteingestion-pa.googleapis.com)に置き換えます。exporters: chronicle/chronicle_w_labels: compression: gzip creds_file_path: '/path/to/ingestion-authentication-file.json' customer_id: 'YOUR_CUSTOMER_ID' endpoint: malachiteingestion-pa.googleapis.com log_type: 'PFSENSE' raw_log_field: body ingestion_labels:
構成ファイルを保存する
- 編集が完了したら、ファイルを保存します。
- Linux:
Ctrl+O、Enter、Ctrl+Xの順に押します。 - Windows: [ファイル> 保存] をクリックします。
- Linux:
Bindplane エージェントを再起動して変更を適用する
Linux で Bindplane エージェントを再起動するには、次のコマンドを実行します。
sudo systemctl restart observiq-otel-collectorサービスが実行されていることを確認します。
sudo systemctl status observiq-otel-collectorログでエラーを確認します。
sudo journalctl -u observiq-otel-collector -f
Windows で Bindplane エージェントを再起動するには、次のいずれかのオプションを選択します。
管理者としてコマンド プロンプトまたは PowerShell を開きます。
net stop observiq-otel-collector && net start observiq-otel-collectorサービス コンソール:
Win+Rキーを押し、「services.msc」と入力して Enter キーを押します。- observIQ OpenTelemetry Collector を見つけます。
右クリックして [再起動] を選択します。
サービスが実行されていることを確認します。
sc query observiq-otel-collectorログでエラーを確認します。
type "C:\Program Files\observIQ OpenTelemetry Collector\log\collector.log"
pfSense で Syslog 転送を構成する
pfSense は FreeBSD で動作し、リモート syslog 転送を含むすべての構成タスク用のウェブベースのインターフェースを提供します。
- pfSense ウェブ インターフェースにログインします。
- [Status] > [System Logs] > [Settings] に移動します。
- [Remote Logging Options] セクションに移動します。
- [リモート ロギングを有効にする] を選択します。
- 次の構成情報を指定します。
- Source Address: [Any](または特定のインターフェース)を選択します。
- IP Protocol: [IPv4] を選択します。
- リモートログ サーバー: 最初の使用可能なフィールドに「
BINDPLANE_IP:514」と入力します。BINDPLANE_IPは、Bindplane エージェント ホストの IP アドレスに置き換えます。
- [Remote Syslog Contents] セクションで、転送するログカテゴリを選択します。
- システム イベント
- ファイアウォール イベント
- DNS イベント(Resolver/unbound、Forwarder/dnsmasq)
- DHCP イベント(DHCP サービス)
- PPP イベント
- 認証イベント(ポータル認証、RADIUS)
- VPN イベント(IPsec、OpenVPN、L2TP)
- Gateway Events(Gateway モニター)
- ルーティング イベント(ルーティング デーモン)
- NTP イベント
- パッケージ(インストール済みパッケージ)
- [保存] をクリックします。
- Bindplane エージェントのログを確認して、syslog メッセージが送信されていることを確認します。
UDM マッピング テーブル
| ログフィールド | UDM マッピング | 論理 |
|---|---|---|
| アプリケーション | principal.application | この値は、grok パターンを使用してログ メッセージから抽出されます。syslog メッセージの場合、アプリケーション名は通常、ホスト名とタイムスタンプの後にあります。 |
| コマンド | principal.process.command_line | ログがコマンドの実行を示している場合に、説明フィールドから抽出されます。 |
| 説明 | metadata.description | description フィールドは UDM メタデータの description にマッピングされます。ただし、syslog-ng アプリケーション ログの場合は metadata.description にマッピングされます。DHCP イベントの場合、dhcp_type が説明の先頭に追加されます。 |
| dhcp_type | metadata.product_event_type | DHCP メッセージ タイプ(DHCPDISCOVER、DHCPOFFER など)が抽出され、マッピングされます。 |
| ホスト | intermediary.hostname または intermediary.ip | ホスト値が有効な IP アドレスの場合、intermediary.ip にマッピングされます。それ以外の場合は、intermediary.hostname にマッピングされます。 |
| ホスト | principal.hostname、principal.asset.hostname | プリンシパル IP が存在しない場合、ホストはプリンシパル ホスト名として扱われます。 |
| mac | principal.mac、network.dhcp.chaddr | DHCP リクエストに関連付けられた MAC アドレスが抽出され、マッピングされます。 |
| src_ip | principal.ip、principal.asset.ip | grok パターンを使用して、特定のログ形式から抽出されます。 |
| src_mac | principal.mac | Grok パターンを使用して、特定のログ形式から抽出されます。 |
| dst_mac | target.mac | grok パターンを使用して、特定のログ形式から抽出されます。 |
| timestamp | metadata.event_timestamp | タイムスタンプはログ メッセージから抽出され、UDM タイムスタンプ形式に変換されます。タイムゾーン情報(tz)は、利用可能な場合は変換前にタイムスタンプに追加されます。 |
| timestamp_no_year | metadata.event_timestamp | 年を含まないタイムスタンプが存在する場合は、解析され、解析プロセス中に現在の年が追加されます。 |
| ユーザー | principal.user.userid | イベントに関連付けられたユーザー名が抽出され、マッピングされます。 |
| column1 | security_result.rule_id | 説明が CSV 形式の場合、最初の CSV 列からマッピングされます。 |
| column6 | security_result.rule_type | 説明が CSV 形式の場合、6 番目の CSV 列からマッピングされます。 |
| column7 | security_result.action | 説明が CSV 形式の場合、7 番目の CSV 列からマッピングされます。「BLOCK」または「ALLOW」に変換されます。 |
| column8 | network.direction | 説明が CSV 形式の場合、8 番目の CSV 列からマッピングされます。「INBOUND」または「OUTBOUND」に変換されます。 |
| column13 | network.ip_protocol(UDP または ICMP の場合) | 説明が CSV 形式で、プロトコルが UDP または ICMP の場合、13 番目の CSV 列からマッピングされます。TCP/UDP イベントの場合、キー「Id」を持つ追加フィールドの作成に使用されます。 |
| column16 | principal.ip、principal.asset.ip(IPv6 で column9 が 6 の場合) | 説明が CSV 形式で、column9 が 6 の場合、16 番目の CSV 列からマッピングされます。TCP/UDP イベントの場合、column9 が 4 の場合、プロトコルの識別に使用されます。 |
| column17 | target.ip、target.asset.ip(IPv6 で ip_failure でない場合) | 説明が CSV 形式で、column9 が 6、値が有効な IP の場合、17 番目の CSV 列からマッピングされます。TCP/UDP イベントの場合、プロトコルの識別に使用されます。 |
| column18 | principal.port(UDP の場合) | 説明が CSV 形式で、プロトコルが UDP の場合、18 番目の CSV 列からマッピングされます。TCP/UDP イベントの場合、network.received_bytes にマッピングされます。 |
| column19 | target.port(UDP の場合) | 説明が CSV 形式で、プロトコルが UDP の場合、19 番目の CSV 列からマッピングされます。DHCP イベントの場合、network.dhcp.yiaddr にマッピングされます。その他のイベントの場合は、principal.ip、principal.asset.ip にマッピングされます。 |
| column20 | additional.fields(キー: 「data_length」)(UDP の場合) | 説明が CSV 形式で、プロトコルが UDP の場合、20 番目の CSV 列からマッピングされます。他のイベントの場合、target.ip、target.asset.ip にマッピングされます。 |
| column21 | principal.port(TCP/UDP の場合) | 説明が CSV 形式で、プロトコルが TCP または UDP の場合、21 番目の CSV 列からマッピングされます。 |
| column22 | target.port(TCP/UDP の場合) | 説明が CSV 形式で、プロトコルが TCP または UDP の場合、22 番目の CSV 列からマッピングされます。 |
| column23 | additional.fields(キー: 「data_length」)(TCP/UDP の場合) | 説明が CSV 形式で、プロトコルが TCP または UDP の場合、23 番目の CSV 列からマッピングされます。 |
| column24 | additional.fields(キー: "tcp_flags")(TCP の場合) | 説明が CSV 形式で、プロトコルが TCP の場合、24 番目の CSV 列からマッピングされます。 |
| column25 | additional.fields(キー: sequence_number)(TCP/UDP の場合) | 説明が CSV 形式で、プロトコルが TCP または UDP の場合、25 番目の CSV 列からマッピングされます。 |
| column29 | additional.fields(キー: 「tcp_options」)(TCP の場合) | 説明が CSV 形式で、プロトコルが TCP の場合、29 番目の CSV 列からマッピングされます。 |
| compression_algo | additional.fields(キー: 「Compression Algorithm」) | 説明フィールドから抽出され、追加フィールドとして追加されました。 |
| 降順 | metadata.description | メッセージ フィールドから抽出され、説明として使用されます。 |
| principal_ip | principal.ip、principal.asset.ip | 説明フィールドから抽出され、プリンシパル IP アドレスを表します。 |
| principal_username | principal.user.userid | 説明フィールドから抽出され、プリンシパル ユーザー名を表します。 |
| ステータス | security_result.detection_fields(キー: 「status」) | 説明フィールドから抽出され、セキュリティ結果内の検出フィールドとして追加されます。 |
| target_host | target.hostname、target.asset.hostname | description フィールドから抽出され、ターゲット ホスト名を表します。 |
| src_port | principal.port | 説明フィールドから抽出され、送信元ポートを表します。さまざまなログフィールドとパーサー ロジックに基づいて決定されます。NETWORK_CONNECTION、NETWORK_DHCP、STATUS_UPDATE、GENERIC_EVENT のいずれかです。「PFSENSE」にハードコードされています。「PFSENSE」にハードコードされています。「PFSENSE」にハードコードされています。DHCP イベントの場合は「DHCP」に設定されます。DHCPDISCOVER と DHCPREQUEST の場合は「BOOTREQUEST」に設定され、DHCPOFFER と DHCPACK の場合は「BOOTREPLY」に設定されます。dhcp_type フィールドに基づいて「DISCOVER」、「REQUEST」、「OFFER」、「ACK」のいずれかに設定します。 |
pid |
intermediary.process.pid |
変更履歴からマッピング |
application |
intermediary.application |
変更履歴からマッピング |
ipv4" and "ipv6 |
principal.ip |
変更履歴からマッピング |
security_result.category |
AUTH_VIOLATION |
変更履歴からマッピング |
method |
network.http.method |
変更履歴からマッピング |
referer |
network.http.referral_url |
変更履歴からマッピング |
response_code |
network.http.response_code |
変更履歴からマッピング |
user_agent |
network.http.user_agent |
変更履歴からマッピング |
sent_bytes |
network.sent_bytes |
変更履歴からマッピング |
url |
target.url |
変更履歴からマッピング |
http_version |
additional.fields |
変更履歴からマッピング |
column19" which is "source-address |
network.dhcp.yiaddr |
変更履歴からマッピング |
column17" which is "destination-address |
target.ip |
変更履歴からマッピング |
column16" which is "source-address |
principal.ip |
変更履歴からマッピング |
column12" which is "hop_limit |
additional.fields |
変更履歴からマッピング |
column13" which is "ip_protocol |
network.ip_protocol |
変更履歴からマッピング |
ttl |
additional.fields |
変更履歴からマッピング |
Offset |
additional.fields |
変更履歴からマッピング |
Data length |
additional.fields |
変更履歴からマッピング |
Length |
additional.fields |
変更履歴からマッピング |
Sequence-number |
additional.fields |
変更履歴からマッピング |
変更ログ
さらにサポートが必要な場合 コミュニティ メンバーや Google SecOps のプロフェッショナルから回答を得ることができます。