Safe Haskell	Safe-Inferred
Language	Haskell2010

Network.Socks5.Lowlevel

Contents

lowlevel types
lowlevel interface

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
}
establish :: SocksVersion -> Socket -> [SocksMethod] -> IO SocksMethod
newtype Connect = Connect SocksAddress
class Command a where
- toRequest :: a -> SocksRequest
- fromRequest :: SocksRequest -> Maybe a
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 Source # show :: SocksHello -> String Source # showList :: [SocksHello] -> ShowS Source #
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 Source # (/=) :: SocksHello -> SocksHello -> Bool Source #

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 Source # show :: SocksHelloResponse -> String Source # showList :: [SocksHelloResponse] -> ShowS Source #
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 Source # (/=) :: SocksHelloResponse -> SocksHelloResponse -> Bool Source #

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 Source # show :: SocksRequest -> String Source # showList :: [SocksRequest] -> ShowS Source #
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 Source # (/=) :: SocksRequest -> SocksRequest -> Bool Source #
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 Source # show :: SocksResponse -> String Source # showList :: [SocksResponse] -> ShowS Source #
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 Source # (/=) :: SocksResponse -> SocksResponse -> Bool Source #

establish :: SocksVersion -> Socket -> [SocksMethod] -> IO SocksMethod 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 Source # show :: Connect -> String Source # showList :: [Connect] -> ShowS Source #
Eq Connect Source #
Instance details Defined in Network.Socks5.Command Methods (==) :: Connect -> Connect -> Bool Source # (/=) :: Connect -> Connect -> Bool Source #
Ord Connect Source #
Instance details Defined in Network.Socks5.Command Methods compare :: Connect -> Connect -> Ordering Source # (<) :: Connect -> Connect -> Bool Source # (<=) :: Connect -> Connect -> Bool Source # (>) :: Connect -> Connect -> Bool Source # (>=) :: Connect -> Connect -> Bool Source # max :: Connect -> Connect -> Connect Source # min :: Connect -> Connect -> Connect Source #
Command Connect Source #
Instance details Defined in Network.Socks5.Command Methods toRequest :: Connect -> SocksRequest Source # fromRequest :: SocksRequest -> Maybe Connect Source #

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 #

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

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

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

lowlevel interface

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 #