安全
有关如何正确披露 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://协议,更倾向于使用自定义协议 - 检查您可以更改哪些熔断器
- 不向不受信任的 Web 内容公开 Electron API
为了自动化检测错误配置和不安全模式,可以使用 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。
请注意,通过设置 nodeIntegration: true 禁用渲染器进程的上下文隔离 也会禁用该进程的进程沙盒。 请参阅下文。
有关 contextIsolation 是什么以及如何启用它的更多信息,请参阅我们的专用 上下文隔离 文档。
4. 启用进程沙盒
此建议是 Electron 自 20.0.0 以来的默认行为。
此外,可以对所有渲染器进程应用程序强制执行进程沙盒:全局启用沙盒
禁用上下文隔离(见上文)也会禁用进程沙盒,无论默认值、sandbox: false 还是全局启用沙盒!
沙盒 是 Chromium 的一项功能,它使用操作系统来显著限制渲染器进程可以访问的内容。 您应该在所有渲染器中启用沙盒。 不建议在未沙盒化的进程(包括主进程)中加载、读取或处理任何不受信任的内容。
有关进程沙盒是什么以及如何启用它的更多信息,请参阅我们的专用 进程沙盒 文档。
5. 处理来自远程内容的会话权限请求
您可能在使用 Chrome 时见过权限请求:它们会在网站尝试使用用户必须手动批准的功能(如通知)时弹出。
该 API 基于 Chromium 权限 API,并实现相同类型的权限。
为什么?
默认情况下,除非开发人员手动配置了自定义处理程序,否则 Electron 将自动批准所有权限请求。 虽然是一个可靠的默认值,但注重安全的开发人员可能希望假设完全相反的情况。
如何实现?
const { session } = require('electron')
const { URL } = require('node: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 元标签
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. 不将 allowpopups 用于 WebViews
此建议是 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 { app } = require('electron')
const { URL } = require('node:url')
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 中比在 Web 浏览器中获得更多的特权,即使在浏览器中,它也与 http/https URL 不同。 使用自定义协议可以使您更符合经典的 Web URL 行为,同时对可以加载什么以及何时加载拥有更多控制权。
在 file:// 上运行的页面可以单方面访问您机器上的每个文件,这意味着 XSS 问题可以用于从用户机器加载任意文件。 使用自定义协议可以防止此类问题,因为您可以将协议限制为仅提供一组特定的文件。
如何实现?
按照 protocol.handle 示例学习如何从自定义协议提供文件/内容。
19. 检查您可以更改哪些熔断器
Electron 附带了一些可能有用但大部分应用程序可能不需要的选项。 为了避免必须构建您自己的 Electron 版本,可以使用 熔断器 将它们打开或关闭。
为什么?
一些熔断器,例如 runAsNode 和 nodeCliInspect,允许应用程序在使用特定的环境变量或 CLI 参数从命令行运行时表现不同。 这些可以用于通过您的应用程序在设备上执行命令。
这可能允许外部脚本运行它们可能不允许的命令,但您的应用程序可能拥有这些命令的权限。
如何实现?
@electron/fuses 是我们制作的一个模块,用于轻松切换这些熔断器。 查看该模块的 README 以获取有关用法和潜在错误情况的更多详细信息,并参阅我们文档中的 如何切换熔断器?。
20. 不向不受信任的 Web 内容公开 Electron API
您不应在预加载脚本中直接将 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 是什么以及如何使用它来保护您的应用程序的更多信息,请参阅 上下文隔离 文档。