3bittechs/3conftest

3Conftest

镜像概述

3Conftest是一款基于正则规则的通用文件验证工具，旨在通过预定义的规则检查目标文件（如Makefile）中的特定内容（如命令、环境变量）是否符合允许列表，帮助用户确保文件内容的合规性和一致性。

核心功能

• 支持自定义配置文件定义验证规则
• 针对不同文件类型（如makefile）设置专属验证逻辑
• 通过正则表达式提取文件中的关键token（如命令、环境变量）
• 验证提取的token是否在允许列表中，快速识别违规内容

使用场景

• CI/CD流程中自动验证Makefile等配置文件的合规性
• 运维场景下检查部署配置中的命令和环境变量是否符合安全规范
• 团队协作中确保配置文件遵循统一标准，避免不合规内容提交

配置说明

需准备config.json配置文件，结构示例如下：

json
{
  "makefile": {
    "filename": "/etc/3conftest/Makefile",
    "rules": [
      {
        "regex": "(?P<token>[a-zA-Z0-9\\-_]+)\\:",
        "type": "COMMAND",
        "allowed": ["docker-login", "build", "clean", "test"]
      },
      {
        "regex": "(?P<token>[a-zA-Z0-9\\-_]+)(\\?\\=|:\\=|\\=)",
        "type": "ENVIRONMENT",
        "allowed": ["MAVEN_REPO", "NAMESPACE", "VERSION"]
      }
    ]
  }
}

关键配置项：

• makefile：文件类型标识（可通过FILETYPE环境变量指定）
• filename：目标文件默认路径（可通过FILENAME环境变量覆盖）
• rules：验证规则列表，包含正则表达式、token类型及允许值

部署示例

示例1：指定文件类型和文件名

bash
docker run -e FILETYPE=makefile -e FILENAME=/etc/3conftest/Makefile -v $(pwd):/etc/3conftest/ 3bittechs/3conftest

示例2：仅指定文件类型（使用配置默认文件名）

bash
docker run -e FILETYPE=makefile -v $(pwd):/etc/3conftest/ 3bittechs/3conftest