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 muda, ele é registrado na linha do tempo, independentemente do que causou a alteração, por exemplo, Dependabot fechando um alerta fixo e um desenvolvedor reabrindo 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, confira Log 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 da 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 saber mais, confira Sobre a visão geral de 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.
- Os eventos do Secret scanning acompanham quando um alerta é criado, resolvido ou reaberto, também quando a proteção por push é ignorada.
- Os eventos do Dependabot acompanham quando um alerta é criado, ignorado ou resolvido.
- A 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, confira Auditar eventos de log para sua empresa e Eventos de log de auditoria para sua organização.
Para obter informações sobre como acessar o log 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.
Você também pode transmitir dados de auditoria do GitHub para um sistema de gerenciamento de dados externo, o que permite analisar e coletar dados para gráficos internos. Os proprietários corporativos podem configurar a transmissão de logs de auditoria. Para obter mais informações, confira Streaming do log de auditoria para sua empresa.
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 em quais respostas agir, por exemplo, é possível definir um webhook que rastreia alertas do secret scanning criados quando alguém ignora 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 saber mais, confira Sobre webhooks e Conteúdo e eventos do 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.
API de alertas do Dependabot
Você pode listar todos os alertas do Dependabot para um repositório, uma organização ou uma 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 apenas os alertas do Dependabot 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, confira Alertas do Dependabot.
API de alertas do Secret scanning
Você pode listar todos os alertas do secret scanning para um repositório, uma organização ou uma 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 do secret scanning foram resultado de um bypass de proteção por push, filtre os resultados para "push_protection_bypassed": true.
Para obter mais informações, confira Secret scanning.
API de alertas da Code scanning
Você pode listar todos os alertas do code scanning para um repositório, uma organização ou uma 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, confira Code scanning.