-
-
Notifications
You must be signed in to change notification settings - Fork 100
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'v5' into v5-expand-timer-api
- Loading branch information
Showing
19 changed files
with
828 additions
and
646 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,230 @@ | ||
| import { join } from 'node:path'; | ||
| import { BrowserWindow, MessageChannelMain, session } from 'electron'; | ||
|
|
||
| import type { Trigger } from '../../../../types/triggers'; | ||
|
|
||
| const logger = require('../../../logwrapper'); | ||
| const preloadPath = join(__dirname, 'sandbox-preload.js'); | ||
| const htmlPath = join(__dirname, './sandbox.html'); | ||
|
|
||
| const charList = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"; | ||
| const handlers = new Map<string, (...args: unknown[]) => unknown>(); | ||
|
|
||
| interface Sandbox { | ||
| finished: boolean, | ||
| tunnel: Electron.MessagePortMain, | ||
| timeout?: ReturnType<typeof setTimeout>, | ||
| window?: Electron.BrowserWindow, | ||
|
|
||
| resolve?: (...args: unknown[]) => void, | ||
| reject?: (...args: unknown[]) => void | ||
| } | ||
|
|
||
| export const evalSandboxedJs = async (code: string, args: unknown[], metadata: Trigger["metadata"]) => { | ||
| if (<unknown>code instanceof String) { | ||
| code = `${code}`; | ||
| } | ||
| if (typeof code !== 'string' || code === '') { | ||
| return; | ||
| } | ||
|
|
||
| return new Promise((resolve, reject) => { | ||
| let { port1: portToBackend, port2: portToSandbox } = new MessageChannelMain(); | ||
|
|
||
| const sandbox : Sandbox = { | ||
| finished: false, | ||
| tunnel: portToSandbox | ||
| }; | ||
|
|
||
| // Frees all resources related to the sandbox | ||
| const cleanup = () => { | ||
| sandbox.finished = true; | ||
|
|
||
| if (sandbox.timeout) { | ||
| clearTimeout(sandbox.timeout); | ||
| sandbox.timeout = null; | ||
| } | ||
|
|
||
| try { | ||
| sandbox.window.webContents.removeAllListeners(); | ||
| } catch (err) {} | ||
| try { | ||
| sandbox.window.removeAllListeners(); | ||
| sandbox.window.destroy(); | ||
| } catch (err) {} | ||
| sandbox.window = null; | ||
|
|
||
| try { | ||
| sandbox.tunnel.close(); | ||
| sandbox.tunnel.removeAllListeners(); | ||
| } catch (err) {} | ||
| sandbox.tunnel = null; | ||
| portToSandbox = null; | ||
|
|
||
| try { | ||
| portToBackend.close(); | ||
| portToBackend.removeAllListeners(); | ||
| } catch (err) {} | ||
| portToBackend = null; | ||
| }; | ||
|
|
||
| // Called when the sandbox successfully returns a result | ||
| sandbox.resolve = (result: unknown) => { | ||
| if (!sandbox.finished) { | ||
| cleanup(); | ||
| resolve(result); | ||
| } | ||
| }; | ||
|
|
||
| // Called when the sandbox ends with an error | ||
| sandbox.reject = (reason?: string | Error) => { | ||
| if (!sandbox.finished) { | ||
| cleanup(); | ||
| reason = typeof reason === 'string' ? new Error(reason) : reason == null ? new Error('unknown error') : reason; | ||
| reject(reason); | ||
| } | ||
| }; | ||
|
|
||
| // Listen for messages from sandbox | ||
| portToSandbox.on('message', async (event) => { | ||
| if (sandbox.finished) { | ||
| cleanup(); | ||
| return; | ||
| } | ||
| const { id, action, method, parameters, status, result } = event.data; | ||
|
|
||
| // Sandbox returned a result for the evaluation | ||
| if ((id === 0 || id === '0') && action === 'result') { | ||
| if (status === 'ok') { | ||
| sandbox.resolve(result); | ||
| } else if (status === 'error') { | ||
| sandbox.reject(result); | ||
| } | ||
|
|
||
| // Sandbox is leveraging Firebot.* apis | ||
| } else if (action === 'method') { | ||
|
|
||
| const base = { id, action: "result" }; | ||
| if (method === 'metadata') { | ||
| sandbox.tunnel.postMessage({ ...base, status: "ok", result: metadata || {} }); | ||
|
|
||
| } else if (handlers.has(method)) { | ||
| try { | ||
| const result = await handlers.get(method)(...parameters); | ||
| if (sandbox.finished) { | ||
| return; | ||
| } | ||
| sandbox.tunnel.postMessage({ ...base, status: "ok", result }); | ||
| } catch (err) { | ||
| sandbox.tunnel.postMessage({ ...base, status: "error", result: err.message }); | ||
| } | ||
| } else { | ||
| sandbox.tunnel.postMessage({ ...base, status: "error", result: "unknown method"}); | ||
| } | ||
| } | ||
| }); | ||
|
|
||
| // Start listening for messages from sandbox | ||
| portToSandbox.start(); | ||
|
|
||
| // Generate a unique session id for the sandbox; this equates to each sandbox getting its own session data(LocalStorage, cache, etc) | ||
| let sandboxSessionId = '', index = 10; | ||
| while (index) { | ||
| sandboxSessionId += charList[Math.floor(62 * Math.random())]; | ||
| index -= 1; | ||
| } | ||
| sandboxSessionId = `firebot-sandbox-${Date.now()}-${sandboxSessionId}`; | ||
|
|
||
| // Create a new, hidden, browser window | ||
| sandbox.window = new BrowserWindow({ | ||
| show: false, | ||
| title: 'Firebot - $JS Eval Sandbox', | ||
| webPreferences: { | ||
| preload: preloadPath, | ||
|
|
||
| // Sandbox the context | ||
| sandbox: true, | ||
| nodeIntegration: false, | ||
| contextIsolation: true, | ||
|
|
||
| // Use a unique session for each sandbox. | ||
| // Creates a unique local/SessionStorage instance, cache, etc for the sandbox | ||
| session: session.fromPartition(sandboxSessionId, { cache: false }), | ||
|
|
||
| // Loosen web-request restrictions | ||
| webSecurity: false, | ||
|
|
||
| // Tighten restrictions | ||
| // No autoplay without user interaction and since the window is | ||
| // never shown to the user there will never be a user gesture thus | ||
| // no playing of audio or video. | ||
| autoplayPolicy: 'user-gesture-required', | ||
|
|
||
| // Disable abusable and/or irrelevent features | ||
| disableDialogs: true, | ||
| webgl: false, | ||
| images: false, | ||
| enableWebSQL: false | ||
| } | ||
| }); | ||
|
|
||
| // Prevent sandbox js from opening windows | ||
| sandbox.window.webContents.setWindowOpenHandler(() => ({ action: 'deny' })); | ||
|
|
||
| // Prevent sandbox js from navigating away from sandbox page | ||
| sandbox.window.webContents.on('will-navigate', event => event.preventDefault()); | ||
|
|
||
| // Prevent sandbox from altering page title | ||
| sandbox.window.on('page-title-updated', event => event.preventDefault()); | ||
|
|
||
| // Cleanup the sandbox if it becomes unresponsive | ||
| sandbox.window.on('unresponsive', () => sandbox.reject('sandbox unresponsive')); | ||
|
|
||
| // Cleanup the sandbox if the window closes | ||
| sandbox.window.on('closed', () => sandbox.reject('sandbox closed')); | ||
|
|
||
| // Reroute console.* from the sandbox to the logger | ||
| sandbox.window.webContents.on('console-message', (event, level, message) => { | ||
| if (level === 2 && /^%cElectron /i.test(message)) { | ||
| return; | ||
| } | ||
| switch (level) { | ||
| case 1: | ||
| logger.info(`($evalJS Sandbox) ${message}`); | ||
| break; | ||
|
|
||
| case 2: | ||
| logger.warn(`($evalJS Sandbox) ${message}`); | ||
| break; | ||
|
|
||
| case 3: | ||
| logger.error(`($evalJS Sandbox) ${message}`); | ||
| break; | ||
|
|
||
| default: | ||
| logger.verbose(`($evalJS Sandbox) ${message}`); | ||
| } | ||
| }); | ||
|
|
||
| // Wait for the contents of the sandbox window to be ready | ||
| sandbox.window.on('ready-to-show', () => { | ||
|
|
||
| // Give evaluation 15s to resolve | ||
| sandbox.timeout = setTimeout(() => sandbox.reject('eval timed out'), 15000); | ||
|
|
||
| // send the message port the sandbox should use to the preload script | ||
| sandbox.window.webContents.postMessage('firebot-port', null, [portToBackend]); | ||
|
|
||
| // tell sandbox the code to evaluate | ||
| sandbox.tunnel.postMessage({ | ||
| id: 0, | ||
| action: 'method', | ||
| method: 'evaluate', | ||
| parameters: [code, ...args] | ||
| }); | ||
| }); | ||
|
|
||
| // load the sandbox html | ||
| sandbox.window.loadFile(htmlPath); | ||
| }); | ||
| }; |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.