QNetworkProxy¶

PyQt5.QtNetwork.QNetworkProxy

Description¶

The QNetworkProxy class provides a network layer proxy.

QNetworkProxy provides the method for configuring network layer proxy support to the Qt network classes. The currently supported classes are QAbstractSocket, QTcpSocket, QUdpSocket, QTcpServer and QNetworkAccessManager. The proxy support is designed to be as transparent as possible. This means that existing network-enabled applications that you have written should automatically support network proxy using the following code.

# QNetworkProxy proxy;
# proxy.setType(QNetworkProxy::Socks5Proxy);
# proxy.setHostName("proxy.example.com");
# proxy.setPort(1080);
# proxy.setUser("username");
# proxy.setPassword("password");
# QNetworkProxy::setApplicationProxy(proxy);

An alternative to setting an application wide proxy is to specify the proxy for individual sockets using setProxy() and setProxy(). In this way, it is possible to disable the use of a proxy for specific sockets using the following code:

# serverSocket->setProxy(QNetworkProxy::NoProxy);

Network proxy is not used if the address used in connectToHost(), bind() or listen() is equivalent to LocalHost or LocalHostIPv6.

Each type of proxy support has certain restrictions associated with it. You should read the ProxyType documentation carefully before selecting a proxy type to use.

Note: Changes made to currently connected sockets do not take effect. If you need to change a connected socket, you should reconnect it.

SOCKS5¶

The SOCKS5 support since Qt 4 is based on RFC 1928 and RFC 1929. The supported authentication methods are no authentication and username/password authentication. Both IPv4 and IPv6 are supported. Domain names are resolved through the SOCKS5 server if the HostNameLookupCapability is enabled, otherwise they are resolved locally and the IP address is sent to the server. There are several things to remember when using SOCKS5 with QUdpSocket and QTcpServer:

With QUdpSocket, a call to bind() may fail with a timeout error. If a port number other than 0 is passed to bind(), it is not guaranteed that it is the specified port that will be used. Use localPort() and localAddress() to get the actual address and port number in use. Because proxied UDP goes through two UDP connections, it is more likely that packets will be dropped.

With QTcpServer a call to listen() may fail with a timeout error. If a port number other than 0 is passed to listen(), then it is not guaranteed that it is the specified port that will be used. Use serverPort() and serverAddress() to get the actual address and port used to listen for connections. SOCKS5 only supports one accepted connection per call to listen(), and each call is likely to result in a different serverPort() being used.

Classes¶

Capabilities

Enums¶

Capability

These flags indicate the capabilities that a given proxy server supports.

QNetworkProxy sets different capabilities by default when the object is created (see ProxyType for a list of the defaults). However, it is possible to change the capabitilies after the object has been created with setCapabilities().

The capabilities that QNetworkProxy supports are:

Member	Value	Description
CachingCapability	0x0008	Ability to cache the contents of the transfer. This capability is specific to each protocol and proxy type. For example, HTTP proxies can cache the contents of web data transferred with “GET” commands.
HostNameLookupCapability	0x0010	Ability to connect to perform the lookup on a remote host name and connect to it, as opposed to requiring the application to perform the name lookup and request connection to IP addresses only.
ListeningCapability	0x0002	Ability to create a listening socket and wait for an incoming TCP connection from a remote host.
SctpListeningCapability	TODO	Ability to create a listening socket and wait for an incoming SCTP connection from a remote host.
SctpTunnelingCapability	TODO	Ability to open transparent, tunneled SCTP connections to a remote host.
TunnelingCapability	0x0001	Ability to open transparent, tunneled TCP connections to a remote host. The proxy server relays the transmission verbatim from one side to the other and does no caching.
UdpTunnelingCapability	0x0004	Ability to relay UDP datagrams via the proxy server to and from a remote host.

ProxyType

This enum describes the types of network proxying provided in Qt.

There are two types of proxies that Qt understands: transparent proxies and caching proxies. The first group consists of proxies that can handle any arbitrary data transfer, while the second can only handle specific requests. The caching proxies only make sense for the specific classes where they can be used.

The table below lists different proxy types and their capabilities. Since each proxy type has different capabilities, it is important to understand them before choosing a proxy type.

Proxy type	Description	Default capabilities
SOCKS 5	Generic proxy for any kind of connection. Supports TCP, UDP, binding to a port (incoming connections) and authentication.	TunnelingCapability, ListeningCapability, UdpTunnelingCapability, HostNameLookupCapability
HTTP	Implemented using the “CONNECT” command, supports only outgoing TCP connections; supports authentication.	TunnelingCapability, CachingCapability, HostNameLookupCapability
Caching-only HTTP	Implemented using normal HTTP commands, it is useful only in the context of HTTP requests (see QNetworkAccessManager)	CachingCapability, HostNameLookupCapability
Caching FTP	Implemented using an FTP proxy, it is useful only in the context of FTP requests (see QNetworkAccessManager)	CachingCapability, HostNameLookupCapability

Also note that you shouldn’t set the application default proxy (setApplicationProxy()) to a proxy that doesn’t have the TunnelingCapability capability. If you do, QTcpSocket will not know how to open connections.

Methods¶

__init__(): TODO

__init__(QNetworkProxy): TODO

__init__(ProxyType, hostName: str = '', port: int = 0, user: str = '', password: str = ''): TODO

@staticmethod applicationProxy() → QNetworkProxy: See also

setApplicationProxy().

capabilities() → Capabilities: See also

setCapabilities().

__eq__(QNetworkProxy) → bool: TODO

hasRawHeader(Union[QByteArray, bytes, bytearray]) → bool: TODO

header(KnownHeaders) → Any: TODO

hostName() → str: See also

setHostName().

isCachingProxy() → bool: TODO

isTransparentProxy() → bool: TODO

__ne__(QNetworkProxy) → bool: TODO

password() → str: See also

setPassword().

port() → int: See also

setPort().

rawHeader(Union[QByteArray, bytes, bytearray]) → QByteArray: TODO

rawHeaderList() → List[QByteArray]: TODO

@staticmethod setApplicationProxy(QNetworkProxy): See also

applicationProxy().

setCapabilities(Union[Capabilities, Capability]): See also

capabilities().

setHeader(KnownHeaders, Any): TODO

setHostName(str): See also

hostName().

setPassword(str): See also

password().

setPort(int): See also

port().

setRawHeader(Union[QByteArray, bytes, bytearray], Union[QByteArray, bytes, bytearray]): TODO

setType(ProxyType): See also

type().

setUser(str): See also

user().

swap(QNetworkProxy): TODO

type() → ProxyType: See also

setType().

user() → str: See also

setUser().

Member	Value	Description
DefaultProxy	0	Proxy is determined based on the application proxy set using setApplicationProxy()
FtpCachingProxy	5	Proxying for FTP requests only
HttpCachingProxy	4	Proxying for HTTP requests only
HttpProxy	3	HTTP transparent proxying is used
NoProxy	2	No proxying is used
Socks5Proxy	1	Socks5 proxying is used