bridgecrew orb

Bridgecrew Orb for Circleci

Bridgecrew Orb

使用Bridgecrew Orb在您的CircleCi工作流程中扫描基础架构 - 代码错误。通过在项目工作流程中使用此球体，您可以自动开始查找，修复和监视您的项目以获取Terraform和CloudFormation中的配置错误。通过注册免费的Bridgecrew社区计划，您还可以查看仪表板和报告。社区计划不会限制您可以邀请查看结果的扫描或用户的数量。 ​

如何使用Bridgecrew Orb

实际上，开始使用球体非常容易。您需要做的就是：

1. 遵循ORB快速启动指南中的说明，以在项目工作流程中使用ORB。
2. 使用BridGecrew API密钥设置环境变量，您可以从Bridgecrew帐户中获得。
3. 在应用程序构建工作中，致电bridgecrew/scan
4. 可选地，为定制球体行为的供应参数
5. Prisma成员 - 设置您可以从Prisma Cloud API URL中获得的Prisma Cloud API URL。您的环境变量（api-key-variable）需要以以下格式为Prisma云访问密钥：<Access_key_id> :: <secret_key>

用法示例

扫描IAC目录

 version : 2.1

  orbs :
    bridgecrew : bridgecrew/[email protected]

  jobs :
    build :
      executor : bridgecrew/default
      steps :
        - checkout
        - bridgecrew/scan :
            directory : ' . '
            soft-fail : true
            api-key-variable : BC_API_KEY
            prisma-api-url : PRISMA_API_URL

扫描IAC文件

 version : 2.1

orbs :
  bridgecrew : bridgecrew/[email protected]

jobs :
  build :
    executor : bridgecrew/default
    steps :
      - checkout
      - bridgecrew/scan :
          file : " ./terraform/db-app.tf "
          api-key-variable : BC_API_KEY
          prisma-api-url : PRISMA_API_URL

高级示例

 version : 2.1

orbs :
bridgecrew : bridgecrew/[email protected]

jobs :
build :
    executor : bridgecrew/default
    steps :
    - checkout
    - bridgecrew/scan :
        directory : " ./terragoat "                # tell bridgecrew where is the directory you want to scan
        soft-fail : true                         # do not fail the workflow in case vulnerabilities have found 
        api-key-variable : BC_API_KEY            # bridgecrew API key or prisma cloud access key (see PRISMA_API_URL)
        prisma-api-url : PRISMA_API_URL # prisma cloud API URL (see: https://prisma.pan.dev/api/cloud/api-urls). Requires api-key-variable to be a prisma cloud access key in the following format: <access_key_id>::<secret_key> 

ORB参数

完整参考文档https://circleci.com/orbs/registry/orb/bridgecrew/bridgecrew

范围	描述	必需的	默认	类型
Api-key变量	Bridgecrew应用程序的BridGecrew API键的环境变量名称	不	BC_API_KEY	env_var_name
Prisma-api-url	prisma云API URL	不	“没有任何”	细绳
目录	IAC根目录扫描	不	“没有任何”	细绳
文件	IAC文件进行扫描	不	“没有任何”	细绳
软脱机	运行支票而不会失败	不	错误的	布尔
输出	报告输出格式	不	“ CLI”	cli json junitxml

屏幕截图

在您的Circleci工作流程中运行Bridgecrew Orb