Segurança no Bitbucket: Scanner de Segredos

Verifica seus arquivos em busca de segredos, chaves e senhas codificados diretamente no código. Cria um relatório de Code Insights de segurança caso sejam encontrados.

Este Pipe compatível com o Bitbucket Cloud utiliza o registro de padrões de segredos gitleaks para oferecer aos clientes do Bitbucket recursos de verificação de segredos de segurança líderes do setor. Consulte a seção Detalhes e Exemplos para obter mais informações.

Nota: Alterações incompatíveis foram introduzidas na versão 2.0.0. Revise a versão atual do Pipe e atualize sua configuração de acordo antes de fazer upgrade.

Nota: Alterações incompatíveis foram introduzidas na versão 3.0.0. Revise a versão atual do Pipe e atualize sua configuração de acordo antes de fazer upgrade.

Definição YAML

Adicione o seguinte trecho à seção de script do seu arquivo 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`

Variáveis

Variável	Uso
GITLEAKS_COMMAND	Comando a ser usado com gitleaks. Disponível: git, dir, stdin. Padrão: git.
GITLEAKS_EXTRA_ARGS	Flags adicionais a serem passadas ao gitleaks gitleaks extra args.
CREATE_REPORT	Controla se o pipe criará relatórios do Bitbucket CodeInsights usando os resultados da execução do gitleaks. Padrão: true.
DEBUG	Ativa informações extras de depuração. Padrão: false.

Detalhes

Por padrão, o pipe irá escanear seus arquivos em busca de credenciais secretas embutidas no código com o comando gitleaks git e criar um relatório de segurança com anotações para cada credencial encontrada.

Uso avançado

Dê uma olhada neste post de blog para uma configuração avançada do gitleaks: gitleaks advanced configuration setup.

Como ignorar segredos de teste: gitleaks additional-configuration.

Exemplos

Exemplo básico:

Executar uma varredura em busca de credenciais secretas com o comando git padrão:

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

O comando dir permite que você escaneie diretórios e arquivos:

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

Não crie um relatório do CodeInsights:

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

Exemplo avançado:

Escaneie diretórios e arquivos, forneça uma configuração personalizada do gitleaks e ative o modo de depuração:

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"

Suporte

Se você precisar de ajuda com este pipe, ou tiver um problema ou solicitação de recurso, avise-nos na Comunidade.

Se estiver relatando um problema, inclua:

• a versão do pipe
• logs e mensagens de erro relevantes
• etapas para reproduzir

Licença

Copyright (c) 2020 Atlassian e outros. Licenciado sob Apache 2.0, consulte o arquivo LICENSE.txt.