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 your GitHub Enterprise Server instance. 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 de Segurança Avançada.

Neste artigo

Nota: Varredura de código está atualmente em versão beta e sujeito a alterações. Para obter mais informações sobre a participação no beta, inscreva-se aqui.

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. Todos os 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 Usar GitHub Actions (consulte "Habilitar Varredura de código usando ações") ou usar o Executor do CodeQL em um sistema contínuo de integração contínua (CI) de terceiros (consulte "Varrendo o código em execução no seu sistema de CI").
Third‑party Usar GitHub Actions (consulte "Habilitar Varredura de código usando ações") ou geradas externamente e subidas em GitHub Enterprise Server (consulte "Fazer upload de um arquivo SARIF em GitHub").

Para os usuários do your GitHub Enterprise Server instance 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 puder ver Segurança Avançada na barra lateral, isso significa que sua licença não inclui suporte para recursos do Segurança Avançada, incluindo Varredura de código. 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.

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

Se você estiver inscrito no beta de GitHub Actions, GitHub Enterprise Server poderá 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 ação

Para executar Varredura de código em GitHub Enterprise Server com GitHub Actions, a ação apropriada deve estar disponível localmente. Você pode disponibilizar a ação de três maneiras.

  • Recomendado Você pode usar GitHub Connect para fazer o download automático das ações no GitHub.com. A máquina que hospeda sua instância deve conseguir acessar GitHub.com. Esta abordagem garante que você irá obter o software mais recente automaticamente. Para obter mais informações, consulte "Configurar o GitHub Connect para sincronizar com GitHub Actions".
  • Se você desejar usar o Fluxo de trabalho de análise do CodeQL, você pode sincronizar o repositório do GitHub.com ao GitHub Enterprise Server, usando a ferramenta de sincronização de Ação do CodeQL disponível em https://github. om/github/codeql-action-sync-tool. Você pode usar essa ferramenta independentemente se your GitHub Enterprise Server instance ou seus executores de GitHub Actions terem acesso à internet, contanto que você possa acessar your GitHub Enterprise Server instance e GitHub.com simultaneamente no seu computador.
  • Você pode criar uma cópia local do repositório da ação no seu servidor, clonando o repositório de GitHub.com com a ação. Por exemplo, se você desejar usar a ação CodeQL, você poderá criar um repositório na sua instância denominada github/codeql-action e, em seguida, clonar o repositório a partir do GitHub.com e, posteriormente, fazer push desse repositório no repositório da sua instância github/codeql-action. Você também deverá fazer o download de qualquer uma das versões do repositório no GitHub.com e fazer o upload no repositório github/codeql-action de sua instância como versões.
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 your GitHub Enterprise Server instance. Para obter mais informações, consulte "Habilitar GitHub Actions e configurar o armazenamento".
  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".

Depois de configurar um executor auto-hospedado, os usuários podem habilitar o Varredura de código para repositórios individuais em your GitHub Enterprise Server instance. Para obter mais informações, consulte "Habilitando Varredura de código.

Executar Varredura de código usando o Executor do CodeQL

Se sua organização não está participando da versão beta do GitHub Actions ou se você não desejar 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.

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.