GHC 10.0.0.20260917 · lts/ghc-10.0.x · 8fef28d · 2026-11-02
Modulesocks-0.6.1Haskell2010
This is an implementation of SOCKS5 as defined in RFC 1928
In Wikipedia's words:
SOCKet Secure (SOCKS) is an Internet protocol that routes network packets between a client and server through a proxy server. SOCKS5 additionally provides authentication so only authorized users may access a server. Practically, a SOCKS server will proxy TCP connections to an arbitrary IP address as well as providing a means for UDP packets to be forwarded.
BIND and UDP ASSOCIATE messages are not implemented. However main usage of SOCKS is covered in this implementation.
Describe a Socket address on the SOCKS protocol
Eq SocksAddressDefined in socks-0.6.1 · Network.Socks5.TypesOrd SocksAddressDefined in socks-0.6.1 · Network.Socks5.TypesShow SocksAddressDefined in socks-0.6.1 · Network.Socks5.TypesA Host address on the SOCKS protocol.
Eq SocksHostAddressDefined in socks-0.6.1 · Network.Socks5.TypesOrd SocksHostAddressDefined in socks-0.6.1 · Network.Socks5.TypesShow SocksHostAddressDefined in socks-0.6.1 · Network.Socks5.TypesType of reply on the SOCKS protocol
Enum SocksReplyDefined in socks-0.6.1 · Network.Socks5.TypesEq SocksReplyDefined in socks-0.6.1 · Network.Socks5.TypesData SocksReplyDefined in socks-0.6.1 · Network.Socks5.TypesOrd SocksReplyDefined in socks-0.6.1 · Network.Socks5.TypesShow SocksReplyDefined in socks-0.6.1 · Network.Socks5.TypesSOCKS error that can be received or sent
Enum SocksErrorDefined in socks-0.6.1 · Network.Socks5.TypesEq SocksErrorDefined in socks-0.6.1 · Network.Socks5.TypesData SocksErrorDefined in socks-0.6.1 · Network.Socks5.TypesOrd SocksErrorDefined in socks-0.6.1 · Network.Socks5.TypesShow SocksErrorDefined in socks-0.6.1 · Network.Socks5.TypesException SocksErrorDefined in socks-0.6.1 · Network.Socks5.TypesdefaultSocksConf create a new record, making sure API remains compatible when the record is extended.
same as defaultSocksConf.
soft deprecation: use 'defaultSocksConf"
SOCKS Host
SOCKS identification and configuration structure.
this structure will be extended in future to support authentification. use defaultSocksConf to create new record.
SocksConfsocksServer :: SockAddrAddress of server
socksVersion :: SocksVersionSOCKS version to use
socksConnectWithSocket :: SocketSocket to use.
-> SocksConfSOCKS configuration for the server.
-> SocksAddressSOCKS Address to connect to.
-> IO (SocksHostAddress, PortNumber)connect a user specified new socket on the socks server to a destination
The socket in parameter needs to be already connected to the socks server
|socket|-----sockServer----->|server|----destAddr----->|destination|
socksConnect :: SocksConfSOCKS configuration for the server.
-> SocksAddressSOCKS Address to connect to.
-> IO (Socket, (SocksHostAddress, PortNumber))connect a new socket to a socks server and connect the stream on the server side to the SocksAddress specified.
connect a new socket to the socks server, and connect the stream to a FQDN resolved on the server side.
The socket needs to *not* be already connected.
The destination need to be an ASCII string, otherwise unexpected behavior will ensue. For unicode destination, punycode encoding should be used.