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 is available if you have a license for Segurança Avançada GitHub.

Neste artigo

Observação: Varredura de código está em beta em GitHub Enterprise Server 2.22. Para a versão geralmente disponível do varredura de código, atualize para a versão mais recente de GitHub Enterprise Server.

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 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 code scanning in your CI system").
Third‑party Using GitHub Actions (see "Setting up Varredura de código using actions") or generated externally and uploaded to GitHub Enterprise Server (see "Uploading a SARIF file to 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 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.

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

Para executar Varredura de código em GitHub Enterprise Server com GitHub Actions, as ações apropriadas devem estar disponíveis localmente. Você pode disponibilizar as ações 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.
  • É possível criar uma cópia local do repositório de uma ação no servidor, clonando o repositório de GitHub.com que contém a ação. Por exemplo, se você quiser usar as ações para CodeQL Varredura de código, você poderá criar um repositório na sua instância denominado github/codeql-action. Em seguida, clone o repositório de GitHub.com depois faça push desse repositório no repositório github/codeql-action da instância. 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 "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, e provisionar as ações, os usuários poderão habilitar Varredura de código para repositórios individuais em your GitHub Enterprise Server instance. For more information, see "Setting up Varredura de código for a repository."

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.

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.