安全
有关如何正确披露 Electron 漏洞的信息,请参阅 SECURITY.md。
关于上游 Chromium 漏洞:Electron 与交替的 Chromium 版本保持同步。更多信息请参阅 Electron 发布时间线文档。
前言
作为 Web 开发者,我们通常享有浏览器提供的强大安全网络——我们编写的代码相关的风险相对较小。我们的网站在沙盒中被授予有限的权限,我们相信我们的用户使用的浏览器是由一个庞大的工程师团队构建的,能够快速响应新发现的安全威胁。
在使用 Electron 时,重要的是要明白 Electron 不是一个 Web 浏览器。它允许您使用熟悉的 Web 技术构建功能丰富的桌面应用程序,但您的代码拥有更大的权力。JavaScript 可以访问文件系统、用户 Shell 等。这使您能够构建高质量的原生应用程序,但固有的安全风险会随着代码获得的额外权限而增加。
考虑到这一点,请注意,显示来自不受信任源的任意内容会带来严重的安全风险,而 Electron 并非旨在处理此类风险。事实上,最流行的 Electron 应用程序 (Atom、Slack、Visual Studio Code 等) 主要显示本地内容 (或受信任的、安全的远程内容,且没有 Node 集成)——如果您的应用程序执行来自在线源的代码,您有责任确保该代码不是恶意的。
一般准则
安全是每个人的责任
请务必记住,您的 Electron 应用程序的安全性是框架基础 (Chromium、Node.js)、Electron 本身、所有 NPM 依赖项和您的代码的整体安全性的结果。因此,您有责任遵循一些重要的最佳实践:
-
保持您的应用程序与最新的 Electron 框架版本同步。 发布产品时,您同时会交付一个由 Electron、Chromium 共享库和 Node.js 组成的捆绑包。影响这些组件的漏洞可能会影响您应用程序的安全性。通过将 Electron 更新到最新版本,您可以确保关键漏洞 (例如 nodeIntegration 绕过) 已得到修补,并且无法在您的应用程序中被利用。更多信息,请参阅“使用当前版本的 Electron”。
-
评估您的依赖项。 尽管 NPM 提供了五十万个可重用包,但选择受信任的第三方库是您的责任。如果您使用受已知漏洞影响的过时库或依赖维护不佳的代码,您的应用程序安全性可能会受到威胁。
-
采用安全编码实践。 应用程序的第一道防线是您自己的代码。常见的 Web 漏洞,例如跨站脚本 (XSS),对 Electron 应用程序有更高的安全影响,因此强烈建议采用安全的软件开发最佳实践并进行安全测试。
隔离不受信任的内容
每当您从不受信任的来源(例如远程服务器)接收代码并在本地执行时,都存在安全问题。例如,考虑在默认 BrowserWindow
中显示的远程网站。如果攻击者设法更改该内容(通过直接攻击源,或通过在您的应用程序和实际目的地之间进行拦截),他们将能够在用户的机器上执行原生代码。
在任何情况下,都不得在启用 Node.js 集成的情况下加载和执行远程代码。相反,只使用本地文件(与您的应用程序一起打包)来执行 Node.js 代码。要显示远程内容,请使用 <webview>
标签或 WebContentsView
,并确保禁用 nodeIntegration
并启用 contextIsolation
。
安全警告和建议会打印到开发者控制台。它们只在二进制文件的名称是 Electron 时显示,这表明开发者当前正在查看控制台。
您可以通过在 process.env
或 window
对象上设置 ELECTRON_ENABLE_SECURITY_WARNINGS
或 ELECTRON_DISABLE_SECURITY_WARNINGS
来强制启用或强制禁用这些警告。
清单:安全建议
您至少应遵循这些步骤来提高应用程序的安全性
- 只加载安全内容
- 在所有显示远程内容的渲染器中禁用 Node.js 集成
- 在所有渲染器中启用上下文隔离
- 启用进程沙盒
- 在所有加载远程内容的会话中使用
ses.setPermissionRequestHandler()
- 不要禁用
webSecurity
- 定义
Content-Security-Policy
并使用限制性规则 (例如script-src 'self'
) - 不要启用
allowRunningInsecureContent
- 不要启用实验性功能
- 不要使用
enableBlinkFeatures
<webview>
: 不要使用allowpopups
<webview>
: 验证选项和参数- 禁用或限制导航
- 禁用或限制新窗口的创建
- 不要对不受信任的内容使用
shell.openExternal
- 使用当前版本的 Electron
- 验证所有 IPC 消息的
sender
- 避免使用
file://
协议,优先使用自定义协议 - 检查可以更改的熔断器 (fuses)
- 不要将 Electron API 暴露给不受信任的 Web 内容
为了自动化检测配置错误和不安全模式,可以使用 Electronegativity。有关使用 Electron 开发应用程序时潜在弱点和实现错误的更多详细信息,请参阅此 开发者和审计员指南。
1. 只加载安全内容
任何未包含在您的应用程序中的资源都应使用安全协议(如 HTTPS
)加载。换句话说,不要使用不安全的协议(如 HTTP
)。同样,我们建议使用 WSS
而不是 WS
,FTPS
而不是 FTP
,依此类推。
为什么?
HTTPS
有两个主要优点
- 它确保数据完整性,断言数据在您的应用程序和主机之间传输时未被修改。
- 它加密了用户与目标主机之间的流量,使得窃听您的应用程序与主机之间发送的信息变得更加困难。
如何实现?
// Bad
browserWindow.loadURL('http://example.com')
// Good
browserWindow.loadURL('https://example.com')
<!-- Bad -->
<script crossorigin src="http://example.com/react.js"></script>
<link rel="stylesheet" href="http://example.com/style.css">
<!-- Good -->
<script crossorigin src="https://example.com/react.js"></script>
<link rel="stylesheet" href="https://example.com/style.css">
2. 不要为远程内容启用 Node.js 集成
自 Electron 5.0.0 起,此建议已成为默认行为。
至关重要的是,不要在任何加载远程内容的渲染器 (BrowserWindow
、WebContentsView
或 <webview>
) 中启用 Node.js 集成。目标是限制您授予远程内容的权限,从而在攻击者获得在您的网站上执行 JavaScript 的能力时,大大增加其伤害用户的难度。
之后,您可以为特定主机授予额外的权限。例如,如果您正在打开一个指向 https://example.com/
的 BrowserWindow,您可以精确地授予该网站所需的权限,不多也不少。
为什么?
如果攻击者能够跳出渲染器进程并在用户的计算机上执行代码,则跨站脚本 (XSS) 攻击会更加危险。跨站脚本攻击相当常见——虽然这是一个问题,但它们的威力通常仅限于干扰它们所执行的网站。禁用 Node.js 集成有助于防止 XSS 升级为所谓的“远程代码执行 (RCE)”攻击。
如何实现?
// Bad
const mainWindow = new BrowserWindow({
webPreferences: {
contextIsolation: false,
nodeIntegration: true,
nodeIntegrationInWorker: true
}
})
mainWindow.loadURL('https://example.com')
// Good
const mainWindow = new BrowserWindow({
webPreferences: {
preload: path.join(app.getAppPath(), 'preload.js')
}
})
mainWindow.loadURL('https://example.com')
<!-- Bad -->
<webview nodeIntegration src="page.html"></webview>
<!-- Good -->
<webview src="page.html"></webview>
禁用 Node.js 集成后,您仍然可以向网站公开使用 Node.js 模块或功能的 API。预加载脚本仍然可以访问 require
和其他 Node.js 功能,从而允许开发者通过 contextBridge API 向远程加载的内容公开自定义 API。
3. 启用上下文隔离
上下文隔离自 Electron 12.0.0 起成为默认行为。
上下文隔离是 Electron 的一项功能,它允许开发者在预加载脚本和 Electron API 中运行代码,在一个专用的 JavaScript 上下文中。实际上,这意味着像 Array.prototype.push
或 JSON.parse
这样的全局对象不能被渲染进程中运行的脚本修改。
Electron 使用与 Chromium 的 内容脚本 相同的技术来实现此行为。
即使使用了 nodeIntegration: false
,为了真正强制实施强隔离并防止使用 Node 原语,必须同时使用 contextIsolation
。
有关 contextIsolation
是什么以及如何启用它的更多信息,请参阅我们的专用 上下文隔离 文档。
4. 启用进程沙盒
沙盒 是 Chromium 的一项功能,它利用操作系统显著限制渲染进程的访问权限。您应该在所有渲染器中启用沙盒。不建议在未沙盒化的进程(包括主进程)中加载、读取或处理任何不受信任的内容。
有关进程沙盒是什么以及如何启用它的更多信息,请参阅我们的专用 进程沙盒 文档。
5. 处理来自远程内容的会话权限请求
您在使用 Chrome 时可能见过权限请求:每当网站尝试使用用户必须手动批准的功能(如通知)时,它们就会弹出。
该 API 基于 Chromium 权限 API,并实现了相同类型的权限。
为什么?
默认情况下,除非开发者手动配置了自定义处理程序,否则 Electron 将自动批准所有权限请求。虽然这是一个可靠的默认设置,但注重安全的开发者可能希望采取完全相反的做法。
如何实现?
const { session } = require('electron')
const { URL } = require('url')
session
.fromPartition('some-partition')
.setPermissionRequestHandler((webContents, permission, callback) => {
const parsedUrl = new URL(webContents.getURL())
if (permission === 'notifications') {
// Approves the permissions request
callback(true)
}
// Verify URL
if (parsedUrl.protocol !== 'https:' || parsedUrl.host !== 'example.com') {
// Denies the permissions request
return callback(false)
}
})
6. 不要禁用 webSecurity
此建议是 Electron 的默认设置。
您可能已经猜到,在渲染器进程 (BrowserWindow
、WebContentsView
或 <webview>
) 上禁用 webSecurity
属性会禁用关键的安全功能。
请勿在生产应用程序中禁用 webSecurity
。
为什么?
禁用 webSecurity
将禁用同源策略并将 allowRunningInsecureContent
属性设置为 true
。换句话说,它允许执行来自不同域的不安全代码。
如何实现?
// Bad
const mainWindow = new BrowserWindow({
webPreferences: {
webSecurity: false
}
})
// Good
const mainWindow = new BrowserWindow()
<!-- Bad -->
<webview disablewebsecurity src="page.html"></webview>
<!-- Good -->
<webview src="page.html"></webview>
7. 定义内容安全策略
内容安全策略(CSP)是抵御跨站脚本攻击和数据注入攻击的额外保护层。我们建议您在 Electron 中加载的任何网站都启用它们。
为什么?
CSP 允许提供内容的服务器限制和控制 Electron 可以为给定网页加载的资源。https://example.com
应该被允许从您定义的源加载脚本,而来自 https://evil.attacker.com
的脚本则不应被允许运行。定义 CSP 是提高应用程序安全性的简单方法。
如何实现?
以下 CSP 将允许 Electron 执行来自当前网站和 apis.example.com
的脚本。
// Bad
Content-Security-Policy: '*'
// Good
Content-Security-Policy: script-src 'self' https://apis.example.com
CSP HTTP 头
CSP 的首选传递机制是 HTTP 头。然而,当使用 file://
协议加载资源时,无法使用此方法。在某些情况下,通过 <meta>
标签直接在标记中为页面设置策略可能很有用
const { session } = require('electron')
session.defaultSession.webRequest.onHeadersReceived((details, callback) => {
callback({
responseHeaders: {
...details.responseHeaders,
'Content-Security-Policy': ['default-src \'none\'']
}
})
})
CSP meta 标签
CSP 首选的传递机制是 HTTP 头。然而,当使用 file://
协议加载资源时,无法使用此方法。在某些情况下,通过 <meta>
标签直接在标记中为页面设置策略可能很有用。
<meta http-equiv="Content-Security-Policy" content="default-src 'none'">
8. 不要启用 allowRunningInsecureContent
此建议是 Electron 的默认设置。
默认情况下,Electron 不会允许通过 HTTPS
加载的网站加载和执行来自不安全源 (HTTP
) 的脚本、CSS 或插件。将属性 allowRunningInsecureContent
设置为 true
将禁用该保护。
通过 HTTPS
加载网站的初始 HTML,然后尝试通过 HTTP
加载后续资源,也称为“混合内容”。
为什么?
通过 HTTPS
加载内容可确保加载资源的真实性和完整性,同时加密流量本身。更多详细信息,请参阅关于仅显示安全内容的部分。
如何实现?
// Bad
const mainWindow = new BrowserWindow({
webPreferences: {
allowRunningInsecureContent: true
}
})
// Good
const mainWindow = new BrowserWindow({})
9. 不要启用实验性功能
此建议是 Electron 的默认设置。
Electron 的高级用户可以使用 experimentalFeatures
属性启用实验性的 Chromium 功能。
为什么?
实验性功能,顾名思义,是实验性的,尚未对所有 Chromium 用户启用。此外,它们对整个 Electron 的影响可能尚未经过测试。
存在合法的用例,但除非您清楚自己在做什么,否则不应启用此属性。
如何实现?
// Bad
const mainWindow = new BrowserWindow({
webPreferences: {
experimentalFeatures: true
}
})
// Good
const mainWindow = new BrowserWindow({})
10. 不要使用 enableBlinkFeatures
此建议是 Electron 的默认设置。
Blink 是 Chromium 后面的渲染引擎的名称。与 experimentalFeatures
类似,enableBlinkFeatures
属性允许开发者启用默认禁用的功能。
为什么?
一般来说,如果一个功能默认没有启用,很可能有很好的理由。启用特定功能存在合法的用例。作为开发者,您应该清楚地知道为什么需要启用某个功能,其后果是什么,以及它如何影响应用程序的安全性。在任何情况下,都不应凭空启用功能。
如何实现?
// Bad
const mainWindow = new BrowserWindow({
webPreferences: {
enableBlinkFeatures: 'ExecCommandInJavaScript'
}
})
// Good
const mainWindow = new BrowserWindow()
11. 不要在 WebViews 中使用 allowpopups
此建议是 Electron 的默认设置。
如果您正在使用 <webview>
,您可能需要加载在 <webview>
标签中的页面和脚本打开新窗口。allowpopups
属性允许它们使用 window.open()
方法创建新的 BrowserWindows
。否则,<webview>
标签不允许创建新窗口。
为什么?
如果您不需要弹出窗口,最好默认不允许创建新的 BrowserWindows
。这遵循最小必要访问原则:除非您知道某个网站需要该功能,否则不要让它创建新的弹出窗口。
如何实现?
<!-- Bad -->
<webview allowpopups src="page.html"></webview>
<!-- Good -->
<webview src="page.html"></webview>
12. 在创建前验证 WebView 选项
在未启用 Node.js 集成的渲染进程中创建的 WebView 将无法自行启用集成。但是,WebView 总是会创建一个独立的渲染进程,并拥有自己的 webPreferences
。
最好从主进程控制新的 <webview>
标签的创建,并验证其 webPreferences 是否未禁用安全功能。
为什么?
由于 <webview>
存在于 DOM 中,即使 Node.js 集成被禁用,它们也可以由在您的网站上运行的脚本创建。
Electron 允许开发者禁用控制渲染进程的各种安全功能。在大多数情况下,开发者不需要禁用任何这些功能——因此您不应允许新创建的 <webview>
标签有不同的配置。
如何实现?
在 <webview>
标签附加之前,Electron 会在宿主 webContents
上触发 will-attach-webview
事件。使用此事件可防止创建带有不安全选项的 webViews
。
app.on('web-contents-created', (event, contents) => {
contents.on('will-attach-webview', (event, webPreferences, params) => {
// Strip away preload scripts if unused or verify their location is legitimate
delete webPreferences.preload
// Disable Node.js integration
webPreferences.nodeIntegration = false
// Verify URL being loaded
if (!params.src.startsWith('https://example.com/')) {
event.preventDefault()
}
})
})
同样,此列表只是将风险降到最低,但并未消除风险。如果您的目标是显示网站,浏览器会是更安全的选择。
13. 禁用或限制导航
如果您的应用程序不需要导航,或者只需要导航到已知页面,那么将导航完全限制在该已知范围内,禁止任何其他类型的导航是一个好主意。
为什么?
导航是一个常见的攻击向量。如果攻击者能够说服您的应用程序离开当前页面,他们可能会强制您的应用程序打开互联网上的网站。即使您的 webContents
配置得更安全(例如禁用 nodeIntegration
或启用 contextIsolation
),让您的应用程序打开随机网站也会大大简化利用您的应用程序的工作。
一种常见的攻击模式是攻击者说服您的应用程序用户以某种方式与应用程序交互,使其导航到攻击者的页面之一。这通常通过链接、插件或其他用户生成的内容完成。
如何实现?
如果您的应用程序不需要导航,您可以在 will-navigate
处理程序中调用 event.preventDefault()
。如果您知道您的应用程序可能导航到哪些页面,请在事件处理程序中检查 URL,并且只有当它与您期望的 URL 匹配时才允许导航发生。
我们建议您使用 Node 的 URL 解析器。简单的字符串比较有时可能会被欺骗——startsWith('https://example.com')
测试会允许 https://example.com.attacker.com
通过。
const { URL } = require('url')
const { app } = require('electron')
app.on('web-contents-created', (event, contents) => {
contents.on('will-navigate', (event, navigationUrl) => {
const parsedUrl = new URL(navigationUrl)
if (parsedUrl.origin !== 'https://example.com') {
event.preventDefault()
}
})
})
14. 禁用或限制新窗口的创建
如果您有一组已知的窗口,最好限制应用程序中额外窗口的创建。
为什么?
与导航类似,创建新的 webContents
是一个常见的攻击向量。攻击者试图说服您的应用程序创建新的窗口、框架或其他渲染进程,使其拥有比以前更多的权限;或者打开它们以前无法打开的页面。
如果您不需要创建除您已知需要创建的窗口之外的额外窗口,禁用创建可以免费为您增加一点额外的安全性。这通常适用于打开一个 BrowserWindow
且不需要在运行时打开任意数量额外窗口的应用程序。
如何实现?
webContents
将在创建新窗口之前委托给其 窗口打开处理程序。该处理程序将接收(除其他参数外)请求打开窗口的 url
和用于创建它的选项。我们建议您注册一个处理程序来监视窗口的创建,并拒绝任何意外的窗口创建。
const { app, shell } = require('electron')
app.on('web-contents-created', (event, contents) => {
contents.setWindowOpenHandler(({ url }) => {
// In this example, we'll ask the operating system
// to open this event's url in the default browser.
//
// See the following item for considerations regarding what
// URLs should be allowed through to shell.openExternal.
if (isSafeForExternalOpen(url)) {
setImmediate(() => {
shell.openExternal(url)
})
}
return { action: 'deny' }
})
})
15. 不要对不受信任的内容使用 shell.openExternal
shell 模块的 openExternal
API 允许使用桌面原生工具打开给定的协议 URI。例如,在 macOS 上,此函数类似于 open
终端命令实用程序,它将根据 URI 和文件类型关联打开特定的应用程序。
为什么?
不正确地使用 openExternal
可能会被利用来危害用户的宿主。当 openExternal
与不受信任的内容一起使用时,它可能会被利用来执行任意命令。
如何实现?
// Bad
const { shell } = require('electron')
shell.openExternal(USER_CONTROLLED_DATA_HERE)
// Good
const { shell } = require('electron')
shell.openExternal('https://example.com/index.html')
16. 使用当前版本的 Electron
您应该努力始终使用 Electron 的最新版本。每当发布新的主版本时,您都应尽快尝试更新您的应用程序。
为什么?
使用旧版 Electron、Chromium 和 Node.js 构建的应用程序比使用这些组件更新版本的应用程序更容易成为攻击目标。一般来说,旧版 Chromium 和 Node.js 的安全问题和漏洞更为广泛。
Chromium 和 Node.js 都是由数千名才华横溢的开发者构建的令人印象深刻的工程壮举。鉴于它们的流行,它们的安全性受到同样熟练的安全研究人员的仔细测试和分析。许多研究人员负责任地披露漏洞,这通常意味着研究人员会给 Chromium 和 Node.js 一些时间来修复问题,然后再发布它们。如果您的应用程序运行的是 Electron 的最新版本(因此也是 Chromium 和 Node.js 的最新版本),那么其潜在的安全问题就不那么广为人知,应用程序将更安全。
如何实现?
一次迁移应用程序一个主版本,同时参考 Electron 的 重大更改 文档,查看是否有任何代码需要更新。
17. 验证所有 IPC 消息的 sender
您应始终验证传入 IPC 消息的 sender
属性,以确保您没有对不受信任的渲染器执行操作或发送信息。
为什么?
理论上,所有 Web 框架都可以向主进程发送 IPC 消息,包括在某些场景下的 iframe 和子窗口。如果您的 IPC 消息通过 event.reply
将用户数据返回给发送者,或者执行渲染器无法原生执行的特权操作,则应确保您没有监听第三方 Web 框架。
默认情况下,您应该验证所有 IPC 消息的 sender
。
如何实现?
// Bad
ipcMain.handle('get-secrets', () => {
return getSecrets()
})
// Good
ipcMain.handle('get-secrets', (e) => {
if (!validateSender(e.senderFrame)) return null
return getSecrets()
})
function validateSender (frame) {
// Value the host of the URL using an actual URL parser and an allowlist
if ((new URL(frame.url)).host === 'electronjs.org') return true
return false
}
18. 避免使用 file://
协议,优先使用自定义协议
您应该从自定义协议而不是 file://
协议提供本地页面。
为什么?
file://
协议在 Electron 中比在网页浏览器中获得更多特权,即使在浏览器中,它也与 http/https URL 不同。使用自定义协议可以让您更符合经典 Web URL 的行为,同时在可以加载什么以及何时加载方面保留更多控制权。
在 file://
上运行的页面可以单方面访问您机器上的每个文件,这意味着 XSS 问题可能被用于从用户机器加载任意文件。使用自定义协议可以防止此类问题,因为您可以将协议限制为只提供特定文件集。
如何实现?
按照 protocol.handle
示例学习如何从自定义协议提供文件/内容。
19. 检查可以更改的熔断器 (fuses)
Electron 附带了一些可能很有用但大部分应用程序可能不需要的选项。为了避免构建自己的 Electron 版本,这些选项可以使用 Fuses (熔断器) 来开启或关闭。
为什么?
一些熔断器,例如 runAsNode
和 nodeCliInspect
,允许应用程序在命令行中使用特定环境变量或 CLI 参数运行时表现不同。这些可用于通过您的应用程序在设备上执行任意命令。
这可能允许外部脚本运行它们可能不允许运行的命令,但您的应用程序可能拥有其权限。
如何实现?
我们创建了一个模块,@electron/fuses
,用于方便地翻转这些熔断器。请查看该模块的 README,了解更多使用细节和潜在错误情况,并参考我们文档中的 如何翻转熔断器?。
20. 不要将 Electron API 暴露给不受信任的 Web 内容
您不应在预加载脚本中直接将 Electron 的 API(尤其是 IPC)暴露给不受信任的 Web 内容。
为什么?
暴露像 ipcRenderer.on
这样的原始 API 是危险的,因为它赋予渲染进程直接访问整个 IPC 事件系统的权限,允许它们监听任何 IPC 事件,而不仅仅是为它们准备的事件。
为了避免这种暴露,我们也不能直接传递回调:IPC 事件回调的第一个参数是一个 IpcRendererEvent
对象,其中包含 sender
等属性,提供对底层 ipcRenderer
实例的访问。即使您只监听特定事件,直接传递回调也意味着渲染器可以访问此事件对象。
简而言之,我们希望不受信任的 Web 内容只能访问必要的信息和 API。
如何实现?
// Bad
contextBridge.exposeInMainWorld('electronAPI', {
on: ipcRenderer.on
})
// Also bad
contextBridge.exposeInMainWorld('electronAPI', {
onUpdateCounter: (callback) => ipcRenderer.on('update-counter', callback)
})
// Good
contextBridge.exposeInMainWorld('electronAPI', {
onUpdateCounter: (callback) => ipcRenderer.on('update-counter', (_event, value) => callback(value))
})
有关 contextIsolation
是什么以及如何使用它来保护您的应用程序的更多信息,请参阅 上下文隔离 文档。