Safe Haskell	None
Language	GHC2021

Network.SOCKS5.Internal

Synopsis

data Method
- = NoAuth
- | GSSAPI
- | UserPass
- | IANAAssigned Word8
- | PrivateMethod Word8
- | NoAcceptableMethods
- | UnknownMethod Word8
newtype Hello = Hello {
- methods :: [Method]
}
newtype MethodSelection = MethodSelection {
- method :: Method
}
data Command
- = Connect
- | Bind
- | UDPAssociate
data Address
- = AddressIPv4 IPv4
- | AddressIPv6 IPv6
- | AddressDomain Text
data Request = Request {
- command :: Command
- destinationAddress :: Address
- destinationPort :: PortNumber
}
data Rep
data Reply = Reply {
- reply :: Rep
- boundAddress :: Address
- boundPort :: PortNumber
}
data UDPRequest = UDPRequest {
- frag :: Word8
- address :: Address
- port :: PortNumber
- payload :: ByteString
}
sendUDPRequestTo :: Socket -> Word8 -> Address -> PortNumber -> ByteString -> SockAddr -> IO ()
data UserPassRequest = UserPassRequest {
- username :: Text
- password :: Text
}
data Status
- = Success
- | Failure
newtype UserPassResponse = UserPassResponse {
- status :: Status
}
data SOCKSException
class Connection c where
- connRecv :: c -> IO ByteString
- connSend :: c -> ByteString -> IO ()
fromSockAddr_ :: SockAddr -> (Address, PortNumber)
toSockAddr_ :: Address -> PortNumber -> SockAddr
recvAndDecode :: (Binary a, Connection c, MonadIO m) => c -> ByteString -> m (a, ByteString)
encodeAndSend :: (Binary a, Connection c, MonadIO m) => c -> a -> m ()

Documentation

data Method Source #

Constructors

NoAuth
GSSAPI
UserPass
IANAAssigned Word8
PrivateMethod Word8
NoAcceptableMethods
UnknownMethod Word8

Instances

Instances details

Show Method Source #
Instance details Defined in Network.SOCKS5.Internal Methods showsPrec :: Int -> Method -> ShowS # show :: Method -> String # showList :: [Method] -> ShowS #
Binary Method Source #
Instance details Defined in Network.SOCKS5.Internal Methods put :: Method -> Put # get :: Get Method # putList :: [Method] -> Put #
Eq Method Source #
Instance details Defined in Network.SOCKS5.Internal Methods (==) :: Method -> Method -> Bool # (/=) :: Method -> Method -> Bool #

newtype Hello Source #

Constructors

Hello
Fields methods :: [Method]

Instances

Instances details

Show Hello Source #
Instance details Defined in Network.SOCKS5.Internal Methods showsPrec :: Int -> Hello -> ShowS # show :: Hello -> String # showList :: [Hello] -> ShowS #
Binary Hello Source #
Instance details Defined in Network.SOCKS5.Internal Methods put :: Hello -> Put # get :: Get Hello # putList :: [Hello] -> Put #
Eq Hello Source #
Instance details Defined in Network.SOCKS5.Internal Methods (==) :: Hello -> Hello -> Bool # (/=) :: Hello -> Hello -> Bool #

newtype MethodSelection Source #

Constructors

MethodSelection
Fields method :: Method

Instances

Instances details

Show MethodSelection Source #
Instance details Defined in Network.SOCKS5.Internal Methods showsPrec :: Int -> MethodSelection -> ShowS # show :: MethodSelection -> String # showList :: [MethodSelection] -> ShowS #
Binary MethodSelection Source #
Instance details Defined in Network.SOCKS5.Internal Methods put :: MethodSelection -> Put # get :: Get MethodSelection # putList :: [MethodSelection] -> Put #
Eq MethodSelection Source #
Instance details Defined in Network.SOCKS5.Internal Methods (==) :: MethodSelection -> MethodSelection -> Bool # (/=) :: MethodSelection -> MethodSelection -> Bool #

data Command Source #

Constructors

Connect
Bind
UDPAssociate

Instances

Instances details

Show Command Source #
Instance details Defined in Network.SOCKS5.Internal Methods showsPrec :: Int -> Command -> ShowS # show :: Command -> String # showList :: [Command] -> ShowS #
Binary Command Source #
Instance details Defined in Network.SOCKS5.Internal Methods put :: Command -> Put # get :: Get Command # putList :: [Command] -> Put #
Eq Command Source #
Instance details Defined in Network.SOCKS5.Internal Methods (==) :: Command -> Command -> Bool # (/=) :: Command -> Command -> Bool #

data Address Source #

Address type used for destination addresses in SOCKS5 protocol.

Constructors

AddressIPv4 IPv4
AddressIPv6 IPv6
AddressDomain Text

Instances

Instances details

Show Address Source #
Instance details Defined in Network.SOCKS5.Internal Methods showsPrec :: Int -> Address -> ShowS # show :: Address -> String # showList :: [Address] -> ShowS #
Binary Address Source #
Instance details Defined in Network.SOCKS5.Internal Methods put :: Address -> Put # get :: Get Address # putList :: [Address] -> Put #
Eq Address Source #
Instance details Defined in Network.SOCKS5.Internal Methods (==) :: Address -> Address -> Bool # (/=) :: Address -> Address -> Bool #

data Request Source #

Constructors

Request
Fields command :: Command destinationAddress :: Address destinationPort :: PortNumber

Instances

Instances details

Show Request Source #
Instance details Defined in Network.SOCKS5.Internal Methods showsPrec :: Int -> Request -> ShowS # show :: Request -> String # showList :: [Request] -> ShowS #
Binary Request Source #
Instance details Defined in Network.SOCKS5.Internal Methods put :: Request -> Put # get :: Get Request # putList :: [Request] -> Put #
Eq Request Source #
Instance details Defined in Network.SOCKS5.Internal Methods (==) :: Request -> Request -> Bool # (/=) :: Request -> Request -> Bool #

data Rep Source #

Constructors

Succeeded
GeneralSOCKSFailure
ConnectionNotAllowedByRuleset
NetworkUnreachable
HostUnreachable
ConnectionRefused
TTLExpired
CommandNotSupported
AddressTypeNotSupported
Unassigned Word8

Instances

Instances details

Show Rep Source #
Instance details Defined in Network.SOCKS5.Internal Methods showsPrec :: Int -> Rep -> ShowS # show :: Rep -> String # showList :: [Rep] -> ShowS #
Binary Rep Source #
Instance details Defined in Network.SOCKS5.Internal Methods put :: Rep -> Put # get :: Get Rep # putList :: [Rep] -> Put #
Eq Rep Source #
Instance details Defined in Network.SOCKS5.Internal Methods (==) :: Rep -> Rep -> Bool # (/=) :: Rep -> Rep -> Bool #

data Reply Source #

Constructors

Reply
Fields reply :: Rep boundAddress :: Address boundPort :: PortNumber

Instances

Instances details

Show Reply Source #
Instance details Defined in Network.SOCKS5.Internal Methods showsPrec :: Int -> Reply -> ShowS # show :: Reply -> String # showList :: [Reply] -> ShowS #
Binary Reply Source #
Instance details Defined in Network.SOCKS5.Internal Methods put :: Reply -> Put # get :: Get Reply # putList :: [Reply] -> Put #
Eq Reply Source #
Instance details Defined in Network.SOCKS5.Internal Methods (==) :: Reply -> Reply -> Bool # (/=) :: Reply -> Reply -> Bool #

data UDPRequest Source #

Constructors

UDPRequest
Fields frag :: Word8 address :: Address port :: PortNumber payload :: ByteString

Instances

Instances details

Show UDPRequest Source #
Instance details Defined in Network.SOCKS5.Internal Methods showsPrec :: Int -> UDPRequest -> ShowS # show :: UDPRequest -> String # showList :: [UDPRequest] -> ShowS #
Binary UDPRequest Source #
Instance details Defined in Network.SOCKS5.Internal Methods put :: UDPRequest -> Put # get :: Get UDPRequest # putList :: [UDPRequest] -> Put #
Eq UDPRequest Source #
Instance details Defined in Network.SOCKS5.Internal Methods (==) :: UDPRequest -> UDPRequest -> Bool # (/=) :: UDPRequest -> UDPRequest -> Bool #

sendUDPRequestTo :: Socket -> Word8 -> Address -> PortNumber -> ByteString -> SockAddr -> IO () Source #

data UserPassRequest Source #

Constructors

UserPassRequest
Fields username :: Text password :: Text

Instances

Instances details

Show UserPassRequest Source #
Instance details Defined in Network.SOCKS5.Internal Methods showsPrec :: Int -> UserPassRequest -> ShowS # show :: UserPassRequest -> String # showList :: [UserPassRequest] -> ShowS #
Binary UserPassRequest Source #
Instance details Defined in Network.SOCKS5.Internal Methods put :: UserPassRequest -> Put # get :: Get UserPassRequest # putList :: [UserPassRequest] -> Put #
Eq UserPassRequest Source #
Instance details Defined in Network.SOCKS5.Internal Methods (==) :: UserPassRequest -> UserPassRequest -> Bool # (/=) :: UserPassRequest -> UserPassRequest -> Bool #

data Status Source #

Constructors

Success
Failure

Instances

Instances details

Show Status Source #
Instance details Defined in Network.SOCKS5.Internal Methods showsPrec :: Int -> Status -> ShowS # show :: Status -> String # showList :: [Status] -> ShowS #
Binary Status Source #
Instance details Defined in Network.SOCKS5.Internal Methods put :: Status -> Put # get :: Get Status # putList :: [Status] -> Put #
Eq Status Source #
Instance details Defined in Network.SOCKS5.Internal Methods (==) :: Status -> Status -> Bool # (/=) :: Status -> Status -> Bool #

newtype UserPassResponse Source #

Constructors

UserPassResponse
Fields status :: Status

Instances

Instances details

Show UserPassResponse Source #
Instance details Defined in Network.SOCKS5.Internal Methods showsPrec :: Int -> UserPassResponse -> ShowS # show :: UserPassResponse -> String # showList :: [UserPassResponse] -> ShowS #
Binary UserPassResponse Source #
Instance details Defined in Network.SOCKS5.Internal Methods put :: UserPassResponse -> Put # get :: Get UserPassResponse # putList :: [UserPassResponse] -> Put #
Eq UserPassResponse Source #
Instance details Defined in Network.SOCKS5.Internal Methods (==) :: UserPassResponse -> UserPassResponse -> Bool # (/=) :: UserPassResponse -> UserPassResponse -> Bool #

data SOCKSException Source #

Constructors

HandshakeFail Reply
AuthUnsupported Method
AuthFailed Status
AuthMissingCredentials
ConnectionToTargetFailed SomeException
NoAcceptableAuthMethods
PortStringInvalid ServiceName

Instances

Instances details

Exception SOCKSException Source #
Instance details Defined in Network.SOCKS5.Internal Methods toException :: SOCKSException -> SomeException # fromException :: SomeException -> Maybe SOCKSException # displayException :: SOCKSException -> String #
Show SOCKSException Source #
Instance details Defined in Network.SOCKS5.Internal Methods showsPrec :: Int -> SOCKSException -> ShowS # show :: SOCKSException -> String # showList :: [SOCKSException] -> ShowS #

class Connection c where Source #

Methods

connRecv :: c -> IO ByteString Source #

connSend :: c -> ByteString -> IO () Source #

Instances

Instances details

Connection Socket Source #
Instance details Defined in Network.SOCKS5.Internal Methods connRecv :: Socket -> IO ByteString Source # connSend :: Socket -> ByteString -> IO () Source #
Connection Context Source #
Instance details Defined in Network.SOCKS5.Internal Methods connRecv :: Context -> IO ByteString Source # connSend :: Context -> ByteString -> IO () Source #

fromSockAddr_ :: SockAddr -> (Address, PortNumber) Source #

toSockAddr_ :: Address -> PortNumber -> SockAddr Source #

recvAndDecode :: (Binary a, Connection c, MonadIO m) => c -> ByteString -> m (a, ByteString) Source #

encodeAndSend :: (Binary a, Connection c, MonadIO m) => c -> a -> m () Source #