电子 require() 未定义

IT技术 javascript html node.js electron
2021-01-22 19:49:02

我正在为自己的目的创建一个 Electron 应用程序。我的问题是,当我在 HTML 页面中使用节点函数时,它会引发以下错误:

'require()' 未定义。

有没有办法在我的所有 HTML 页面中使用 Node 功能?如果可能,请给我一个如何执行此操作的示例或提供链接。以下是我尝试在 HTML 页面中使用的变量:

  var app = require('electron').remote; 
  var dialog = app.dialog;
  var fs = require('fs');

这些是我在 Electron 中所有 HTML 窗口中使用的值。

6个回答

从第 5 版开始,默认值nodeIntegration从 true 更改为 false。您可以在创建浏览器窗口时启用它:

app.on('ready', () => {
    mainWindow = new BrowserWindow({
        webPreferences: {
            nodeIntegration: true,
            contextIsolation: false,
        }
    });
});
不在 10.1.15 上工作,仍然收到安全警告。
2021-03-12 19:49:02
这让我发疯了。我的应用程序不会显示任何错误并且没有运行我的代码。正是当我使用 try catch 块来拦截最终将我带到这里的错误时。
2021-03-13 19:49:02
@PauloHenriquenodeIntegration: true仅当您在应用程序上执行一些不受信任的远程代码时才存在安全风险。例如,假设您的应用程序打开了第三方网页。这将是一个安全风险,因为第三方网页将可以访问节点运行时并可以在您用户的文件系统上运行一些恶意代码。在这种情况下,设置nodeIntegration: false. 如果你的应用没有显示任何远程内容,或者只显示受信任的内容,那么设置nodeIntegration: true就可以了。
2021-03-22 19:49:02
我已经检查了电子 12.0 发布的文档 electronjs.org/docs/break-changes并获得以前的行为 contextIssolation 应该是假的,谢谢
2021-03-29 19:49:02
@PauloHenrique - 如果您想遵循并创建一个安全的应用程序(遵守安全最佳实践),请按照我在此评论中描述的设置进行操作:github.com/electron/electron/issues/9920#issuecomment-575839738
2021-04-09 19:49:02

我希望这个答案得到一些关注,因为这里的大部分答案都会在您的电子应用程序中留下很大的安全漏洞。事实上,这个答案本质上是您应该require()在电子应用程序中使用的内容。(只有一个新的电子 API 使它在 v7 中更简洁一些)。

使用最新的电子 API 在 github 中编写了详细的解释/解决方案,说明您如何require()做某事,但我将在这里简要解释为什么您应该遵循使用预加载脚本、contextBridge 和 ipc 的方法。

问题

Electron 应用程序很棒,因为我们可以使用 node,但这种能力是一把双刃剑。如果我们不小心,我们会通过我们的应用程序授予某人访问节点的权限,而对于节点,坏人可能会损坏您的机器或删除您的操作系统文件(除其他外,我想)。

正如@raddevus 在评论中提出的,这在加载远程内容必要的如果您的电子应用程序完全离线/本地,那么您可能只需打开即可但是,我仍然会选择继续为使用您的应用程序的意外/恶意用户提供保护,并防止任何可能安装在您机器上的恶意软件与您的电子应用程序交互并使用攻击向量(非常罕见) ,但可能会发生)!nodeIntegration:truenodeIntegration:falsenodeIntegration:true

问题是什么

当您(以下任一情况)时,就会出现此问题:

  1. nodeIntegration:true启用
  2. 使用remotemodule

所有这些问题都使您可以从渲染器进程不间断地访问节点。如果您的渲染器进程被劫持,您可以认为一切都已丢失。

我们的解决方案是什么

解决方案是不让渲染器直接访问节点(即require()),而是让我们的电子主进程访问require,并且在我们的渲染器进程需要使用的任何时候require,将请求编组到主进程。

在最新版本(7+)Electron 中的工作方式是在渲染器端设置ipcRenderer绑定,在主端设置ipcMain绑定。在 ipcMain 绑定中,我们设置了使用module的侦听器方法require()这很好,因为我们的主进程可以require随心所欲。

我们使用contextBridge将 ipcRenderer 绑定传递给我们的应用程序代码(使用),因此当我们的应用程序需要使用requiremain 中d module时,它通过 IPC(进程间通信)发送消息并运行主进程一些代码,然后我们发送一条带有结果的消息。

粗略地说,这就是你想要做的。

主文件

const {
  app,
  BrowserWindow,
  ipcMain
} = require("electron");
const path = require("path");
const fs = require("fs");

// Keep a global reference of the window object, if you don't, the window will
// be closed automatically when the JavaScript object is garbage collected.
let win;

async function createWindow() {

  // Create the browser window.
  win = new BrowserWindow({
    width: 800,
    height: 600,
    webPreferences: {
      nodeIntegration: false, // is default value after Electron v5
      contextIsolation: true, // protect against prototype pollution
      enableRemoteModule: false, // turn off remote
      preload: path.join(__dirname, "preload.js") // use a preload script
    }
  });

  // Load app
  win.loadFile(path.join(__dirname, "dist/index.html"));

  // rest of code..
}

app.on("ready", createWindow);

ipcMain.on("toMain", (event, args) => {
  fs.readFile("path/to/file", (error, data) => {
    // Do something with file contents

    // Send result back to renderer process
    win.webContents.send("fromMain", responseObj);
  });
});

预加载.js

const {
    contextBridge,
    ipcRenderer
} = require("electron");

// Expose protected methods that allow the renderer process to use
// the ipcRenderer without exposing the entire object
contextBridge.exposeInMainWorld(
    "api", {
        send: (channel, data) => {
            // whitelist channels
            let validChannels = ["toMain"];
            if (validChannels.includes(channel)) {
                ipcRenderer.send(channel, data);
            }
        },
        receive: (channel, func) => {
            let validChannels = ["fromMain"];
            if (validChannels.includes(channel)) {
                // Deliberately strip event as it includes `sender` 
                ipcRenderer.on(channel, (event, ...args) => func(...args));
            }
        }
    }
);

索引.html

<!doctype html>
<html lang="en-US">
<head>
    <meta charset="utf-8"/>
    <title>Title</title>
</head>
<body>
    <script>
        window.api.receive("fromMain", (data) => {
            console.log(`Received ${data} from main process`);
        });
        window.api.send("toMain", "some data");
    </script>
</body>
</html>

免责声明

我是secure-electron-template构建电子应用程序的安全模板的作者我关心这个话题,并且已经为此工作了几个星期(此时此刻)。

我是新的 ElectronJS 开发人员,正在通过 PluralSite 教程工作,该教程不再运行 bec 节点集成设置已更改。你的帖子非常好,我也在阅读你相关的 Github 帖子和相关的官方电子安全文档。完全正确地设置节点集成(因此应用程序将正常工作并且是安全的)有很多活动部分(特别是对于新手)。以下来自 Electron 文档的句子“在加载远程内容的任何渲染器(BrowserWindow、BrowserView 或 <webview>)都不要启用 Node.js 集成是最重要的 ”(我的重点)
2021-03-18 19:49:02
我假设反之亦然......“如果 BrowserWindow 不加载远程内容,那么包含 Node 集成是安全的”。如果这句话是真的,您可能需要稍微修改您的帖子以强调这一点,因为在我的情况下,我有两个应用程序属于该类别并且不需要删除节点集成。谢谢你的帮助。
2021-03-20 19:49:02
@raddevus 谢谢,我希望该模板可以帮助您构建安全的电子应用程序(如果您选择使用它)!是的,你的重点是正确的。但是,我会说禁用nodeIntegration可以防止用户在使用应用程序时意外或故意对自己造成伤害,并且是一种额外的保护措施,以防某些恶意软件附加到您的电子进程并能够在知道此向量已打开的情况下执行 XSS(令人难以置信)很少见,但这就是我的大脑去的地方)!
2021-03-28 19:49:02
@raddevus 谢谢,我正在更新我的帖子以反映您的评论。
2021-03-30 19:49:02
我可能有点慢,但我发现这个答案令人困惑。事实上,电子文档中关于上下文隔离页面对其进行了更好的解释,并指出@Mateen Ulhaq 的答案中使用的稍微简单的方法仍然不理想,默认情况下在 Electron 12 中不起作用。
2021-04-10 19:49:02

出于安全原因,您应该保留nodeIntegration: false并使用预加载脚本,通过 window 变量将 Node/Electron API 中您需要的内容暴露给渲染器进程(视图)。电子文档

预加载脚本继续可以访问require和其他 Node.js 功能


例子

主文件

const mainWindow = new BrowserWindow({
  webPreferences: {
    preload: path.join(app.getAppPath(), 'preload.js')
  }
})

预加载.js

const { remote } = require('electron');

let currWindow = remote.BrowserWindow.getFocusedWindow();

window.closeCurrentWindow = function(){
  currWindow.close();
}

渲染器.js

let closebtn = document.getElementById('closebtn');

closebtn.addEventListener('click', (e) => {
  e.preventDefault();
  window.closeCurrentWindow();
});
在较新版本的电子中,您需要添加 enableRemoteModule: true,在创建windo 以启用远程未定义时
2021-03-13 19:49:02
如果您和我一样是电子新手:渲染器文件通常以经典方式包含在 html 中: <script src="./renderer.js"></script>
2021-03-18 19:49:02
自 2019 年以来,您链接的文档已被标记为“已弃用”。(他们应该使用鲜红色的横幅,而不是这条带引号的灰色消息。)
2021-03-20 19:49:02
这个话题上手太奇怪了,应该只是从一开始就谈论预加载,安全大惊小怪是什么。我们只是试图遵循教程,如果不需要,那又怎样,只需在文档中说明什么。顺便说一句,我喜欢这个答案。
2021-03-25 19:49:02
如果官方文档不可require()为什么在渲染器中require使用?
2021-04-05 19:49:02

首先,@Sathiraumesh 解决方案让您的电子应用程序面临巨大的安全问题。想象一下,您的应用程序正在向 中添加一些额外的功能messenger.com,例如,当您有未读消息时,工具栏的图标会发生变化或闪烁。所以在你的main.js文件中,你像这样创建新的 BrowserWindow(注意我故意拼错了 messenger.com):

app.on('ready', () => {
    const mainWindow = new BrowserWindow({
        webPreferences: {
            nodeIntegration: true
        }
    });
    mainWindow.loadURL(`https://messengre.com`);
});

如果messengre.com是一个恶意网站,想要损害您的计算机怎么办如果您设置nodeIntegration: true此站点可以访问您的本地文件系统并可以执行以下操作:

require('child_process').exec('rm -r ~/');

你的主目录不见了。

解决方案
只公开你需要的东西,而不是一切。这是通过使用require语句预加载 javascript 代码来实现的

// main.js
app.on('ready', () => {
    const mainWindow = new BrowserWindow({
        webPreferences: {
            preload: `${__dirname}/preload.js`
        }
    });
    mainWindow.loadURL(`https://messengre.com`);
});
// preload.js
window.ipcRenderer = require('electron').ipcRenderer;
// index.html
<script>
    window.ipcRenderer.send('channel', data);
</script>

现在可怕的messengre.com无法删除您的整个文件系统。

看起来 Electron 的安全性是这样发展的(来源)。

Electron 1 nodeIntegration默认为 true

Renderer 拥有对 Node API 的完全访问权——如果 Renderer 加载远程代码,则存在巨大的安全风险。

Electron 5 nodeIntegration默认为 false

当设置为 false 时,预加载脚本用于向渲染器公开特定的 API。(无论nodeIntegration的值如何,预加载脚本始终可以访问节点 API

//preload.js
window.api = {
    deleteFile: f => require('fs').unlink(f)
}

Electron 5 contextIsolation默认为 true(实际上在 Electron 11 中仍然默认为 false)

这会导致预加载脚本在单独的上下文中运行。你不能再这样做了window.api = ...你现在必须做:

//preload.js
const { contextBridge } = require('electron')

contextBridge.exposeInMainWorld('api', {
    deleteFile: f => require('fs').unlink(f)
})

require()沙盒渲染器中的Electron 6 ing 节点内置程序不再隐式加载远程版本

如果 Renderer 已sandbox设置为 true,则必须执行以下操作:

//preload.js
const { contextBridge, remote } = require('electron')

contextBridge.exposeInMainWorld('api', {
    deleteFile: f => remote.require('fs').unlink(f)
})

Electron 10 enableRemoteModule默认为 false(远程module在 Electron 12 中已弃用)

remote当您需要从沙盒渲染器访问 Node API 时使用module(如上例所示);或者当您需要访问仅适用于主进程(例如对话框、菜单)的 Electron API 时。如果没有remote,您将需要编写如下所示的显式 IPC 处理程序。

//preload.js
const { contextBridge, ipcRenderer } = require('electron')

contextBridge.exposeInMainWorld('api', {
    displayMessage: text => ipcRenderer.invoke("displayMessage", text)
})

//main.js
const { ipcMain, dialog } = require('electron')

ipcMain.handle("displayMessage", text => dialog.showMessageBox(text))

Electron 10 弃用 nodeIntegration标志(在 Electron 12 中删除)

推荐

始终设置{nodeIntegration: false, contextIsolation: true, enableRemoteModule: false}

为了最大的安全性,设置{sandbox: true}. 您的预加载脚本将不得不使用 IPC 调用 Main 进程来完成所有工作

如果sandbox为 false,则您的预加载脚本可以直接访问 Node API,如require('fs').readFile. 只要你不这样做,你就是安全的:

//bad
contextBridge.exposeInMainWorld('api', {
    readFile: require('fs').readFile
})