summaryrefslogtreecommitdiff
path: root/doc/ci/examples/dast.md
diff options
context:
space:
mode:
authorOlivier Gonzalez <ogonzalez@gitlab.com>2018-04-03 19:19:00 +0000
committerMarcia Ramos <virtua.creative@gmail.com>2018-04-03 19:19:00 +0000
commita086945275bb2c3ea7d75f9e26d85743754f0c40 (patch)
tree90ed08d25746b896e9aa86c958f4d4bc896da720 /doc/ci/examples/dast.md
parent59a158955e1ae09420ad05e53782e0dbc512e9c8 (diff)
downloadgitlab-ce-a086945275bb2c3ea7d75f9e26d85743754f0c40.tar.gz
Update Security Products examples documentation
Diffstat (limited to 'doc/ci/examples/dast.md')
-rw-r--r--doc/ci/examples/dast.md25
1 files changed, 24 insertions, 1 deletions
diff --git a/doc/ci/examples/dast.md b/doc/ci/examples/dast.md
index 96de0f5ff5c..8df223ee560 100644
--- a/doc/ci/examples/dast.md
+++ b/doc/ci/examples/dast.md
@@ -14,9 +14,10 @@ called `dast`:
```yaml
dast:
- image: owasp/zap2docker-stable
+ image: registry.gitlab.com/gitlab-org/security-products/zaproxy
variables:
website: "https://example.com"
+ allow_failure: true
script:
- mkdir /zap/wrk/
- /zap/zap-baseline.py -J gl-dast-report.json -t $website || true
@@ -30,6 +31,28 @@ the tests on the URL defined in the `website` variable (change it to use your
own) and finally write the results in the `gl-dast-report.json` file. You can
then download and analyze the report artifact in JSON format.
+It's also possible to authenticate the user before performing DAST checks:
+
+```yaml
+dast:
+ image: registry.gitlab.com/gitlab-org/security-products/zaproxy
+ variables:
+ website: "https://example.com"
+ login_url: "https://example.com/sign-in"
+ allow_failure: true
+ script:
+ - mkdir /zap/wrk/
+ - /zap/zap-baseline.py -J gl-dast-report.json -t $website \
+ --auth-url $login_url \
+ --auth-username "john.doe@example.com" \
+ --auth-password "john-doe-password" || true
+ - cp /zap/wrk/gl-dast-report.json .
+ artifacts:
+ paths: [gl-dast-report.json]
+```
+See [zaproxy documentation](https://gitlab.com/gitlab-org/security-products/zaproxy)
+to learn more about authentication settings.
+
TIP: **Tip:**
Starting with [GitLab Ultimate][ee] 10.4, this information will
be automatically extracted and shown right in the merge request widget. To do