Skip to content

Latest commit

 

History

History
72 lines (56 loc) · 3.45 KB

GettingStarted.md

File metadata and controls

72 lines (56 loc) · 3.45 KB
Raw

NowSecure AUTO Jenkins Plugin

Generate API Key

See https://docs.nowsecure.com/auto/integration-services/jenkins-integration for adding API token.

Store API Key in Jenkins Credentials

Select Credentials from sideline: Credentials

Store API Key as Secret text: StoreCredentials

Define Jenkins Job

New Build

Bind Credentials with apiKey variable

Bind

Adding Plugin to your mobile build

Select Configure option from Jenkins console, then select dropdown of build step and choose NS Auto Jenkins Plugin, e.g. Build Step

Specify configuration parameters

Configure Step

Advanced configuration options

Advanced

Kick off build

Kick off your mobile builds and you will see the raw JSON reports and score under artifacts folder. Console

Pipeline

Adding plugin to pipeline: Pipeline Setup

Pipeline Config

Sample pipeline script

pipeline {
    agent any
    stages {
        stage('security-test') {
            environment {
                apiKey = credentials('AutoApiKey')
            }
            steps {
                step([$class: 'NSAutoPlugin', apiKey: env.apiKey, binaryName: 'myapk.apk', breakBuildOnScore: true, description: 'my description', group: 'mygroup', waitForResults: true, showStatusMessages: true, debug: true, proxyEnabled: false])
            }
        }
    }
}

*** Note: The apiKey will retreive credentials from Jenkins; binaryName and group are required fields but other parameters such as breakBuildOnScore, waitForResults and showStatusMessages are optional parameters.

*** Note: proxyEnabled would use Jenkins' proxy settings if available ***

Artifacts

This plugin generates following artifacts: Artifacts

  • nowsecure-auto-security-test-uploaded-binary.json - stores metadata in json format after mobile file is uploaded.
  • nowsecure-auto-security-test-preflight.json - stores output json when request of preflight is submitted.
  • nowsecure-auto-security-test-request.json - stores output json when request of security test is submitted.
  • nowsecure-auto-security-test-report.json - stores output json when security analysis is completed.
  • nowsecure-auto-security-test-score.json - stores output json for overall score of security test.

Resources