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.

Types

data SocksAddress

Describe a Socket address on the SOCKS protocol

Constructors

SocksAddress !SocksHostAddress !PortNumber

Instances

Eq SocksAddress

Defined in Network.Socks5.Types

Methods

(==) :: SocksAddress -> SocksAddress -> Bool

(/=) :: SocksAddress -> SocksAddress -> Bool

Ord SocksAddress

Defined in Network.Socks5.Types

Methods

compare :: SocksAddress -> SocksAddress -> Ordering

(<) :: SocksAddress -> SocksAddress -> Bool

(<=) :: SocksAddress -> SocksAddress -> Bool

(>) :: SocksAddress -> SocksAddress -> Bool

(>=) :: SocksAddress -> SocksAddress -> Bool

max :: SocksAddress -> SocksAddress -> SocksAddress

min :: SocksAddress -> SocksAddress -> SocksAddress

Show SocksAddress

Defined in Network.Socks5.Types

Methods

showsPrec :: Int -> SocksAddress -> ShowS

show :: SocksAddress -> String

showList :: [SocksAddress] -> ShowS

data SocksHostAddress

A Host address on the SOCKS protocol.

Constructors

SocksAddrIPV4 !HostAddress

SocksAddrDomainName !FQDN

SocksAddrIPV6 !HostAddress6

Instances

Eq SocksHostAddress

Defined in Network.Socks5.Types

Methods

(==) :: SocksHostAddress -> SocksHostAddress -> Bool

(/=) :: SocksHostAddress -> SocksHostAddress -> Bool

Ord SocksHostAddress

Defined in Network.Socks5.Types

Methods

compare :: SocksHostAddress -> SocksHostAddress -> Ordering

(<) :: SocksHostAddress -> SocksHostAddress -> Bool

(<=) :: SocksHostAddress -> SocksHostAddress -> Bool

(>) :: SocksHostAddress -> SocksHostAddress -> Bool

(>=) :: SocksHostAddress -> SocksHostAddress -> Bool

max :: SocksHostAddress -> SocksHostAddress -> SocksHostAddress

min :: SocksHostAddress -> SocksHostAddress -> SocksHostAddress

Show SocksHostAddress

Defined in Network.Socks5.Types

Methods

showsPrec :: Int -> SocksHostAddress -> ShowS

show :: SocksHostAddress -> String

showList :: [SocksHostAddress] -> ShowS

data SocksReply

Type of reply on the SOCKS protocol

Constructors

SocksReplySuccess

SocksReplyError SocksError

Instances

Enum SocksReply

Defined in Network.Socks5.Types

Methods

succ :: SocksReply -> SocksReply

pred :: SocksReply -> SocksReply

toEnum :: Int -> SocksReply

fromEnum :: SocksReply -> Int

enumFrom :: SocksReply -> [SocksReply]

enumFromThen :: SocksReply -> SocksReply -> [SocksReply]

enumFromTo :: SocksReply -> SocksReply -> [SocksReply]

enumFromThenTo :: SocksReply -> SocksReply -> SocksReply -> [SocksReply]

Eq SocksReply

Defined in Network.Socks5.Types

Methods

(==) :: SocksReply -> SocksReply -> Bool

(/=) :: SocksReply -> SocksReply -> Bool

Data SocksReply

Defined in Network.Socks5.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SocksReply -> c SocksReply

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SocksReply

toConstr :: SocksReply -> Constr

dataTypeOf :: SocksReply -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SocksReply)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SocksReply)

gmapT :: (forall b. Data b => b -> b) -> SocksReply -> SocksReply

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SocksReply -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SocksReply -> r

gmapQ :: (forall d. Data d => d -> u) -> SocksReply -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SocksReply -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SocksReply -> m SocksReply

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SocksReply -> m SocksReply

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SocksReply -> m SocksReply

Ord SocksReply

Defined in Network.Socks5.Types

Methods

compare :: SocksReply -> SocksReply -> Ordering

(<) :: SocksReply -> SocksReply -> Bool

(<=) :: SocksReply -> SocksReply -> Bool

(>) :: SocksReply -> SocksReply -> Bool

(>=) :: SocksReply -> SocksReply -> Bool

max :: SocksReply -> SocksReply -> SocksReply

min :: SocksReply -> SocksReply -> SocksReply

Show SocksReply

Defined in Network.Socks5.Types

Methods

showsPrec :: Int -> SocksReply -> ShowS

show :: SocksReply -> String

showList :: [SocksReply] -> ShowS

data SocksError

SOCKS error that can be received or sent

Constructors

SocksErrorGeneralServerFailure

SocksErrorConnectionNotAllowedByRule

SocksErrorNetworkUnreachable

SocksErrorHostUnreachable

SocksErrorConnectionRefused

SocksErrorTTLExpired

SocksErrorCommandNotSupported

SocksErrorAddrTypeNotSupported

SocksErrorOther Word8

Instances

Enum SocksError

Defined in Network.Socks5.Types

Methods

succ :: SocksError -> SocksError

pred :: SocksError -> SocksError

toEnum :: Int -> SocksError

fromEnum :: SocksError -> Int

enumFrom :: SocksError -> [SocksError]

enumFromThen :: SocksError -> SocksError -> [SocksError]

enumFromTo :: SocksError -> SocksError -> [SocksError]

enumFromThenTo :: SocksError -> SocksError -> SocksError -> [SocksError]

Eq SocksError

Defined in Network.Socks5.Types

Methods

(==) :: SocksError -> SocksError -> Bool

(/=) :: SocksError -> SocksError -> Bool

Data SocksError

Defined in Network.Socks5.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SocksError -> c SocksError

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SocksError

toConstr :: SocksError -> Constr

dataTypeOf :: SocksError -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SocksError)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SocksError)

gmapT :: (forall b. Data b => b -> b) -> SocksError -> SocksError

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SocksError -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SocksError -> r

gmapQ :: (forall d. Data d => d -> u) -> SocksError -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SocksError -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SocksError -> m SocksError

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SocksError -> m SocksError

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SocksError -> m SocksError

Ord SocksError

Defined in Network.Socks5.Types

Methods

compare :: SocksError -> SocksError -> Ordering

(<) :: SocksError -> SocksError -> Bool

(<=) :: SocksError -> SocksError -> Bool

(>) :: SocksError -> SocksError -> Bool

(>=) :: SocksError -> SocksError -> Bool

max :: SocksError -> SocksError -> SocksError

min :: SocksError -> SocksError -> SocksError

Show SocksError

Defined in Network.Socks5.Types

Methods

showsPrec :: Int -> SocksError -> ShowS

show :: SocksError -> String

showList :: [SocksError] -> ShowS

Exception SocksError

Defined in Network.Socks5.Types

Methods

toException :: SocksError -> SomeException

fromException :: SomeException -> Maybe SocksError

displayException :: SocksError -> String

Configuration

data SocksConf

SOCKS identification and configuration structure.

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

Constructors

SocksConf

Fields

• socksServer :: SockAddr

  Address of server

• socksVersion :: SocksVersion

  SOCKS version to use

socksHost :: SocksConf -> SockAddr

SOCKS Host

defaultSocksConf :: SockAddr -> SocksConf

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

defaultSocksConfFromSockAddr :: SockAddr -> SocksConf

same as defaultSocksConf.

soft deprecation: use 'defaultSocksConf"

Methods

socksConnectWithSocket

Arguments

:: 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

|socket|-----sockServer----->|server|----destAddr----->|destination|

socksConnect

Arguments

:: 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

socksConnectName :: 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.