Gerenciar alertas da verificação de segredo

Gerenciar alertas de verificação de segredo

Observação: os alertas são criados somente para repositórios com alertas de verificação de segredo para usuários habilitados. Os segredos encontrados em repositórios públicos e pacotes npm públicos que usam o serviço gratuito de alertas de verificação de segredo para parceiros são relatados diretamente ao parceiro, sem a criação de um alerta. Para obter mais informações, confira "Padrões de digitalização de segredo".

No GitHub.com, navegue até a página principal do repositório.
Abaixo do nome do repositório, clique em Segurança. Caso não consiga ver a guia "Segurança", selecione o menu suspenso e clique em Segurança.
Na barra lateral esquerda, em "Alertas de vulnerabilidades", clique em Secret scanning .
Em "Secret scanning" clique no alerta que você deseja exibir.
Opcionalmente, se o segredo vazado for um token do GitHub, você também poderá revisar os metadados do token. Para obter mais informações sobre como revisar metadados de token, confira "Revisando metadados de token do GitHub."
Para ignorar um alerta, selecione o menu suspenso "Fechar como" e clique em um motivo para resolver um alerta.
Opcionalmente, no campo "Comentário", adicione um comentário de ignorar. O comentário de ignorar será adicionado à linha do tempo do alerta e pode ser usado como justificativa em auditorias e relatórios. Você pode exibir o histórico de todos os alertas ignorados e comentários de demissão na linha do tempo do alerta. Você também pode recuperar ou definir um comentário usando a API do Secret scanning. O comentário está contido no campo resolution_comment. Para obter mais informações, confira "Verificação de segredo" na documentação da API REST.
Clique em Fechar alerta.

Revisando metadados de token do GitHub

Observação: os metadados de token do GitHub estão em versão prévia pública no momento e sujeitos a alterações.

Na exibição de um alerta de token ativo do GitHub, você pode examinar determinados metadados sobre o token. Esses metadados podem ajudá-lo a identificar o token e decidir quais etapas de correção devem ser tomadas. Para obter mais informações sobre como exibir alertas individuais, confira "Gerenciando alertas do secret scanning."

Tokens, como personal access token e outras credenciais, são considerados informações pessoais. Para obter mais informações sobre como usar tokens do GitHub, consulte a Política de Privacidade do GitHub e as Políticas de Uso Aceitável.

Captura de tela da interface do usuário de um token do GitHub mostrando os metadados do token.

Os metadados para tokens de GitHub estão disponíveis para tokens ativos em qualquer repositório com a verificação de segredo habilitada. Se um token tiver sido revogado ou seu status não puder ser validado, os metadados não estarão disponíveis. GitHub revoga automaticamente tokens de GitHub em repositórios públicos, portanto, é improvável que os metadados para tokens de GitHub em repositórios públicos estejam disponíveis. Os seguintes metadados estão disponíveis para tokens ativos do GitHub:

Metadados	Descrição
Nome do segredo	O nome dado ao token GitHub por seu criador
Proprietário do segredo	O identificador de GitHub do proprietário do token
Criado em	Data em que o token foi criado
Expirou em	Data em que o token expirou
Usado pela última vez em	Data em que o token foi usado pela última vez
Access	Se o token tem acesso à organização

Protegendo segredos comprometidos

Uma vez que um segredo tenha sido committed a um repositório, você deve considerar o segredo comprometido. O GitHub recomenda as seguintes ações para segredos comprometidos:

Para um GitHub personal access token comprometido, exclua o token comprometido, crie um novo token e atualize qualquer serviço que usa o token antigo. Para obter mais informações, confira "Gerenciar seus tokens de acesso pessoal".
Para todos os outros segredos, primeiro, verifique se o segredo confirmado no GitHub é válido. Nesse caso, crie um segredo, atualize todos os serviços que usam o segredo antigo e, em seguida, exclua o segredo antigo.

Observação: se um segredo for detectado em um repositório público no GitHub.com e o segredo também corresponder a um padrão de parceiros, um alerta será gerado e o segredo potencial será relatado ao provedor de serviços. Para mais detalhes sobre os padrões dos parceiros, confira "Padrões de digitalização de segredo".

Configurar notificações para alertas de verificação de segredo

As notificações são diferentes para verificações incrementais e verificações históricas.

Verificações incrementais

Quando um novo segredo é detectado, o GitHub notifica todos os usuários com acesso aos alertas de segurança do repositório de acordo com as preferências de notificação. Esses usuários incluem:

Administradores do repositório
Gerentes de segurança
Usuários com funções personalizadas com acesso de leitura/gravação
Proprietários da organização e proprietários da empresa, se forem administradores de repositórios onde os segredos foram vazados

Nota: os autores de commit que fizeram commit acidental de segredos serão notificados, independentemente de suas preferências de notificação.

Você receberá uma notificação por email se:

Estiver inspecionando o repositório.
Tiver habilitado as notificações para "Todas as atividades" ou para os "Alertas de segurança" personalizados no repositório.
Tiver selecionado, em suas configurações de notificação, em "Assinaturas" e, em seguida, em "Inspeção", a opção para receber notificações por email.

No GitHub.com, navegue até a página principal do repositório.
Para começar a inspecionar o repositório, selecione Inspecionar.
No menu suspenso, clique em Todas as atividades. Como alternativa, para assinar somente alertas de segurança, clique em Personalizado e, em seguida, em Alertas de segurança.
Acesse as configurações de notificação da sua conta pessoal. Elas estão disponíveis em https://github.com/settings/notifications.
Na página de configurações de notificação, em "Assinaturas" e, em seguida, em "Inspeção", selecione o menu suspenso Notificar-me.
Selecione "Email" como uma opção de notificação e clique em Salvar.

Para obter mais informações sobre como configurar as preferências de configurações, confira "Gerenciando as configurações de segurança e análise do repositório" e "Como definir as configurações de inspeção de um repositório individual."

Verificações históricas

Para verificações históricas, GitHub notifica os seguintes usuários:

Proprietários da organização, proprietários da empresa e gerentes de segurança sempre que uma verificação histórica for concluída, mesmo que nenhum segredo seja encontrado.
Administradores de repositório, gerentes de segurança e usuários com funções personalizadas com acesso de leitura/gravação sempre que uma verificação histórica detecta um segredo e de acordo com suas preferências de notificação.

Não notificamos os autores de commit.