Versions Compared

Old Version 203

changes.mady.by.user Michelle Friedman

Saved on

compared with

New Version 214

changes.mady.by.user Michelle Friedman

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.1.1

wss-unified-agent.jar

Release Notes 2122.101.1

3123-1001-2021

74BB03F271E93CAB9FD3710FC6B786DB

N/A

2022

Previous Unified Agent Versions

Expand

Version

File

Features

Release Date

MD5

Comments

21.912.1.12

wss-unified-agent-21.912.1.12.jar

Release Notes 21.912.1.12

2509-1001-20212022

706694E349EA14CB04C4621B70D99A93N/A

N/A

21.812.1.1

wss-unified-agent-21.812.1.1.jar

Release Notes 21.8.112.1

3126-0812-2021

239DAD256F1E8BFAF7361FDEECE3E2CE9F459173DD2F4A1B0BCA16E3387248D6

N/A

21.11.82.1

wss-unified-agent-21.811.2.1.jar

Release Notes 21.11.82.1

2916-0812-2021

5E066881180AB1C1C24748145F784B32C938CB75252B312961D16FBA3FC0F443

N/A

21.711.2

wss-unified-agent-21.711.2.jar

Release Notes 21.711.2

1512-0812-2021

90BE9617B380EF507C5D5ABE0191FCFA1EEDF78497CD5801D152B19CC7E65C69

N/A

21.711.1

wss-unified-agent-21.711.1.jar

Release Notes 21.711.1

0128-0811-2021

B18E7F9CACB80993151F4518F852710BBA19E92BC8B508AA93CC7652EC878B1B

N/A

21.610.32

wss-unified-agent-21.610.32.jar

Release Notes 21.610.32

1814-0711-2021

B897BADFEBA66A39963717899E327F8690A989C0D60A70FCC9A62AF2D54F5E9B

N/A

21.610.2.21

wss-unified-agent-21.610.21.2.jar

Release Notes 21.610.2.21

0631-0710-2021

BAC44FB66BE88130ECA094A37B81F52774BB03F271E93CAB9FD3710FC6B786DB

N/A

21.69.1.21

wss-unified-agent-21.9.61.21.jar

Release Notes 21.69.1.21

0425-0710-2021

5E7FE501C0B1BEF76F64EE683B917012706694E349EA14CB04C4621B70D99A93

N/A

21.69.1

wss-unified-agent-21.69.1.jar

Release Notes 21.69.1

2017-0610-2021

F2EB843816A572904954052756EB66E7510303D7588212C666F16B042A05BC3F

N/A

21.58.1.21

wss-unified-agent-21.58.21.1.jar

Release Notes 21.58.1.21

0631-0608-2021

8E51FDC3C9EF7FCAE250737BD226C8F6239DAD256F1E8BFAF7361FDEECE3E2CE

N/A

21.58.1

wss-unified-agent-21.58.1.jar

Release Notes 21.58.1

2329-0508-2021

B50664F3840004A868D34D608030005C5E066881180AB1C1C24748145F784B32

N/A

21.47.2

wss-unified-agent-21.47.2.jar

Release Notes 21.47.2

0915-0508-2021

19ADD8EB5637DBD6BE63B9553576DAF990BE9617B380EF507C5D5ABE0191FCFA

N/A

21.47.1

wss-unified-agent-21.47.1.jar

Release Notes 21.47.1

2501-0408-2021

AD4F3747F519F83A2DF8963FF36D61B4B18E7F9CACB80993151F4518F852710B

N/A

21.6.3.2.1

wss-unified-agent-21.6.3.2.1.jar

Release Notes 21.6.3.2.1

1318-0407-2021

707B193FEB891C1B40DD98A0B433ECA8B897BADFEBA66A39963717899E327F86

N/A

21.36.2.2

wss-unified-agent-21.6.32.2.jar

Release Notes 21.36.2.2

1106-0407-2021

C3576952F70F574FE6745E754A16A0EEBAC44FB66BE88130ECA094A37B81F527

N/A

21.36.12

wss-unified-agent-21.36.12.jar

Release Notes 21.36.12

04-0407-2021

C5639E304DEC915F664CE2B391D5A9D75E7FE501C0B1BEF76F64EE683B917012

N/A

21.26.21

wss-unified-agent-21.26.21.jar

Release Notes 21.26.21

1420-0306-2021

5118B3403C578EC3AD922901CF70EF85F2EB843816A572904954052756EB66E7

N/A

21.5.2.1

wss-unified-agent-21.5.2.1.jar

Release Notes 21.5.2.1

2806-0206-2021

490F2217238889F0EC22A4D9352174B98E51FDC3C9EF7FCAE250737BD226C8F6

N/A

21.15.2.1

wss-unified-agent-21.1.25.1.jar

Release Notes 21.15.2.1

1423-0205-2021

9C6B4DE63AAC89EBB4E7411F792C0AA8B50664F3840004A868D34D608030005C

N/A

21.14.2

wss-unified-agent-21.14.2.jar

Release Notes 21.14.2

1409-0205-2021

15D50AB0EF4D43907393515BF19F689719ADD8EB5637DBD6BE63B9553576DAF9

N/A

21.14.1

wss-unified-agent-21.14.1.jar

Release Notes 21.14.1

3125-0104-2021

FDC75043196E49882BCBE19CBCBBD81DAD4F3747F519F83A2DF8963FF36D61B4

N/A

2021.3.122.31

wss-unified-agent-2021.3.122.31.jar

Release Notes 2021.3.122.31

1713-0104-2021 2021

00198172C5724A389CCD6EACD41B8D96707B193FEB891C1B40DD98A0B433ECA8

N/A

2021.123.2

wss-unified-agent-2021.123.2.jar

Release Notes 2021.123.2

0311-0104-2021

DA174CC191818A3763CC79934C2AEAE8C3576952F70F574FE6745E754A16A0EE

N/A

2021.123.1

wss-unified-agent-2021.123.1.jar

Release Notes 2021.123.1

2004-1204-20202021

70C387ECCA4FA7DCEA02C6C27FFE9247C5639E304DEC915F664CE2B391D5A9D7

N/A

2021.112.2

wss-unified-agent-2021.112.2.jar

Release Notes 2021.112.2

0614-1203-20202021

20FC4F59F3183F98D12E82882039531A5118B3403C578EC3AD922901CF70EF85

N/A

2021.112.1

wss-unified-agent-2021.112.1.jar

Release Notes 2021.112.1

2228-1102-20202021

75293725F596010982E7B831B6BC2F98490F2217238889F0EC22A4D9352174B9

N/A

2021.101.2.1

wss-unified-agent-20.10.2.jar

Release Notes 20.10.2

08-11-2020

AD6F30452BAB599BA13CFBE6CDC59AC1

N/A

20.10.1

wss-unified-agent-20.10.1.jar

Release Notes 20.10.1

25-10-2020

2D4624B239234177C851F7204ADB21F3

N/A

20.9.2.1

wss-unified-agent-20.9.2.1.jar

Release Notes 20.9.2.1

15-10-2020

673218A312EB4BF2EB4BB2122E66D2EC

N/A

20.9.1

wss-unified-agent-20.9.1.jar

Release Notes 20.9.1

04-10-2020

F375670B1F651330254AF5C65830CB10

N/A

20.8.2

wss-unified-agent-20.8.2.jar

Release Notes 20.8.2

13-09-2020

6CD6522EB3BFA9D5893505B618303C72

N/A

20.8.1.1

wss-unified-agent-20.8.1.1.jar

Release Notes 20.8.1.1

09-02-2020

E4D40C9C156BA1F284D23A09061FCAA9

N/A

20.8.1

wss-unified-agent-20.8.1.jar

Release Note 20.8.1

30-08-2020

2D4624B239234177C851F7204ADB21F3

N/A

20.7.3.1

wss-unified-agent-20.7.3.1.jar

Release Notes 20.7.3.1

24-08-2020

F15A81CA898EF48378C004F0C30DAC17

N/A

20.7.3

wss-unified-agent-20.7.3.jar

Release Notes 20.7.3

16-08-2020

088FE4495C2636DB12DDE290599D3487

N/A

20.7.2

wss-unified-agent-20.7.2.jar

Release Notes 20.7.2

02-08-2020

C4C1C03EAD650710F41BA06F934E6C8A

N/A

20.7.121.1.2.1.jar

Release Notes 21.1.2.1

14-02-2021

9C6B4DE63AAC89EBB4E7411F792C0AA8

N/A

21.1.2

wss-unified-agent-2021.71.12.jar

Release Notes 2021.71.12

1914-0702-20202021

B0E5171D9187DD5DCF0DC2E31065F21015D50AB0EF4D43907393515BF19F6897

N/A

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

Setting Up the Unified Agent

...

Parameter Name

Environment Variable Name

Configuration File Parameter Name

Command Line Parameter Name 

Description

API Key

WS_APIKEY

apiKey

-apiKey

The identifier of the organization. This can be found on the Integrate page of the WhiteSource User Interface under the Organization section. Requires admin level access to see this page.

WhiteSource URL

WS_WSS_URL

wss.url

-wss.url

The Server URL with /agent added. This can also be found on the Integrate page of the WhiteSource User Interface under the Organization section. Requires admin level access to see this page.

For example: https://saas.whitesourcesoftware.com/agent

User Key

WS_USERKEY

userKey

-userKey

Required if enforce user level access has been enabled as shown here. See the following link for how to generate a user key.

Product Name

WS_PRODUCTNAME

productName

-product

The name of the product created after running a scan.

Project Name

WS_PROJECTNAME

projectName

-project

The name of the project created after running a scan

...