Modulecrypton-socks-0.6.2Haskell2010

Network.Socks5

This is an implementation of the SOCKS Protocol Version 5 as defined in RFC 1928.

In Wikipedia's words:

SOCKS is an Internet protocol that exchanges network packets between a client and server through a proxy server. SOCKS5 optionally provides authentication so only authorized users may access a server. Practically, a SOCKS server proxies TCP connections to an arbitrary IP address, and provides a means for UDP packets to be forwarded. A SOCKS server accepts incoming client connection on TCP port 1080.

BIND and UDP ASSOCIATE messages are not implemented. However the main usage of SOCKS is implemented.

Contents

Types
Configuration
Methods
Variants

Synopsis

data SocksAddress
data SocksHostAddress
data SocksReply
data SocksError
data SocksConf
value socksHost
value defaultSocksConf
value defaultSocksConfFromSockAddr
value socksConnectWithSocket
value socksConnect
value socksConnectName

Packagecrypton-socks-0.6.2
Exports11
LanguageHaskell2010
LicenceBSD-3-Clause
SourceSocks5.hs

Types

datadata SocksAddress

Source#

Type representing socket addresses under the SOCKS protocol.

Constructors

SocksAddress !SocksHostAddress !PortNumber

Instances3Eq, Ord, Show

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

datadata SocksHostAddress

Source#

Type representing host addresses under the SOCKS protocol.

Constructors

SocksAddrIPV4 !HostAddress
A version-4 IP address.
SocksAddrDomainName !SocksFQDN
A fully-qualified domain name (FQDN).
SocksAddrIPV6 !HostAddress6
A version-6 IP address.

Instances3Eq, Ord, Show

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

datadata SocksReply

Source#

Type representing replies under the SOCKS protocol.

Constructors

SocksReplySuccess
The server reports that the request succeeded.
SocksReplyError SocksError
The server reports that the request did not succeed.

Instances5Enum, Eq, Data, Ord, Show

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

datadata SocksError

Source#

Type representing SOCKS errors that can be part of a SOCKS reply.

Constructors

SocksErrorGeneralServerFailure
General SOCKS server failure.
SocksErrorConnectionNotAllowedByRule
Connection not allowed by ruleset.
SocksErrorNetworkUnreachable
Network unreachable.
SocksErrorHostUnreachable
Host unreachable.
SocksErrorConnectionRefused
Connection refused.
SocksErrorTTLExpired
TTL expired.
SocksErrorCommandNotSupported
Command not supported.
SocksErrorAddrTypeNotSupported
Address type not supported.
SocksErrorOther Word8
Other error. Unassigned in SOCKS Protocol Version 5.

Instances6Enum, Eq, Data, Ord, Show, Exception

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

Configuration

datadata SocksConf

Source#

Type representing SOCKS identification and configuration structures.

The data constructors may be extended in the future to support authentification. Use the smart constructor defaultSocksConf and socksHost.

Constructors

SocksConf
- socksServer :: SockAddr
  The address of the server.
- socksVersion :: SocksVersion
  The SOCKS protocol version to use.

valuesocksHost

:: SocksConf
The configuration.
-> SockAddr

Source#

Yield the socket address of the server from the specified configuration.

valuedefaultSocksConf

:: SockAddr
The address of the server.
-> SocksConf

Source#

Yield a configuration given the specified socket addresss.

valuedefaultSocksConfFromSockAddr :: SockAddr -> SocksConf

Source#

Deprecated. Will be removed from future package versions. Use defaultSocksConf instead.

Same as defaultSocksConf.

Methods

valuesocksConnectWithSocket

:: Socket
The socket to use.
-> SocksConf
The SOCKS configuration for the server.
-> SocksAddress
The SOCKS address to connect to.
-> IO (SocksHostAddress, PortNumber)

Source#

Connect a user-specified new socket on the SOCKS server to a destination.

The specified socket needs to be connected to the SOCKS server already.

valuesocksConnect

:: SocksConf
The SOCKS configuration for the server.
-> SocksAddress
The SOCKS address to connect to.
-> IO (Socket, (SocksHostAddress, PortNumber))

Source#

Connect a new socket to a SOCKS server and connect the stream on the server side to the specified SOCKS address.

Variants

valuesocksConnectName

:: Socket
The socket to use. The socket must *not* be connected already.
-> SocksConf
The SOCKS configuration for the server.
-> String
Destination FQDN. Should comprise only ASCII characters, otherwise unexpected behaviour will ensure. For FQDN including other Unicode code points, Punycode encoding should be used.
-> PortNumber
The port number to use.
-> IO ()

Source#

Connect a new socket to the SOCKS server, and connect the stream to a fully-qualified domain name (FQDN) resolved on the server side.