Safe Haskell	None
Language	Haskell2010

Network.Socks5.Lowlevel

Contents

lowlevel types

Synopsis

socksListen :: Socket -> IO SocksRequest
data SocksHello = SocksHello {
- getSocksHelloMethods :: [SocksMethod]
}
data SocksHelloResponse = SocksHelloResponse {
- getSocksHelloResponseMethod :: SocksMethod
}
data SocksRequest = SocksRequest {
- requestCommand :: SocksCommand
- requestDstAddr :: SocksHostAddress
- requestDstPort :: PortNumber
}
data SocksResponse = SocksResponse {
- responseReply :: SocksReply
- responseBindAddr :: SocksHostAddress
- responseBindPort :: PortNumber
}
newtype SocksUsernamePassword = SocksUsernamePassword SocksCredentials
newtype SocksUsernamePasswordResponse = SocksUsernamePasswordResponse {
- getUsernamePasswordResponse :: SocksAuthStatus
}
data SocksAuthStatus
- = SocksAuthSuccess
- | SocksAuthFailure Word8
class Command a where
- toRequest :: a -> SocksRequest
- fromRequest :: SocksRequest -> Maybe a
establish :: SocksVersion -> Socket -> [SocksMethod] -> IO SocksMethod
authenticate :: SocksVersion -> Socket -> SocksCredentials -> IO SocksAuthStatus
newtype Connect = Connect SocksAddress
connectIPV4 :: Socket -> HostAddress -> PortNumber -> IO (HostAddress, PortNumber)
connectIPV6 :: Socket -> HostAddress6 -> PortNumber -> IO (HostAddress6, PortNumber)
connectDomainName :: Socket -> [Char] -> PortNumber -> IO (SocksHostAddress, PortNumber)
rpc :: Command a => Socket -> a -> IO (Either SocksError (SocksHostAddress, PortNumber))
rpc_ :: Command a => Socket -> a -> IO (SocksHostAddress, PortNumber)
sendSerialized :: Serialize a => Socket -> a -> IO ()
waitSerialized :: Serialize a => Socket -> IO a

Documentation

socksListen :: Socket -> IO SocksRequest Source #

lowlevel types

data SocksHello Source #

Initial message sent by client with the list of authentification methods supported

Constructors

SocksHello
Fields getSocksHelloMethods :: [SocksMethod]

Instances

Instances details

Show SocksHello Source #
Instance details Defined in Network.Socks5.Wire Methods showsPrec :: Int -> SocksHello -> ShowS show :: SocksHello -> String showList :: [SocksHello] -> ShowS
Serialize SocksHello Source #
Instance details Defined in Network.Socks5.Wire Methods put :: Putter SocksHello get :: Get SocksHello
Eq SocksHello Source #
Instance details Defined in Network.Socks5.Wire Methods (==) :: SocksHello -> SocksHello -> Bool (/=) :: SocksHello -> SocksHello -> Bool

data SocksHelloResponse Source #

Initial message send by server in return from Hello, with the server chosen method of authentication

Constructors

SocksHelloResponse
Fields getSocksHelloResponseMethod :: SocksMethod

Instances

Instances details

Show SocksHelloResponse Source #
Instance details Defined in Network.Socks5.Wire Methods showsPrec :: Int -> SocksHelloResponse -> ShowS show :: SocksHelloResponse -> String showList :: [SocksHelloResponse] -> ShowS
Serialize SocksHelloResponse Source #
Instance details Defined in Network.Socks5.Wire Methods put :: Putter SocksHelloResponse get :: Get SocksHelloResponse
Eq SocksHelloResponse Source #
Instance details Defined in Network.Socks5.Wire Methods (==) :: SocksHelloResponse -> SocksHelloResponse -> Bool (/=) :: SocksHelloResponse -> SocksHelloResponse -> Bool

data SocksRequest Source #

Define a SOCKS requests

Constructors

SocksRequest
Fields requestCommand :: SocksCommand requestDstAddr :: SocksHostAddress requestDstPort :: PortNumber

Instances

Instances details

Show SocksRequest Source #
Instance details Defined in Network.Socks5.Wire Methods showsPrec :: Int -> SocksRequest -> ShowS show :: SocksRequest -> String showList :: [SocksRequest] -> ShowS
Serialize SocksRequest Source #
Instance details Defined in Network.Socks5.Wire Methods put :: Putter SocksRequest get :: Get SocksRequest
Eq SocksRequest Source #
Instance details Defined in Network.Socks5.Wire Methods (==) :: SocksRequest -> SocksRequest -> Bool (/=) :: SocksRequest -> SocksRequest -> Bool
Command SocksRequest Source #
Instance details Defined in Network.Socks5.Command Methods toRequest :: SocksRequest -> SocksRequest Source # fromRequest :: SocksRequest -> Maybe SocksRequest Source #

data SocksResponse Source #

Define a SOCKS response

Constructors

SocksResponse
Fields responseReply :: SocksReply responseBindAddr :: SocksHostAddress responseBindPort :: PortNumber

Instances

Instances details

Show SocksResponse Source #
Instance details Defined in Network.Socks5.Wire Methods showsPrec :: Int -> SocksResponse -> ShowS show :: SocksResponse -> String showList :: [SocksResponse] -> ShowS
Serialize SocksResponse Source #
Instance details Defined in Network.Socks5.Wire Methods put :: Putter SocksResponse get :: Get SocksResponse
Eq SocksResponse Source #
Instance details Defined in Network.Socks5.Wire Methods (==) :: SocksResponse -> SocksResponse -> Bool (/=) :: SocksResponse -> SocksResponse -> Bool

newtype SocksUsernamePassword Source #

Constructors

SocksUsernamePassword SocksCredentials

Instances

Instances details

Show SocksUsernamePassword Source #
Instance details Defined in Network.Socks5.Wire Methods showsPrec :: Int -> SocksUsernamePassword -> ShowS show :: SocksUsernamePassword -> String showList :: [SocksUsernamePassword] -> ShowS
Serialize SocksUsernamePassword Source #
Instance details Defined in Network.Socks5.Wire Methods put :: Putter SocksUsernamePassword get :: Get SocksUsernamePassword
Eq SocksUsernamePassword Source #
Instance details Defined in Network.Socks5.Wire Methods (==) :: SocksUsernamePassword -> SocksUsernamePassword -> Bool (/=) :: SocksUsernamePassword -> SocksUsernamePassword -> Bool

newtype SocksUsernamePasswordResponse Source #

Constructors

SocksUsernamePasswordResponse
Fields getUsernamePasswordResponse :: SocksAuthStatus

Instances

Instances details

Show SocksUsernamePasswordResponse Source #
Instance details Defined in Network.Socks5.Wire Methods showsPrec :: Int -> SocksUsernamePasswordResponse -> ShowS show :: SocksUsernamePasswordResponse -> String showList :: [SocksUsernamePasswordResponse] -> ShowS
Serialize SocksUsernamePasswordResponse Source #
Instance details Defined in Network.Socks5.Wire Methods put :: Putter SocksUsernamePasswordResponse get :: Get SocksUsernamePasswordResponse
Eq SocksUsernamePasswordResponse Source #
Instance details Defined in Network.Socks5.Wire Methods (==) :: SocksUsernamePasswordResponse -> SocksUsernamePasswordResponse -> Bool (/=) :: SocksUsernamePasswordResponse -> SocksUsernamePasswordResponse -> Bool

data SocksAuthStatus Source #

Constructors

SocksAuthSuccess
SocksAuthFailure Word8

Instances

Instances details

Show SocksAuthStatus Source #
Instance details Defined in Network.Socks5.Wire Methods showsPrec :: Int -> SocksAuthStatus -> ShowS show :: SocksAuthStatus -> String showList :: [SocksAuthStatus] -> ShowS
Serialize SocksAuthStatus Source #
Instance details Defined in Network.Socks5.Wire Methods put :: Putter SocksAuthStatus get :: Get SocksAuthStatus
Eq SocksAuthStatus Source #
Instance details Defined in Network.Socks5.Wire Methods (==) :: SocksAuthStatus -> SocksAuthStatus -> Bool (/=) :: SocksAuthStatus -> SocksAuthStatus -> Bool

class Command a where Source #

Methods

toRequest :: a -> SocksRequest Source #

fromRequest :: SocksRequest -> Maybe a Source #

Instances

Instances details

Command Connect Source #
Instance details Defined in Network.Socks5.Command Methods toRequest :: Connect -> SocksRequest Source # fromRequest :: SocksRequest -> Maybe Connect Source #
Command SocksRequest Source #
Instance details Defined in Network.Socks5.Command Methods toRequest :: SocksRequest -> SocksRequest Source # fromRequest :: SocksRequest -> Maybe SocksRequest Source #

establish :: SocksVersion -> Socket -> [SocksMethod] -> IO SocksMethod Source #

authenticate :: SocksVersion -> Socket -> SocksCredentials -> IO SocksAuthStatus Source #

newtype Connect Source #

Constructors

Connect SocksAddress

Instances

Instances details

Show Connect Source #
Instance details Defined in Network.Socks5.Command Methods showsPrec :: Int -> Connect -> ShowS show :: Connect -> String showList :: [Connect] -> ShowS
Eq Connect Source #
Instance details Defined in Network.Socks5.Command Methods (==) :: Connect -> Connect -> Bool (/=) :: Connect -> Connect -> Bool
Ord Connect Source #
Instance details Defined in Network.Socks5.Command Methods compare :: Connect -> Connect -> Ordering (<) :: Connect -> Connect -> Bool (<=) :: Connect -> Connect -> Bool (>) :: Connect -> Connect -> Bool (>=) :: Connect -> Connect -> Bool max :: Connect -> Connect -> Connect min :: Connect -> Connect -> Connect
Command Connect Source #
Instance details Defined in Network.Socks5.Command Methods toRequest :: Connect -> SocksRequest Source # fromRequest :: SocksRequest -> Maybe Connect Source #

connectIPV4 :: Socket -> HostAddress -> PortNumber -> IO (HostAddress, PortNumber) Source #

connectIPV6 :: Socket -> HostAddress6 -> PortNumber -> IO (HostAddress6, PortNumber) Source #

connectDomainName :: Socket -> [Char] -> PortNumber -> IO (SocksHostAddress, PortNumber) Source #

rpc :: Command a => Socket -> a -> IO (Either SocksError (SocksHostAddress, PortNumber)) Source #

rpc_ :: Command a => Socket -> a -> IO (SocksHostAddress, PortNumber) Source #

sendSerialized :: Serialize a => Socket -> a -> IO () Source #

waitSerialized :: Serialize a => Socket -> IO a Source #