⚠️ このプロジェクトはアーカイブされました ⚠️
代わりに 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 コメントを使用して個々のチェックを無効にできます。たとえば、特定のチェックにコードの1行を無視させたい場合は、次のように無効化できます:
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 -->)は、その行に限り指定されたチェックを無効化します。また、スネークケースの 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 パイプラインの一部として実行し、「Code scanning alerts」を取得できます:

CLI と同様のオプションを使用して、electronegativity をプログラムから利用することもできます:
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 アプリケーションを破ってみませんか!