• 扫描执行策略编辑器
• 扫描执行策略 schema
• Scan execution policy schema
• pipeline 规则类型
• schedule 规则类型
  • agent schema
    • 策略示例
• scan 操作类型
• 示例安全策略项目
• 扫描执行策略编辑器示例

扫描执行策略

群组级别安全策略引入于 15.2 版本。

群组、子组或项目所有者可以使用扫描执行策略来要求安全扫描按指定的计划运行，或与项目（支持多个项目，如果策略是在群组或子组级别定义的）流水线一起运行。所需的扫描将作为新作业注入 CI 流水线，具有长且随机的作业名称。在不太可能发生作业名称冲突的情况下，安全策略作业会覆盖流水线中任何预先存在的作业。如果在群组级别创建策略，它将应用于每个子项目或子组。不能从子项目或子组编辑群组级策略。

扫描执行策略编辑器

完成策略后，通过选择编辑器底部的 通过合并请求创建 来保存。您将被重定向到项目的已配置安全策略项目的合并请求。如果没有关联到您的项目，则会自动创建一个安全策略项目。通过选择编辑器底部的 删除策略，也可以从编辑器界面中删除现有策略。

大多数策略更改会在合并请求合并后立即生效。未通过合并请求并直接提交到默认分支的任何更改，可能需要长达 10 分钟才能使策略更改生效。

扫描执行策略 schema

带有扫描执行策略的 YAML 文件由一组与扫描执行策略模式匹配的对象组成，这些对象嵌套在 scan_execution_policy 键下。您可以在 scan_execution_policy 键下配置最多 5 个策略。前 5 个之后配置的任何其他策略都不会应用。

当您保存新策略时，系统会根据此 JSON 模式验证其内容。 如果您不熟悉如何阅读JSON 模式，以下部分和表格提供另一种选择。

Scan execution policy schema

pipeline 规则类型

每当流水线为选定的分支运行时，此规则就会强制执行定义的操作。

schedule 规则类型

此规则强制执行定义的操作并在提供的日期/时间安排扫描。

极狐GitLab 支持 cadence 字段的以下类型的 CRON 语法：

• 在指定时间每小时一次的每日周期，例如：0 18 * * *
• 在指定日期和指定时间每周一次的每周周期，例如：0 13 * * 0

CRON 语法的其他元素可能会在 cadence 字段中起作用，但是，极狐GitLab 并未正式测试或支持它们。

agent schema

使用此 schema，在 schedule 规则类型中定义 agents 对象。

策略示例

- name: Enforce Container Scanning in cluster connected through gitlab-agent for production and staging namespaces
  enabled: true
  rules:
  - type: schedule
    cadence: '0 10 * * *'
    agents:
      gitlab-agent:
        namespaces:
        - 'production'
        - 'staging'
  actions:
  - scan: container_scanning

scan 操作类型

当满足已定义策略中至少一条规则的条件时，此操作会使用附加参数执行选定的 scan。

注意：

• 您必须为分配的每个项目创建具有选定名称的站点配置文件和扫描器配置文件到选定的安全策略项目。否则，不会应用该策略，而是创建带有错误消息的作业。
• 一旦您在策略中按名称关联站点配置文件和扫描器配置文件，就无法修改或删除它们。如果要修改它们，必须首先通过将 active 标志设置为 false 来禁用策略。
• 使用计划的 DAST 扫描配置策略时，安全策略项目的仓库中提交的作者必须有权访问扫描程序和站点配置文件。否则，扫描不会成功调度。
• 对于 secret 检测扫描，仅支持具有默认规则集的规则。不支持自定义规则集。
• Secret 检测扫描在作为流水线的一部分执行时以 normal 模式运行，当作为流水线的一部分执行时，以 history 模式运行计划扫描。
• 为 pipeline 规则类型配置的容器扫描和集群镜像扫描会忽略 agents 对象中定义的集群，agents 对象仅适用于 schedule 规则类型。 必须为项目创建和配置具有在 agents 对象中提供的名称的代理。
• SAST 扫描使用默认模板并在子流水线中运行。

示例安全策略项目

您可以在 .gitlab/security-policies/policy.yml 中使用此示例，如安全策略项目中所述。

---
scan_execution_policy:
- name: Enforce DAST in every release pipeline
  description: This policy enforces pipeline configuration to have a job with DAST scan for release branches
  enabled: true
  rules:
  - type: pipeline
    branches:
    - release/*
  actions:
  - scan: dast
    scanner_profile: Scanner Profile A
    site_profile: Site Profile B
- name: Enforce DAST and secret detection scans every 10 minutes
  description: This policy enforces DAST and secret detection scans to run every 10 minutes
  enabled: true
  rules:
  - type: schedule
    branches:
    - main
    cadence: "*/10 * * * *"
  actions:
  - scan: dast
    scanner_profile: Scanner Profile C
    site_profile: Site Profile D
  - scan: secret_detection
- name: Enforce Secret Detection and Container Scanning in every default branch pipeline
  description: This policy enforces pipeline configuration to have a job with Secret Detection and Container Scanning scans for the default branch
  enabled: true
  rules:
  - type: pipeline
    branches:
    - main
  actions:
  - scan: secret_detection
  - scan: sast
    variables:
      SAST_EXCLUDED_ANALYZERS: brakeman
  - scan: container_scanning

在此示例中：

• 对于在匹配 release/* 通配符的分支上执行的每个流水线（例如，分支 release/v1.2.1），DAST 扫描使用 Scanner Profile A 和 Site Profile B 运行。
• DAST 和 secret 检测扫描每 10 分钟运行一次。DAST 扫描使用 Scanner Profile C 和 Site Profile D。
• Secret 检测、容器扫描和 SAST 扫描针对在 main 分支上执行的每个流水线运行。SAST 扫描运行时将 SAST_EXCLUDED_ANALYZER 变量设置为 "brakeman"。

扫描执行策略编辑器示例

您可以在扫描执行策略编辑器的 YAML 模式下使用此示例。它对应于上一个示例中的单个对象。

name: Enforce Secret Detection and Container Scanning in every default branch pipeline
description: This policy enforces pipeline configuration to have a job with Secret Detection and Container Scanning scans for the default branch
enabled: true
rules:
  - type: pipeline
    branches:
      - main
actions:
  - scan: secret_detection
  - scan: container_scanning