.. _corelight-client:

.. バージョン番号は自動的に埋め込まれます。 .. |version| replace:: 1.5.17

==================================== Corelight Sensor コマンドラインクライアント

.. contents::

概要

このツールは、Corelight Sensor <https://www.corelight.com>_ 向けのコマンドラインクライアントを提供します。Corelight Sensor は、Bro の開発者によってゼロから設計された Bro <https://www.bro.org>_ アプライアンスであり、ネットワークトラフィックをアナリティクスパイプライン向けの高忠実度データへ変換します。このコマンドラインクライアントを使用すると、包括的な RESTful API を通じて Corelight Sensor をリモートで設定および制御できます。このクライアント概要の詳細版については、Corelight Sensor のドキュメントを参照してください。

:バージョン: |version| :ホーム: http://www.corelight.com :GitHub: https://github.com/corelight/corelight-client :著者: Corelight, Inc. <https://www.corelight.com>_ [email protected]

ライセンス

このクライアントは BSD ライセンスの下でオープンソースです。詳細は COPYING を参照してください。

インストール

このコマンドラインクライアントには Python >= 3.4 が必要で、主要な依存関係として requests モジュールがインストールされている必要があります。

クライアントをインストールする最も簡単な方法は、Python Package Index を利用することです::

# pip3 install corelight-client

あるいは、GitHub から最新版をインストールすることもできます::

# git clone https://github.com/corelight/corelight-client
# cd corelight-client
# python3 setup.py install

すべてが正しくインストールされていれば、--help で使用方法のメッセージが表示されます::

# corelight-client --help
Usage: corelight-client [<global options>] <command> <subcommand> [<options>]
          [--ssl-ca-cert SSL_CA_CERT] [--ssl-no-verify-certificate]
          [--ssl-no-verify-hostname] [--cache CACHE]
[...]

最初のうちは、--help はまだ使用するコマンドを表示しないことに注意してください。次のセクションに進んで、クライアントをデバイスに接続させてください。

アクセスと認証

デバイスの設定インターフェースを通じて Corelight API へのアクセスを有効にする必要があります。また、API ユーザー admin（無制限アクセス用）と monitor（読み取り専用アクセス用）のパスワードを設定する必要があります。詳細については Corelight Sensor のドキュメントを参照してください。

次に、corelight-client に Corelight Sensor のネットワークアドレスを指定する必要があります。これには次の 3 つの方法があります:

• コマンドラインに -b <address> を追加する。
• 内容 device=<address> の設定ファイル ~/.corelight-client.rc を作成する。
• 環境変数 CORELIGHT_DEVICE=<address> を設定する。

これがすべて設定されていれば、corelight-client --help はユーザー名とパスワードを尋ね、その後、デバイス API によってクライアントが提供できるコマンドの完全なリストを表示します。認証情報の保存を確認すると、クライアントは将来の再利用のためにそれらを ~/.corelight-client/credentials に保存します。認証情報は、設定ファイル_ または グローバルオプション_ で指定することもできます。

使用法

クライアントは、<command> <subcommand> [options] の形式の一連のコマンドを通じて API の機能を提供します。任意のコマンドに --help を追加すると、そのすべての機能とオプションの説明が表示されます。

--help の出力でコマンドのオプションが file タイプとして表示されている場合、クライアントは送信するファイルのパスを指定する必要があります。さらに、任意のオプションの値の前に file:// を付けると、コマンドライン上で直接指定する代わりに、ファイルからその内容を読み取ることができます。

(注: --help の出力にコマンドのリストが含まれるのは、クライアントがデバイスに接続して認証できる場合のみです。)

.. _corelight-client-options:

グローバルオプション

corelight-client は以下のグローバルコマンドラインオプションをサポートします。--device と --fleet のオプションは相互に排他的に使用する必要があります。その他のオプションはすべてのリクエストに適用されます:

--async 非同期コマンドの完了を待たずに終了します。

--device Corelight Sensor デバイスのネットワークアドレスを指定します。

--fleet Corelight Fleet Manager のネットワークアドレスを指定します。

--uid 指定された Corelight Fleet Manager によって管理される Corelight Sensor の UID を指定します。

--cache=<file> Corelight Sensor のメタデータをキャッシュするためのカスタムファイルを設定します。

--debug HTTP リクエストと応答を表示するデバッグ出力を有効にします。

--password 認証用のパスワードを指定します。

--mfa 指定された Corelight Fleet Manager での認証用の 2FA 検証コードを指定します。ユーザーに尋ねるには '-' を使用します。

--ssl-ca-cert デバイスの正当性を検証するためのカスタム SSL CA 証明書を含むファイルを指定します。

--ssl-no-verify-certificate Corelight Sensor の SSL 証明書をすべて受け入れるようクライアントに指示します。

--ssl-no-verify-hostname ホスト名と一致しない場合でも、Corelight Sensor の SSL 証明書を受け入れるようクライアントに指示します。

--socket リクエスト送信に Unix ドメインソケットを使用するようクライアントに指示します。

--user 認証用のユーザー名を指定します。

--version corelight-client のバージョンを表示して終了します。

--ignore-meta CLI で指定されない限り、センサー API 呼び出しにメタデータ情報を送信しません。

.. _corelight-client-config:

設定ファイル

corelight-client は設定ファイル ~/.corelight-client.rc を探します。ファイルは <key>=<value> の行で構成されている必要があります。# で始まるコメントは無視されます。corelight-client は以下のキーをサポートします:

device Corelight Sensor デバイスのネットワークアドレス。

fleet Corelight Fleet Manager のネットワークアドレス。

uid 指定された Corelight Fleet Manager によって管理される Corelight Sensor の UID。

user 認証用のユーザー名。

password 認証用のパスワード。

mfa Corelight Fleet Manager での認証用の 2FA 検証コード。ユーザーに尋ねるには '-' を使用します。

ssl-ca-cert デバイスの正当性を検証するためのカスタム SSL CA 証明書を含むファイル。

ssl-no-verify-certificate false に設定すると、クライアントは Corelight Sensor の SSL 証明書をすべて受け入れます。

ssl-no-verify-hostname false に設定すると、ホスト名と一致しない場合でも、クライアントは Corelight Sensor の SSL 証明書を受け入れます。

socket リクエスト送信に使用する Unix ドメインソケット。