Criando credenciais do OAuth 2,0 para GitHub JWT para Integrações de vulnerabilidade de aplicação do GitHub

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 10 min. de leitura
  • Execute as etapas a seguir para integrar seu GitHub Aplicativos que usam o token do portador JWT para Integrações de vulnerabilidade de aplicação do GitHub.

    Funções necessárias:
    • sn_vul.app_sec_manager e admin para registros em seu ServiceNow AI Platform.
    • Nenhuma função de instância necessária para tarefas em seu GitHub conta.
    • Para obter mais informações sobre o contexto das etapas desta configuração, consulte Protocolo OAuth 2,0 .

    Crie e configure o. GitHub aplicação para Integrações de vulnerabilidade de aplicação do GitHub

    Criar um personalizado GitHub Aplicativo do seu GitHub Conta para ativar a autenticação OAuth 2,0 com seu Integrações de vulnerabilidade de aplicação do GitHub em sua instância.

    Antes de Iniciar

    Função necessária: Nenhuma função de instância necessária

    Por Que e Quando Desempenhar Esta Tarefa

    Conclua estas etapas no seu GitHub conta. Confira Construção GitHub Apps em GitHub Site do desenvolvedor para obter instruções sobre como criar e configurar aplicações personalizadas.

    Procedimento

    1. Do seu GitHub, crie sua GitHub Navegando até Configurações do desenvolvedor > GitHub Apps.
    2. Em URL da página inicial campo, insira https://<instance-name>.service-now.com .
    3. Em URL de retorno de chamada de autorização do usuário campo, insira https://<instance-name>.service-now.com/oauth_redirect.do .
    4. Em Identificar e autorizar usuários desmarque Tokens de autorização do usuário expirados campo.
    5. Em Webhook , selecione Ativo campo.
    6. Em URL do webhook campo, insira https://instance-name>.service-now.com/ .
    7. Deixe os campos restantes em branco (padrão).
    8. Em Permissões do repositório defina as seguintes configurações.
      Verificação de código Somente leitura
      Conteúdos Somente leitura
      Propriedades personalizadas Somente leitura
      Alertas dependentes Somente leitura
      Metadados Somente leitura
      Nota:
      Se você já estiver usando um aplicativo GitHub e atualizar qualquer uma das permissões, revise e aceite essas permissões para o seu aplicativo GitHub Você pode navegar até seu app e selecionar Revisar solicitação > Aceitar novas permissões .
    9. Deixe as permissões restantes como Sem acesso (padrão).
    10. Em Assinar eventos , selecione Regra de proteção de implantação opção.
    11. Clique com o botão direito do mouse no cabeçalho para salvar as mudanças.
    12. Instale o recém-criado GitHub Nas contas de sua escolha.
      1. Na página de configurações do GitHub Apps, selecione seu app.
      2. Na barra lateral esquerda, selecione Instale o app .
      3. Selecione Instalar ao lado da organização ou da conta pessoal que contém o repositório correto.
      4. Instale o app em todos os repositórios ou selecione repositórios.
        Para obter mais informações, consulte Instalando aplicações do GitHub .
    13. Após a instalação, selecione as configurações (ícone de engrenagem) da sua aplicação e anote ou anote as seguintes informações.

      Esses detalhes são necessários quando você cria o registro da aplicação em seu ServiceNow AI Platform instância.

      • ID de app
      • ID de cliente
      • Segredo do cliente.
      • Anote o token no URL. Este é o ID do token que você insere no URL do token em sua instância.
    14. Role a página para baixo, gere uma nova chave privada e salve-a em sua máquina.

    Gere o certificado JKS para Integrações de vulnerabilidade de aplicação do GitHub

    Gere um certificado JKS para a autenticação JWT para Integrações de vulnerabilidade de aplicação do GitHub.

    Antes de Iniciar

    Anote a senha que você usa para gerar o arquivo .jks (senha do armazenamento de chaves).

    Função necessária: sn_vul.app_sec_manager

    Procedimento

    1. Crie um certificado assinado por CA usando GitHub Chave privada da aplicação:
      openssl req -new -x509 -key <file-name>.pem -out <certificate-name>.pem -days 1095
    2. Insira os detalhes necessários.
    3. Crie o arquivo PKCS 12 usando GitHub Chave privada da aplicação e certificado assinado por CA:
      openssl pkcs12 -export -in <certificate-name>.pem -inkey <file-name>.pem -certfile <certificate-name>.pem -out <PKCS-12-file-name>.p12 
    4. Forneça a senha de exportação.
    5. Crie o arquivo JKS:
      keytool -importkeystore -srckeystore <PKCS-12-file-name>.p12 -srcstoretype pkcs12 -destkeystore <JKS-certificate-filename>.jks -deststoretype JKS
    6. Forneça as senhas do armazenamento de chaves de destino e de origem.

    Anexe o. GitHub Java Key Store para sua instância para Integrações de vulnerabilidade de aplicação do GitHub

    Ative a autenticação de token de concessão do portador JWT anexando o certificado do GitHub Java KeyStore (JKS) válido à sua instância.

    Antes de Iniciar

    Um certificado Java KeyStore válido.

    Função necessária: sn_vul.app_sec_manager

    Procedimento

    1. Navegar até Tudo > Definição do Sistema > Certificados.
    2. Selecione Novo.
    3. No formulário, preencha os campos.
      Tabela 1. Campos do formulário da certificação X.509
      Campo Descrição
      Nome Nome para identificar exclusivamente o registro. Por exemplo, Meu certificado de app GitHub para AVR .
      Notificar no vencimento Opção para especificar os usuários a serem notificados quando o certificado expirar.
      Aviso emitido antes do vencimento (em dias) Número de dias para enviar uma notificação antes que o certificado expire.
      Ativo Opção para habilitar o certificado.
      Tipo Opção para selecionar o tipo de certificado. Selecione Armazenamento de chaves Java.
      Dias até o vencimento Número de dias até o certificado expirar.
      Senha do armazenamento de chaves Senha associada ao certificado (dica: A senha do armazenamento de chaves de destino criada anteriormente).
      Descrição resumida Resumo sobre o certificado.
    4. Selecione o ícone Anexos e anexe um certificado JKS.
    5. Selecione Validar armazenamentos/certificados .
      Uma mensagem key_store válida é exibida para arquivos de certificado válidos.

    Crie uma chave de assinatura JWT para GitHub Certificado JKS para Integrações de vulnerabilidade de aplicação do GitHub

    Crie uma chave de assinatura JSON Web Token (JWT) para atribuir ao seu GitHub Java KeyStore certificado.

    Antes de Iniciar

    Funções necessárias:
    • administrador
    • sn_vul.app_sec_manager

    Procedimento

    1. Navegar até Tudo > OAuth de Sistema > Chaves de JWT.
    2. Selecione Novo.
    3. No formulário, preencha os campos.
      Tabela 2. Campos do formulário de chaves de JWT
      Campo Descrição
      Nome Nome para identificar exclusivamente a chave de assinatura JWT. Por exemplo, Minha chave JWT da aplicação GitHub para AVR .
      Armazenamento de chaves de assinatura Selecione o certificado JKS válido anexado na tarefa anterior.
      ID de chave Deixe esse campo em branco.
      Algoritmo de assinatura Deixe este valor como RSA 256.
      Senha da chave de assinatura Senha associada à chave de assinatura. Esta é a senha que você usou para gerar o arquivo JKS.
      Ativo Opção para habilitar a chave.
    4. Clique com o botão direito do mouse em qualquer lugar no cabeçalho cinza da página e selecione Salvar .

    Crie um provedor JWT para seu GitHub chave de assinatura do Integrações de vulnerabilidade de aplicação do GitHub

    Adicione um provedor JSON Web Token (JWT) ao seu ServiceNow instância para GitHub.

    Antes de Iniciar

    Funções necessárias:
    • administrador
    • sn_vul.app_sec_manager

    Procedimento

    1. Navegar até Tudo > OAuth de Sistema > Provedores JWT.
    2. Selecione Novo.
    3. No formulário, preencha os campos.
      Tabela 3. Campos de formulário do Provedor JWT
      Campo Descrição
      Nome Nome para identificar o provedor JWT de forma única. Por exemplo, Provedor JWT da aplicação GitHub para AVR .
      Intervalo de Vencimento (s) Número em segundos para definir a vida útil dos tokens do provedor JWT. Você pode deixar essa configuração no padrão.
      Configuração de Assinatura Selecione a chave JWT que você criou nas etapas anteriores.
    4. Clique com o botão direito no cabeçalho do formulário e selecione “Salvar”.
    5. Insira seu GitHub Aplicação ID da aplicação para o valor de iss Declaração, na lista relacionada Declarações padrão.
      Este é o ID da aplicação do GitHub Em seu GitHub console que você criou nas etapas anteriores.
    6. Sair aud e. sub valores em branco (padrão).
    7. Clique com o botão direito no cabeçalho do formulário e selecione “Salvar”.

    Registre-se GitHub Como um provedor OAuth (JWT) para Integrações de vulnerabilidade de aplicação do GitHub

    Use as informações geradas durante GitHub Configuração da conta da aplicação a ser registrada GitHub Como um provedor OAuth e permitir que a instância solicite tokens OAuth 2,0.

    Antes de Iniciar

    Funções necessárias:
    • administrador
    • sn_vul.app_sec_manager

    Procedimento

    1. Navegar até Tudo > OAuth de Sistema > Registro de aplicações.
    2. Selecione Novo.
      . Que tipo de aplicação OAuth? a mensagem é exibida.
    3. Selecione Conecte-se a um provedor OAuth de terceiros .
    4. No formulário, preencha os campos.
      Tabela 4. Campos do formulário Registro de aplicações
      Campo Descrição
      Nome Nome para identificar exclusivamente o registro. Por exemplo, insira Meu provedor de aplicações GitHub para AVR .
      ID de cliente ID do cliente do seu GitHub Aplicação O ID do cliente é do GitHub aplicação em seu GitHub console que você criou nas etapas anteriores. Este ID está disponível em Sobre . GitHub Configuração da aplicação em GitHub.
      Acessível Deixe esta configuração em seu valor atual.
      Segredo do cliente Segredo do cliente do seu GitHub Aplicação O segredo do cliente é do GitHub aplicação em seu GitHub console que você criou nas etapas anteriores. Este ID está disponível em Sobre . GitHub Configuração da aplicação em GitHub.
      Ativo Opção para habilitar a chave. Deixe selecionado.
      URL de Autorização Este URL é gerado automaticamente.
      URL do token O local do endpoint do token que a instância usa para recuperar e atualizar tokens. Insira o Token do URL em seu GitHub Aplicação Este é o token exibido no URL depois que seu app é instalado em GitHub. Na seção Instalar aplicativo na configuração do aplicativo GitHub em GitHub, selecione a engrenagem. O token é exibido no URL da página da web.
      Script da API OAuth Opção que permite que você faça referência a uma inclusão de script OAuthUtil corrigida. Selecione OAuthGitHubJWTHHandler .
      Tipo de concessão padrão Tipo de concessão associada ao registro da aplicação. Selecione Portador JWT.
    5. Deixe o restante dos campos do formulário como padrão.
    6. Clique com o botão direito no cabeçalho do formulário e selecione “Salvar”.
    7. Role até Perfis de entidade OAuth lista relacionada, selecione-a e abra o perfil padrão que foi criado na lista.
    8. Preencha Provedor JWT Campo com o provedor JWT criado anteriormente e salve o formulário.
    9. Retorne ao arquivo de registro da aplicação e salve-o.
    10. Navegar até Gestão de chave > Políticas de Acesso ao Módulo > Tudo.
    11. Selecione a política para que com_snc_platform_security_oauth_glideencrypter é exibido como Módulo de criptografia valor do campo, e. OAuthGitHubJWTHHandler É a inclusão de script no Script de destino campo.

      Na imagem a seguir com_snc_platform_security_oauth_glideencrypter selecionado como o valor para Módulo de criptografia campo. . Tabela de scripts o campo é exibido Inclusão de script [sys_script_include] e Script de destino o valor do campo é OAuthGitHubJWTHHandler .

      Campo do módulo de criptografia com Inclusão de script OAuthGitHubJWTHandler

    12. Selecione Atualizar.

      Tipo: Script e Resultado: Rastrear

      Como mostrado na imagem anterior, o valor em Nome da política mudanças de campo e Tabela de scripts e. Script de destino os campos não são mais exibidos.
    13. Verifique Resultado o campo está definido como Rastrear e salve suas mudanças.

    Criar credenciais e conexões para Integrações de vulnerabilidade de aplicação do GitHub

    Crie um registro de credencial para GitHub Provedor de app criado anteriormente para autorizar ações.

    Antes de Iniciar

    Funções necessárias:
    • administrador
    • sn_vul.app_sec_manager

    Procedimento

    1. Navegar até Credenciais e conexões > Credenciais.
    2. Selecione Novo.
    3. Selecione Credenciais OAuth 2.0.
    4. Selecione Novo e preencha os campos.
      CampoDescrição
      Nome Nome exclusivo do registro.
      Aplica-se a Selecione as Credenciais do OAuth 2,0 na lista.
      Perfil de Entidade OAuth Selecione o ícone de pesquisa e localize o perfil de entidade que você criou nas etapas anteriores.
      Outros campos Deixe esses campos em seus padrões.
    5. Clique com o botão direito do mouse em qualquer lugar no cabeçalho da página e selecione Salvar .
      A lista Credenciais é exibida.
    6. Abra o registro que você acabou de criar e selecione Obter token OAuth link relacionado.
      É exibida uma mensagem informando que o token OAuth foi importado com sucesso.
    7. Navegar até Credenciais e conexões > Conexões.
    8. Selecione Novo.
    9. Selecione Conexão HTTP(s).
    10. Selecione Novo e preencha os campos.
      CampoDescrição
      Nome Nome do registro.
      Aplicação Somente leitura.
      Alias primário (opcional) Selecione o ícone de pesquisa e escolha um na lista.
      Tipo Conexão e credencial.
      Tipo de conexão HTTP.
      Suporte a várias conexões ativas (opcional) Desativado.
      Política de nova tentativa padrão Política de novas tentativas HTTP padrão
      Modelo de configuração Deixe em branco.
    11. Selecione Enviar.
      A lista Conexões e Aliases de credencial é exibida.
    12. Abra seu registro e, na guia da lista relacionada Conexões, selecione Novo E preencha os campos no registro de conexão HTTP.
      CampoDescrição
      Nome Nome do registro.
      Ativo Ativado.
      Credencial Selecione o registro de credencial que você criou nas etapas anteriores.
      Alias de conexão Seu registro é exibido.
      Construtor de URL Desativado.
      URL de conexão

      Este é o URL base: https://api.github.com Para empresas. O local é o URL do endpoint do GitHub.

      Usar MID Server (opcional) O MID Server é necessário para no local. É opcional para Enterprise.
      Tempo limite de conexão Insira um valor.
    13. Selecione Enviar.
      A lista Conexões e Aliases de credencial é exibida. Agora você está pronto para concluir as etapas para Configure o Integrações de vulnerabilidade de aplicação do GitHub. No campo Conexão, insira as credenciais que você criou nas etapas anteriores.