import { BrowserWindow, WebPreferences } from 'electron/main'; import { expect } from 'chai'; import * as fs from 'node:fs/promises'; import * as http from 'node:http'; import * as path from 'node:path'; import { setTimeout } from 'node:timers/promises'; import { emittedUntil } from './lib/events-helpers'; import { listen } from './lib/spec-helpers'; import { closeWindow } from './lib/window-helpers'; const messageContainsSecurityWarning = (event: Event, level: number, message: string) => { return message.includes('Electron Security Warning'); }; const isLoaded = (event: Event, level: number, message: string) => { return (message === 'loaded'); }; describe('security warnings', () => { let server: http.Server; let w: BrowserWindow; let useCsp = true; let serverUrl: string; before(async () => { // Create HTTP Server server = http.createServer(async (request, response) => { const uri = new URL(request.url!, `http://${request.headers.host}`).pathname!; let filename = path.join(__dirname, 'fixtures', 'pages', uri); try { const stats = await fs.stat(filename); if (stats.isDirectory()) { filename += '/index.html'; } const file = await fs.readFile(filename, 'binary'); const cspHeaders = [ ...(useCsp ? ['script-src \'self\' \'unsafe-inline\''] : []) ]; response.writeHead(200, { 'Content-Security-Policy': cspHeaders }); response.write(file, 'binary'); } catch { response.writeHead(404, { 'Content-Type': 'text/plain' }); } response.end(); }); serverUrl = `http://localhost2:${(await listen(server)).port}`; }); after(() => { // Close server server.close(); server = null as unknown as any; }); afterEach(async () => { useCsp = true; await closeWindow(w); w = null as unknown as any; }); it('should warn about Node.js integration with remote content', async () => { w = new BrowserWindow({ show: false, webPreferences: { nodeIntegration: true, contextIsolation: false } }); w.loadURL(`${serverUrl}/base-page-security.html`); const [,, message] = await emittedUntil(w.webContents, 'console-message', messageContainsSecurityWarning); expect(message).to.include('Node.js Integration with Remote Content'); }); it('should not warn about Node.js integration with remote content from localhost', async () => { w = new BrowserWindow({ show: false, webPreferences: { nodeIntegration: true } }); w.loadURL(`${serverUrl}/base-page-security-onload-message.html`); const [,, message] = await emittedUntil(w.webContents, 'console-message', isLoaded); expect(message).to.not.include('Node.js Integration with Remote Content'); }); const generateSpecs = (description: string, webPreferences: WebPreferences) => { describe(description, () => { it('should warn about disabled webSecurity', async () => { w = new BrowserWindow({ show: false, webPreferences: { webSecurity: false, ...webPreferences } }); w.loadURL(`${serverUrl}/base-page-security.html`); const [,, message] = await emittedUntil(w.webContents, 'console-message', messageContainsSecurityWarning); expect(message).to.include('Disabled webSecurity'); }); it('should warn about insecure Content-Security-Policy', async () => { w = new BrowserWindow({ show: false, webPreferences }); useCsp = false; w.loadURL(`${serverUrl}/base-page-security.html`); const [,, message] = await emittedUntil(w.webContents, 'console-message', messageContainsSecurityWarning); expect(message).to.include('Insecure Content-Security-Policy'); }); it('should not warn about secure Content-Security-Policy', async () => { w = new BrowserWindow({ show: false, webPreferences }); useCsp = true; w.loadURL(`${serverUrl}/base-page-security.html`); let didNotWarn = true; w.webContents.on('console-message', () => { didNotWarn = false; }); await setTimeout(500); expect(didNotWarn).to.equal(true); }); it('should warn about allowRunningInsecureContent', async () => { w = new BrowserWindow({ show: false, webPreferences: { allowRunningInsecureContent: true, ...webPreferences } }); w.loadURL(`${serverUrl}/base-page-security.html`); const [,, message] = await emittedUntil(w.webContents, 'console-message', messageContainsSecurityWarning); expect(message).to.include('allowRunningInsecureContent'); }); it('should warn about experimentalFeatures', async () => { w = new BrowserWindow({ show: false, webPreferences: { experimentalFeatures: true, ...webPreferences } }); w.loadURL(`${serverUrl}/base-page-security.html`); const [,, message] = await emittedUntil(w.webContents, 'console-message', messageContainsSecurityWarning); expect(message).to.include('experimentalFeatures'); }); it('should warn about enableBlinkFeatures', async () => { w = new BrowserWindow({ show: false, webPreferences: { enableBlinkFeatures: 'my-cool-feature', ...webPreferences } }); w.loadURL(`${serverUrl}/base-page-security.html`); const [,, message] = await emittedUntil(w.webContents, 'console-message', messageContainsSecurityWarning); expect(message).to.include('enableBlinkFeatures'); }); it('should warn about allowpopups', async () => { w = new BrowserWindow({ show: false, webPreferences }); w.loadURL(`${serverUrl}/webview-allowpopups.html`); const [,, message] = await emittedUntil(w.webContents, 'console-message', messageContainsSecurityWarning); expect(message).to.include('allowpopups'); }); it('should warn about insecure resources', async () => { w = new BrowserWindow({ show: false, webPreferences }); w.loadURL(`${serverUrl}/insecure-resources.html`); const [,, message] = await emittedUntil(w.webContents, 'console-message', messageContainsSecurityWarning); expect(message).to.include('Insecure Resources'); }); it('should not warn about loading insecure-resources.html from localhost', async () => { w = new BrowserWindow({ show: false, webPreferences }); w.loadURL(`${serverUrl}/insecure-resources.html`); const [,, message] = await emittedUntil(w.webContents, 'console-message', messageContainsSecurityWarning); expect(message).to.not.include('insecure-resources.html'); }); }); }; generateSpecs('without sandbox', { contextIsolation: false }); generateSpecs('with sandbox', { sandbox: true, contextIsolation: false }); });