⚠️ 此项目已归档 ⚠️
请改用 ElectroNG!
Electronegativity 是一款用于识别基于 Electron 的应用程序中错误配置和安全反模式的工具。
它利用 AST 和 DOM 解析来查找与安全相关的配置,如 "Electron Security Checklist - A Guide for Developers and Auditors" 白皮书所述。
软件开发人员和安全审计人员可以在使用 Electron 开发应用程序时,使用此工具检测并缓解潜在的弱点和实现缺陷。使用 Electronegativity 时仍需对 Electron 的(不)安全性有良好的理解,因为该工具检测到的某些潜在问题需要人工调查。
如果您对 Electron 安全感兴趣,请查看我们的 BlackHat 2017 研究 Electronegativity - A Study of Electron Security,并关注 Doyensec 的博客。

主要版本已发布到 NPM,可以直接使用以下命令安装:
$ npm install @doyensec/electronegativity -g
$ electronegativity -h
| 选项 | 描述 |
|---|---|
| -V | 输出版本号 |
| -i, --input | 输入(目录、.js、.html、.asar) |
| -l, --checks | 仅运行指定的检查项,以 csv 格式传入 |
| -x, --exclude-checks | 跳过指定的检查项列表,以 csv 格式传入 |
| -s, --severity | 仅返回指定严重级别或更高级别的发现结果 |
| -c, --confidence | 仅返回指定置信度级别或更高级别的发现结果 |
| -o, --output <filename[.csv or .sarif]> | 将结果以 csv 或 sarif 格式保存到文件 |
| -r, --relative | 显示文件的相对路径 |
| -v, --verbose | 显示发现结果的描述,默认为 true |
| -u, --upgrade | 运行 Electron 升级检查,例如 -u 7..8 检查从 Electron 7 升级到 8 |
| -e, --electron-version | 假定设定的 Electron 版本,覆盖检测到的版本,例如 -e 7.0.0 视为使用 Electron 7 |
| -p, --parser-plugins | 指定要使用的额外解析器插件,以逗号分隔,例如 -p optionalChaining |
| -h, --help | 输出使用信息 |
使用 electronegativity 在包含 Electron 应用的目录中查找问题:
$ electronegativity -i /path/to/electron/app
使用电负性在 asar 归档中查找问题,并将结果保存到 csv 文件中:
$ electronegativity -i /path/to/asar/archive -o result.csv
在从一个 Electron 版本升级到另一个版本时,利用电负性来查找破坏性变更:
$ electronegativity -i /path/to/electron/app -v -u 7..8
注意:如果你遇到致命错误“JavaScript heap out of memory”,可以使用 node --max-old-space-size=4096 electronegativity -i /path/to/asar/archive -o result.csv 来运行 node。
Electronegativity 允许你使用 eng-disable 注释来禁用单个检查。例如,如果你想让某个特定检查忽略一行代码,可以按如下方式禁用它:
const res = eval(safeVariable); /* eng-disable DANGEROUS_FUNCTIONS_JS_CHECK */
<webview src="https://doyensec.com/" enableblinkfeatures="DangerousFeature"></webview> <!-- eng-disable BLINK_FEATURES_HTML_CHECK -->
任何 eng-disable 行内注释(// eng-disable、/* eng-disable */、<!-- eng-disable -->)将仅对该行禁用指定的检查。也可以同时使用检查的 snake case ID(DANGEROUS_FUNCTIONS_JS_CHECK)或其构造名称(dangerousFunctionsJSCheck)来提供多个检查名称:
shell.openExternal(eval(safeVar)); /* eng-disable OPEN_EXTERNAL_JS_CHECK DANGEROUS_FUNCTIONS_JS_CHECK */
如果在 .js 或 .html 文件顶部的任何代码之前放置 eng-disable 指令,将会对整个文件禁用所传入的检查。
eng-disable 注解的说明在 v1.9.0 之前,无法使用代码注解禁用全局检查。如果你仍在使用旧版本,请改用 -x CLI 参数手动禁用一组检查(例如 -x LimitNavigationJsCheck,PermissionRequestHandlerJsCheck,CSPGlobalCheck)。
请注意,使用注解可能不适用于某些更高级别的检查,例如 CSP_GLOBAL_CHECK 或 AVAILABLE_SECURITY_FIXES_GLOBAL_CHECK。对于这些情况,你可能希望使用 -x 标志从扫描中排除特定检查。
Electronegativity Action 可以作为 GitHub CI/CD 流水线的一部分运行,以获取“代码扫描警报”:

你也可以以编程方式使用 electronegativity,使用与 CLI 类似的选项:
const run = require('@doyensec/electronegativity')
// or: import run from '@doyensec/electronegativity';
run({
// input (directory, .js, .html, .asar)
input: '/path/to/electron/app',
// save the results to a file in csv or sarif format (optional)
output: '/path/for/output/file',
// true to save output as sarif, false to save as csv (optional)
isSarif: false,
// only run the specified checks (optional)
customScan: ['dangerousfunctionsjscheck', 'remotemodulejscheck'],
// only return findings with the specified level of severity or above (optional)
severitySet: 'high',
// only return findings with the specified level of confidence or above (optional)
confidenceSet: 'certain',
// show relative path for files (optional)
isRelative: false,
// run Electron upgrade checks, eg -u 7..8 to check upgrade from Electron 7 to 8 (optional)
electronUpgrade: '7..8',
// assume the set Electron version, overriding the detected one
electronVersion: '5.0.0',
// use additional parser plugins
parserPlugins: ['optionalChaining']
})
.then(result => console.log(result))
.catch(err => console.error(err));
结果包含全局检查和原子检查的数量、解析过程中遇到的任何错误,以及发现的问题数组,如下所示:
{
globalChecks: 6,
atomicChecks: 36,
errors: [
{
file: 'ts/main/main.ts',
sample: 'shell.openExternal(url);',
location: { line: 328, column: 4 },
id: 'OPEN_EXTERNAL_JS_CHECK',
description: 'Review the use of openExternal',
properties: undefined,
severity: { value: 2, name: 'MEDIUM', format: [Function: format] },
confidence: { value: 0, name: 'TENTATIVE', format: [Function: format] },
manualReview: true,
shortenedURL: 'https://git.io/JeuMC'
},
{
file: 'ts/main/main.ts',
sample: 'const popup = new BrowserWindow(options);',
location: { line: 340, column: 18 },
id: 'CONTEXT_ISOLATION_JS_CHECK',
description: 'Review the use of the contextIsolation option',
properties: undefined,
severity: { value: 3, name: 'HIGH', format: [Function: format] },
confidence: { value: 1, name: 'FIRM', format: [Function: format] },
manualReview: false,
shortenedURL: 'https://git.io/Jeu1p'
}
]
}
如果您正在考虑为本项目做出贡献,请查看我们的 CONTRIBUTING.md。
Electronegativity 的诞生离不开众多贡献者的努力。
本项目由 Doyensec LLC 赞助。
联系我们攻破您的 Electron.js 应用!