Sobre as ferramentas de segurança para auditores
GitHub fornece ferramentas para auditores de segurança e desenvolvedores revisarem e analisarem respostas a alertas de segurança em uma empresa ou organização. Este guia descreve as ferramentas, que incluem linhas do tempo históricas, visão geral de segurança, logs de auditoria, API e webhooks.
Os auditores de segurança podem usar essas ferramentas para garantir que as ações apropriadas estejam sendo tomadas para resolver alertas de segurança e identificar áreas para treinamento adicional. Os desenvolvedores podem usar essas ferramentas para monitorar e depurar seus próprios alertas de segurança. Você só verá dados para repositórios e organizações às quais você já tem acesso.
Linhas do tempo do alerta de segurança
Cada alerta de segurança tem uma linha do tempo histórica que mostra quando o alerta foi criado ou quando um problema foi detectado. Quando o status de um alerta é alterado, isso é registrado na linha do tempo, independentemente do que causou a alteração, por exemplo, Dependabot fechar um alerta fixo e um desenvolvedor reabrir um alerta. Você pode ver a linha do tempo histórica de um alerta na página de alerta na descrição do problema.
Muitos dos eventos na linha do tempo também criam um evento no log de auditoria, que você pode consultar usando a interface do usuário do log de auditoria ou a API. Para obter mais informações, veja Registo de auditoria.
Página de visão geral da segurança
A visão geral da segurança consolida informações sobre alertas de segurança e fornece resumos de alto nível do status de segurança da sua empresa ou organização.
Na visão geral de segurança, você pode ver repositórios com alertas de segurança abertos, bem como quais repositórios habilitaram recursos de segurança específicos. Você também pode usar a visão geral de segurança para filtrar e classificar alertas de segurança usando exibições interativas.
Para obter mais informações, consulte Visão geral da segurança.
Log de auditoria
Você pode acessar e pesquisar logs de auditoria usando a API ou a interface do usuário do log de auditoria. O log de auditoria lista eventos que são disparados por atividades que afetam sua empresa ou organização, incluindo eventos que são criados quando há determinadas interações com um alerta de segurança. As interações que criam um evento podem ser disparadas manualmente ou pela automação, por exemplo, quando Dependabot cria um alerta.
- Secret scanning os eventos registram quando um alerta é criado, resolvido ou reaberto, bem como quando a proteção por push é contornada.
- Dependabot os eventos acompanham quando um alerta é criado, descartado ou resolvido.
- Code scanning não cria eventos de linha do tempo em um log de auditoria.
Para obter uma lista de eventos do log de auditoria, consulte Auditar eventos de log para sua empresa e Eventos de registro de auditoria para a sua organização.
Para obter informações sobre como acessar o registro de auditoria da sua empresa ou organização, consulte Como acessar o log de auditoria da sua empresa e Revisar o log de auditoria da organização.
Webhooks
Você poderá configurar webhooks code_scanning_alert, dependabot_alert e secret_scanning_alert para receber cargas sempre que houver uma resposta a um alerta de segurança em uma organização ou repositório. Você também pode definir a quais respostas reagir; por exemplo, talvez você queira definir um webhook que rastreia alertas secret scanning criados quando alguém contorna a proteção por push usando a propriedade de alerta "push_protection_bypassed": true.
Você também pode integrar o conteúdo de webhook em outras ferramentas usadas para monitorar e informar comportamentos de segurança. Por exemplo, um webhook é acionado quando um alerta secreto é criado, resolvido, revogado, reaberto ou quando o status de validade de um segredo é alterado. É possível analisar o conteúdo do webhook e integrá-lo a qualquer ferramenta usada por você e sua equipe, como o Slack, Microsoft Teams, Splunk ou email. Para obter mais informações, consulte Sobre webhooks e Eventos e payloads de webhook.
API
Você pode usar a API para listar e interagir com alertas de segurança, por exemplo, obtendo as informações mais recentes sobre um alerta atualizado ou ignorado. Você também pode usar a API para fazer outras atualizações no alerta ou automatizar ações de acompanhamento, como a criação de um novo problema para cada alerta que precisa de mais ações. Somente o status atual de um alerta é relatado pela API.
Dependabot API de alertas
Você pode listar todos os Dependabot alertas de um repositório, organização ou empresa ou usar parâmetros de caminho para listar apenas alertas que atendam a um conjunto específico de critérios. Por exemplo, talvez você queira listar Dependabot apenas os alertas para o Maven que foram ignorados. Como alternativa, você pode obter detalhes completos para um alerta ou atualizar o alerta.
Para obter mais informações, consulte Pontos de extremidade da API REST para o Dependabot alerts.
Secret scanning API de alertas
Você pode listar todos os secret scanning alertas de um repositório, organização ou empresa ou usar parâmetros de caminho para listar apenas alertas que atendam a um conjunto específico de critérios. Como alternativa, você pode obter detalhes completos para um alerta ou atualizar o alerta.
Para ver quais alertas secret scanning resultaram de um desvio da proteção por push, filtre os resultados por "push_protection_bypassed": true.
Para obter mais informações, consulte Pontos de extremidade da API REST para verificação de segredos.
Code scanning API de alertas
Você pode listar todos os code scanning alertas de um repositório, organização ou empresa ou usar parâmetros de caminho para listar apenas alertas que atendam a um conjunto específico de critérios. Como alternativa, você pode obter detalhes completos para um alerta ou atualizar o alerta.
Para obter mais informações, consulte Pontos de extremidade da API REST para varredura de código.