README.md

serverless-whitesource

Description

Perform a WhiteSource scan for Serverless functions after deployment.

Requirements

• Serverless Framework 1.49.0 or higher
• [WhiteSource Unified Agent] (https://whitesource.atlassian.net/wiki/spaces/WD/pages/33718339/Unified+Agent) 19.7.2 or higher

Installation

npm install serverless-whitesource

sudo npm install -g serverless #this step is required only in the first run

Configuration

serverless.yml

plugins:
  - serverless-whitesource

custom:
  whitesource:
    pathToConfig: ${path-to-configuration-file}
    pathToJar: ${path-to-UA-jar-file}
    [optional] wss-{valid UA's command-line paramter}: {parameter value}

Usage

1. Download the UA jar

curl -LJO https://wss-qa.s3.amazonaws.com/unified-agent/integration/wss-unified-agent

2. Install WhiteSource plugin

npm install serverless-whitesource

3. Update the serverless.yml with the path to the configuration-file, jar-file and relevant parameters

4. Deploy the serverless function(s)

sls deploy

Authors

Created and maintained by WhiteSource Software (product@whitesourcesoftware.com)

License

Apache 2.0 License (see LICENSE)