Como habilitar a Segurança Avançada do GitHub para sua empresa

Sobre habilitar GitHub Advanced Security

O GitHub Advanced Security ajuda os desenvolvedores a aprimorar e manter a segurança e a qualidade do código. Para obter mais informações, confira "Sobre a Segurança Avançada do GitHub".

Quando você habilita o GitHub Advanced Security para sua empresa, os administradores de repositório em todas as organizações podem habilitar os recursos, a menos que você configure uma política para restringir o acesso. Para obter mais informações, confira "Como impor políticas para segurança e análise de código na empresa".

Você também pode habilitar ou desabilitar recursos do Advanced Security por meio da API. Para obter mais informações, confira "Pontos de extremidade da API REST para verificação de segredos" na documentação da API REST.

Para obter diretrizes sobre uma implantação em fases do GitHub Advanced Security, confira "Introdução à adoção do GitHub Advanced Security em escala".

Verificando se a sua licença inclui GitHub Advanced Security

1. No canto superior à direita de GitHub Enterprise Server, clique na sua foto do perfil e clique em Configurações da empresa.

   

2. Do lado esquerdo da página, na barra lateral da conta empresarial, clique em Configurações.

3. Em Configurações, clique em Licença .

4. Se sua licença incluir GitHub Advanced Security, a página de licença incluirá uma seção que mostra os detalhes do uso atual.

Pré-requisitos para habilitar GitHub Advanced Security

1. Você pode atualizar sua licença do GitHub Enterprise Server para incluir GitHub Advanced Security. Para obter informações sobre como funciona o licenciamento, consulte "Sobre o faturamento da Segurança Avançada do GitHub".

2. Faça o download do novo arquivo de licença. Para obter mais informações, confira "Fazendo o download da sua licença para o GitHub Enterprise".

3. Envie o novo arquivo de licença para o sua instância do GitHub Enterprise Server. Para obter mais informações, confira "Fazer o upload uma nova licença para o GitHub Enterprise Server".

4. Revise os pré-requisitos para as funcionalidades que você pretende habilitar.

   • Code scanning, confira "Como configurar a verificação de código do seu dispositivo".
   • Secret scanning, consulte "Configurar a varredura de segredo para o seu dispositivo".
   • Dependabot, confira "Habilitando o Dependabot para sua empresa".

Habilitar e desabilitar funcionalidades de GitHub Advanced Security

1. Em uma conta administrativa no GitHub Enterprise Server, no canto superior direito de qualquer página, clique em .

2. Se você ainda não estiver na página "Administração do site", no canto superior esquerdo, clique em Administração do site.

3. Na barra lateral " Administrador do site", clique em Console de Gerenciamento .

4. Na barra lateral "Configurações", clique em Segurança.

5. Em "Segurança", marque os recursos que deseja habilitar e desmarque os que deseja desabilitar.

6. Na barra lateral "Configurações", clique em Salvar configurações.

   Observação: se você salvar as configurações no Console de Gerenciamento, isso reiniciará os serviços do sistema, o que poderá resultar em tempo de inatividade visível pelo usuário.

7. Aguarde a conclusão da execução de suas configurações.

Quando GitHub Enterprise Server terminar de reiniciar, você estará pronto para definir todas as funcionalidades adicionais necessárias para recursos recém-habilitados. Para obter mais informações, confira "Como configurar a verificação de código do seu dispositivo".

Habilitar ou desabilitar as funcionalidades de GitHub Advanced Security por meio do shell administrativo (SSH)

É possível habilitar ou desabilitar recursos programaticamente no sua instância do GitHub Enterprise Server. Para saber mais sobre o shell administrativo e os utilitários de linha de comando do GitHub Enterprise Server, confira "Acesar o shell administrativo (SSH)" e "Utilitários de linha de comando".

Por exemplo, você pode habilitar qualquer recurso de GitHub Advanced Security com as suas ferramentas de código de infraestrutura ao implantar uma instância para preparação ou recuperação de desastres.

1. Conecte-se via SSH ao sua instância do GitHub Enterprise Server. Se sua instância for composta por vários nós, por exemplo, se a alta disponibilidade ou a replicação geográfica estiver configurada, efetue SSH no nó primário. Se você usar um cluster, poderá efetuar SSH em qualquer nó. Substitua HOSTNAME pelo nome do host da instância ou pelo nome do host ou endereço IP de um nó. Para obter mais informações, confira "Acesar o shell administrativo (SSH)".

   Shell

   ssh -p 122 admin@HOSTNAME
   

2. Habilitar funcionalidades para GitHub Advanced Security.

   • Para habilitar o Code scanning, digite os comandos a seguir.

     Shell

     ghe-config app.minio.enabled true
     ghe-config app.code-scanning.enabled true
     

   • Para habilitar secret scanning, digite o comando a seguir.

     Shell

     ghe-config app.secret-scanning.enabled true
     

   • Para habilitar o grafo de dependência, digite o seguinte comando.

     Shell

     ghe-config app.dependency-graph.enabled true
     

3. Você tem a opção de habilitar funcionalidades para GitHub Advanced Security.

   • Para desabilitar code scanning, digite os comandos a seguir.

     Shell

     ghe-config app.code-scanning.enabled false
     

     • Opcionalmente, se você desabilitar code scanning, também poderá desabilitar o serviço MinIO interno para GitHub Advanced Security. Se Dependabot updates estiverem habilitados para a instância e você desejar desabilitar esse serviço, também deverá desabilitar Dependabot updates. A desabilitação do serviço não afeta o armazenamento do MinIO para GitHub Actions ou GitHub Packages. Para obter mais informações sobre as Dependabot updates, confira "Habilitando o Dependabot para sua empresa".

       • Para desabilitar Dependabot updates, digite o comando a seguir.

         Shell

         ghe-config app.dependabot.enabled false
         

       • Para desabilitar o MinIO, digite o comando a seguir.

         Shell

         ghe-config app.minio.enabled false
         

   • Para desabilitar secret scanning, digite o seguinte comando.

     Shell

     ghe-config app.secret-scanning.enabled false
     

   • Para desabilitar o grafo de dependência, digite o seguinte comando.

     ghe-config app.dependency-graph.enabled false
     

4. Para aplicar a configuração, execute o comando a seguir.

   Observação: durante uma execução de configuração, os serviços do sua instância do GitHub Enterprise Server podem ser reiniciados, o que pode causar um breve tempo de inatividade para os usuários.

   Shell

   ghe-config-apply
   

5. Aguarde a conclusão da execução de suas configurações.