安全
有关如何正确披露 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://
协议,优先使用自定义协议 - 检查哪些熔断器可以更改
- 不要将 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()
方法创建新的 BrowserWindow
。否则,<webview>
标签不允许创建新窗口。
为什么?
如果您不需要弹出窗口,最好默认不允许创建新的 BrowserWindow
。这遵循最小必要访问原则:除非您知道某个网站需要该功能,否则不要让它创建新的弹出窗口。
如何做?
<!-- 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. 禁用或限制导航
如果您的应用程序不需要导航,或者只需要导航到已知页面,则最好将导航完全限制在该已知范围内,禁止任何其他类型的导航。
为什么?
导航是常见的攻击媒介。如果攻击者可以说服您的应用程序导航离开当前页面,他们可能会强制您的应用程序打开 Internet 上的网站。即使您的 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 的 重大变更(Breaking Changes) 文档,查看是否有代码需要更新。
17. 验证所有 IPC 消息的 sender
您应始终验证传入 IPC 消息的 sender
属性,以确保您不会对不受信任的渲染器执行操作或向其发送信息。
为什么?
理论上,所有 Web 框架都可以向主进程发送 IPC 消息,包括在某些情况下的 iframe 和子窗口。 如果您有一个通过 event.reply
向发送方返回用户数据或执行渲染器本身无法执行的特权操作的 IPC 消息,您应确保不监听来自第三方 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 中比在 Web 浏览器中获得更多权限,即使在浏览器中,它与 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 内容。
为什么?
暴露原始 API,例如 ipcRenderer.on
,是很危险的,因为它允许渲染器进程直接访问整个 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
是什么以及如何使用它来保护您的应用的更多信息,请参阅 上下文隔离 (Context Isolation) 文档。