| // Licensed to the Software Freedom Conservancy (SFC) under one |
| // or more contributor license agreements. See the NOTICE file |
| // distributed with this work for additional information |
| // regarding copyright ownership. The SFC licenses this file |
| // to you under the Apache License, Version 2.0 (the |
| // "License"); you may not use this file except in compliance |
| // with the License. You may obtain a copy of the License at |
| // |
| // http://www.apache.org/licenses/LICENSE-2.0 |
| // |
| // Unless required by applicable law or agreed to in writing, |
| // software distributed under the License is distributed on an |
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| // KIND, either express or implied. See the License for the |
| // specific language governing permissions and limitations |
| // under the License. |
| |
| /** |
| * @fileoverview Defines functions for configuring a webdriver proxy: |
| * |
| * const Capabilities = require('./capabilities').Capabilities; |
| * |
| * var capabilities = new Capabilities(); |
| * capabilities.setProxy(proxy.manual({http: 'host:1234'}); |
| */ |
| |
| 'use strict'; |
| |
| var ProxyConfig = require('./capabilities').ProxyConfig; |
| |
| |
| // PUBLIC API |
| |
| |
| /** |
| * Configures WebDriver to bypass all browser proxies. |
| * @return {!ProxyConfig} A new proxy configuration object. |
| */ |
| exports.direct = function() { |
| return {proxyType: 'direct'}; |
| }; |
| |
| |
| /** |
| * Manually configures the browser proxy. The following options are |
| * supported: |
| * |
| * - `ftp`: Proxy host to use for FTP requests |
| * - `http`: Proxy host to use for HTTP requests |
| * - `https`: Proxy host to use for HTTPS requests |
| * - `bypass`: A list of hosts requests should directly connect to, |
| * bypassing any other proxies for that request. May be specified as a |
| * comma separated string, or a list of strings. |
| * |
| * Behavior is undefined for FTP, HTTP, and HTTPS requests if the |
| * corresponding key is omitted from the configuration options. |
| * |
| * @param {{ftp: (string|undefined), |
| * http: (string|undefined), |
| * https: (string|undefined), |
| * bypass: (string|!Array.<string>|undefined)}} options Proxy |
| * configuration options. |
| * @return {!ProxyConfig} A new proxy configuration object. |
| */ |
| exports.manual = function(options) { |
| // TODO(jleyba): Figure out why the Closure compiler does not think this is |
| // a ProxyConfig record without the cast. |
| return /** @type {!ProxyConfig} */({ |
| proxyType: 'manual', |
| ftpProxy: options.ftp, |
| httpProxy: options.http, |
| sslProxy: options.https, |
| noProxy: Array.isArray(options.bypass) ? |
| options.bypass.join(',') : options.bypass |
| }); |
| }; |
| |
| |
| /** |
| * Creates a proxy configuration for a socks proxy. |
| * |
| * __Example:__ |
| * |
| * const {Capabilities} = require('selenium-webdriver'); |
| * const proxy = require('selenium-webdriver/lib/proxy'); |
| * |
| * let capabilities = new Capabilities(); |
| * capabilities.setProxy(proxy.socks('localhost:1234', 'bob', 'password')); |
| * |
| * |
| * @param {string} host The proxy host, in the form `hostname:port`. |
| * @param {string} username The user name to authenticate as. |
| * @param {string} password The password to authenticate with. |
| * @return {!ProxyConfig} A new proxy configuration object. |
| * @see https://en.wikipedia.org/wiki/SOCKS |
| */ |
| exports.socks = function(host, username, password) { |
| return /** @type {!ProxyConfig} */({ |
| proxyType: 'manual', |
| socksProxy: host, |
| socksUsername: username, |
| socksPassword: password |
| }); |
| }; |
| |
| |
| /** |
| * Configures WebDriver to configure the browser proxy using the PAC file at |
| * the given URL. |
| * @param {string} url URL for the PAC proxy to use. |
| * @return {!ProxyConfig} A new proxy configuration object. |
| */ |
| exports.pac = function(url) { |
| return { |
| proxyType: 'pac', |
| proxyAutoconfigUrl: url |
| }; |
| }; |
| |
| |
| /** |
| * Configures WebDriver to use the current system's proxy. |
| * @return {!ProxyConfig} A new proxy configuration object. |
| */ |
| exports.system = function() { |
| return {proxyType: 'system'}; |
| }; |