- Enable or disable scan policies
- Security Policies project
- Security Policy project selection
Scan Policies in GitLab provide security teams a way to require scans of their choice to be run whenever a project pipeline runs according to the configuration specified. Security teams can therefore be confident that the scans they set up have not been changed, altered, or disabled. You can access these by navigating to your project’s Security & Compliance > Scan Policies page.
GitLab supports the following security policies:
Scan Policies is under development and is not ready for production use. It’s deployed behind a feature flag that’s disabled by default. GitLab administrators with access to the GitLab Rails console can enable it for your instance. Scan Policies can be enabled or disabled per-project.
To enable it:
# Instance-wide Feature.enable(:security_orchestration_policies_configuration) # or by project Feature.enable(:security_orchestration_policies_configuration, Project.find(<project ID>))
To disable it:
# Instance-wide Feature.disable(:security_orchestration_policies_configuration) # or by project Feature.disable(:security_orchestration_policies_configuration, Project.find(<project ID>))
The Security Policies feature is a repository to store policies. All security policies are stored in
.gitlab/security-policies directory as a YAML file with this format:
--- type: scan_execution_policy name: Enforce DAST in every pipeline description: This policy enforces pipeline configuration to have a job with DAST scan enabled: true rules: - type: pipeline branch: master actions: - scan: dast scanner_profile: Scanner Profile A site_profile: Site Profile B
|The policy’s type.|
|Name of the policy.|
||Description of the policy.|
||Flag to enable (|
||List of rules that the policy applies.|
||List of actions that the policy enforces.|
This rule enforces the defined actions whenever the pipeline runs for a selected branch.
|The rule’s type.|
||The branch the given policy applies to (supports wildcard).|
This action executes the selected
scan with additional parameters when conditions for at least one
rule in the defined policy are met.
|The action’s type.|
|Name of the selected DAST site profile.||The DAST site profile to execute the DAST scan.|
||Name of the selected DAST scanner profile.||The DAST scanner profile to execute the DAST scan.|
Note the following:
- You must create the site profile and scanner profile with selected names for the project that is assigned to the selected Security Policy Project. Otherwise, the policy is not applied and a job with an error message is created instead.
- Once you associate the site profile and scanner profile by name in the policy, it is not possible
to modify or delete them. If you want to modify them, you must first disable the policy by setting
Here’s an example:
--- type: scan_execution_policy name: Enforce DAST in every pipeline description: This policy enforces pipeline configuration to have a job with DAST scan enabled: true rules: - type: pipeline branch: release/* actions: - scan: dast scanner_profile: Scanner Profile A site_profile: Site Profile B
In this example, the DAST scan runs with the scanner profile
Scanner Profile A and the site
Site Profile B. The scan runs for every pipeline executed on branches that match the
release/* wildcard (for example, branch name
When the Security Policy project is created and policies are created within that repository, you must create an association between that project and the project you want to apply policies to. To do this, navigate to your project’s Security & Compliance > Policies, select Security policy project from the dropdown menu, then select the Create policy button to save changes.
You can always change the Security policy project by navigating to your project’s Security & Compliance > Policies and modifying the selected project.
See the Category Direction page for more information on the product direction of Container Network Security.