Unified Agent の導入
概要概要
このページでは、Unified Agent の使用を開始する方法について説明します。
前提条件
Unified Agent を実行するコンピュータに次の Java バージョンのいずれかがあることを確認します 。
Java JDK 8
Java JRE 8
Java JDK 11
さらに、プロジェクトタイプに応じて、関連するパッケージマネージャーがインストールされていることを確認します。
C# |
|
Elixir, Erlang | MIX |
Go |
|
Haskell | Cabal |
Java |
|
JavaScript |
|
Objective-C, Swift | CocoaPods プロジェクトがビルドされていない場合にのみ必要 |
OCaml | Opam |
PHP | Composer プロジェクトがビルドされていない場合にのみ必要 |
Python |
|
NS | Packrat-使用する場合 |
R | Packrat プロジェクトがビルドされていない場合（または検出がNPMを使用するように設定されている場合）にのみ必要です |
Ruby | Bundler |
Rust | Cargo プロジェクトが構築されていない場合にのみ必要 |
Scala | SBT |
統合エージェントの使用の概要
1 | Download the latest version of the Unified Agent and verify its integrity. |
2 | |
3 | |
4 | 次のいずれかを実行します。
（このページの実行例を参照してください） |
5 |
ユニファイドエージェントのダウンロード
ユニファイドエージェントの最新バージョンは Amazon S3 もしくは GitHubからダウンロードされます。
21.9.1.1 | 25-10-2021 | 706694E349EA14CB04C4621B70D99A93 | 該当なし |
Unified Agent の設定
Unified Agent を設定するには、いくつかの方法があります。
： バージョン20.9.1以降、設定ファイルを使用して Unified Agent を実行する必要がなくなりました。必須パラメータが Unified Agent に再渡されると、サポートされているいずれかの方法で、設定ファイルが欠落している場合でも、Unified Agent を失敗することなく実行できます。
設定ファイル
設定ファイルへのパスは、-c 引数を使用してコマンドラインで Unified Agent に渡すことができます。ファイルが指定されていない場合、Unified Agent は現在の作業ディレクトリで wss-unified-agent.config という名前の設定ファイルを探します。詳細については、こちらを参照してください。構成ファイルをダウンロードするには、ここをクリックしてください。完全な設定パラメータリファレンスについては、Unified Agent 設定パラメータのページを参照してください。環境変数
設定ファイルで使用可能なすべてのパラメータは、環境変数を使用して Unified Agent に渡すこともできます。詳細については、こちらを参照してください。コマンドラインパラメータ
Unified Agent は、コマンドラインオプションとパラメータをサポートしています。詳細については、こちらを参照してください。
構成は、次の優先順位で適用されます。
コマンドラインパラメータ
環境変数
設定ファイル
デフォルト値
設定パラメーターの設定
Unified Agent を実行するために、使用可能な任意の方法で次の設定パラメータを設定します。
API Key | WS_API_KEY | apiKey | -apiKey | 組織の識別子 |
WhiteSource URL | WS_WSS_URL | wss.url | -wss.url | WhiteSource URL: https://[saas/app/app-eu/saas-eu].whitesourcesoftware.com/agent |
Project Name | WS_PROJECT_NAME | projectName | -project | スキャンの実行後に作成されたプロジェクトの名前 |
Includes | WS_INCLUDES | includes | N/A | GLOBパターン（つまり、 すべての.cファイルをスキャンするための **/*.c ）を使用して、スキャンに含める/除外するファイル（ファイル拡張子、ファイル名、フォルダー名など）。参照してください詳細についてはここで参照してください。 |
より高度で特定の環境関連パラメータの設定については、 こちらを参照してください。
スキャンのベストプラクティス
一般的なヒント
WhiteSourceツールを使用した最適な検出は、製品の作成に使用された依存関係ファイルが利用可能なビルド中（またはビルド前）にスキャンするときに実現されます。
検出中、マニフェストファイル（Pythonのrequirements.txtなど）がスキャンされ、使用されているパッケージの特定のバージョンを特定するために使用されます。
スキャンおよび検出プロセス中に依存関係/マニフェストファイルが欠落している場合、WhiteSource Unified Agentはソースファイル（Pythonの.pyファイルなど）を検出し、それらをソースファイルのWhiteSourceインデックスと照合します。
一致したソースファイルごとに、そのソースの可能性のあるオリジン/レポが決定されます。
ソースファイルのスキャンの概要
WhiteSourceは、一連の高度なアルゴリズムを利用して、ソースファイルを（GitHub、SourceForge、またはその他のSCMからの）ソースライブラリと照合します。WhiteSourceのナレッジベースには、最大3億4000万のソースファイルと最大4500万のオープンソースプロジェクト（ソースライブラリ）が含まれています。
依存関係解決プロセスを利用して解決できる既知のパッケージがない場合は、ソースファイルの照合方法が必要です。代わりに、オープンソースライセンス情報を検出するために、スキャンされたソースファイルのリストを、ファイルがダウンロードされたソースライブラリ（そのバージョンとともに）と照合する必要があります。
この情報はソースファイルに依存するため、アルゴリズムはセキュリティの脆弱性のレポートには影響しないことに注意してください。
スキャン手順
以下は、CおよびC ++ソースファイルのスキャンの例です。
i ncludes = **/*。c**/*。cc**/*。cp**/*。cpp**/*。cxx**/*。c++**/*。h**/ *。 hpp **/*。hxx
ignoreSourceFiles = false（デフォルト）
[統合]タブの[詳細設定]セクションで、既存の組織に対してSmartMatch *（拡張マッチングアルゴリズム）を有効にすることをお勧めします。
ユニファイドエージェントの実行
コマンドラインからUnifiedAgentを実行するには、コードベースが配置されているマシンで、またはビルドパイプラインの一部としてシェルスクリプトタスクで次のコマンドを実行します。
Linux / macOS：
java -jar /path/to/wss-unified-agent.jar -c /path/to/wss-unified-agent.config -d / path / to / project / root / directory
ウィンドウズ：
java -jar "C：\ path \ to \ wss-unified-agent.jar" -c "C：\ path \ to \ wss-unified-agent.config" -d "C：\ path \ to \ project \ root \ディレクトリ"
ノート：
フルパスまたは相対パスのいずれかを使用できます
引数値にスペースが含まれる場合は常に、二重引用符で囲む必要があります
-c パラメータでファイルが指定されていない場合、UnifiedAgent は現在の作業ディレクトリでwss-unified-agent.configという名前の設定ファイルを探します。
-d パラメータでパスが指定されていない場合、 UnifiedAgentは現在の作業ディレクトリをスキャンします
DockerコンテナでのUnifiedAgentの実行
Unified Agentは、Dockerコンテナを介して実行することもできます。さまざまなパッケージマネージャー（maven、npmなど）を含むDockerfileテンプレートはここにあります。このファイルには、プロジェクト/ファイルをスキャンするためのカスタマイズ可能な実行環境を作成できるインストールコマンドと、基本的な（編集可能な）パッケージマネージャーのセットが含まれています。
注：このオプションは現在、Dockerスキャンをサポートしていません。
スキャン手順と概要の表示と理解
Unified Agentコマンドラインインターフェイスを使用すると、スキャンの一部として実行されたステップを表示し、各ステップにかかった時間を理解できます。
開始/終了表示
スキャンステップごとに開始/終了表示が表示されます。例えば：
開始/終了表示
スキャンステップごとに開始/終了表示が表示されます。例えば：
1
2
3
4
5
6
7
8
9
10
11
12
------------------------------------------------------------------------
-------------------- Start: Pre-Step & Resolve Dependencies ------------
------------------------------------------------------------------------
[INFO] [2019-03-07 13:58:02,775 +0200] - Trying to resolve MAVEN dependencies
[INFO] [2019-03-07 13:58:02,776 +0200] - topFolder = C:\Users\Me\Desktop\UAtests\GenerateScanReport\generateScanReport\Data
[INFO] [2019-03-07 13:58:07,105 +0200] - Start parsing pom files
[INFO] [2019-03-07 13:58:07,112 +0200] - End parsing pom files , found : search-engine,search-engine-client,search-engine-server
[INFO] [2019-03-07 13:58:07,191 +0200] - Trying to resolve HTML dependencies
[INFO] [2019-03-07 13:58:09,113 +0200] -
------------------------------------------------------------------------
-------------------- End: Pre-Step & Resolve Dependencies --------------
------------------------------------------------------------------------ |
要約表
スキャン終了時の要約と、各ステップのすべての関連情報も表示されます。次の列が含まれています。
ステップ：スキャンの関連ステップ
完了ステータス： 「COMPLETED」または「FAILED」のいずれか
経過： そのステップにかかった時間。サブステップは、合計経過実行時間には含まれないことに注意してください（Maven、HTMLなど）。
コメント： 利用可能な場合は、ステップに関する詳細情報。
例えば：
1
2
3
4
5
6
7
8
9
10
11
12
13
Step Completion Status Elapsed Comments
======================================================================================================================================================
Fetch Configuration COMPLETED 00:00:00.078 --------
Scan Files Matching 'Includes' Pattern COMPLETED 00:00:00.014 1 source/binary files
Pre-Step & Resolve Dependencies COMPLETED 00:00:06.378 7 total dependencies (7 unique)
MAVEN COMPLETED 00:00:04.416 5 total dependencies (5 unique)
HTML COMPLETED 00:00:01.922 2 total dependencies (2 unique)
Update Inventory COMPLETED 00:00:01.551 2 updated projects
======================================================================================================================================================
Elapsed running time: 00:00:08.021
======================================================================================================================================================
Process finished with exit code SUCCESS (0) |
実行例
以下は、Unified Agent 実行のさまざまな使用例の構文例です。
Unified Agentの実行
1
java -jar /path/to/jar/wss-unified-agent.jar -d /path/to/lib/folder |
設定ファイルを別のフォルダーに配置する場合は、次のようにパスを指定できます。
1
java -jar /path/to/jar/wss-unified-agent.jar -c /path/to/config/file -d /path/to/lib/folder |
テキストファイルからの複数のフォルダとファイル
(1) 長いコマンドライン文字列を避けるために、新しい行で区切られたフォルダとファイルを含むテキストファイルを使用してください。例えば：
1
2
3
4
5
/path/to/javascript/lib
/path/to/ruby/lib
/path/to/jars/aopalliance-1.0.jar
/path/to/jars/antlr-2.7.7.jar
/path/to/cpp/httpclient.cpp |
(2) 引数 '-f' を使用してエージェントを実行します（コマンドラインパラメーターを参照）。
1
java -jar /path/to/jar/wss-unified-agent.jar -f files.list |
複数のフォルダとファイル
カンマ区切りのパスを入力し、引数 '-d' を使用すると、複数のフォルダーとファイルをスキャンできます。
注： -d 引数を介して挿入された単一ファイルは、 excludeglob パターンと一致する場合は除外されません。
1
java -jar /path/to/jar/wss-unified-agent.jar -c /path/to/config/file -d /path/to/java/lib,/path/to/cpp/lib,/path/to/js/lib,/path/to/file/myfile.rb |
設定ファイルの代わりに、コマンドラインからプロジェクトや製品のパラメータを使用して Unified Agent を実行します。
1
java -jar /path/to/jar/wss-unified-agent.jar -c /path/to/config/file -d /path/to/lib/folder -product my-product-name -productVersion 1.0.0 -project my-project-name -projectVersion 1.0.0 |
リモートの場所からも設定ファイルをダウンロードして使用できるようにします。
1
java -jar /path/to/jar/wss-unified-agent.jar -c http://user:password@example.com:8080/ -d /path/to/lib/folder |
コマンドラインから update Type を使用して Unified Agent を実行します。
注：バージョン17.11.2からサポートされています。 指定しない場合、デフォルト値は updateType OVERRIDE です。
1
java -jar /path/to/jar/wss-unified-agent.jar -updateType APPEND -c /path/to/config/file -d /path/to/lib/folder |
Unified Agent を実行して、サブフォルダーごとに1つのプロジェクトを作成します。
1
java -jar /path/to/jar/wss-unified-agent.jar -projectPerFolder true -c /path/to/config/file -d /path/to/lib/folder |
設定ファイルの代わりにコマンドラインからapiKeyを使用してUnifiedAgentを実行します。
1
java -jar /path/to/jar/wss-unified-agent.jar -c /path/to/config/file -apiKey your-api-key -d /path/to/lib/folder |
使用例
設定ファイルの代わりにコマンドラインからプロキシパラメータを使用してUnifiedAgentを実行します
1
java -jar /path/to/jar/wss-unified-agent.jar -c /path/to/config/file -d /path/to/lib/folder -proxy.host my-proxy-host-name -proxy.port my-proxy-port-number -proxy.user my-proxy-username -proxy.pass my-proxy-password |
プロキシを使用してリモートロケーションから設定ファイルをダウンロードして使用できるようにする
注： CLIから '-product' および '-project' パラメーターを指定して Unified Agent を実行すると、構成ファイル（バージョン1.7.1からサポート）で設定された同じパラメーターが無視されます。
1
java -jar /path/to/jar/wss-unified-agent.jar -c path/to/config/file/in/remote -proxy scheme://<user>:<password>@host:port/ -d /path/to/lib/folder |