Definindo padrões personalizados para varredura de segredo

Você pode definir padrões personalizados para varredura secreta em organizações e repositórios privados.

Varredura secreta está disponível para todos os repositórios públicos e para repositórios privados pertencentes a organizações em que Segurança Avançada GitHub está habilitado. Para obter mais informações, consulte "Sobre Segurança Avançada GitHub".

Sobre padrões personalizados para varredura secreta

GitHub executa varredura secreta nos repositórios públicos e privados para padrões de segredo fornecidos por parceiros de GitHub e GitHub. Para obter mais informações sobre o programa de parceria de varredura secreta, consulte "Programa de varredura de segredo de parceiros".

No entanto, pode haver situações em que você deverá pesquisar outros padrões secretos nos seus repositórios privados. Por exemplo, você pode ter um padrão de segredo que é interno da sua organização. Para esses casos, você pode definir padrões personalizados de varredura secreta na sua empresa, organização ou repositório privado em GitHub. É possível definir até 100 padrões personalizados para cada conta da organização ou empresa e até 20 padrões personalizados por repositório privado.

Sintaxe de expressão regular para padrões personalizados

Os padrões personalizados para varredura secreta são especificados como expressões regulares. Varredura secreta usa a biblioteca Hyperscan e é compatível apenas os construtores regex do Hyperscan, que são um subconjunto da sintaxe PCRE. Os modificadores de opções de huperscan não são compatíveis. Para obter mais informações sobre construções de padrões do Hyperscan, consulte "suporte do padrãona documentação do Hyperscan.

Definindo um padrão personalizado para um repositório

Antes de definir um padrão personalizado, você deve garantir que varredura secreta está habilitado no seu repositório. Para obter mais informações, consulte "Configurar varredura secreta para os seus repositórios".

  1. No GitHub, 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. Na barra lateral esquerda, clique em Security & analysis (Segurança e análise). aba de "Segurança & análise" nas configurações do repositório

  4. Em "Configurar recursos de segurança e análise", encontre "Segurança Avançada GitHub".

  5. Under "Varredura secreta", under "Custom patterns", click New pattern.

  6. Insira as informações para o seu novo padrão personalizado:

    1. Você deve fornecer, pelo menos, o nome para o seu padrão e uma expressão regular para o formato do seu padrão de segredo.
    2. Você pode clicar em Mais opções para fornecer outros conteúdos adjacentes ou requisitos adicionais de correspondência para o formato do segredo.
    3. Provide a sample test string to make sure your configuration is matching the patterns you expect.

    Crie um formulário de padrão personalizado de varredura secreta

  7. When you are satisfied with your new custom pattern, click Create pattern.

Após a criação do seu padrão, varredura secreta verifica todos segredos em todo o histórico do Git em todos os branches presentes no repositório GitHub. Para mais informações sobre visualização de alertas varredura secreta, consulte "Gerenciando alertas de varredura secreta".

Definindo um padrão personalizado para uma organização

Antes de definir um padrão personalizado, você deverá habilitar varredura secreta para os repositórios privaivados que você deseja fazer a varredura na organização. Para habilitar varredura secreta em todos os repositórios privados na sua organização, consulte "Gerenciar as configurações de segurança e análise da sua organização".

Observação: Como não há nenhuma funcionalidade de teste, recomendamos que você teste seus padrões personalizados em um repositório antes de defini-los para toda a organização. Dessa forma, você pode evitar criar alertas falsos-positivos de varredura secreta.

  1. No canto superior direito do GitHub, clique na sua foto de perfil e, em seguida, clique em Suas organizações. Suas organizações no menu de perfil

  2. Ao lado da organização, clique em Configurações. Botão de configurações

  3. Na barra lateral esquerda, clique em Security & analysis (Segurança e análise). "Security & analysis" (Segurança e análise) aba nas configurações da organização

  4. Em "Configurar recursos de segurança e análise", encontre "Segurança Avançada GitHub".

  5. Under "Varredura secreta", under "Custom patterns", click New pattern.

  6. Insira as informações para o seu novo padrão personalizado:

    1. Você deve fornecer, pelo menos, o nome para o seu padrão e uma expressão regular para o formato do seu padrão de segredo.
    2. Você pode clicar em Mais opções para fornecer outros conteúdos adjacentes ou requisitos adicionais de correspondência para o formato do segredo.
    3. Provide a sample test string to make sure your configuration is matching the patterns you expect.

    Crie um formulário de padrão personalizado de varredura secreta

  7. When you are satisfied with your new custom pattern, click Create pattern.

Depois que o padrão for criado, varredura secreta irá verificar todos os segredos nos repositórios privados na sua organização, incluindo todo seu histórico do Git em todos os branches. Os proprietários da organização e administradores do repositório receberão um alerta sobre todos os segredos encontrados e poderão revisar o alerta no repositório onde o segredo for encontrado. Para obter mais informações sobre a visualização de alertas de varredura secreta, consulte "Gerenciar alertas de varredura secreta".

Definir um padrão personalizado para uma conta corporativa

Antes de definir um padrão personalizado, você deverá garantir que você habilite a digitalização de segredo para a sua conta corporativa. Para obter mais informações, consulte "Habilitar Segurança Avançada GitHub para a sua empresa."

Observação: Como não há nenhuma funcionalidade de teste, recomendamos que você teste seus padrões personalizados em um repositório antes de defini-los para toda sua empresa. Dessa forma, você pode evitar criar alertas falsos-positivos de varredura secreta.

  1. No canto superior direito de GitHub, clique na sua foto de perfil e, em seguida, clique em Suas empresas. "Suas empresas" no menu suspenso para a foto do perfil em GitHub

  2. Na lista de empresas, clique na empresa que você deseja visualizar. Nome de uma empresa na lista das suas empresas

  3. Na barra lateral da conta corporativa, clique em Policies. Aba de políticas na barra lateral da conta corporativa

  4. Em Políticas, clique em "Segurança Avançada". Políticas de "Segurança avançada" na barra lateral

  5. Under "GitHub Advanced Security", click the Security features tab.

  6. Em "Padrões personalizados de digitalização de segredos", clique em Novo padrão.

  7. Insira as informações para o seu novo padrão personalizado:

    1. Você deve fornecer, pelo menos, o nome para o seu padrão e uma expressão regular para o formato do seu padrão de segredo.
    2. Você pode clicar em Mais opções para fornecer outros conteúdos adjacentes ou requisitos adicionais de correspondência para o formato do segredo.
    3. Provide a sample test string to make sure your configuration is matching the patterns you expect.

    Crie um formulário de padrão personalizado de varredura secreta

  8. When you are satisfied with your new custom pattern, click Create pattern.

Depois que seu padrão for criado, varredura secreta irá verificar se há segredos em repositórios privados dentro das organizações da sua empresa com Segurança Avançada GitHub habilitado, incluindo toda a sua história de Git em todos os branches. Os proprietários da organização e administradores do repositório receberão um alerta sobre todos os segredos encontrados e poderão revisar o alerta no repositório onde o segredo for encontrado. Para obter mais informações sobre a visualização de alertas de varredura secreta, consulte "Gerenciar alertas de varredura secreta".

Editando um padrão personalizado

Ao salvar uma alteração em um padrão personalizado, isso irá fechar todos os alertas de varredura secreta que foram criados usando a versão anterior do padrão.

  1. Acesse o local onde o padrão personalizado foi criado. Um padrão personalizado pode ser criado na conta de um repositório, organização ou empresa.
  2. Em "Varredura secreta", à direita do padrão personalizado que você deseja editar, clique em .
  3. Ao revisar e testar suas alterações, clique em Salvar alterações.

Removendo um padrão personalizado

  1. Acesse o local onde o padrão personalizado foi criado. Um padrão personalizado pode ser criado na conta de um repositório, organização ou empresa.

  2. À direita do padrão personalizado que você deseja remover, clique em .

  3. Revise a confirmação e selecione um método para lidar com todos os alertas abertos relacionados ao padrão personalizado.

  4. Clique em Sim, excluir este padrão.

    Confirmando a exclusão de um padrão varredura secreta personalizado

Esse documento ajudou você?

Política de Privacidade

Ajude-nos a tornar esses documentos ótimos!

Todos os documentos do GitHub são de código aberto. Você percebeu que algo que está errado ou não está claro? Envie um pull request.

Faça uma contribuição

Ou, aprenda como contribuir.