REST API 사용

API를 사용하여 SBOM 파일을 업로드하려면 sn_sbom_core.sbom_ingest 역할이 필요합니다.

업로드 API.

이 API는 SBOM 파일(CycloneDX/SPDX)을 인스턴스에 업로드하고 수집하는 데 사용됩니다.

HTTP 메서드: (POST)

{

"result": {

"status": "success",

"message": "Queued for processing.",

"bomRecordId": "f207059b4393c290629aa597cbb8f247"

}

}

상태 API

상태 API 기본 응답 예입니다.

{
   "result": {
      "bomRecordId": "0407c0fea3e70a505df340f5251e617e",
      "uploadStatus": "processed",
      "additionalInfoStatus": "not_requested",
      "uploadSummary": {
         "components": {
            "added": 0,
            "removed": 0,
            "total": 70
         }
       }
    } 
}

추가 매개변수가 있는 상태 API 응답 예. 해당 SBOM에 대한 fetchVulenrabilityInfo를 요청한 경우 응답의 일부로 취약성 세부 항목을 가져옵니다.

{
 "result": {

  "bomRecordId": "93af349b4393c290629aa597cbb8f258",

  "uploadStatus": "processed",

  "additionalInfoStatus": "complete",

  "uploadSummary": {

    "components": {
 
     "added": 0,

     "removed": 0,

     "total": 3

   },

   "vulnerabilityInfo": {

    "critical": 0,

    "high": 0,

    "medium": 0,

    "low": 0,

    "none": 0

   }

  },

  "buildId": "1"

 }

}

해당 SBOM에 대해 fetchPackageInfo를 요청한 경우 응답의 일부로 부실 및 중단된 카운트가 표시됩니다.

성공적으로 SBOM 처리된 후 업로드된 기록을 보는 위치는 사용 중인 애플리케이션에 따라 다릅니다.

• 응답을 사용하는 SBOM 경우 작업 공간의 BOM 큐 모듈 SBOM 에 있는 수집 상태 목록에 BOM 엔터티 기록이 표시됩니다SBOM.
• SBOM Core를 사용하는 경우 SBOM Core > BOM 수집 상태.

지원되는 SBOM 표준 및 일반 사용 정보의 개선 사항

호출 사용자가 성공적으로 인증되고 인스턴스에 ServiceNow sn_sbom_core.sbom_ingest 역할이 있는 경우 인스턴스 외부에서 API에 액세스하여 데이터를 업로드할 수 있습니다.SBOM

데이터가 업로드되면 구문 분석됩니다. 데이터를 구문 분석하기 전에 다음 요구 사항이 검증됩니다.

• 수신 데이터가 유효한 JSON 또는 XML인지 확인합니다.
• BOM 형식이 지원됩니다. Core v2.1 SBOM 부터는 CycloneDX(JSON 및 XML) 및 SPDX(XML) 형식이 지원됩니다.
• 데이터를 구문 분석할 수 있도록 최소 필드를 사용할 수 있습니다.

이러한 검사가 확인되면 들어오 SBOM 는 데이터가 첨부 파일로 포함된 BOM [sn_sbom_doc] 테이블에 항목이 작성됩니다.

에 SBOM 나열된 모든 구성요소에는 정의된 유형이 있습니다.

• 파일이 업로드된 구성요소 SBOM 는 BOM 엔터티로 간주됩니다.
• type=library로 나열된 구성요소는 외부 공급업체 구성요소로 간주됩니다.