Habilitando GitHub Advanced Securityprodutos para sua empresa

Sobre como habilitar GitHub Advanced Security produtos

Os recursos do GitHub Advanced Security ajudam os desenvolvedores a aprimorar e manter a segurança e a qualidade do código. Para saber mais, confira Sobre GitHub Segurança Avançada.

Quando você habilita 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. 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 GitHub Secret Protection or GitHub Code Security por meio da API. Para saber mais, 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, GitHub Advanced Securityconsulte Introdução à adoção GitHub Advanced Security em escala.

Verificando se sua licença inclui Advanced Security

1. No canto superior à direita do GitHub Enterprise Server, clique na sua imagem do perfil e clique em Configurações da empresa.
2. Na parte superior da página, clique em Settings.
3. Em Configurações, clique em Licença.
4. Se sua licença incluir GitHub Secret Protection, GitHub Code Security, or GitHub Advanced Security, a página de licença inclui uma seção mostrando detalhes do uso atual.

Pré-requisitos para habilitar Secret Protection and Code Security

1. Atualize sua GitHub Enterprise licença para incluir Secret Protection and Code Security. Para obter informações sobre como funciona o licenciamento, consulte GitHub Advanced Security cobrança de licença.

2. Faça o download do novo arquivo de licença. Confira Baixando sua licença para GitHub Enterprise.

3. Carregue o novo arquivo de licença para GitHub Enterprise Server. Confira Carregando uma nova licença no GitHub Enterprise Server.

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

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

Habilitar e desabilitar Advanced Security recursos

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 " Site admin", 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 configurar os recursos adicionais necessários para funcionalidades recém-habilitadas. Confira Configurando a verificação de código para seu dispositivo.

Habilitar ou desabilitar Advanced Security recursos por meio do SSH (shell administrativo)

Você pode habilitar ou desabilitar recursos programaticamente.GitHub Enterprise Server Para obter mais informações sobre o shell administrativo e os utilitários de linha de comando para GitHub Enterprise Server, consulte Acessar o shell administrativo (SSH) e Utilitários de linha de comando.

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

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 saber mais, confira Acessar o shell administrativo (SSH).

   Shell

   ssh -p 122 admin@HOSTNAME
   

2. Habilitar recursos para Advanced Security.

   • Para habilitar code scanning, insira os comandos a seguir.

     Shell

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

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

     Shell

     ghe-config app.secret-scanning.enabled true
     

   • Opcionalmente, para habilitar verificações de validade para secret scanning:

     • Insira o seguinte comando:

       Shell

       ghe-config app.secret-scanning.validity-checks-available-on-instance true`
       

     • Para verificar se a conexão de saída é possível, use:

       Shell

       /usr/local/share/enterprise/ghe-secret-scanning-validity-checks-connection-test
       

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

     Shell

     ghe-config app.dependency-graph.enabled true
     

3. Opcionalmente, desabilite os recursos para Advanced Security.

   • Para desabilitar code scanning, insira 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 Advanced Security. Se Dependabot updates estiver habilitado para a instância e você quiser desabilitar esse serviço, também deverá desabilitar Dependabot updates. Desabilitar o serviço não afeta o armazenamento do MinIO para GitHub Actions ou GitHub Packages. Para obter mais informações sobre Dependabot updates, confira Habilitando o Dependabot para sua empresa.

       • Para desabilitar Dependabot updates, insira 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, insira o comando a seguir.

     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.