Versions Compared

Old Version 205

changes.mady.by.user Lena Kleyner

Saved on

compared with

New Version 240

changes.mady.by.user David Jaffe

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This page describes how to get started with the Unified Agent.

Prerequisites

  1. Ensure you have one of the following Java versions on the computer on which you want to run the Unified Agent

...

  1. :

    • Java JDK 8

    • Java JRE 8

    • Java JDK 11

...

    • Java JDK 17

  2. Depending on your project type,

...

  1. make sure that the relevant package

...

  1. manager is installed:

Project Type

Package Manager

C#

  • NuGet + .Net

  • Paket

Elixir, Erlang

MIX

Go

  • Dep

  • Godep

  • Vndr

  • Gogradle

  • Govendor

  • Gopm

  • Glide

  • Vgo

  • Modules

  • Bazel

Haskell

Cabal

Java

  • Maven

  • Gradle

  • ANT

  • Bazel

JavaScript

  • Yarn - required only if the project is not built

  • NPM - required only if the project is not built (or the detection was set to use NPM)

  • Bower

Objective-C, Swift

CocoaPods - required only if the project is not built  

OCaml

Opam

PHP

Composer - required only if the project is not built

Python

  • PIP

  • Poetry

  • Pipenv

  • Conda

R

Packrat - if used

Ruby

Bundler

Rust

Cargo - required only if the project is not built

Scala

SBT

Unified Agent Usage Overview

Step #

Step Name

1

Download the latest version of the Unified Agent and verify its integrity.

2

Set up the Unified Agent.

3

Do one of the following:

(See execution examples on this page)

4

View the results in your WhiteSource organizational portal.

...

Latest Unified Agent Version

File

Features

Release Date

MD5

Comments

21.1022.4.2

wss-unified-agent.jar

Release Notes 2122.104.2

1415-1105-2021

90A989C0D60A70FCC9A62AF2D54F5E9B

N/A

2022

Previous Unified Agent Versions

NOTE: Unified Agent versions will be available and supported for a year after their release.  

Expand

Version

File

Features

Release Date

MD5

Comments

2122.4.101.1

wss-unified-agent-2122.4.101.1.jar

Release Notes 21.10.1

31-10-2021

74BB03F271E93CAB9FD3710FC6B786DB

N/A

21.9.1.1

wss-unified-agent-21.9.1.1.jar

Release Notes 21.9.1.1

25-10-2021

706694E349EA14CB04C4621B70D99A93

N/A

21.9.1

wss-unified-agent-21.9.1.jar

Release Notes 21.9.1

17-10-2021

510303D7588212C666F16B042A05BC3F

N/A

21.8.1.1

wss-unified-agent-21.8.1.1.jar

Release Notes 21.8.1.1

31-08-2021

239DAD256F1E8BFAF7361FDEECE3E2CE

N/A

21.8.1

wss-unified-agent-21.8.1.jar

Release Notes 21.8.1

29-08-2021

5E066881180AB1C1C24748145F784B32

N/A

21.7.2

wss-unified-agent-21.7.2.jar

Release Notes 21.7.2

15-08-2021

90BE9617B380EF507C5D5ABE0191FCFA

N/A

21.7.1

wss-unified-agent-21.7.1.jar

Release Notes 21.7.1

01-08-2021

B18E7F9CACB80993151F4518F852710B

N/A

21.6.322.4.1

wss-unified-agent-2122.64.31.jar

Release Notes 2122.64.31

1801-0705-20212022

B897BADFEBA66A39963717899E327F86N/A

N/A

2122.63.2.23

wss-unified-agent-2122.63.23.2.jar

Release Notes 2122.63.2.23

0617-0704-20212022

BAC44FB66BE88130ECA094A37B81F527N/A

N/A

2122.63.2.1

wss-unified-agent-2122.63.2.1.jar

Release Notes 2122.63.2.1

06-04-07-20215E7FE501C0B1BEF76F64EE683B9170122022

N/A

N/A

2122.63.12

wss-unified-agent-2122.63.12.jar

Release Notes 2122.63.12

2003-0604-20212022

F2EB843816A572904954052756EB66E7N/A

N/A

2122.53.21

wss-unified-agent-2122.53.21.jar

Release Notes 2122.53.21

0620-0603-20212022

8E51FDC3C9EF7FCAE250737BD226C8F6N/A

N/A21.5.1

22.2.2.2

wss-unified-agent-2122.2.52.12.jar

Release Notes 2122.2.52.12

2320-0503-20212022

B50664F3840004A868D34D608030005CN/A

N/A

2122.42.2.1

wss-unified-agent-2122.42.2.1.jar

Release Notes 2122.42.2.1

09-0503-20212022

19ADD8EB5637DBD6BE63B9553576DAF9N/A

N/A

2122.42.12

wss-unified-agent-2122.42.12.jar

Release Notes 2122.42.12

2506-0403-20212022

AD4F3747F519F83A2DF8963FF36D61B4N/A

N/A

21.322.2.1

wss-unified-agent-2122.3.2.1.jar

Release Notes 2122.3.2.1

1320-0402-20212022

707B193FEB891C1B40DD98A0B433ECA8N/A

N/A

2122.31.2

wss-unified-agent-2122.31.2.jar

Release Notes 2122.31.2

1106-0402-20212022

C3576952F70F574FE6745E754A16A0EEN/A

N/A

2122.1.31.1

wss-unified-agent-2122.1.31.1.jar

Release Notes 2122.1.31.1

0427-0401-20212022

C5639E304DEC915F664CE2B391D5A9D7N/A

N/A

2122.21.21

wss-unified-agent-2122.21.21.jar

Release Notes 2122.21.21

1423-0301-20212022

5118B3403C578EC3AD922901CF70EF85N/A

N/A

21.12.2.1

wss-unified-agent-21.12.2.1.jar

Release Notes 21.12.2.1

2809-0201-20212022

490F2217238889F0EC22A4D9352174B9N/A

N/A

21.112.2.1

wss-unified-agent-21.112.2.1.jar

Release Notes 21.1.212.1

1426-0212-2021

9C6B4DE63AAC89EBB4E7411F792C0AA89F459173DD2F4A1B0BCA16E3387248D6

N/A

21.111.2.1

wss-unified-agent-21.111.2.1.jar

Release Notes 21.111.2.1

1416-0212-2021

15D50AB0EF4D43907393515BF19F6897C938CB75252B312961D16FBA3FC0F443

N/A

21.111.12

wss-unified-agent-21.111.12.jar

Release Notes 21.111.12

3112-0112-2021

FDC75043196E49882BCBE19CBCBBD81D1EEDF78497CD5801D152B19CC7E65C69

N/A

2021.1211.31

wss-unified-agent-2021.1211.31.jar

Release Notes 2021.1211.31

1728-0111-2021 2021

00198172C5724A389CCD6EACD41B8D96BA19E92BC8B508AA93CC7652EC878B1B

N/A

2021.1210.2

wss-unified-agent-2021.1210.2.jar

Release Notes 2021.1210.2

0314-0111-2021

DA174CC191818A3763CC79934C2AEAE890A989C0D60A70FCC9A62AF2D54F5E9B

N/A

2021.1210.1

wss-unified-agent-2021.1210.1.jar

Release Notes 2021.1210.1

2031-1210-20202021

70C387ECCA4FA7DCEA02C6C27FFE924774BB03F271E93CAB9FD3710FC6B786DB

N/A

2021.9.111.21

wss-unified-agent-2021.9.111.21.jar

Release Notes 2021.9.111.21

0625-1210-20202021

20FC4F59F3183F98D12E82882039531A706694E349EA14CB04C4621B70D99A93

N/A

2021.119.1

wss-unified-agent-2021.119.1.jar

Release Notes 2021.119.1

2217-1110-20202021

75293725F596010982E7B831B6BC2F98510303D7588212C666F16B042A05BC3F

N/A

2021.8.101.21

wss-unified-agent-2021.8.101.21.jar

Release Notes 2021.8.101.21

31-08-11-20202021

AD6F30452BAB599BA13CFBE6CDC59AC1239DAD256F1E8BFAF7361FDEECE3E2CE

N/A

2021.108.1

wss-unified-agent-2021.108.1.jar

Release Notes 2021.108.1

2529-1008-20202021

2D4624B239234177C851F7204ADB21F35E066881180AB1C1C24748145F784B32

N/A

2021.97.2.1

wss-unified-agent-2021.97.2.1.jar

Release Notes 2021.97.2.1

15-1008-20202021

673218A312EB4BF2EB4BB2122E66D2EC90BE9617B380EF507C5D5ABE0191FCFA

N/A

2021.97.1

wss-unified-agent-2021.97.1.jar

Release Notes 2021.97.1

0401-1008-20202021

F375670B1F651330254AF5C65830CB10B18E7F9CACB80993151F4518F852710B

N/A

2021.86.23

wss-unified-agent-2021.86.23.jar

Release Notes 2021.86.23

1318-0907-20202021

6CD6522EB3BFA9D5893505B618303C72B897BADFEBA66A39963717899E327F86

N/A

2021.86.12.12

wss-unified-agent-2021.86.12.12.jar

Release Notes 2021.86.12.12

0906-0207-20202021

E4D40C9C156BA1F284D23A09061FCAA9BAC44FB66BE88130ECA094A37B81F527

N/A

2021.86.12

wss-unified-agent-2021.86.12.jar

Release Note 20Notes 21.86.12

3004-0807-20202021

2D4624B239234177C851F7204ADB21F35E7FE501C0B1BEF76F64EE683B917012

N/A

2021.7.36.1

wss-unified-agent-2021.76.3.1.jar

Release Notes 2021.76.3.1

2420-0806-20202021

F15A81CA898EF48378C004F0C30DAC17F2EB843816A572904954052756EB66E7

N/A

2021.75.32

wss-unified-agent-2021.75.32.jar

Release Notes 2021.75.32

1606-0806-20202021

088FE4495C2636DB12DDE290599D34878E51FDC3C9EF7FCAE250737BD226C8F6

N/A

2021.75.21

wss-unified-agent-2021.75.21.jar

Release Notes 2021.75.21

0223-0805-20202021

C4C1C03EAD650710F41BA06F934E6C8AB50664F3840004A868D34D608030005C

N/A

2021.74.12

wss-unified-agent-2021.74.12.jar

Release Notes 2021.74.12

1909-0705-20202021

B0E5171D9187DD5DCF0DC2E31065F21019ADD8EB5637DBD6BE63B9553576DAF9

N/A

Click here for earlier versions of the Unified Agent (previously called the File System Agent (FSA)).

Setting Up the Unified Agent

There are several methods for configuring the Unified Agent:

Environment Variables (Recommended)

All the parameters available in the configuration file can be passed to the Unified Agent using environment variables. For more information, refer here.

Configuration File

  • A configuration file can be passed to the Unified Agent in the command line using the -c argument. If no file is specified, the Unified Agent will look for a configuration file named wss-unified-agent.config in the current working directory.  Refer here for more information.
    It is recommended to create a blank configuration file and only add parameters that you want to change, in order to make use of the default configuration settings. As a reference, please refer here.

Command-line Parameters

The Unified Agent supports command-line options and parameters. For more information refer here.

The configuration is applied in the following order of precedence:

...

Linux/macOS:

export WS_APIKEY=my<your-api-apiKeykey>
export WS_USERKEY=my<your-user-userKeykey>
export WS_PRODUCTNAME=my<your-product-name>
export WS_PROJECTNAME=my<your-project-name>
export WS_WSS_URL=https://saas.whitesourcesoftware.com/agent
java -jar wss-unified-agent.jar

...

Executing the Unified Agent with Inline environment variables:

export WS_APIKEY=my<your-api-apiKeykey>
export WS_USERKEY=my<your-user-userKeykey>
WS_PRODUCTNAME=my<your-product-name> WS_PROJECTNAME=my<your-project-name> java -jar ./wss-unified-agent.jar

...

Executing the Unified Agent on multiple folders or files:

export WS_APIKEY=my<your-api-apiKeykey>
export WS_USERKEY=my<your-user-userKeykey>
export WS_PRODUCTNAME=my<your-product-name>
export WS_PROJECTNAME=my<your-project-name>
java -jar ./wss-unified-agent.jar -d /directory/to/scan,/directory/to/scan2,/file/to/scan

Executing the Unified Agent with a policy check to return an error code in order to break a CI/CD pipeline:

export WS_APIKEY=my<your-api-apiKeykey>
export WS_USERKEY=my<your-user-userKeykey>
export WS_PRODUCTNAME=my<your-product-name>
export WS_PROJECTNAME=my<your-project-name>
export WS_CHECKPOLICIES=true
export WS_FORCECHECKALLDEPENDENCIES=true
export WS_FORCEUPDATE=true
export WS_FORCEUPDATE_FAILBUILDONPOLICYVIOLATION=true
java -jar ./wss-unified-agent.jar

Executing the Unified Agent with a proxy:

export WS_APIKEY=my<your-api-apiKeykey>
export WS_USERKEY=my<your-user-userKeykey>
export WS_PRODUCTNAME=my<your-product-name>
export WS_PROJECTNAME=my<your-project-name>
export WS_PROXY_HOST=my<your-proxy-host-namename>
export WS_PROXY_PORT=my<your-proxy-port-numbernumber>
export WS_PROXY_USER=my<your-proxy-usernameusername>
export WS_PROXY_PASS=my<your-proxy-passwordpassword>
java -jar ./wss-unified-agent.jar 

...