Bitbucket 安全：密钥扫描器

扫描你的文件中的硬编码密钥、密钥和密码。如果发现，则创建一个安全 Code Insights 报告。

这个受 Bitbucket Cloud 支持的 Pipe 利用 gitleaks 密钥模式注册表，为 Bitbucket 客户提供业界领先的安全密钥扫描能力。 有关更多信息，请参阅详情和示例部分。

注意：2.0.0 版本引入了破坏性变更。请在升级前查看 Pipe 的当前版本并相应地更新你的配置。

注意：3.0.0 版本引入了破坏性变更。请在升级前查看 Pipe 的当前版本并相应地更新你的配置。

YAML 定义

将以下代码片段添加到你的 bitbucket-pipelines.yml 文件的 script 部分：

- pipe: atlassian/git-secrets-scan:3.2.0
  variables:
    # GITLEAKS_COMMAND: '<string>' # Optional. Default: `git`
    # GITLEAKS_EXTRA_ARGS: '<array>' # Optional.
    # CREATE_REPORT: "<boolean>" # Optional. Default: `true`
    # DEBUG: "<boolean>" # Optional. Default: `false`

变量

变量	用途
GITLEAKS_COMMAND	与 gitleaks 配合使用的命令。可用值：git、dir、stdin。默认值：git。
GITLEAKS_EXTRA_ARGS	传递给 gitleaks 的额外标志 gitleaks 额外参数。
CREATE_REPORT	控制该管道是否使用 gitleaks 执行结果创建 Bitbucket CodeInsights 报告。默认值：true。
DEBUG	开启额外的调试信息。默认值：false。

详情

默认情况下，该管道会使用 gitleaks git 命令扫描你的文件以查找硬编码的机密凭据，并 为每个发现的凭据创建带有注释的安全报告。

高级用法

查看这篇博文以了解高级 gitleaks 配置设置：[gitleaks 高级配置设置]。

如何忽略测试机密：[gitleaks 附加配置]。

示例

基本示例：

使用默认的 git 命令运行机密凭据扫描：

script:
  - pipe: atlassian/git-secrets-scan:3.2.0

dir 命令可让你扫描目录和文件：

script:
  - pipe: atlassian/git-secrets-scan:3.2.0
    variables:
      GITLEAKS_COMMAND: "dir"
      GITLEAKS_EXTRA_ARGS: "./path_to_directory_or_file"

不要创建 CodeInsights 报告：

script:
  - pipe: atlassian/git-secrets-scan:3.2.0
    variables:
      CREATE_REPORT: "false"

高级示例：

扫描目录和文件，提供自定义 gitleaks 配置并开启调试：

script:
  - pipe: atlassian/git-secrets-scan:3.2.0
    variables:
      DEBUG: "true"
      GITLEAKS_COMMAND: "dir"
      GITLEAKS_EXTRA_ARGS: 
        - "./path_to_directory_or_file"
        - "--config=my-gitleaks-config.toml"

支持

如果你需要关于此 pipe 的帮助，或者遇到问题、有功能需求，请在社区中告知我们。

如果你要报告问题，请包含：

• pipe 的版本
• 相关日志和错误消息
• 复现步骤

许可证

Copyright (c) 2020 Atlassian and others. 采用 Apache 2.0 许可，请参阅 LICENSE.txt 文件。