Skip to main content
Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais recentes, acesse a documentação em inglês. Se houver problemas com a tradução desta página, entre em contato conosco.

Configurar a varredura de segredo para os seus repositórios

Você pode configurar como GitHub digitaliza os seus repositórios vom relação a segredos que correspondem a padrões avançados de segurança.

People with admin permissions to a repository can enable >- secret scanning for advanced security for the repository.

Secret scanning for advanced security is available for organization-owned repositories in GitHub Enterprise Cloud if your enterprise has a license for Segurança Avançada GitHub. For more information, see "GitHub's products."

Habilitar o >- secret scanning for advanced security

Você pode habilitar >- secret scanning for advanced security para qualquer repositório que pertença a uma organização. Uma vez habilitado, varredura secreta verifica todos segredos em todo o histórico do Git em todos os branches presentes no repositório GitHub.

  1. No GitHub.com, navegue até a página principal do repositório.

  2. No nome do seu repositório, clique em Configurações. Botão de configurações do repositório

  3. In the "Security" section of the sidebar, click Code security and analysis.

  4. Se Segurança Avançada ainda não estiver habilitado para o repositório, à direita de "Segurança Avançada GitHub", clique em Habilitar. Habilitar Segurança Avançada GitHub para o seu repositório

  5. Revise o impacto de habilitar Segurança Avançada, e clique em Permitir Segurança Avançada GitHub para este repositório.

  6. Quando você habilitar Segurança Avançada, varredura secreta pode ser habilitado automaticamente para o repositório, devido às configurações da organização. Se "Varredura secreta" é exibido com um botão habilitar. Você ainda precisa habilitar varredura secreta clicando em Habilitar. Se você vir um botão Desabilitar, significa que varredura secreta já está habilitado. Habilitar varredura secreta para o seu repositório

  7. Opcionalmente, se você quiser habilitar a proteção push, clique em Habilitar à direita de "Proteção push". When you enable push protection, varredura secreta also checks pushes for high-confidence secrets (those identified with a low false positive rate). Varredura secreta lists any secrets it detects so the author can review the secrets and remove them or, if needed, allow those secrets to be pushed. Para obter mais informações, consulte "Protegendo pushes com varredura secreta". Habilitar proteção push para o seu repositório

Excluindo diretórios de >- secret scanning for advanced security

Você pode usar um arquivo secret_scanning.yml para excluir diretórios do varredura secreta. Por exemplo, você pode excluir diretórios que contenham testes ou conteúdo gerado aleatoriamente.

  1. No GitHub.com, navegue até a página principal do repositório.

  2. Acima da lista de arquivos, utilizando o menu suspenso Add file (Adicionar arquivo), clique em Create new file (Criar novo arquivo). "Criar novo arquivo" no menu suspenso "Adicionar arquivo"

  3. No campo do nome de arquivo, digite .github/secret_scanning.yml. .

  4. Em Editar o novo arquivo, digite paths-ignore: seguido pelos paths que você deseja excluir do varredura secreta.

    paths-ignore:
      - "foo/bar/*.js"
    

    Você pode usar caracteres especiais, como * para filtrar paths. Para obter mais informações sobre padrões de filtro, consulte "Sintaxe do fluxo de trabalho para o GitHub Actions".

    Notas:

    • Se houver mais de 1.000 entradas em paths-ignore, varredura secreta excluirá apenas os primeiros 1.000 diretórios das verificações.
    • Se secret_scanning.yml for maior que 1 MB, varredura secreta ignorará todo o arquivo.

Você também pode ignorar alertas individuais de varredura secreta. Para obter mais informações, consulte "Gerenciando alertas do varredura secreta."

Leia mais