Componente GitLeaks GitLab CI

Um componente GitLab CI para Gitleaks - uma ferramenta SAST para detetar e prevenir segredos codificados como palavras-passe, chaves de API e tokens em repositórios git.

Funcionalidades

Deteção de Segredos: Analisa repositórios em busca de segredos codificados e informações sensíveis
Regras Abrangentes: Conjunto extenso de regras integradas para detetar vários tipos de segredos
Configuração Personalizada: Suporte para ficheiros de configuração locais e remotos
Múltiplos Formatos de Saída: Suporte para formatos de relatório JSON, SARIF e outros
Argumentos Flexíveis: Passar flags adicionais diretamente para o Gitleaks
Configuração Remota: Descarregar e usar ficheiros de configuração de URLs remotos
Configurações de Job Configuráveis: Personalizar nome do job, stage e imagem do contentor

Uso

Uso Básico

include:
  - component: $CI_SERVER_FQDN/niclas-zone/ci/gitleaks/main@latest

stages:
  - test

Com Configuração Personalizada

include:
  - component: $CI_SERVER_FQDN/niclas-zone/ci/gitleaks/main@latest
    inputs:
      GITLEAKS_CONFIG: ".gitleaks.toml"
      GITLEAKS_EXTRA_ARGS: "--verbose --report-format sarif"

stages:
  - test

Com Configuração Remota

include:
  - component: $CI_SERVER_FQDN/niclas-zone/ci/gitleaks/main@latest
    inputs:
      GITLEAKS_REMOTE_CONFIG: "https://gitlab.com/niclas-zone/ci/gitleaks/-/raw/main/configs/gitleaks.toml"

stages:
  - test

Entradas

Ficheiros de Configuração

Configuração Local

Coloque um ficheiro .gitleaks.toml na raiz do seu repositório ou especifique o caminho usando GITLEAKS_CONFIG.

Configuração Remota

Defina GITLEAKS_REMOTE_CONFIG para descarregar um ficheiro de configuração de um URL. Isto é útil para partilhar configurações entre vários projetos.

Configuração Predefinida

Se nenhuma configuração local ou remota for especificada, o componente usará as regras predefinidas integradas do Gitleaks.

Artefactos

O componente gera os seguintes artefactos:

gitleaks-report.json: Resultados da análise em formato JSON (ou outro formato baseado no argumento --report-format)

Documentação

Para mais informações sobre a configuração e opções do Gitleaks, consulte:

`job_name`	Nome do job de CI	`"secret scanning"`
`stage`	Estágio do pipeline	`"test"`
`image`	Imagem Docker para Gitleaks	`"registry.gitlab.com/niclas-zone/ctr/gitleaks:8.28.0"`
`GITLEAKS_EXTRA_ARGS`	Argumentos extras para Gitleaks	`"--verbose --redact --report-format json"`
`GITLEAKS_CONFIG`	Caminho para o ficheiro de configuração local do Gitleaks	`""`
`GITLEAKS_REMOTE_CONFIG`	URL para descarregar o ficheiro de configuração do Gitleaks	`""`

GitLeaks

Mais Populares