Sicurezza di Bitbucket: Scanner di segreti

Analizza i tuoi file alla ricerca di segreti, chiavi e password hardcoded. Crea un report di Code Insights sulla sicurezza se ne vengono trovati.

Questa Pipe supportata da Bitbucket Cloud sfrutta il registro di pattern dei segreti gitleaks per offrire ai clienti Bitbucket capacità di scansione dei segreti di sicurezza all'avanguardia nel settore. Consulta la sezione Dettagli ed Esempi per ulteriori informazioni.

Nota: Sono state introdotte modifiche incompatibili nella versione 2.0.0. Ti invitiamo a rivedere la versione corrente della Pipe e ad aggiornare la tua configurazione di conseguenza prima di eseguire l'aggiornamento.

Nota: Sono state introdotte modifiche incompatibili nella versione 3.0.0. Ti invitiamo a rivedere la versione corrente della Pipe e ad aggiornare la tua configurazione di conseguenza prima di eseguire l'aggiornamento.

Definizione YAML

Aggiungi il seguente snippet alla sezione script del tuo file bitbucket-pipelines.yml:

- pipe: atlassian/git-secrets-scan:3.2.0
  variables:
    # GITLEAKS_COMMAND: '<string>' # Optional. Default: `git`
    # GITLEAKS_EXTRA_ARGS: '<array>' # Optional.
    # CREATE_REPORT: "<boolean>" # Optional. Default: `true`
    # DEBUG: "<boolean>" # Optional. Default: `false`

Variabili

Variabile	Utilizzo
GITLEAKS_COMMAND	Comando da usare con gitleaks. Disponibili: git, dir, stdin. Predefinito: git.
GITLEAKS_EXTRA_ARGS	Flag aggiuntivi da passare a gitleaks gitleaks extra args.
CREATE_REPORT	Controlla se la pipe creerà report Bitbucket CodeInsights usando i risultati dell'esecuzione di gitleaks. Predefinito: true.
DEBUG	Attiva informazioni di debug aggiuntive. Predefinito: false.

Dettagli

Per impostazione predefinita, la pipe analizzerà i tuoi file alla ricerca di credenziali segrete hardcoded con il comando gitleaks git e creerà un report di sicurezza con annotazioni per ogni credenziale trovata.

Utilizzo avanzato

Dai un'occhiata a questo post del blog per una configurazione avanzata di gitleaks: gitleaks advanced configuration setup.

Come ignorare i segreti di test: gitleaks additional-configuration.

Esempi

Esempio di base:

Esegui una scansione delle credenziali segrete con il comando predefinito git:

script:
  - pipe: atlassian/git-secrets-scan:3.2.0

Il comando dir consente di scansionare directory e file:

script:
  - pipe: atlassian/git-secrets-scan:3.2.0
    variables:
      GITLEAKS_COMMAND: "dir"
      GITLEAKS_EXTRA_ARGS: "./path_to_directory_or_file"

Non creare un report CodeInsights:

script:
  - pipe: atlassian/git-secrets-scan:3.2.0
    variables:
      CREATE_REPORT: "false"

Esempio avanzato:

Scansiona directory e file, fornisci una configurazione gitleaks personalizzata e attiva il debug:

script:
  - pipe: atlassian/git-secrets-scan:3.2.0
    variables:
      DEBUG: "true"
      GITLEAKS_COMMAND: "dir"
      GITLEAKS_EXTRA_ARGS: 
        - "./path_to_directory_or_file"
        - "--config=my-gitleaks-config.toml"

Supporto

Se desideri assistenza con questa pipe, o hai un problema o una richiesta di funzionalità, faccelo sapere sulla Community.

Se stai segnalando un problema, includi:

• la versione della pipe
• i log e i messaggi di errore pertinenti
• i passaggi per riprodurre il problema

Licenza

Copyright (c) 2020 Atlassian e altri. Con licenza Apache 2.0, vedi il file LICENSE.txt.