一、开源项目简介

OpenSCA作为悬镜安全旗下源鉴OSS开源威胁管控产品的开源版本，继承了源鉴OSS的多源SCA开源应用安全缺陷检测等核心能力，通过软件成分分析、依赖分析、特征分析、引用识别、合规分析等方法，深度挖掘组件中潜藏的各类安全漏洞及开源协议风险。

二、开源协议

使用Apache-2.0开源协议

三、界面展示

四、功能概述

丰富的语言支持，海量知识库支撑

• 支持Java、JavaScript、PHP等多种主流编程语言的软件成分分析
• 云平台实时的组件库、漏洞库、许可证库、特征库等海量知识库支撑

组件依赖解析，可视化SBOM分析

• 组件的直接依赖及间接依赖解析
• 组件安全漏洞分析，快速定位漏洞影响范围并及时修复
• 可视化SBOM（软件物料清单），助力快速梳理内部软件资产

许可合规分析，知识产权安全保障

• 支持主流许可证的检出
• 分析开源许可证的合规性及兼容性风险

企业级核心引擎，更高检出更低误报

• 拥有企业级SCA核心检测引擎及分析引擎
• 基于海量知识库，多源SCA开源应用安全缺陷检测等算法，对特征文件进行精准识别，提高组件的检出率

安全开发

• OpenSCA开源的IDE开源风险检测插件，帮助个人/企业开发者快速定位并修复漏洞
• 开发人员友好，轻量级低成本零门槛安装
• 企业级SCA核心引擎，支持二次开发

安全测试

• 产品第三方开源组件的安全测试
• 提高软件产品安全性，防止应用带病上线

安全管理

• 第三方组件及供应商软件的安全准入
• 企业内部安全组件库的建立
• 软件或组件资产可视化清单梳理
• 安全部门合规审查及相关开源治理工作

五、技术选型

检测能力

OpenSCA现已支持以下编程语言相关的配置文件解析及对应的包管理器，后续会逐步支持更多的编程语言，丰富相关配置文件的解析。

支持语言

包管理器

解析文件

Java

Maven

pom.xml

JavaScript

Npm

package-lock.jsonpackage.jsonyarn.lock

PHP

Composer

composer.json

Ruby

gem

gemfile.lock

Golang

gomod

go.modgo.sum

Rust

cargo

Cargo.lock

Erlang

Rebar

rebar.lock

下载安装

1. 访问一飞开源：https://code.exmay.com/ 下载对应系统架构的可执行文件压缩包
2. 或者下载源码编译(需要 go 1.18 及以上版本)
3. git clone https://github.com/XmirrorSecurity/OpenSCA-cli.git opensca cd opensca go work init cli analyzer util go build -o opensca-cli cli/main.go
4. 默认生成当前系统架构的程序，如需生成其他系统架构可配置环境变量后编译
5. 禁用CGO_ENABLED CGO_ENABLED=0
6. 指定操作系统 GOOS=${OS} \\ darwin,freebsd,liunx,windows
7. 指定体系架构 GOARCH=${arch} \\ 386,amd64,arm

使用样例

仅检测组件信息

opensca-cli -path ${project_path}

连接云平台

opensca-cli -url ${url} -token ${token} -path ${project_path}

或使用本地漏洞库

opensca-cli -db db.json -path ${project_path}

参数说明

可在配置文件中配置参数，也可在命令行输入参数，两者冲突时优先使用输入参数

参数

类型

描述

使用样例

config

string

指定配置文件路径，程序启动时将配置文件中的参数作为启动参数，配置参数与命令行输入参数冲突时优先使用输入参数

-config config.json

path

string

指定要检测的文件或目录路径

-path ./foo

url

string

从云漏洞库查询漏洞，指定要连接云服务的地址，与 token 参数一起使用

-url https://opensca.xmirror.cn

token

string

云服务验证 token，需要在云服务平台申请，与 url 参数一起使用

-token xxxxxxx

cache

bool

建议开启，缓存下载的文件(例如 .pom 文件)，重复检测相同组件时会节省时间，下载的文件会保存到工具所在目录的.cache 目录下

-cache

vuln

bool

结果仅保留有漏洞信息的组件，使用该参数将不会保留组件层级结构

-vuln

out

string

将检测结果保存到指定文件，根据后缀生成不同格式的文件，默认为 json 格式

-out output.json

db

string

指定本地漏洞库文件，希望使用自己漏洞库时可用，漏洞库文件为 json 格式，具体格式会在之后给出;若同时使用云端漏洞库与本地漏洞库，漏洞查询结果取并集

-db db.json

progress

bool

显示进度条

-progress

漏洞库文件格式

[
  {
    "vendor": "org.apache.logging.log4j",
    "product": "log4j-core",
    "version": "[2.0-beta9,2.12.2)||[2.13.0,2.15.0)",
    "language": "java",
    "name": "Apache Log4j2 远程代码执行漏洞",
    "id": "XMIRROR-2021-44228",
    "cve_id": "CVE-2021-44228",
    "cnnvd_id": "CNNVD-202112-799",
    "cnvd_id": "CNVD-2021-95914",
    "cwe_id": "CWE-502,CWE-400,CWE-20",
    "description": "Apache Log4j是美国阿帕奇（Apache）基金会的一款基于Java的开源日志记录工具。\r\nApache Log4J 存在代码问题漏洞，攻击者可设计一个数据请求发送给使用 Apache Log4j工具的服务器，当该请求被打印成日志时就会触发远程代码执行。",
    "description_en": "Apache Log4j2 2.0-beta9 through 2.12.1 and 2.13.0 through 2.15.0 JNDI features used in configuration, log messages, and parameters do not protect against attacker controlled LDAP and other JNDI related endpoints. An attacker who can control log messages or log message parameters can execute arbitrary code loaded from LDAP servers when message lookup substitution is enabled. From log4j 2.15.0, this behavior has been disabled by default. From version 2.16.0, this functionality has been completely removed. Note that this vulnerability is specific to log4j-core and does not affect log4net, log4cxx, or other Apache Logging Services projects.",
    "suggestion": "2.12.1及以下版本可以更新到2.12.2，其他建议更新至2.15.0或更高版本，漏洞详情可参考：https://github.com/apache/logging-log4j2/pull/608 \r\n1、临时解决方案，适用于2.10及以上版本：\r\n\t（1）设置jvm参数：“-Dlog4j2.formatMsgNoLookups=true”；\r\n\t（2）设置参数：“log4j2.formatMsgNoLookups=True”；",
    "attack_type": "远程",
    "release_date": "2021-12-10",
    "security_level_id": 1,
    "exploit_level_id": 1
  },
  {}
]

漏洞库字段说明

字段

描述

是否必填

vendor

组件厂商

否

product

组件名

是

version

漏洞影响版本

是

language

组件语言

是

name

漏洞名

否

id

自定义编号

是

cve_id

cve 编号

否

cnnvd_id

cnnvd 编号

否

cnvd_id

cnvd 编号

否

cwe_id

cwe 编号

否

description

漏洞描述

否

description_en

漏洞英文描述

否

suggestion

漏洞修复建议

否

attack_type

攻击方式

否

release_date

漏洞发布日期

否

security_level_id

漏洞风险评级(1~4 风险程度递减)

否

exploit_level_id

漏洞利用评级(0:不可利用,1:可利用)

否

六、源码地址

源码下载