https://github.com/nowsecure/gitlabci
https://github.com/nowsecure/gitlabci
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/nowsecure/gitlabci
- Owner: nowsecure
- Created: 2020-11-19T17:33:22.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-12-15T18:14:04.000Z (about 5 years ago)
- Last Synced: 2025-01-13T13:49:11.211Z (12 months ago)
- Language: Dockerfile
- Size: 1.18 MB
- Stars: 3
- Watchers: 9
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# NowSecure GitLab CI
This is the source repository to build the docker image available at https://hub.docker.com/repository/docker/nowsecure/gitlab-ci to be used within GitLab CI.
This image gives you the ability to perform automatic mobile app security testing for Android and iOS mobile apps through the NowSecure test engine.
## Summary
Purpose-built for mobile app teams, NowSecure provides fully automated, mobile appsec testing coverage (static+dynamic+behavioral tests) optimized for the dev pipeline. Because NowSecure tests the mobile app binary post-build from Gitlab, it can test software developed in any language and provides complete results including newly developed code, 3rd party code, and compiler/operating system dependencies. With near zero false positives, NowSecure pinpoints real issues in minutes, with developer fix details, and routes tickets automatically into ticketing systems, such as Jira. NowSecure is frequently used to perform security testing in parallel with functional testing in the dev cycle. Requires a license for and connection to the NowSecure software.
https://www.nowsecure.com
## Getting Started
### Access token
Generate token as described in https://nowsecurehelp.zendesk.com/hc/en-us/articles/360034149691 (Note: customer sign in is required to access this resource). This token will be specified by environment variable `NOWSECURE_TOKEN`.
### Required Environment variables
- `NOWSECURE_GROUP=default_group` - Specifies group for your account
- `NOWSECURE_TOKEN=Access_Token` - Specifies token from your Platform account
- `NOWSECURE_BINARY_FILE=default_binary` - Path to Android apk or IOS ipa - this file must be mounted via volume for the access
**Note**: We recommend using secured environment variables in Gitlab to specify `NOWSECURE_GROUP` and `NOWSECURE_BINARY_FILE` values.
### Optional Environment variables
Following are optional parameters that can be set from environment variables:
- `NOWSECURE_MIN_WAIT=nn (default 30)` - Default max wait in minutes for the mobile analysis
- `NOWSECURE_MIN_SCORE=nn (default 50)` - Minimum score the app must have otherwise it would fail
- `NOWSECURE_ARTIFACTS_DIR=/home/gradle/artifacts` - Specifies artifacts directory where json files are stored
## Creating a Gitlab-CI Pipeline:
Here is a sample config that you can save under `.gitlab-ci.yml` in your mobile project. Please read https://docs.gitlab.com/ee/ci/pipelines/pipeline_architectures.html for more information on Gitlab Pipeline.
```yaml
nowsecure:
stage: test
image: nowsecure/gitlab-ci:latest
variables:
NOWSECURE_BINARY_FILE: test.apk
script:
- nowsecure.sh
stages:
- build
- test
- deploy
image: alpine
build_a:
stage: build
script:
- echo "Building...."
test_a:
stage: test
script:
- echo "Testing..."
deploy_a:
stage: deploy
script:
- echo "Deploying..."
```
## Adding Environment variables in Gitlab Pipeline
Select Settings option from your Gitlab project and then jump to `Variables` section to add environment variables for your pipeline, e.g.
## Submitting CI/CD Submitting Pipeline
The CI/CD will be run when you check-in new changes or you can select CI/CD option from your Gitlab project and then click on `Run Pipeline` to submit a pipeline, e.g.
## Verifying the Build
Upon completion of CI/CD job, you will see a score of your mobile app. Note: you can configure your build to fail the CI/CD job when score is below a configurable miniumum value, e.g.
