HCL BigFix ログを収集する

以下でサポートされています。

このドキュメントでは、Cloud Run 関数を介して Cloud Storage V2 を使用して HCL BigFix ログを Google Security Operations に取り込む方法について説明します。

HCL BigFix は、統合エンドポイント管理、セキュリティ、コンプライアンス機能を提供するエンドポイント管理プラットフォームです。組織は、パッチ管理、ソフトウェア配布、構成管理、セキュリティ コンプライアンスなど、インフラストラクチャ全体のエンドポイントを検出、管理、修復できます。Cloud Run functions の関数は、セッション関連性クエリを使用して HCL BigFix REST API をポーリングし、結果を NDJSON として Cloud Storage バケットに書き込みます。Google SecOps は、Cloud Storage V2 フィードを介してそれらを取り込みます。

始める前に

次の前提条件を満たしていることを確認してください。

  • Google SecOps インスタンス
  • 課金が有効になっている Google Cloud プロジェクト
  • マスター オペレーター権限での HCL BigFix コンソールへのアクセス
  • HCL BigFix Server バージョン 9.5 以降
  • BigFix サーバーで実行されている WebReports サービス
  • Cloud Run functions の関数からポート 52311(デフォルトの REST API ポート)の BigFix サーバーへのネットワーク接続
  • Google Cloud 有効な API: Cloud Run functions、Cloud Storage、Cloud Scheduler、Pub/Sub、Identity and Access Management(IAM)

Cloud Storage バケットを作成する

  1. Google Cloud コンソールに移動します。
  2. プロジェクトを選択するか、新しいプロジェクトを作成します。
  3. ナビゲーション メニューで、[Cloud Storage] > [バケット] に移動します。
  4. [バケットを作成] をクリックします。
  5. 次の構成情報を提供してください。

    設定 値
    バケットに名前を付ける グローバルに一意の名前(hcl-bigfix-logs など)を入力します。
    ロケーション タイプ ニーズに応じて選択します(リージョン、デュアルリージョン、マルチリージョン)。
    ロケーション Google SecOps インスタンスに最も近いロケーションを選択します(例: us-central1)。
    ストレージ クラス Standard(頻繁にアクセスされるログに推奨)
    アクセス制御 均一(推奨)
    保護ツール 省略可: オブジェクトのバージョニングまたは保持ポリシーを有効にする
  6. [作成] をクリックします。

HCL BigFix API 認証情報を収集する

Cloud Run functions がエンドポイント データを取得できるようにするには、REST API アクセス権限を持つ専用の BigFix Console オペレーターを作成する必要があります。

API アクセス専用のオペレーターを作成する

  1. BigFix コンソールにログインします。
  2. [ツール] > [オペレーターを作成] に移動します。
  3. [ユーザーを追加] ダイアログで、次の情報を入力します。

    • ユーザー名: わかりやすいユーザー名を入力します(例: chronicle_api)。
    • パスワード: 安全なパスワードを入力します。
    • パスワードの確認: パスワードを再入力します。
  4. [OK] をクリックします。

オペレーターの権限を構成する

オペレーターを作成すると、[Console Operator] ウィンドウが自動的に開きます。

  1. [詳細] タブをクリックします。
  2. [概要] セクションで次の操作を行います。
    • [このユーザーのログインを常に許可する] を選択します。
  3. [権限] セクションで、次の権限を設定します。
    • クエリを送信できる: [はい] に設定します。
    • カスタム コンテンツ: [はい] に設定します。
  4. [Interface Login Privileges] セクションで、次の操作を行います。
    • REST API を使用できる: [はい] に設定します。
  5. [管理対象のパソコン] タブをクリックします。
  6. [All computers] を選択して、オペレーターがすべてのエンドポイントをクエリできるようにするか、要件に基づいて特定のコンピュータ グループを選択します。
  7. [変更を保存] をクリックします。

API 認証情報を記録する

Cloud Run 関数の環境変数を構成するために、次の情報を保存します。

  • ユーザー名: 作成したオペレーターのユーザー名(例: chronicle_api)
  • パスワード: オペレーターのパスワード
  • BigFix サーバーのホスト名: BigFix サーバーの完全修飾ドメイン名または IP アドレス(例: bigfix.company.com)
  • API ポート: REST API ポート(デフォルトは 52311)

API の接続性をテストする

  • BigFix サーバーへのネットワーク アクセス権を持つマシンから次のテストクエリを実行して、API 認証情報が機能することを確認します。

    curl -k -u "chronicle_api:YOUR_PASSWORD" \
      -X POST \
      -H "Content-Type: application/x-www-form-urlencoded" \
      -d "relevance=(name of it, id of it) of bes computers" \
      "https://bigfix-server:52311/api/query"
    

    成功すると、コンピュータ名と ID を含む XML ドキュメントが返されます。認証エラーが発生した場合は、前の手順で構成したオペレーターの権限を確認します。

Cloud Run functions のサービス アカウントを作成する

  1. Google Cloud コンソールで、[IAM と管理] > [サービス アカウント] に移動します。
  2. [サービス アカウントを作成] をクリックします。
  3. 次の構成情報を提供してください。

    • サービス アカウント名: bigfix-cloud-run(またはわかりやすい名前)を入力します。
    • サービス アカウントの説明: 「Service account for HCL BigFix Cloud Run function to write logs to Cloud Storage」と入力します。
  4. [作成して続行] をクリックします。

  5. [このサービス アカウントにプロジェクトへのアクセスを許可する] セクションで、次のロールを追加します。

    • Storage オブジェクト管理者(Cloud Storage バケット内のオブジェクトの読み取り / 書き込みを行う)。
    • Cloud Run 起動元(Cloud Scheduler が関数を呼び出せるようにするため)。
  6. [続行] をクリックします。

  7. [完了] をクリックします。

Pub/Sub トピックの作成

Cloud Scheduler は、Pub/Sub トピックを介して Cloud Run 関数をトリガーします。

  1. Google Cloud コンソールで、[Pub/Sub] > [トピック] に移動します。
  2. [トピックを作成] をクリックします。
  3. [トピック ID] フィールドに「bigfix-ingestion-trigger」と入力します。
  4. デフォルト設定のままにします。
  5. [作成] をクリックします。

Cloud Run functions を作成する

関数のソースファイルを準備する

Cloud Run functions の関数のデプロイ用に、次の 2 つのファイルを作成します。

  • requirements.txt

    functions-framework==3.*
    google-cloud-storage==2.*
    requests>=2.31.0
    
  • main.py

    import base64
    import json
    import logging
    import os
    import xml.etree.ElementTree as ET
    from datetime import datetime, timezone, timedelta
    
    import requests
    import urllib3
    from google.cloud import storage
    
    urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
    
    logging.basicConfig(level=logging.INFO)
    logger = logging.getLogger(__name__)
    
    GCS_BUCKET = os.environ["GCS_BUCKET"]
    GCS_PREFIX = os.environ.get("GCS_PREFIX", "bigfix_logs")
    STATE_KEY = os.environ.get("STATE_KEY", "bigfix_state.json")
    BIGFIX_SERVER = os.environ["BIGFIX_SERVER"]
    BIGFIX_PORT = os.environ.get("BIGFIX_PORT", "52311")
    BIGFIX_USERNAME = os.environ["BIGFIX_USERNAME"]
    BIGFIX_PASSWORD = os.environ["BIGFIX_PASSWORD"]
    MAX_RECORDS = int(os.environ.get("MAX_RECORDS", "10000"))
    LOOKBACK_HOURS = int(os.environ.get("LOOKBACK_HOURS", "24"))
    
    BIGFIX_BASE_URL = f"https://{BIGFIX_SERVER}:{BIGFIX_PORT}/api"
    
    RELEVANCE_QUERIES = {
        "computers": (
            '(id of it, name of it, operating system of it, '
            'last report time of it as string, ip address of it as string, '
            'root server of it) of bes computers'
        ),
        "actions": (
            '(id of it, name of it, name of issuer of it, '
            'time issued of it as string, state of it) of bes actions'
        ),
        "fixlets": (
            '(id of it, name of it, source severity of it, '
            'source of it, category of it) of bes fixlets '
            'whose (source severity of it is not "")'
        ),
    }
    
    def _get_auth_header():
        """Build Basic Auth header from credentials."""
        credentials = f"{BIGFIX_USERNAME}:{BIGFIX_PASSWORD}"
        encoded = base64.b64encode(credentials.encode("utf-8")).decode("utf-8")
        return {"Authorization": f"Basic {encoded}"}
    
    def _query_bigfix(relevance, session=None):
        """Execute a session relevance query against the BigFix REST API."""
        url = f"{BIGFIX_BASE_URL}/query"
        headers = _get_auth_header()
        headers["Content-Type"] = "application/x-www-form-urlencoded"
    
        data = {"relevance": relevance}
        http = session or requests
        resp = http.post(url, headers=headers, data=data, verify=False, timeout=120)
        resp.raise_for_status()
        return resp.text
    
    def _parse_query_xml(xml_text, query_name):
        """Parse BigFix XML response into a list of dicts."""
        root = ET.fromstring(xml_text)
        results = []
    
        for result_elem in root.iter("Result"):
            tuples = result_elem.findall("Tuple")
            if tuples:
                for tup in tuples:
                    answers = [a.text or "" for a in tup.findall("Answer")]
                    record = _map_answers(query_name, answers)
                    record["_query"] = query_name
                    record["_collection_time"] = (
                        datetime.now(timezone.utc).isoformat()
                    )
                    results.append(record)
            else:
                answers_elems = result_elem.findall("Answer")
                if answers_elems:
                    answers = [a.text or "" for a in answers_elems]
                    record = _map_answers(query_name, answers)
                    record["_query"] = query_name
                    record["_collection_time"] = (
                        datetime.now(timezone.utc).isoformat()
                    )
                    results.append(record)
    
        logger.info(
            "Query '%s' returned %d results.", query_name, len(results)
        )
        return results
    
    def _map_answers(query_name, answers):
        """Map positional answers to named fields based on query type."""
        field_maps = {
            "computers": [
                "client_id", "client_name", "OS",
                "last_report_time", "ip_address", "root_server",
            ],
            "actions": [
                "action_id", "action_name", "issuer",
                "time_issued", "state",
            ],
            "fixlets": [
                "fixlet_id", "fixlet_name", "source_severity",
                "source", "category",
            ],
        }
        fields = field_maps.get(query_name, [])
        record = {}
        for i, value in enumerate(answers):
            key = fields[i] if i < len(fields) else f"field_{i}"
            record[key] = value
        return record
    
    def _load_state(gcs_client):
        """Load the last run state from GCS."""
        bucket = gcs_client.bucket(GCS_BUCKET)
        blob = bucket.blob(f"{GCS_PREFIX}/{STATE_KEY}")
        if blob.exists():
            data = blob.download_as_text()
            return json.loads(data)
        return {}
    
    def _save_state(gcs_client, state):
        """Persist run state to GCS."""
        bucket = gcs_client.bucket(GCS_BUCKET)
        blob = bucket.blob(f"{GCS_PREFIX}/{STATE_KEY}")
        blob.upload_from_string(
            json.dumps(state), content_type="application/json"
        )
        logger.info("State saved to gs://%s/%s/%s", GCS_BUCKET, GCS_PREFIX, STATE_KEY)
    
    def _write_ndjson(gcs_client, records, timestamp_str):
        """Write records as NDJSON to GCS."""
        if not records:
            logger.info("No records to write.")
            return
    
        records = records[:MAX_RECORDS]
        ndjson_lines = "\n".join(json.dumps(r) for r in records)
        blob_name = f"{GCS_PREFIX}/{timestamp_str}/bigfix_events.ndjson"
        bucket = gcs_client.bucket(GCS_BUCKET)
        blob = bucket.blob(blob_name)
        blob.upload_from_string(ndjson_lines, content_type="application/x-ndjson")
        logger.info(
            "Wrote %d records to gs://%s/%s",
            len(records), GCS_BUCKET, blob_name,
        )
    
    def main(event, context):
        """Cloud Run function entry point triggered by Pub/Sub."""
        logger.info("HCL BigFix ingestion function started.")
    
        gcs_client = storage.Client()
        state = _load_state(gcs_client)
    
        last_run = state.get("last_run")
        if last_run:
            logger.info("Last successful run: %s", last_run)
    
        now = datetime.now(timezone.utc)
        timestamp_str = now.strftime("%Y/%m/%d/%H%M%S")
    
        all_records = []
        session = requests.Session()
    
        for query_name, relevance in RELEVANCE_QUERIES.items():
            try:
                xml_text = _query_bigfix(relevance, session=session)
                records = _parse_query_xml(xml_text, query_name)
                all_records.extend(records)
            except requests.exceptions.RequestException as e:
                logger.error(
                    "Failed to execute query '%s': %s", query_name, e
                )
            except ET.ParseError as e:
                logger.error(
                    "Failed to parse XML for query '%s': %s", query_name, e
                )
    
        session.close()
    
        _write_ndjson(gcs_client, all_records, timestamp_str)
    
        state["last_run"] = now.isoformat()
        state["records_written"] = len(all_records)
        _save_state(gcs_client, state)
    
        logger.info(
            "HCL BigFix ingestion complete. %d total records written.",
            len(all_records),
        )
        return "OK"
    

Cloud Run 関数をデプロイする

  1. 両方のファイル(main.py と requirements.txt)をローカル ディレクトリ(bigfix-function/ など)に保存します。
  2. Cloud Shell または gcloud CLI がインストールされているターミナルを開きます。
  3. 次のコマンドを実行して、関数をデプロイします。

    gcloud functions deploy bigfix-to-gcs \
      --gen2 \
      --region=us-central1 \
      --runtime=python312 \
      --trigger-topic=bigfix-ingestion-trigger \
      --entry-point=main \
      --memory=512MB \
      --timeout=540s \
      --service-account=bigfix-cloud-run@PROJECT_ID.iam.gserviceaccount.com \
      --set-env-vars="GCS_BUCKET=hcl-bigfix-logs,GCS_PREFIX=bigfix_logs,STATE_KEY=bigfix_state.json,BIGFIX_SERVER=bigfix.company.com,BIGFIX_PORT=52311,BIGFIX_USERNAME=chronicle_api,BIGFIX_PASSWORD=YOUR_PASSWORD,MAX_RECORDS=10000,LOOKBACK_HOURS=24"
    
  4. 次のプレースホルダの値を置き換えます。

    • PROJECT_ID: 実際の Google Cloud プロジェクト ID。
    • hcl-bigfix-logs: Cloud Storage バケット名。
    • bigfix.company.com: BigFix サーバーのホスト名または IP アドレス。
    • chronicle_api: BigFix オペレーターのユーザー名。
    • YOUR_PASSWORD: BigFix オペレーターのパスワード。
  5. 関数のステータスを確認して、デプロイを検証します。

    gcloud functions describe bigfix-to-gcs --region=us-central1 --gen2
    

環境変数のリファレンス

変数 必須 デフォルト 説明
GCS_BUCKET ○ NDJSON 出力を保存する Cloud Storage バケット名
GCS_PREFIX × bigfix_logs バケット内のオブジェクト接頭辞(フォルダパス)
STATE_KEY × bigfix_state.json 接頭辞内の状態ファイルの blob 名
BIGFIX_SERVER ○ BigFix サーバーのホスト名または IP アドレス
BIGFIX_PORT × 52311 BigFix REST API ポート
BIGFIX_USERNAME ○ BigFix オペレーターのユーザー名
BIGFIX_PASSWORD ○ BigFix オペレーターのパスワード
MAX_RECORDS × 10000 1 回の実行で書き込むレコードの最大数
LOOKBACK_HOURS × 24 最初の収集で遡る時間数

Cloud Scheduler ジョブを作成する

Cloud Scheduler は、Pub/Sub トピックを介して Cloud Run functions の関数を定期的にトリガーします。

  1. Google Cloud コンソールで、[Cloud Scheduler] に移動します。
  2. [ジョブを作成] をクリックします。
  3. 次の構成情報を指定します。
    • 名前: 「bigfix-ingestion-schedule」と入力します。
    • リージョン: Cloud Run functions の関数と同じリージョン(us-central1 など)を選択します。
    • 頻度: 0 */4 * * * と入力します(4 時間ごとに実行)。データ量と鮮度の要件に基づいてスケジュールを調整します。
    • タイムゾーン: 任意のタイムゾーンを選択します。
  4. [続行] をクリックします。
  5. [実行を構成する] セクションで、次の操作を行います。
    • ターゲット タイプ: [Pub/Sub] を選択します。
    • トピック: bigfix-ingestion-trigger を選択します。
    • メッセージ本文: 「{"run": true}」と入力します。
  6. [続行] をクリックします。
  7. [オプションの設定を構成する] セクションで、次の操作を行います。
    • 最大再試行回数: 「3」と入力します。
    • 最小バックオフ時間: 「5s」と入力します。
    • 最大バックオフ時間: 「60s」と入力します。
  8. [作成] をクリックします。
  9. テストをすぐに実行するには、ジョブ名の横にあるその他アイコン(...)をクリックし、[Force run] を選択します。

Google SecOps サービス アカウントを取得してフィードを構成する

Google SecOps は、一意のサービス アカウントを使用して Cloud Storage バケットからデータを読み取ります。このサービス アカウントにバケットへのアクセス権を付与する必要があります。

サービス アカウントのメールアドレスを取得する

  1. [設定] > [データ マネジメント] > [フィード] に移動します。SIEM のみのプラットフォームを使用している場合は、[設定] > [フィード] に移動します。
  2. [Add New Feed] をクリックします。
  3. [単一フィードを設定] をクリックします。
  4. [フィード名] フィールドに、フィードの名前を入力します(例: HCL BigFix Logs)。
  5. [ソースタイプ] として [Google Cloud Storage V2] を選択します。
  6. [ログタイプ] として [HCL BigFix] を選択します。
  7. [サービス アカウントを取得する] をクリックします。

    一意のサービス アカウントのメールアドレスが表示されます。例:

    chronicle-12345678@chronicle-gcp-prod.iam.gserviceaccount.com
    
  8. このメールアドレスをコピーして、次のステップで使用します。

  9. [次へ] をクリックします。

  10. 次の入力パラメータの値を指定します。

    • ストレージ バケットの URL: Cloud Storage バケットの URI を入力します。

      gs://hcl-bigfix-logs/bigfix_logs/
      
      • hcl-bigfix-logs は、Cloud Storage バケット名で置き換えます。
      • bigfix_logs は、構成済みの GCS_PREFIX 値に置き換えます。
    • Source deletion option: 必要に応じて削除オプションを選択します。

      • なし: 転送後にファイルを削除しません(テストにおすすめ)。
      • 転送されたファイルを削除する: 転送が完了した後にファイルを削除します。
      • 転送されたファイルと空のディレクトリを削除する: 転送が成功した後にファイルと空のディレクトリを削除します。

    • ファイルの最長存続期間: 過去数日間に変更されたファイルを含めます(デフォルトは 180 日)。

    • Asset namespace: アセットの名前空間。

    • Ingestion labels: このフィードのイベントに適用されるラベル。

  11. [次へ] をクリックします。

  12. [Finalize] 画面で新しいフィードの設定を確認し、[送信] をクリックします。

Google SecOps サービス アカウントに IAM 権限を付与する

Google SecOps サービス アカウントには、Cloud Storage バケットに対する Storage オブジェクト閲覧者のロールが必要です。

  1. [Cloud Storage] > [バケット] に移動します。
  2. バケット名(例: hcl-bigfix-logs)をクリックします。
  3. [権限] タブに移動します。
  4. [アクセス権を付与] をクリックします。
  5. 次の構成情報を指定します。
    • プリンシパルを追加: Google SecOps サービス アカウントのメールアドレス(例: chronicle-12345678@chronicle-gcp-prod.iam.gserviceaccount.com)を貼り付けます。
    • ロールを割り当てる: [Storage オブジェクト閲覧者] を選択します。
  6. [保存] をクリックします。

UDM マッピング テーブル

ログフィールド UDM マッピング ロジック
WMI_Asset_ID entity.asset.asset_id 空でなく、「なし」でない場合は、「アセット ID:」+ 値に設定します。
Computer_Serial_Number, Computer_Manufacturer, Computer_Model entity.asset.hardware serial_number、manufacturer、model を含むオブジェクト
client_name entity.asset.hostname 値を直接コピー
MAC_Addresses entity.asset.mac 書式設定後に配列から統合
OperatingSystemType entity.asset.platform_software.platform 空でなく「Unix」でない場合は大文字の値
OS entity.asset.platform_software.platform_version 値を直接コピー
SerialNumber entity.asset.product_object_id 空でない場合の値
WindowsOperatingSystem entity.asset.software 空でない場合は、名前が値に設定されたオブジェクト
OperatingSystemRole entity.asset.type 空でない場合は大文字の値
DNS_Name entity.domain.name 空でない場合の値
CloudInfo entity.labels キー「CloudInfo」と値(引用符は削除)を持つラベル オブジェクト(空でない場合)
ドメインロール entity.user.attribute.roles 空でない場合は、名前が値に設定されたオブジェクト
Active_Directory_Path entity.user.group_identifiers 空ではなく、かつ「」ではない場合は、統合された値
WMI_Service_Tag entity.user.product_object_id 空でない場合の値
User_Name entity.user.user_display_name 空でなく「」でない場合の値
client_id entity.user.userid 値を直接コピー
metadata.entity_type SerialNumber が空でない場合は「ASSET」に設定し、それ以外の場合は「USER」に設定します。
metadata.product_name 「HCL Big Fix」に設定します。
metadata.vendor_name 「HCL Software」に設定します。
CloudInfo event.idm.entity.entity.labels 変更履歴からマッピング

変更ログ

このパーサーの変更ログを表示する

さらにサポートが必要な場合 コミュニティ メンバーや Google SecOps のプロフェッショナルから回答を得ることができます。