Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais recentes, acesse a documentação em inglês. Se houver problemas com a tradução desta página, entre em contato conosco.

Configurar a varredura de código para o seu aparelho

Você pode habilitar, configurar e desativar Varredura de código para sua instância do GitHub Enterprise Server. Varredura de código permite aos usuários varrer códigos com relação a erros e vulnerabilidades.

Varredura de código está disponível se você tiver uma licença para Segurança Avançada GitHub. Para obter mais informações, consulte "Sobre Segurança Avançada GitHub".

Neste artigo

Sobre o Varredura de código

Varredura de código é um recurso que você usa para analisar o código em um repositório de GitHub para localizar vulnerabilidades de segurança e erros de codificação. Quaisquer problemas identificados pela análise são exibidos em GitHub Enterprise Server.

A tabela abaixo resume os tipos de análise disponíveis para Varredura de código e fornece links para habilitar o recurso para repositórios individuais.

Tipo de análise Opções para gerar alertas
CodeQL Using GitHub Actions (see "Setting up Varredura de código using actions") or using the Executor do CodeQL in a third-party continuous integration (CI) system (see "Running CodeQL code scanning in your CI system").
Third‑party Usar GitHub Actions (ver "Configurar Varredura de código usando ações") ou gerado externamente e enviado para GitHub Enterprise Server (ver "Fazer o upload de um arquivo SARIF para GitHub").

Para os usuários do sua instância do GitHub Enterprise Server conseguirem habilitar e usar o Varredura de código em seus repositórios, você deve, como administrador do site, habilitar esse recurso para todo o appliance.

Como eu sei se Varredura de código está habilitado para meu appliance

  1. A partir de uma conta administrativa em GitHub Enterprise Server, clique em no canto superior direito de qualquer página.
    Ícone de foguete para acessar as configurações de administrador do site
  2. Na barra lateral esquerda, clique em Console de gerenciamento.
    Console de gerenciamento aba na barra lateral esquerda
  3. Verificar se há uma Segurança Avançada entrada na barra lateral esquerda.
    Barra lateral de segurança avançada

Se você não pode ver Segurança Avançada na barra lateral. Isso significa que sua licença não inclui suporte para funcionalidades de Segurança Avançada, incluindo Varredura de código e varredura secreta. A licença do Segurança Avançada dá a você e aos seus usuários acesso a recursos que ajudam a tornar seus repositórios e códigos mais seguros. Para obter mais informações, consulte "Sobre o GitHub Advanced Security" ou entre em contato com Equipe de Vendas do GitHub.

Habilitar o Varredura de código

Aviso: Alterar essa configuração fará com que GitHub Enterprise Server seja reiniciado. Você deve programar essa mudança com cuidado para minimizar o tempo de inatividade.

  1. A partir de uma conta administrativa em GitHub Enterprise Server, clique em no canto superior direito de qualquer página.
    Ícone de foguete para acessar as configurações de administrador do site
  2. Na barra lateral esquerda, clique em Console de gerenciamento.
    Console de gerenciamento aba na barra lateral esquerda
  3. Na barra lateral esquerda, clique em Segurança Avançada.
    Barra lateral de segurança avançada
  4. Em " Segurança Avançada," clique em Varredura de código.
    Caixa de seleção para habilitar ou desabilitar Varredura de código
  5. Na barra lateral esquerda, clique Save settings (Salvar configurações).
    Botão Save settings (Salvar configurações) no Console de gerenciamento
  6. Aguarde a conclusão da execução de suas configurações.

Executar Varredura de código usando GitHub Actions

Configurar um executor auto-hospedado

GitHub Enterprise Server pode executar Varredura de código usando um fluxo de trabalho de GitHub Actions. Primeiro, você precisa fornecer um ou mais executores auto-hospedados de GitHub Actions em seu ambiente. É possível fornecer executores auto-hospedados no nível da conta do repositório, organização ou empresa. Para obter mais informações, consulte "Sobre executores auto-hospedados" e "Adicionar executores auto-hospedados".

Você deve garantir que o Git esteja na variável do PATH em qualquer executor auto-hospedados que você usar para executar ações de CodeQL.

Provisionar ações

Se você quiser usar ações para executar Varredura de código em GitHub Enterprise Server, as ações deverão estar disponíveis no seu aparelho.

A ação CodeQL está incluída na sua instalação de GitHub Enterprise Server. Se GitHub Enterprise Server tiver acesso à internet, a ação fará automaticamente o download do pacote de CodeQL necessário para realizar a análise. Como alternativa, você pode usar uma ferramenta de sincronização para tornar o pacote de análise de CodeQL disponível localmente. Para obter mais informações, consulte "Configurar CodeQL análise em um servidor sem acesso à internet" abaixo.

Você também pode disponibilizar ações de terceiros para os usuários de Varredura de código, configurando GitHub Connect. Para obter mais informações, consulte "Configurar GitHub Connect para sincronizar GitHub Actions" abaixo.

Configurar a análise de CodeQL em um servidor sem acesso à internet

Se o servidor em que você está executando GitHub Enterprise Server não estiver conectado à internet e você deseja permitir que os usuários habilitem CodeQL Varredura de código para seus repositórios, você deverá usar a ferramenta de sincronização de ação CodeQL para copiar o pacote de análises CodeQL de GitHub.com para seu servidor. A ferramenta e os detalhes de como usá-la estão disponíveis em https://github.com/github/codeql-action-sync-tool.

Se você configurar a ferramenta de sincronização de ação de CodeQL, você poderá usá-la para sincronizar as últimas versões da ação de CodeQL e pacote de análise associado a CodeQL. Estes são compatíveis com GitHub Enterprise Server.

Configurar GitHub Connect para sincronizar GitHub Actions

  1. Se você deseja fazer o download dos fluxos de trabalho de ação sob demanda a partir de GitHub.com, você deverá habilitar o GitHub Connect. Para obter mais informações, consulte "Habilitar GitHub Connect".
  2. Você também precisa habilitar o GitHub Actions para sua instância do GitHub Enterprise Server. Para obter mais informações, consulte "Primeiros passos com GitHub Actions for GitHub Enterprise Server".
  3. A próxima etapa é configurar o acesso a ações no GitHub.com usando GitHub Connect. Para obter mais informações, consulte "Habilitar o acesso automático às ações de GitHub.com usando o GitHub Connect".
  4. Adicione um executor auto-hospedado ao seu repositório, organização ou conta corporativa. Para obter mais informações, consulte "Adicionando executores auto-hospedados".

Habilitar a verificação de código para repositórios individuais

Depois que você configurar um executor auto-hospedado, os usuários poderão habilitar Varredura de código para repositórios individuais em sua instância do GitHub Enterprise Server. Para obter mais informações, consulte "Configurar Varredura de código para um repositório".

Executar Varredura de código usando o Executor do CodeQL

Se você não quiser usar GitHub Actions, você poderá executar Varredura de código usando o Executor do CodeQL.

O Executor do CodeQL é uma ferramenta de linha de comando que você pode adicionar ao seu sistema CI/CD de terceiros. A ferramenta executa a análise do CodeQL em um checkout de um repositório do GitHub. Para obter mais informações, consulte "Executar o Varredura de código no seu sistema de CI".

Desabilitar Varredura de código

Aviso: Alterar essa configuração fará com que GitHub Enterprise Server seja reiniciado. Você deve programar essa mudança com cuidado para minimizar o tempo de inatividade.

  1. A partir de uma conta administrativa em GitHub Enterprise Server, clique em no canto superior direito de qualquer página.
    Ícone de foguete para acessar as configurações de administrador do site
  2. Na barra lateral esquerda, clique em Console de gerenciamento.
    Console de gerenciamento aba na barra lateral esquerda
  3. Na barra lateral esquerda, clique em Segurança Avançada.
    Barra lateral de segurança avançada
  4. Em " Segurança Avançada", desmarque Varredura de código.
    Caixa de seleção para habilitar ou desabilitar Varredura de código
  5. Na barra lateral esquerda, clique Save settings (Salvar configurações).
    Botão Save settings (Salvar configurações) no Console de gerenciamento
  6. Aguarde a conclusão da execução de suas configurações.

Habilitar ou desabilitar Varredura de código através do shell administrativo (SSH)

Você pode habilitar ou desabilitar Varredura de código programaticamente em sua instância do GitHub Enterprise Server. Por exemplo, você pode habilitar Varredura de código com suas ferramentas de código de infraestrutura quando e quando você implantar uma instância para preparação ou recuperação de desastres.

Para mais informações sobre o shell administrativo e os utilitários da linha de comando para GitHub Enterprise Server, consulte "Acessar o shell administrativo (SSH)" e "Utilitários de linha de comando".

  1. SSH em sua instância do GitHub Enterprise Server.
  2. Habilite Varredura de código.
    ghe-config app.minio.enabled true
    ghe-config app.code-scanning.enabled true
  3. Opcionalmente, desabilite Varredura de código.
    ghe-config app.minio.enabled false
    ghe-config app.code-scanning.enabled false
  4. Aplique a configuração.
    ghe-config-apply

Esse documento ajudou você?

Privacy policy

Ajude-nos a tornar esses documentos ótimos!

Todos os documentos do GitHub são de código aberto. Você percebeu que algo que está errado ou não está claro? Envie um pull request.

Faça uma contribuição

Ou, aprenda como contribuir.