Add support for proxies that require basic authentication

Author: noahpfichter

ElectronNET.API/Entities/BrowserViewConstructorOptions.cs

@@ -9,5 +9,17 @@ public class BrowserViewConstructorOptions
         /// See BrowserWindow.
         /// </summary>
         public WebPreferences WebPreferences { get; set; }
+
+        /// <summary>
+        /// A proxy to set on creation in the format host:port.
+        /// The proxy can be alternatively set using the BrowserView.WebContents.SetProxyAsync function.
+        /// </summary>
+        public string Proxy { get; set; }
+
+        /// <summary>
+        /// The credentials of the Proxy in the format username:password.
+        /// These will only be used if the Proxy field is also set.
+        /// </summary>
+        public string ProxyCredentials { get; set; }
     }
 }

ElectronNET.API/Entities/BrowserWindowOptions.cs

@@ -258,5 +258,17 @@ public class BrowserWindowOptions
         /// Settings of web page's features.
         /// </summary>
         public WebPreferences WebPreferences { get; set; }
+
+        /// <summary>
+        /// A proxy to set on creation in the format host:port.
+        /// The proxy can be alternatively set using the BrowserWindow.WebContents.SetProxyAsync function.
+        /// </summary>
+        public string Proxy { get; set; }
+
+        /// <summary>
+        /// The credentials of the Proxy in the format username:password.
+        /// These will only be used if the Proxy field is also set.
+        /// </summary>
+        public string ProxyCredentials { get; set; }
     }
 }

ElectronNET.Host/api/browserView.js

@@ -1,8 +1,9 @@
 import { BrowserView } from 'electron';
 const browserViews: BrowserView[] = (global['browserViews'] = global['browserViews'] || []) as BrowserView[];
 let browserView: BrowserView, electronSocket;
+const proxyToCredentialsMap: { [proxy: string]: string } = (global['proxyToCredentialsMap'] = global['proxyToCredentialsMap'] || []) as { [proxy: string]: string };
 
-const browserViewApi = (socket: SocketIO.Socket) => {
+const browserViewApi = (socket: SocketIO.Socket, app: Electron.App) => {
     electronSocket = socket;
 
     socket.on('createBrowserView', (options) => {
@@ -12,6 +13,15 @@ const browserViewApi = (socket: SocketIO.Socket) => {
 
         browserView = new BrowserView(options);
         browserView['id'] = browserViews.length + 1;
+
+        if (options.proxy) {
+            browserView.webContents.session.setProxy({proxyRules: options.proxy});
+        }
+
+        if (options.proxy && options.proxyCredentials) {
+            proxyToCredentialsMap[options.proxy] = options.proxyCredentials;
+        }
+
         browserViews.push(browserView);
 
         electronSocket.emit('BrowserViewCreated', browserView['id']);

ElectronNET.Host/api/browserView.js.map

@@ -5,8 +5,23 @@ const windows: Electron.BrowserWindow[] = (global['browserWindows'] = global['br
 let readyToShowWindowsIds: number[] = [];
 let window, lastOptions, electronSocket;
 let mainWindowURL;
+const proxyToCredentialsMap: { [proxy: string]: string } = (global['proxyToCredentialsMap'] = global['proxyToCredentialsMap'] || []) as { [proxy: string]: string };
+
 export = (socket: SocketIO.Socket, app: Electron.App) => {
     electronSocket = socket;
+
+    app.on('login', (event, webContents, request, authInfo, callback) => {
+        if (authInfo.isProxy) {
+            let proxy = `${authInfo.host}:${authInfo.port}`
+            if (proxy in proxyToCredentialsMap && proxyToCredentialsMap[proxy].split(':').length === 2) {
+                event.preventDefault()
+                let user = proxyToCredentialsMap[proxy].split(':')[0]
+                let pass = proxyToCredentialsMap[proxy].split(':')[1]
+                callback(user, pass)
+            }
+        }
+    })
+
     socket.on('register-browserWindow-ready-to-show', (id) => {
         if (readyToShowWindowsIds.includes(id)) {
             readyToShowWindowsIds = readyToShowWindowsIds.filter(value => value !== id);
@@ -213,6 +228,14 @@ export = (socket: SocketIO.Socket, app: Electron.App) => {
             window = new BrowserWindow(options);
         }
 
+        if (options.proxy) {
+            window.webContents.session.setProxy({proxyRules: options.proxy});
+        }
+
+        if (options.proxy && options.proxyCredentials) {
+            proxyToCredentialsMap[options.proxy] = options.proxyCredentials;
+        }
+
         window.on('ready-to-show', () => {
             if (readyToShowWindowsIds.includes(window.id)) {
                 readyToShowWindowsIds = readyToShowWindowsIds.filter(value => value !== window.id);

ElectronNET.Host/api/browserView.ts

@@ -201,7 +201,7 @@ function startSocketApiBridge(port) {
         if (shellApi === undefined) shellApi = require('./api/shell')(socket);
         if (screen === undefined) screen = require('./api/screen')(socket);
         if (clipboard === undefined) clipboard = require('./api/clipboard')(socket);
-        if (browserView === undefined) browserView = require('./api/browserView').browserViewApi(socket);
+        if (browserView === undefined) browserView = require('./api/browserView').browserViewApi(socket, app);
         if (powerMonitor === undefined) powerMonitor = require('./api/powerMonitor')(socket);
         if (nativeTheme === undefined) nativeTheme = require('./api/nativeTheme')(socket);
         if (dock === undefined) dock = require('./api/dock')(socket);