Artifactory プラグイン



概要

情報

情報

プロキシ設定は、WhiteSourceサーバーのリクエストにのみ関連します。リモートリポジトリリクエストのプロキシはサポートされていません

このプラグインはJFrogArtifactoryプラグインがWhiteSource を統合します。

JFrogArtifactory プラグインは Artifactory アーティファクトに追加情報を追加し、WhiteSource を更新します。

追加されると、Artifactory のすべての成果物が WhiteSource のリストにアップロードされます。

  • Artifactory インスタンスは WhiteSource 製品にマッピングされます。

  • Artifactory リポジトリは WhiteSource プロジェクトにマッピングされます。

  • WhiteSource 組織は、ポリシー違反に関係なく更新されます。

  • ポリシーが適用され、ポリシーの詳細が成果物のプロパティタブ、WSS-Acrion(承認/却下)および WSS に追加されます。

  • WSS-Licensing、WSS-Description、WSS-Homepage、および WSS-Vulnerabilities の各プロパティの追加データがプロパティタブに追加されます。

このプラグインは、Apache 2.0 ライセンスの下で許可されています。

注記プラグインは Artifactory リポジトリを10000個以下のアーティファクトで更新します。

WhiteSourceのインベントリは、cronベースのジョブを使用している場合にのみ更新されます。

プラグインはWhiteSourceを2000個以下のアーティファクトを含むリポジトリで更新します。

ノート

  • GroovyベースのユーザープラグインでサポートされていないArtifactoryエディションは、WhiteSourceではサポートされていません。

  • Dockerリポジトリのスキャンはサポートされていません。

  • 仮想リポジトリのスキャンはサポートされていません。

  • JFrog Artifactoryに推奨される統合方法は、UnifiedAgentを使用することです。

  • Artifactoryの更新:プラグインは、10000以下のアーティファクトでArtifactoryリポジトリを更新します。

  • WhiteSourceの更新:プラグインは、2000個以下のアーティファクトを持つリポジトリでWhiteSourceを更新します。

使い方

Artifactory プラグインは2つのモードで動作します。

  1. Cron ベースのジョブ : 呼び出されると、リポジトリの成果物が WhiteSource でチェックされ、追加のデータが各成果物のプロパティタブに追加されます。

  2. 新しいアーティファクトを追加する : アップロードすると、新しいアーティファクトが WhiteSource チェックされます。ポリシーがチェックされ、追加のデータが案件のプロパティタブに追加されます。

インストール

プラグインのダウンロード

バージョン

ファイル

概要

リリース日付

MD5

バージョン

ファイル

概要

リリース日付

MD5

21.7.2

whitesource-artifactory-plugin-21.7.2.zip

一時フォルダの削除の修正と依存関係のバージョンのアップグレード

2021-08-15

1B4B6DE62613AD5F52B8B162F6A7993D

20.9.1

whitesource-artifactory-plugin-20.9.1.zip

誤字の修正

2020-10-04

3A238385348051D7AD24EE166F26F935

20.7.3

whitesource-artifactory-plugin-20.7.3.zip

Artifactory 7.x のサポート 

2020-08-16

0A26F0B1CA1A7C2C5FA012D9AED3ED4C

20.6.2

whitesource-artifactory-plugin-20.6.2.zip

Bug fixed - Block artifact in before download in case of policy violation

2020-07-07

A766DE35D4D39C7C5761E1F7F49501E7

20.5.1

whitesource-artifactory-plugin-20.5.1.zip

Bug fixes

2020-05-24

0F7A360476D0B870229CF54C500A5AC4

19.9.1

whitesource-artifactory-plugin-19.9.1.zip

Minor bug fix

2019-09-22

520A2FC631F9D368AE2F2DFC308FAB12

19.4.2

whitesource-artifactory-plugin-19.4.2.zip

Memory leak bug fix

2019-05-05

E7DC7341CF90A2B37EAC328D5A675743

19.3.2

whitesource-artifactory-plugin-19.3.2.zip

Minor bug fix

2019-04-07

0D7103F7CE1142ED3D3C9C206E081AA8

19.3.1

whitesource-artifactory-plugin-19.3.1.zip

Add archive extraction depth 'archiveExtractionDepth' parameter

2019-03-24

7352FC6C56D61A001756A1CF040A0576

19.1.1

whitesource-artifactory-plugin-19.1.1.zip

Updates agent version

2019-01-27

018B2749498BF6BC144B03556EAD034B

18.8.2

whitesource-artifactory-plugin-18.8.2.zip

Minor Bug fixes

2018-09-02

BB473552069155C24CDD8021C38B9029

18.6.3

whitesource-artifactory-plugin-18.6.3.zip

Minor Bug fixes

2018-07-08

480A308C2359BC75EBED9717A032D1B7

18.5.1

whitesource-artifactory-plugin-18.5.1.zip

Add user key - unique identifier of user, can be generate from the profile page in your whitesource account

2018-05-27

EA4F045B6A00136342FF7B9F01FFAFBA

17.12.1

whitesource-artifactory-plugin-17.12.1.zip

Bug fix - Archive extraction

2017-12-17

80DC1701AAB7B471EF58E6E3A1CC5D82

1.0.9

whitesource-artifactory-plugin-1.0.9.zip

Add support for 'before download' method from a local repository according to a policy in WhiteSource

Resolved issues WSA-308

2017-10-08

0FFCEF0BC0777C06898A031E6F2679F6

1.0.8

whitesource-artifactory-plugin-1.0.8.zip

  1. Add CVSS score

  2. Add before download method - prevent artifacts download from a remote repository according to a policy in WhiteSource

Resolved issues WSA-242, WSA-177.

2017-09-27

E8643C70DEEF4C75EF45AC18B3F9EBF0

1.0.7

whitesource-artifactory-plugin-1.0.7.zip

Add option for creating a project in WhiteSource for each repository

2017-09-11

D0C22C6E4D265BBF2FBC3A799848838

1.0.6

whitesource-artifactory-plugin-1.0.6.zip

Add parameter for updating WhiteSource

2017-08-08

48D7AED7EB8D005F5F6F45E210EEC33B

1.0.5

whitesource-artifactory-plugin-1.0.5.zip

Minor bug fixes.

2017-07-18

F18B154FC8B0CEF0D96DD08848B3FFB7

1.0.4

whitesource-artifactory-plugin-1.0.4.zip

Adjust plugin version to agents-api & whitesource-fs-agent versions.

2017-07-16

675032D04CE06BDC28EC70FAEBA4D2AF

1.0.3

whitesource-artifactory-plugin-1.0.3.zip

Enabliing update WSS scan Artifactory repositories.

2017-05-07

37568D088633E3EF877C364A1F901221

1.0.2.2

whitesource-artifactory-plugin-1.0.2.2.zip

Minor Bug fixes

2017-02-01

C1A62DE5C257874E0C5DF82869DC2892

1.0.2.1

whitesource-artifactory-plugin-1.0.2.1.zip

Minor bug fixes

2017-01-29

14DFB6A85A821C01F962886FCC68A62F

1.0.2

whitesource-artifactory-plugin-1.0.2.zip

Add proxy support.

2017-01-24

B7C4E651C1707B1B530BCE871BB7207C

1.0.1.2

whitesource-artifactory-plugin-1.0.1.2.zip 

Split vulnerability link and severity into 2 lines.

2016-07-17

FA1BE663ED9A0526237ED1B03D97ADCC

1.0.1.1

whitesource-artifactory-plugin-1.0.1.1.zip

Bug fixes. rename properties file.

2016-05-03

272692C2CD8C04DA0BE3E9858248A717

1.0.1

whitesource-artifactory-plugin-1.0.1.zip

Add setup.groovy file to automatically install dependencies.

2016-04-27

D2BA5AC9B45EEEA144BA324924BB1C85

1.0.0

whitesource-artifactory-plugin-1.0.0.zip

Check Policies and Add additional data to the Artifact property tab.

2016-04-07

e2654abeb61162044495e49e6845eb2e



GitHub リポジトリ

プラグインのインストール

Artifactory バージョン <= 6.x
  1. zipファイルをダウンロードして解凍します。

  2. whitesource-artifactory-plugin.propertieswhitesource-artifactory-plugin.groovyファイルを ${ARTIFACTORY_HOME}/etc/plugins の下に配置します。

  3. ${ARTIFACTORY_HOME}/etc/plugins/lib の下に新しい lib フォルダを作成します。

  4. lib フォルダに次の jar ファイルを配置します。
    wss-agent-report-<version>.jar
    wss-agent-api-client-<version>.jar
    wss-agent-api-<version>.jar
    wss-unified-agent-<version>.jar もしくは wss-unified-agent-utils-<version>.jar

  5. whitesource-artifactory-plugin.properties ファイルを適切なパラメータで更新します 。(全リファレンスを参照してください)

  6. job セクションの下の whitesource-artifactory-plugin.groovy ファイルで cron ジョブをスケジュールします。(を参照)。

  7. Artifactory を再開します。

Artifactory バージョン >= 7.x
  1. zipファイルをダウンロードして解凍します。

  2. whitesource-artifactory-plugin.propertieswhitesource-artifactory-plugin.groovy ファイルを ${ARTIFACTORY_HOME}/var/etc/artifactory/plugins の下に配置します。

  3. ${ARTIFACTORY_HOME}/var/etc/artifactory/plugins の下に新しい lib フォルダを作成します。

  4. lib フォルダに次の jar ファイルを配置します。
    wss-agent-report-<version>.jar
    wss-agent-api-client-<version>.jar
    wss-agent-api-<version>.jar
    wss-unified-agent-utils-<version>.jar

  5. whitesource-artifactory-plugin.properties ファイルを適切なパラメータで更新します 。(全リファレンス参照してください)

  6. job セクションの下の whitesource-artifactory-plugin.groovy ファイルで cron ジョブをスケジュールします。(を参照)。

  7. Artifactory を再開します。

プラグインの構成

プロパティファイルの例

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 // whitesource-artifactory-plugin properties file wssUrl="" // wssUrl="http://localhost:8080/agent" // Organization Token: apiKey="<your WSS api key>" // UserKey Token: Unique identifier of user, can be generate from the profile page in your whitesource account. //userKey="<your WSS user key>" // Product Name - represents Artifactory instance, Artifactory repositry represents project // In order to map repository to a product in WhiteSource mark this field as comment productName="<your Artifactory representing name>" // Check Policices. will check only delta between WSS and current files checkPolicies=false // check all files all the time. if true that checkpolicies must also be true forceCheckAllDependencies=false // update WSS updateWss=false // update WSS regardless of the check policies result forceUpdate=false // Names of the repositories in the Artifactory to scan repoKeys=["repo1","repo2","repo3"] // Proxy Settings useProxy=false //proxyHost="127.0.0.1" //proxyPort=3128 //proxyUser="" //proxyPass="" // The type of files that will be extracted and their content will be checked archiveIncludes = ["war", "ear", "zip"] // archiveExtractionDepth=2 // Once the archive was extracted, which files within it should be checked includesRepositoryContent=["m", "mm", "js", "php", "jar", "zip"] // Whether to run beforeDownload/afterCreate method (defaults to true) //triggerBeforeDownload=false //triggerAfterCreate=false/triggerAfterCreate=false

一般的なパラメータ



Attribute

Type

Description

Required

Additional Information

Attribute

Type

Description

Required

Additional Information

wssUrl

文字列

リクエストを送信するURL。

[Server URLs] パネルの [Profile] ページから取得できる WhiteSource Server URL を使用します。その URL に /agent パスを付与します。例: "https://saas.whitesourcesoftware.com/agent".

いいえ。デフォルト値は https://saas.whitesourcesoftware.com/agent



apiKey

文字列

組織の一意のキー。WhileSource アカウントの管理者ページから取得できます。

はい



userKey

文字列

ユーザーの一意のキー。WhileSource アカウントのプロフィールページで生成できます。

管理者が Enforce user level access オプションを有効にしていた場合は必須

Supported since version 18.5.1

productName

文字列

WhiteSource の Artifactory インスタンスと製品を表します。

このフィールドをコメント化すると、リポジトリが WhiteSource の製品にマップされます(プロジェクトがリポジトリも表します)

No



checkPolicies

真偽値

WhiteSource にポリシーチェックを行うリクエストを送信するかどうか。

No



forceCheckAllDependencies





真偽値

'checkPolicies' に true がセットされているときのみ使用されます。

'forceCheckAllDependencies' を true に設定すると、WhiteSourceプロジェクトに導入されたすべての依存関係のすべてのポリシーが強制的にチェックされます。

 'forceCheckAllDependencies' を false に設定するか、まったく使用しない場合、WhiteSourceプロジェクトに導入された新しい依存関係のみがチェックされます。

No

Supported since version 1.0.3

updateWss

真偽値

WhiteSource を更新するかどうか。

Yes

Supported since version 1.0.6

forceUpdate

真偽値

ポリシーに違反していたとしても組織のインベントリを更新するかどうか。

No, the default value is false.Supported 

Supported since version 1.0.3

repoKeys

リスト

スキャンするリポジトリのリスト

Yes



useProxy

真偽値

プロキシサーバ設定を使うかどうか

Yes



proxyHost

文字列

プロキシサーバのホスト URL

No



proxyPort

数値

プロキシサーバのポート

No 



proxyUser

文字列

プロキシサーバの認証に必要なユーザ名(必要ならば)

No 



proxyPass

文字列

プロキシサーバの認証に必要なパスワード(必要ならば)

No 



archiveIncludes

文字列

アーカイブファイルのタイプを指定するカンマ区切りリスト

No. The default list inclues the following: jar, war, ear, egg, zip, whl, sca, sda, gem, tar.gz, tar, tgz, tar.bz2, rpm, rar.

Supported since version 1.0.3

archiveExtractionDepth

文字列

アーカイブファイルをどこまでドリルダウンするか。最大値は7

No, default is 2

Supported since version 19.4.2

includesRepositoryContent

文字列

カンマ区切りリスト。'archiveIncludes' パラメータに従ってアーカイブが抽出されたときに、スキャンに含めるファイルを指定

No

Required since version 1.0.3

triggerBeforeDownload

真偽値

'beforeDownload' をトリガーにするかどうか

No, the default value is true.

Supported since version 18.10.3

triggerAfterCreate

真偽値

'afterCreate' をトリガーにするかどうか

No, the default value is true.

Supported since version 18.10.3





アーカイブファイル用の Artifactory プラグインの抽出の深さは、現在第1レベルです。  Unified Agent の抽出する深さは最大7レベルです。

Cron によるスケジューリングの例:

whitesource-artifactory-plugin.groovy ファイルをテキストエディタで開き、 jobs セクションに移動します。

次のような行 updateRepoWithWhiteSource(cron: "* * * * *?")を見つけ、特定の実行時間にジョブをスケジュールします。

Cron のパラメータ(左から右へ):

1 - 秒、2 - 分、3 - 時間、4 - 日、5 - 月、6 - 曜日、7 - 年(オプションフィールド)。

例:

"0 42 10 * *?" - 午前10時42分に毎日発生するトリガーを構築する。

"0 0/2 8-17 * *?" - 毎日午前8時から午後5時まで毎分発生するトリガーを構築する。

プラグイン ログ

プラグインのデフォルトのログレベルは "warn"です。 プラグインのログレベルを変更するには、${ARTIFACTORY_HOME}/etc/logback.xml に次の行を追加します。

Plugin logs
1 2 3 <logger name="whitesource-artifactory-plugin"> <level value="info"/> </logger>

Artifactory 更新インベントリプラグイン - (非推奨)

バージョン

ファイル

特徴

リリース日

MD5

追加情報

バージョン

ファイル

特徴

リリース日

MD5

追加情報

1.0.0

whitesource-artifactory-UpdateInventory-plugin-1.0.0.zip

WhiteSourceインベントリをリポジトリデータで更新します。

2017-02-20

E26480E230E3BF7605EECB21690C6A54



Deprecated

バージョン1.0.3(2017-05-07)以降非推奨