供应商只交付软件物料清单,或者构建流水线已经生成一份SBOM时,可以把清单直接提交到Checkmarx One做软件成分分析。扫描结果取决于清单里声明了哪些包,以及平台能否识别这些包。实际操作中,文件能上传、任务能完成、组件都被纳入分析,是三个需要分别核对的结果。
一、Checkmarx怎么扫描SBOM
Checkmarx One可以从网页、命令行或接口发起SBOM项目扫描。网页适合核对单份交付清单,命令行则方便把同样的操作放到构建流程里。
1、在网页中上传SBOM
①、登录Checkmarx One,在【Applications and Projects】页面切换到【Projects】,找到接收这次扫描结果的项目。
②、将鼠标移到项目所在行,点击扫描图标。在【New Scan】窗口中核对【Project Name】。
③、在【Source to Scan】中选择【SBOM】,点击【Select File】选取清单。需要区分交付分支或批次时,填写【Branch】或【Scan Tags】。
④、点击【Next】,确认扫描器为【SCA】,再点击【Scan】。任务结束后,在项目的【SCA Results】中打开这一次的结果。
SBOM扫描根据清单里的包标识和版本查询已知风险,也会在信息可用时展示许可证。若项目同时保留源码扫描和SBOM扫描记录,查看结果前可以先确认扫描时间和批次,避免把上一轮的包列表当成本次上传的结果。
2、通过命令行提交构建产物
接入流水线时,可以让生成清单的步骤把文件路径传给扫描步骤。一个项目如果产出多份清单,还应事先约定哪份清单对应本次发布。
①、在配置好Checkmarx One访问权限的环境中,使用【cx scan create】发起项目扫描。
②、通过【--project-name】指定项目,通过【-s】传入SBOM文件的完整路径。
③、将【--scan-types】设为【sca】,加上【--sbom-only】标志,再执行命令并记录扫描标识。
二、Checkmarx扫描SBOM支持哪些格式
核对输入时,要同时看标准名称、标准版本和文件的实际编码格式。两个文件都以.json结尾,也可能一个符合要求,另一个采用了平台尚不支持的标准版本。
1、检查CycloneDX清单的版本和文件类型
①、打开【CycloneDX】清单,核对【specVersion】。Checkmarx One的SBOM项目扫描支持1.0至1.6。
②、确认生成器输出的是【JSON】或【XML】。如果版本或文件类型不符,回到生成器选择受支持的输出配置,再重新生成清单。
2、确认SPDX清单为受支持的JSON
SPDX清单还涉及依赖关系。项目如果需要区分直接依赖与传递依赖,生成清单时就要保留相应关系。
①、打开【SPDX】文件,检查【spdxVersion】是否为2.2或2.3,并确认文件内容采用【JSON】。
②、核对【relationships】中的【DESCRIBES】或【DEPENDS_ON】,确认根对象与直接依赖的对应关系。缺少用于识别直接依赖的关系时,Checkmarx会将文件中的包视为直接依赖。
③、如果收到的是标签值文本等其他表示形式,向清单提供方索取受支持版本的【SPDX JSON】,或通过生成工具重新输出。
3、逐项核对组件的包标识
①、在清单中抽查组件的【PURL】。先选几个本次交付中需要跟踪的包,核对包名、包类型及版本是否与实际发布内容相符。
②、检查【PURL类型】是否属于扫描器识别的范围,例如【npm】、【maven】、【pypi】或【nuget】。仅有CPE或文件哈希的条目,以及使用不受支持类型的条目,可能不会出现在结果中。
③、对缺少【版本】的包回查构建记录。Checkmarx会按其库中的较新规则所指定的最新版本评估无版本条目,因此交付时应补齐实际使用的版本。
格式兼容只能说明平台可以读取这类清单。比如同一份文件里既有应用依赖,也有以rpm标识的操作系统包,应用依赖可能被分析,`rpm`条目则会被跳过。验收时应把这种差异记到具体包上。
三、Checkmarx扫描SBOM后怎么核对覆盖范围
扫描成功后,先确认需要跟踪的包有没有出现在结果里,再读风险明细。只看风险条数,容易把“包已识别且未匹配到风险”和“包没有进入分析”混在一起。
1、对照清单和扫描结果中的包
①、在项目的【SCA Results】中打开本次扫描,找到包列表,并与原始【SBOM】逐项对照。
②、先核对关键包的名称和版本。发现清单中有记录、结果中却找不到时,检查该条目的【PURL】是否缺失、类型不受支持或写法有误。
③、将找不到的条目连同原因写入【交付核对记录】。如果需要修正清单,保留原始文件和重新生成的文件,方便追查哪一次扫描使用了哪份输入。
2、处理没有有效PURL的扫描错误
整份清单都提取不到可识别的PURL时,扫描可能直接报错。此时可以先挑一个熟悉的包,把标识和文件结构查清楚,再修正生成规则。
①、从【扫描任务】中记录错误信息,打开本次提交的文件,确认【标准版本】和【文件类型】与要求相符。
②、检查至少一条组件记录的【PURL】,核对包类型、命名空间、包名与版本。对于带作用域的npm包,还要检查作用域起始的【 】是否按要求编码为【%40】。
③、修正【SBOM生成配置】,重新生成并提交文件。扫描完成后,在【SCA Results】中抽查修正过的包是否出现。
总结
对交付验收来说,一份SBOM能否被Checkmarx One接收,只是开始。更有用的是保留清单对应的发布版本,并说清哪些组件进入了分析、哪些还缺少可识别的标识。这样,当结果里没有发现某个包的风险时,团队可以先确认这个包确实被分析过,再决定如何使用这份结果。