Configuring the Artifactory Integration plugin

Artifactory Integration

Version
latest

You must modify the blackDuckArtifactoryIntegration.properties file before the plugin can function, which you configure by manually editing the property file using any text editor.

The following is an overview of important settings the blackDuckArtifactoryIntegration.properties file.

Black Duck SCA connection credentials

You require a connection to Black Duck SCA that you configure in the properties file.

You must add a Black Duck SCA the token blackduck.api.token=<BD API token> and the Black Duck SCA URL under Black Duck SCA credentials in the property file.

# BlackDuck credentials
blackduck.url=
blackduck.api.token=

If you are using an access token and are not using a Proxy for Black Duck, this is all the information you need for the Credentials section in the properties file.

Artifactory configuration name

You must set the configuration name to match the name given to the Artifactory Integration configuration in your Black Duck SCA instance. When Artifactory Integration is initialized, it will connect to the Black Duck SCA instance, configured above, and retrieve the Integration settings based on following configuration:

blackduck.artifactory.config.name=

If no configuration exists in the Black Duck SCA instance for the given blackduck.artifactory.config.name, an error will be logged and Artifactory Integration will not be loaded into your Artifactory instance. You will need to modify the name and restart your Artifactory instance.

General properties

The date time pattern used by Artifactory can be configured to display the scan/inspection timestamp. The Artifactory plugin accepts any valid Java 8 ZoneId. For more information, refer to https://docs.oracle.com/javase/8/docs/api/java/time/ZoneId.html.

# blackduck.artifactory.scan.cutoff.date must comply to this pattern
 
blackduck.date.time.pattern=yyyy-MM-dd'T'HH:mm:ss.SSS
blackduck.date.time.zone=

The following is a list of short IDs:

ID

Value

EST
  • 05:00

HST
  • 10:00

MST
  • 07:00

ACT Australia/Darwin
AET Australia/Sydney
AGT America/Argentina/Buenos_Aires
ART Africa/Cairo
AST America/Anchorage
BET America/Sao_Paulo
BST Asia/Dhaka
CAT Africa/Harare
CNT America/St_Johns
CST America/Chicago
CTT Asia/Shanghai
EAT Africa/Addis_Ababa
ECT Europe/Paris
IET America/Indiana/Indianapolis
IST Asia/Kolkata
JST Asia/Tokyo
MIT Pacific/Apia
NET Asia/Yerevan
NST Pacific/Auckland
PLT Asia/Karachi
PNT America/Phoenix
PRT America/Puerto_Rico
PST America/Los_Angeles
SST Pacific/Guadalcanal
VST Asia/Ho_Chi_Minh

Client Side Scan

Allows you to use client side resources for scanning artifacts thus bypassing the need to transfer them across the firewall to Black Duck SCA for scanning – matching and policy evaluation will still occur on your Black Duck SCA instance. Will require Client Side Scan setup and endpoint on customer hardware inside the firewall.

blackduck.client.scan.url=
blackduck.client.concurrent.scans=

If no URL is given for blackduck.client.scan.url, Artifactory Integration will proceed to transfer artifacts to Black Duck SCA for scanning, mapping, and policy evaluation.