Modulesocks-0.6.1Haskell2010

Network.Socks5

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.

5 types
6 values

Packagesocks-0.6.1
Exports11
LanguageHaskell2010
LicenceBSD-3-Clause
SourceSocks5.hs

Types

4 declarations

datadata SocksAddress

Describe a Socket address on the SOCKS protocol

Constructors

SocksAddress !SocksHostAddress !PortNumber

Instances3Eq, Ord, Show

Eq SocksAddressDefined in socks-0.6.1 · Network.Socks5.Types
Ord SocksAddressDefined in socks-0.6.1 · Network.Socks5.Types
Show SocksAddressDefined in socks-0.6.1 · Network.Socks5.Types

datadata SocksHostAddress

A Host address on the SOCKS protocol.

Constructors

Instances3Eq, Ord, Show

Eq SocksHostAddressDefined in socks-0.6.1 · Network.Socks5.Types
Ord SocksHostAddressDefined in socks-0.6.1 · Network.Socks5.Types
Show SocksHostAddressDefined in socks-0.6.1 · Network.Socks5.Types

datadata SocksReply

Type of reply on the SOCKS protocol

Constructors

Instances5Enum, Eq, Data, Ord, Show

Enum SocksReplyDefined in socks-0.6.1 · Network.Socks5.Types
Eq SocksReplyDefined in socks-0.6.1 · Network.Socks5.Types
Data SocksReplyDefined in socks-0.6.1 · Network.Socks5.Types
Ord SocksReplyDefined in socks-0.6.1 · Network.Socks5.Types
Show SocksReplyDefined in socks-0.6.1 · Network.Socks5.Types

datadata SocksError

SOCKS error that can be received or sent

Constructors

Instances6Enum, Eq, Data, Ord, Show, Exception

Enum SocksErrorDefined in socks-0.6.1 · Network.Socks5.Types
Eq SocksErrorDefined in socks-0.6.1 · Network.Socks5.Types
Data SocksErrorDefined in socks-0.6.1 · Network.Socks5.Types
Ord SocksErrorDefined in socks-0.6.1 · Network.Socks5.Types
Show SocksErrorDefined in socks-0.6.1 · Network.Socks5.Types
Exception SocksErrorDefined in socks-0.6.1 · Network.Socks5.Types

Configuration

4 declarations

datadata SocksConf

SOCKS identification and configuration structure.

this structure will be extended in future to support authentification. use defaultSocksConf to create new record.

Constructors

SocksConf
- socksServer :: SockAddr
  Address of server
- socksVersion :: SocksVersion
  SOCKS version to use

valuesocksHost :: SocksConf -> SockAddr

SOCKS Host

valuedefaultSocksConf :: SockAddr -> SocksConf

defaultSocksConf create a new record, making sure API remains compatible when the record is extended.

valuedefaultSocksConfFromSockAddr :: SockAddr -> SocksConf

same as defaultSocksConf.

soft deprecation: use 'defaultSocksConf"

Methods

2 declarations

valuesocksConnectWithSocket

:: Socket
Socket to use.
-> SocksConf
SOCKS configuration for the server.
-> SocksAddress
SOCKS 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

valuesocksConnect

:: SocksConf
SOCKS configuration for the server.
-> SocksAddress
SOCKS 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.

Variants

1 declaration

valuesocksConnectName :: Socket -> SocksConf -> String -> PortNumber -> IO ()

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.