2ms (Too many secrets)

![Latest Release]([] ![Homebrew]([] ![License]([***]

!2ms Mascot

Too many secrets (2ms) 是由Checkmarx开发的开源CLI工具，用于识别系统中以未加密文本形式存储的敏感数据，如密钥、认证令牌和密码。该工具支持扫描内部通信平台（Slack、***）、内容管理系统（Confluence、Paligo）和源代码存储位置（Git仓库、本地目录）。 此应用程序采用Go语言编写，基于gitleaks框架构建。

该工具通过一系列规则检查内容，旨在识别各种敏感项，如AWS访问令牌、Bitbucket客户端ID、GitHub PAT等。完整规则列表参见docs/list-of-rules.md。

此外，该工具还整合了基于通用漏洞评分系统(CVSS)的评分机制，帮助优先排序修复工作。

安装

以下部分介绍如何通过以下方法安装2ms：

• Homebrew (macOS/Linux)
• 下载并安装预编译二进制文件
• 从源代码编译
• 从Docker容器运行
• CI/CD集成

从Docker容器运行

我们将2ms的容器镜像发布到checkmarx/2ms。 要从Docker容器运行2ms，请使用以下命令：

docker run checkmarx/2ms

挂载本地目录

您还可以使用-v标志挂载本地目录，语法如下：-v <本地目录路径>:<容器目录路径>

示例：

bash
docker run -v /home/user/workspace/git-repo:/repo checkmarx/2ms git /repo

• 对于git命令，需要将Git仓库挂载到容器内的/repo目录

CI/CD集成

GitHub Actions

以下是创建GitHub Action的模板，该Action从Docker镜像运行2ms以扫描GitHub仓库。 注意： 确保在actions/checkout步骤中通过设置fetch-depth: 0来获取完整历史记录

yaml
name: Pipeline Example With 2MS

on:
  pull_request:
    workflow_dispatch:
    push:
      branches: [main]
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
        with:
          # 2ms需要可见所有提交历史
          fetch-depth: 0

      # ...

      - name: Run 2ms Scan
        run: docker run -v $(pwd):/repo checkmarx/2ms:2.8.1 git /repo

• 本示例使用2ms的2.8.1版本。请确保检查最新版本。

Azure DevOps Pipeline

要在Azure DevOps Pipeline中使用2ms，请创建新管道(查看本教程了解Azure DevOps Pipelines入门)。然后，使用以下模板创建azure-pipelines.yml文件来运行2ms：

yaml
trigger:
  - master

pool:
  vmImage: ubuntu-latest

steps:
  - script: docker run -v $(pwd):/repo checkmarx/2ms:2.8.1 git /repo
    displayName: Run 2ms

运行2ms扫描

概述

2ms具有用于扫描每个支持平台的专用命令。要运行扫描，您需要输入要扫描的平台的命令，以及与该平台相关的所有参数。扫描命令参数用于身份验证以及提供有关将要扫描的位置的详细信息。这些参数因平台而异。此外，您可以添加全局标志来自定义扫描配置。 扫描命令的基本结构是：

text
2ms <扫描命令> [扫描命令参数] [全局标志]

扫描命令参数和全局标志可以作为扫描命令中的标志传递，也可以通过配置文件传递。

扫描命令

以下部分描述用于扫描每个支持平台的参数。

Git仓库

扫描本地Git仓库

text
2ms git <Git仓库本地路径> [标志]

例如

bash
git clone [***]
cd my-repo
2ms git .

使用Docker运行示例：

bash
docker run -v $(pwd):/repo checkmarx/2ms git /repo

本地目录

扫描本地目录

bash
2ms filesystem --path PATH [标志]

使用Docker运行示例：

bash
docker run -v /path/to/local/directory:/scan checkmarx/2ms filesystem --path /scan

全局标志

下表描述了可与任何扫描命令一起使用的全局标志。