PHP Security-checker 镜像文档

镜像概述

该镜像属于Pipeline Components项目，提供容器化的php-security-checker工具，专为GitLab CI环境设计，用于自动化检查PHP项目的依赖安全漏洞。工具预安装于/app/目录，支持自定义配置，可直接集成到CI/CD流水线中。

核心功能与特性

• 即插即用：无需手动安装依赖，容器化设计确保快速集成到CI流程
• 安全检查：通过分析composer.lock文件，识别PHP项目依赖中的已知安全漏洞
• 灵活配置：工具安装路径为/app/，支持自定义安装前的配置调整
• 轻量高效：优化的镜像体积，适合CI环境中的快速执行

使用场景

主要用于GitLab CI/CD流水线的代码检查阶段（如linting阶段），对使用Composer管理依赖的PHP项目进行自动化安全扫描，确保项目依赖无已知安全风险。

使用方法

GitLab CI配置示例

在GitLab CI配置文件（如.gitlab-ci.yml）中，可按以下方式集成：

yaml
php-security-checker:
  stage: linting
  image: registry.gitlab.com/pipeline-components/php-security-checker:latest
  script:
    - cd ${COMPOSER_LOCATION:-.} && security-checker security:check composer.lock

配置说明

• 环境变量：COMPOSER_LOCATION指定Composer文件所在目录，默认值为当前目录（.）
• 核心命令：security-checker security:check composer.lock为安全检查主命令，需在包含composer.lock的目录执行

版本控制

项目采用语义化版本（Semantic Versioning）进行版本管理，确保版本号的规范性和兼容性。

支持与反馈

获取帮助

• 访问***频道
• 提交Issue

贡献指南

本项目为开源项目，欢迎通过代码贡献或使用反馈参与改进。贡献指南详见项目贡献文档。

许可证

本项目基于MIT许可证授权，原作者为Robbert Müller。