Skip to content

Latest commit

 

History

History
executable file
·
56 lines (38 loc) · 3.08 KB

README.md

File metadata and controls

executable file
·
56 lines (38 loc) · 3.08 KB
Raw

FAST plugin for Jenkins

Plugin for adding a Wallarm application security test stage in your pipeline. Requires a working docker command to run from inside the pipeline.

FAST setup and use

Requires an account on us1.my.wallarm.com or my.wallarm.com After registration, you will need a Wallarm API TOKEN which can be created at https://us1.my.wallarm.com/nodes Creating a TestRun can be done here: https://us1.my.wallarm.com/testing/ After you're done recording your baselines you may reuse the TestRecord in other TestRuns (i.e. in a pipeline)

Any vulnerabilities found will be displayed here: https://us1.my.wallarm.com/vulnerabilities/

Plugin use

The FAST plugin has two modes of operation: recording and playback. Recording mode launches the plugin in proxy mode. All requests sent through the FAST proxy will be added to a newly created TestRecord for later use. Playback mode uses prerecorded TestRecords to run security tests as a separate build stage in your pipeline. It requires your target application to be up and running. FAST will use the same authentication as in the TestRecord. The host will be resolved via header-host unless a specific address is provided (via app_host and app_port - this option is recommended).

The Wallarm API TOKEN is always a required parameter for the plugin to function.

Recording mode

Should you require automatic recording of Baselines, a recording mode is provided. This mode will allow you to send your test traffic through the FAST proxy. All requests sent this way will be recorded into a new Test Record for later use. For this to work, some extra parameters need to be provided, like the port where the FAST docker container will accept incomming requests. If your application is running inside docker specifying a local docker network and ip will also be required. Providing a Name for the docker container is not required, but will help in cleanup if the build fails outside of the plugin scope. Without this parameter, the only (automatic) way for the proxy to shut down after recording is by waiting out the Inactivity_timeout

Playback mode

When running FAST it will use a prerecorded set of baselines. For a specific set, you must specify the Test Record ID, otherwise the last recorded set will be used (useful if the recording and playback are done in a single run). You may reuse the same Test Record multiple times with different Policies (you need to specify Policy ID for this, otherwise the default Policy will be used)

Building locally

To build the plugin locally run the following code:

git clone https://github.com/jenkinsci/wallarm-fast-plugin
cd FastJenkinsPlugin
mvn package

The plugin will appear in target/FastJenkinsPlugin.hpi

To import the plugin you need to add it via Jenkins:

  1. Manage Plugins
  2. Advanced
  3. Upload Plugin (select FastJenkinsPlugin.hpi)
  4. Restart Jenkins

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request