Componente GitLab CI per GitLeaks

Un componente GitLab CI per Gitleaks - uno strumento SAST per rilevare e prevenire segreti hardcoded come password, chiavi API e token nei repository git.

Funzionalità

Rilevamento segreti: Scansiona i repository per segreti hardcoded e informazioni sensibili
Regole complete: Set esteso di regole integrate per rilevare vari tipi di segreti
Configurazione personalizzata: Supporto per file di configurazione locali e remoti
Formati di output multipli: Supporto per JSON, SARIF e altri formati di report
Argomenti flessibili: Passa flag aggiuntivi direttamente a Gitleaks
Configurazione remota: Scarica e utilizza file di configurazione da URL remoti
Impostazioni job configurabili: Personalizza nome job, stage e immagine container

Utilizzo

Utilizzo base

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

stages:
  - test

Con configurazione personalizzata

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

Con configurazione 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

Input

File di configurazione

Configurazione locale

Posiziona un file .gitleaks.toml nella root del tuo repository o specifica il percorso usando GITLEAKS_CONFIG.

Configurazione remota

Imposta GITLEAKS_REMOTE_CONFIG per scaricare un file di configurazione da un URL. Questo è utile per condividere configurazioni tra più progetti.

Configurazione predefinita

Se non viene specificata alcuna configurazione locale o remota, il componente utilizzerà le regole predefinite integrate di Gitleaks.

Artefatti

Il componente genera i seguenti artefatti:

gitleaks-report.json: Risultati della scansione in formato JSON (o altro formato basato sull'argomento --report-format)

Documentazione

Per maggiori informazioni sulla configurazione e le opzioni di Gitleaks, consulta:

`job_name`	Nome del job CI	`"secret scanning"`
`stage`	Stage della pipeline	`"test"`
`image`	Immagine Docker per Gitleaks	`"registry.gitlab.com/niclas-zone/ctr/gitleaks:8.28.0"`
`GITLEAKS_EXTRA_ARGS`	Argomenti extra per Gitleaks	`"--verbose --redact --report-format json"`
`GITLEAKS_CONFIG`	Percorso del file di configurazione locale di Gitleaks	`""`
`GITLEAKS_REMOTE_CONFIG`	URL per scaricare il file di configurazione di Gitleaks	`""`

GitLeaks

Più Popolari