Pipeline Components: Snyk 镜像文档

镜像概述

该镜像专为GitLab CI/CD流水线设计，用于运行Snyk安全扫描工具。Snyk已预安装在容器的/app/目录下，且容器内集成了Docker环境，可直接扫描Docker镜像的安全漏洞。使用时需确保本地存在可用的Docker服务（如dind或共享Docker socket）。

核心功能与特性

• Snyk集成：内置Snyk工具，支持执行snyk test等安全扫描命令
• Docker环境：容器内预装Docker，无需额外配置即可扫描本地Docker镜像
• CI/CD适配：无缝集成GitLab CI流水线，可作为代码检查或安全扫描阶段的任务
• 灵活配置：支持通过环境变量（如SNYK_TOKEN）自定义扫描参数，满足不同场景需求

使用场景

主要用于GitLab CI/CD流水线中的安全检查阶段，扫描Docker镜像的潜在安全漏洞，帮助开发团队在部署前发现并修复依赖或配置中的安全风险。

使用方法与配置说明

必要配置

• 环境变量：需设置SNYK_TOKEN作为Snyk服务的认证令牌，建议在GitLab项目中配置为秘密变量（Secret Variable），避免明文暴露
• 本地镜像：待扫描的Docker镜像需确保已存在于本地环境（如提前拉取或构建）

GitLab CI配置示例

yaml
snyk:
  stage: linting  # 通常作为代码检查阶段的任务
  variables:
    SNYK_TOKEN: my-secret-snyk-token  # 替换为实际的Snyk令牌，通过GitLab秘密变量传入
  image: registry.gitlab.com/pipeline-components/snyk:latest
  script:
    - snyk test --docker pipelinecomponents/php-linter:latest --file=Dockerfile  # 扫描指定Docker镜像

示例参数说明

• pipelinecomponents/php-linter:latest：目标扫描镜像，需本地可用
• --file=Dockerfile：指定用于扫描的Dockerfile（可选，用于更精准的依赖分析）
• SNYK_TOKEN：Snyk API认证令牌，通过GitLab秘密变量注入，确保安全性

版本控制

项目采用语义化版本控制（Semantic Versioning）管理版本号，格式为MAJOR.MINOR.PATCH。

支持与反馈

问题咨询

• 查看***频道
• 在项目Issues提交问题报告

贡献指南

本项目为活跃的开源项目，欢迎使用或贡献代码。贡献详情请参阅贡献 guidelines。感谢您的参与！😍

作者与贡献者

• 仓库初始设置由Robbert Müller完成
• 构建流水线基于Community Hass.io Add-ons（作者：Franck Nijhof）
• 完整贡献者列表见贡献者页面

许可证

本项目采用MIT许可证，由Robbert Müller授权。