15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2011 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef NET_PROXY_PROXY_SERVER_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define NET_PROXY_PROXY_SERVER_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "build/build_config.h" 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined(OS_MACOSX) 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <CoreFoundation/CoreFoundation.h> 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string> 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "net/base/host_port_pair.h" 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "net/base/net_export.h" 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace net { 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// ProxyServer encodes the {type, host, port} of a proxy server. 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// ProxyServer is immutable. 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class NET_EXPORT ProxyServer { 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The type of proxy. These are defined as bit flags so they can be ORed 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // together to pass as the |scheme_bit_field| argument to 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // ProxyService::RemoveProxiesWithoutScheme(). 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) enum Scheme { 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SCHEME_INVALID = 1 << 0, 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SCHEME_DIRECT = 1 << 1, 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SCHEME_HTTP = 1 << 2, 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SCHEME_SOCKS4 = 1 << 3, 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SCHEME_SOCKS5 = 1 << 4, 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SCHEME_HTTPS = 1 << 5, 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Default copy-constructor and assignment operator are OK! 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Constructs an invalid ProxyServer. 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ProxyServer() : scheme_(SCHEME_INVALID) {} 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ProxyServer(Scheme scheme, const HostPortPair& host_port_pair); 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool is_valid() const { return scheme_ != SCHEME_INVALID; } 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Gets the proxy's scheme (i.e. SOCKS4, SOCKS5, HTTP) 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Scheme scheme() const { return scheme_; } 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns true if this ProxyServer is actually just a DIRECT connection. 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool is_direct() const { return scheme_ == SCHEME_DIRECT; } 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns true if this ProxyServer is an HTTP proxy. 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool is_http() const { return scheme_ == SCHEME_HTTP; } 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns true if this ProxyServer is an HTTPS proxy. 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool is_https() const { return scheme_ == SCHEME_HTTPS; } 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns true if this ProxyServer is a SOCKS proxy. 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool is_socks() const { 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return scheme_ == SCHEME_SOCKS4 || scheme_ == SCHEME_SOCKS5; 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const HostPortPair& host_port_pair() const; 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Parses from an input with format: 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // [<scheme>"://"]<server>[":"<port>] 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Both <scheme> and <port> are optional. If <scheme> is omitted, it will be 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // assumed as |default_scheme|. If <port> is omitted, it will be assumed as 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the default port for the chosen scheme (80 for "http", 1080 for "socks"). 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If parsing fails the instance will be set to invalid. 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Examples (for |default_scheme| = SCHEME_HTTP ): 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // "foopy" {scheme=HTTP, host="foopy", port=80} 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // "socks://foopy" {scheme=SOCKS5, host="foopy", port=1080} 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // "socks4://foopy" {scheme=SOCKS4, host="foopy", port=1080} 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // "socks5://foopy" {scheme=SOCKS5, host="foopy", port=1080} 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // "http://foopy:17" {scheme=HTTP, host="foopy", port=17} 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // "https://foopy:17" {scheme=HTTPS, host="foopy", port=17} 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // "direct://" {scheme=DIRECT} 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // "foopy:X" INVALID -- bad port. 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static ProxyServer FromURI(const std::string& uri, Scheme default_scheme); 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static ProxyServer FromURI(std::string::const_iterator uri_begin, 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string::const_iterator uri_end, 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Scheme default_scheme); 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Formats as a URI string. This does the reverse of FromURI. 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string ToURI() const; 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Parses from a PAC string result. 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If <port> is omitted, it will be assumed as the default port for the 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // chosen scheme (80 for "http", 1080 for "socks"). 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If parsing fails the instance will be set to invalid. 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Examples: 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // "PROXY foopy:19" {scheme=HTTP, host="foopy", port=19} 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // "DIRECT" {scheme=DIRECT} 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // "SOCKS5 foopy" {scheme=SOCKS5, host="foopy", port=1080} 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // "HTTPS foopy:123" {scheme=HTTPS, host="foopy", port=123} 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // "BLAH xxx:xx" INVALID 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static ProxyServer FromPacString(const std::string& pac_string); 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static ProxyServer FromPacString(std::string::const_iterator pac_string_begin, 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string::const_iterator pac_string_end); 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns a ProxyServer representing DIRECT connections. 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static ProxyServer Direct() { 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return ProxyServer(SCHEME_DIRECT, HostPortPair()); 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined(OS_MACOSX) 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Utility function to pull out a host/port pair from a dictionary and return 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // it as a ProxyServer object. Pass in a dictionary that has a value for the 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // host key and optionally a value for the port key. In the error condition 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // where the host value is especially malformed, returns an invalid 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // ProxyServer. 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static ProxyServer FromDictionary(Scheme scheme, 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CFDictionaryRef dict, 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CFStringRef host_key, 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CFStringRef port_key); 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Formats as a PAC result entry. This does the reverse of FromPacString(). 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string ToPacString() const; 1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the default port number for a proxy server with the specified 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // scheme. Returns -1 if unknown. 1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static int GetDefaultPortForScheme(Scheme scheme); 1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Parses the proxy scheme from a URL-like representation, to a 1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // ProxyServer::Scheme. This corresponds with the values used in 1335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // ProxyServer::ToURI(). If no type could be matched, returns SCHEME_INVALID. 1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |scheme| can be one of http, https, socks, socks4, socks5, direct. 1355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static Scheme GetSchemeFromURI(const std::string& scheme); 1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool operator==(const ProxyServer& other) const { 1385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return scheme_ == other.scheme_ && 1395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) host_port_pair_.Equals(other.host_port_pair_); 1405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Comparator function so this can be placed in a std::map. 1435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool operator<(const ProxyServer& other) const { 1445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (scheme_ != other.scheme_) 1455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return scheme_ < other.scheme_; 1465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return host_port_pair_ < other.host_port_pair_; 1475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 149f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)#if defined(SPDY_PROXY_AUTH_ORIGIN) 150f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) // Returns true if this proxy server is the data reduction proxy or its 151f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) // fallback, respectively, as configured in gyp. These functions will return 152f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) // false for data reduction proxy servers specified on the command line. 153f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) bool isDataReductionProxy() const; 154f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) bool isDataReductionProxyFallback() const; 155f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)#endif // defined(SPDY_PROXY_AUTH_ORIGIN) 156f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) 1575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 1585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Creates a ProxyServer given a scheme, and host/port string. If parsing the 1595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // host/port string fails, the returned instance will be invalid. 1605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static ProxyServer FromSchemeHostAndPort( 1615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Scheme scheme, 1625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string::const_iterator host_and_port_begin, 1635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string::const_iterator host_and_port_end); 1645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Scheme scheme_; 1665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) HostPortPair host_port_pair_; 1675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)typedef std::pair<HostPortPair, ProxyServer> HostPortProxyPair; 1705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace net 1725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // NET_PROXY_PROXY_SERVER_H_ 174