Adicionar uma política de segurança a um repositório

Você pode dar instruções sobre como relatar uma vulnerabilidade de segurança no seu projeto, adicionando uma política de segurança ao seu repositório.

Neste artigo

Sobre políticas de segurança

Para dar às pessoas instruções para relatar vulnerabilidades de segurança em seu projeto, você pode adicionar um arquivo SECURITY.md à raiz, docs ou pasta .github do repositório. Adicionar esse arquivo a esta(s) parte(s) do repositório cria automaticamente uma linha com uma descrição onde as pessoas podem revisá-lo. Quando uma pessoa cria um problema no seu repositório, ela verá um link para a política de segurança do seu projeto.

Você pode criar uma política de segurança padrão para sua organização ou conta pessoal. Para saber mais, confira Como criar um arquivo padrão de integridade da comunidade.

Dica

Para ajudar as pessoas a encontrar sua política de segurança, crie um link para o arquivo SECURITY.md de outros locais no repositório, como o arquivo README. Para saber mais, confira Sobre LEIAMEs.

Depois que alguém relatar uma vulnerabilidade de segurança no seu projeto, use as GitHub Security Advisories para divulgar, corrigir e publicar informações sobre a vulnerabilidade. Para saber mais sobre o processo de relatório e divulgação de vulnerabilidades no GitHub, confira Sobre a divulgação coordenada de vulnerabilidades de segurança. Para saber mais sobre os avisos de segurança do repositório, confira Sobre os avisos de segurança do repositório.

Você também pode ingressar no GitHub Security Lab para procurar tópicos relacionados à segurança e contribuir com ferramentas de segurança e projetos.

Para obter um exemplo de um arquivo SECURITY.md real, consulte https://github.com/electron/electron/blob/main/SECURITY.md.

Adicionar uma política de segurança a um repositório

  1. Em GitHub, acesse a página principal do repositório.

  2. 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.

    Captura de tela de um cabeçalho de repositório que mostra as guias. A guia "Segurança" é realçada por um contorno laranja escuro.

  3. Na barra lateral esquerda, em "Relatórios", clique em Política.

  4. Clique em Iniciar instalação.

  5. No novo arquivo SECURITY.md, adicione informações sobre as versões com suporte do seu projeto e como relatar uma vulnerabilidade.

  6. Clique em Fazer commit das alterações...

  7. No campo "Mensagem do commit", digite uma mensagem curta e relevante que descreva a alteração que você fez no arquivo. Você pode atribuir o commit a mais de um autor na mensagem de commit. Para saber mais, confira Criar um commit com vários autores.

  8. Se você tiver mais de um endereço de email associado à sua conta em GitHub, clique no menu suspenso do endereço de email e selecione o email a ser usado como o endereço de email do autor do Git. Apenas endereços de e-mail verificados aparecem neste menu suspenso. Se você habilitou a privacidade do endereço de email, um email sem resposta será o endereço de email do autor de commit padrão. Para obter mais informações sobre a forma exata que o endereço de email sem resposta pode assumir, confira Configurar o endereço de e-mail do commit.

    Captura de tela de uma solicitação de pull do GitHub que mostra um menu suspenso com opções para escolher o endereço de email do autor do commit. octocat@github.com está selecionado.

  9. Abaixo dos campos de mensagem do commit, opte por adicionar o commit ao branch atual ou a um novo branch. Se seu branch atual for o branch-padrão, você deverá optar por criar um novo branch para seu commit e, em seguida, criar um pull request. Para saber mais, confira Como criar uma solicitação de pull.

    Captura de tela de uma solicitação de pull do GitHub que mostra um botão de opção para fazer commit diretamente na ramificação principal ou para criar um branch. O novo branch está selecionado.

  10. Clique em Fazer commit de alterações ou em Propor alterações.

Leitura adicional