Carregando Lista de materiais de software arquivos usando uma REST API

  • Versão de lançamento: Washingtondc
  • Atualizado 1 de fev. de 2024
  • 2 min. de leitura

    • Revise as informações a seguir antes de carregar arquivos Lista de materiais de software usando uma API.

    REST API

    Para carregar dados com uma API, use o seguinte endpoint REST de script. A função sn_sbom_core.sbom_ingest é necessária.

    <host_name/api/sbom/core/upload.
    Nota:
    <host_name>é o nome da sua instância ServiceNow .

    Depois que um SBOM é processado com sucesso, onde você exibe os registros carregados depende dos aplicativos que você está usando.

    • Se você estiver usando SBOM Resposta, o registro de entidade da lista de materiais será exibido na lista de status de ingestão SBOM no módulo Fila da lista de materiais no espaço SBOM.
    • Se você estiver usando o SBOM Core, navegue até Núcleo de SBOM > Status de ingestão da lista de materiais.

    Usando a REST API

    Você pode carregar somente SBOM arquivos no formato CycloneDX JSON.

    Se o usuário que chama for autenticado com sucesso e tiver a função sn_sbom_core.sbom_ingest em sua instância ServiceNow, você poderá acessar a API de fora da sua instância para carregar os dados SBOM.

    O conteúdoSBOM pode ser enviado para a API como um corpo da solicitação HTTP ou por meio de uma solicitação de linha de comando com um arquivo de dados SBOM. Por exemplo, você pode usar a ferramenta de linha de comando curl, desde que os usuários tenham seu próprio processo para gerenciar os arquivos.

    Além disso, você pode incluir o sys_id do modelo de produto e a aplicação de negócios em seus parâmetros de consulta. A entidade da lista de materiais será mapeada para esses parâmetros se você os incluir. Os seguintes parâmetros são compatíveis:

    • productModelId
    • businessApplicationId

    Cada chamada de API é enfileirada e um sys_id do registro enfileirado é retornado como a resposta da API.

    Por meio da REST API, os dados SBOM são enviados para sua instância Now Platform.

    Depois que os dados são carregados, eles são analisados. Antes que os dados sejam analisados, os seguintes requisitos são verificados:

    • Os dados de entrada são verificados se são JSON válidos.
    • O formato de lista de materiais é compatível. Para esta integração, somente o formato CycloneDX é compatível.
    • Os campos mínimos estão disponíveis para que os dados possam ser analisados.

    Depois que essas verificações forem verificadas, uma entrada será feita na tabela Lista de materiais [sn_sbom_doc] com os dados SBOM de entrada como anexo.

    A regra de negócios Process BOM file é acionada automaticamente como resultado da inserção do registro e da análise de dados.
    Nota:
    Esta regra de negócios é ativada durante a instalação do SBOM Core por padrão.

    Todos os componentes listados em um SBOM têm um tipodefinido.

    • Componentes para os quais os arquivos SBOM foram carregados são considerados entidades da lista de materiais.
    • Os componentes listados como type=library são considerados componentes de terceiros.