Commit 9274346c authored by Nick Gaskill's avatar Nick Gaskill

Merge branch 'docs-fix-yaml-secure-docs' into 'master'

Update yaml codeblocks with yamllint in secure docs

See merge request gitlab-org/gitlab!41862
parents 2edfdb80 bef4319b
...@@ -606,36 +606,36 @@ Example profile definition: ...@@ -606,36 +606,36 @@ Example profile definition:
```yaml ```yaml
Profiles: Profiles:
- Name: Quick-10 - Name: Quick-10
DefaultProfile: Quick DefaultProfile: Quick
Routes: Routes:
- Route: *Route0 - Route: *Route0
Checks: Checks:
- Name: FormBodyFuzzingCheck - Name: FormBodyFuzzingCheck
Configuration: Configuration:
FuzzingCount: 10 FuzzingCount: 10
UnicodeFuzzing: true UnicodeFuzzing: true
- Name: GeneralFuzzingCheck - Name: GeneralFuzzingCheck
Configuration: Configuration:
FuzzingCount: 10 FuzzingCount: 10
UnicodeFuzzing: true UnicodeFuzzing: true
- Name: JsonFuzzingCheck - Name: JsonFuzzingCheck
Configuration: Configuration:
FuzzingCount: 10 FuzzingCount: 10
UnicodeFuzzing: true UnicodeFuzzing: true
- Name: XmlFuzzingCheck - Name: XmlFuzzingCheck
Configuration: Configuration:
FuzzingCount: 10 FuzzingCount: 10
UnicodeFuzzing: true UnicodeFuzzing: true
``` ```
To turn off the General Fuzzing Check you can remove these lines: To turn off the General Fuzzing Check you can remove these lines:
```yaml ```yaml
- Name: GeneralFuzzingCheck - Name: GeneralFuzzingCheck
Configuration: Configuration:
FuzzingCount: 10 FuzzingCount: 10
UnicodeFuzzing: true UnicodeFuzzing: true
``` ```
This results in the following YAML: This results in the following YAML:
...@@ -644,20 +644,20 @@ This results in the following YAML: ...@@ -644,20 +644,20 @@ This results in the following YAML:
- Name: Quick-10 - Name: Quick-10
DefaultProfile: Quick DefaultProfile: Quick
Routes: Routes:
- Route: *Route0 - Route: *Route0
Checks: Checks:
- Name: FormBodyFuzzingCheck - Name: FormBodyFuzzingCheck
Configuration: Configuration:
FuzzingCount: 10 FuzzingCount: 10
UnicodeFuzzing: true UnicodeFuzzing: true
- Name: JsonFuzzingCheck - Name: JsonFuzzingCheck
Configuration: Configuration:
FuzzingCount: 10 FuzzingCount: 10
UnicodeFuzzing: true UnicodeFuzzing: true
- Name: XmlFuzzingCheck - Name: XmlFuzzingCheck
Configuration: Configuration:
FuzzingCount: 10 FuzzingCount: 10
UnicodeFuzzing: true UnicodeFuzzing: true
``` ```
### Turn off an Assertion for a Check ### Turn off an Assertion for a Check
...@@ -671,14 +671,14 @@ This example shows the FormBody Fuzzing Check: ...@@ -671,14 +671,14 @@ This example shows the FormBody Fuzzing Check:
```yaml ```yaml
Checks: Checks:
- Name: FormBodyFuzzingCheck - Name: FormBodyFuzzingCheck
Configuration: Configuration:
FuzzingCount: 30 FuzzingCount: 30
UnicodeFuzzing: true UnicodeFuzzing: true
Assertions: Assertions:
- Name: LogAnalysisAssertion - Name: LogAnalysisAssertion
- Name: ResponseAnalysisAssertion - Name: ResponseAnalysisAssertion
- Name: StatusCodeAssertion - Name: StatusCodeAssertion
``` ```
Here you can see three Assertions are on by default. A common source of false positives is Here you can see three Assertions are on by default. A common source of false positives is
...@@ -688,30 +688,30 @@ example provides only the other two Assertions (`LogAnalysisAssertion`, ...@@ -688,30 +688,30 @@ example provides only the other two Assertions (`LogAnalysisAssertion`,
```yaml ```yaml
Profiles: Profiles:
- Name: Quick-10 - Name: Quick-10
DefaultProfile: Quick DefaultProfile: Quick
Routes: Routes:
- Route: *Route0 - Route: *Route0
Checks: Checks:
- Name: FormBodyFuzzingCheck - Name: FormBodyFuzzingCheck
Configuration: Configuration:
FuzzingCount: 10 FuzzingCount: 10
UnicodeFuzzing: true UnicodeFuzzing: true
Assertions: Assertions:
- Name: LogAnalysisAssertion - Name: LogAnalysisAssertion
- Name: ResponseAnalysisAssertion - Name: ResponseAnalysisAssertion
- Name: GeneralFuzzingCheck - Name: GeneralFuzzingCheck
Configuration: Configuration:
FuzzingCount: 10 FuzzingCount: 10
UnicodeFuzzing: true UnicodeFuzzing: true
- Name: JsonFuzzingCheck - Name: JsonFuzzingCheck
Configuration: Configuration:
FuzzingCount: 10 FuzzingCount: 10
UnicodeFuzzing: true UnicodeFuzzing: true
- Name: XmlInjectionCheck - Name: XmlInjectionCheck
Configuration: Configuration:
FuzzingCount: 10 FuzzingCount: 10
UnicodeFuzzing: true UnicodeFuzzing: true
``` ```
<!-- <!--
......
...@@ -177,9 +177,9 @@ include: ...@@ -177,9 +177,9 @@ include:
variables: variables:
DAST_WEBSITE: https://example.com DAST_WEBSITE: https://example.com
DAST_AUTH_URL: https://example.com/sign-in DAST_AUTH_URL: https://example.com/sign-in
DAST_USERNAME_FIELD: session[user] # the name of username field at the sign-in HTML form DAST_USERNAME_FIELD: session[user] # the name of username field at the sign-in HTML form
DAST_PASSWORD_FIELD: session[password] # the name of password field at the sign-in HTML form DAST_PASSWORD_FIELD: session[password] # the name of password field at the sign-in HTML form
DAST_AUTH_EXCLUDE_URLS: http://example.com/sign-out,http://example.com/sign-out-2 # optional, URLs to skip during the authenticated scan; comma-separated, no spaces in between DAST_AUTH_EXCLUDE_URLS: http://example.com/sign-out,http://example.com/sign-out-2 # optional, URLs to skip during the authenticated scan; comma-separated, no spaces in between
``` ```
The results are saved as a The results are saved as a
......
...@@ -244,8 +244,8 @@ analyzer and compilation will be skipped: ...@@ -244,8 +244,8 @@ analyzer and compilation will be skipped:
image: maven:3.6-jdk-8-alpine image: maven:3.6-jdk-8-alpine
stages: stages:
- build - build
- test - test
include: include:
- template: SAST.gitlab-ci.yml - template: SAST.gitlab-ci.yml
...@@ -523,13 +523,13 @@ For details on saving and transporting Docker images as a file, see Docker's doc ...@@ -523,13 +523,13 @@ For details on saving and transporting Docker images as a file, see Docker's doc
Add the following configuration to your `.gitlab-ci.yml` file. You must replace Add the following configuration to your `.gitlab-ci.yml` file. You must replace
`SECURE_ANALYZERS_PREFIX` to refer to your local Docker container registry: `SECURE_ANALYZERS_PREFIX` to refer to your local Docker container registry:
```yaml ```yaml
include: include:
- template: SAST.gitlab-ci.yml - template: SAST.gitlab-ci.yml
variables: variables:
SECURE_ANALYZERS_PREFIX: "localhost:5000/analyzers" SECURE_ANALYZERS_PREFIX: "localhost:5000/analyzers"
``` ```
The SAST job should now use local copies of the SAST analyzers to scan your code and generate The SAST job should now use local copies of the SAST analyzers to scan your code and generate
security reports without requiring internet access. security reports without requiring internet access.
......
...@@ -66,7 +66,7 @@ global: ...@@ -66,7 +66,7 @@ global:
enabled: true enabled: true
metrics: metrics:
enabled: enabled:
- 'flow:sourceContext=namespace;destinationContext=namespace' - 'flow:sourceContext=namespace;destinationContext=namespace'
``` ```
The **Container Network Policy** section displays the following information The **Container Network Policy** section displays the following information
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment