bridgecrew orb

Bridgecrew Orb para Circleci

El orbe de Bridgecrew

Use el orbe Bridgecrew para escanear en busca de errores de infraestructura como código en sus flujos de trabajo Circleci. Al utilizar este ORB en el flujo de trabajo de su proyecto, puede comenzar automáticamente a encontrar, solucionar y monitorear su proyecto para errores de configuración en Terraform y CloudFormation. Al registrarse para un plan comunitario de Bridgecrew gratuito, también puede ver paneles e informes. El plan de la comunidad no limita la cantidad de escaneos o usuarios que puede invitar para ver los resultados. ​

Cómo usar el orbe Bridgecrew

De hecho, es muy fácil comenzar a usar el ORB. Todo lo que necesitas hacer es:

1. Siga las instrucciones en la Guía de inicio rápido de ORB para habilitar el uso de Orbs en el flujo de trabajo de su proyecto.
2. Configure una variable de entorno con su clave de API Bridgecrew, que puede obtener de su cuenta Bridgecrew.
3. En el trabajo de compilación de la aplicación, llame al bridgecrew/scan
4. Opcionalmente, el suministro de parámetros para personalizar el comportamiento de ORB
5. Miembros del Prisma: establezca su URL de la API de la nube Prisma que pueda obtener de las URL de las API de la nube de Prisma. Su variable de entorno (API-Key-Variable) requiere ser una clave de acceso a la nube de Prisma en el siguiente formato: <ACCESS_KEY_ID> :: <Secret_Key>

Ejemplos de uso

Escanear directorio de 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

Escanear archivos 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

Ejemplo avanzado

 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> 

Parámetros de orbe

Documentos de referencia completa https://circleci.com/orbs/registry/orb/bridgecrew/bridgecrew

Parámetro	Descripción	Requerido	Por defecto	Tipo
API-Key-Variable	Nombre de la variable de entorno para la tecla API Bridgecrew de la aplicación Bridgecrew	No	Bc_api_key	env_var_name
prisma-api-url	PRISMA Cloud API URL	No	"ninguno"	cadena
directorio	Directorio de raíz IAC para escanear	No	"ninguno"	cadena
archivo	Archivo IAC para escanear	No	"ninguno"	cadena
fail suave	Ejecuta cheques sin fallar la compilación	No	FALSO	booleano
producción	Formato de salida del informe	No	"CLI"	cli json junitxml

Capturas de pantalla

Ejecute Bridgecrew Orb en su flujo de trabajo Circleci