Network.Socks5.Types

socks-0.5.5: Socks proxy (version 5) implementation.

License | BSD-style
Maintainer | Vincent Hanquez <vincent@snarc.org>
Stability | experimental
Portability | unknown
Safe Haskell | None
Language | Haskell98

Network.Socks5.Types

Description

Synopsis

- data SocksVersion = SocksVer5
- data SocksCommand
  - = SocksCommandConnect
  - | SocksCommandBind
  - | SocksCommandUdpAssociate
  - | SocksCommandOther !Word8
- data SocksMethod
  - = SocksMethodNone
  - | SocksMethodGSSAPI
  - | SocksMethodUsernamePassword
  - | SocksMethodOther !Word8
  - | SocksMethodNotAcceptable
- data SocksHostAddress
  - = SocksAddrIPV4 !HostAddress
  - | SocksAddrDomainName !ByteString
  - | SocksAddrIPV6 !HostAddress6
- data SocksAddress = SocksAddress !SocksHostAddress !PortNumber
- data SocksReply
  - = SocksReplySuccess
  - | SocksReplyError SocksError
- data SocksVersionNotSupported = SocksVersionNotSupported
- data SocksError
  - = SocksErrorGeneralServerFailure
  - | SocksErrorConnectionNotAllowedByRule
  - | SocksErrorNetworkUnreachable
  - | SocksErrorHostUnreachable
  - | SocksErrorConnectionRefused
  - | SocksErrorTTLExpired
  - | SocksErrorCommandNotSupported
  - | SocksErrorAddrTypeNotSupported
  - | SocksErrorOther Word8

# Documentation

data SocksVersion #

Socks Version

Constructors

SocksVer5 |

Instances

Eq SocksVersion # |
Methods (==) :: SocksVersion -> SocksVersion -> Bool # (/=) :: SocksVersion -> SocksVersion -> Bool #
Ord SocksVersion # |
Methods compare :: SocksVersion -> SocksVersion -> Ordering # (<) :: SocksVersion -> SocksVersion -> Bool # (<=) :: SocksVersion -> SocksVersion -> Bool # (>) :: SocksVersion -> SocksVersion -> Bool # (>=) :: SocksVersion -> SocksVersion -> Bool # max :: SocksVersion -> SocksVersion -> SocksVersion # min :: SocksVersion -> SocksVersion -> SocksVersion #
Show SocksVersion # |
Methods showsPrec :: Int -> SocksVersion -> ShowS # show :: SocksVersion -> String # showList :: [SocksVersion] -> ShowS #

data SocksCommand #

Command that can be send and receive on the SOCKS protocol

Constructors

SocksCommandConnect |
SocksCommandBind |
SocksCommandUdpAssociate |
SocksCommandOther !Word8 |

Instances

Enum SocksCommand # |
Methods succ :: SocksCommand -> SocksCommand # pred :: SocksCommand -> SocksCommand # toEnum :: Int -> SocksCommand # fromEnum :: SocksCommand -> Int # enumFrom :: SocksCommand -> [SocksCommand] # enumFromThen :: SocksCommand -> SocksCommand -> [SocksCommand] # enumFromTo :: SocksCommand -> SocksCommand -> [SocksCommand] # enumFromThenTo :: SocksCommand -> SocksCommand -> SocksCommand -> [SocksCommand] #
Eq SocksCommand # |
Methods (==) :: SocksCommand -> SocksCommand -> Bool # (/=) :: SocksCommand -> SocksCommand -> Bool #
Ord SocksCommand # |
Methods compare :: SocksCommand -> SocksCommand -> Ordering # (<) :: SocksCommand -> SocksCommand -> Bool # (<=) :: SocksCommand -> SocksCommand -> Bool # (>) :: SocksCommand -> SocksCommand -> Bool # (>=) :: SocksCommand -> SocksCommand -> Bool # max :: SocksCommand -> SocksCommand -> SocksCommand # min :: SocksCommand -> SocksCommand -> SocksCommand #
Show SocksCommand # |
Methods showsPrec :: Int -> SocksCommand -> ShowS # show :: SocksCommand -> String # showList :: [SocksCommand] -> ShowS #

data SocksMethod #

Authentication methods available on the SOCKS protocol.

Only SocksMethodNone is effectively implemented, but other value are enumerated for completeness.

Constructors

SocksMethodNone |
SocksMethodGSSAPI |
SocksMethodUsernamePassword |
SocksMethodOther !Word8 |
SocksMethodNotAcceptable |

Instances

Enum SocksMethod # |
Methods succ :: SocksMethod -> SocksMethod # pred :: SocksMethod -> SocksMethod # toEnum :: Int -> SocksMethod # fromEnum :: SocksMethod -> Int # enumFrom :: SocksMethod -> [SocksMethod] # enumFromThen :: SocksMethod -> SocksMethod -> [SocksMethod] # enumFromTo :: SocksMethod -> SocksMethod -> [SocksMethod] # enumFromThenTo :: SocksMethod -> SocksMethod -> SocksMethod -> [SocksMethod] #
Eq SocksMethod # |
Methods (==) :: SocksMethod -> SocksMethod -> Bool # (/=) :: SocksMethod -> SocksMethod -> Bool #
Ord SocksMethod # |
Methods compare :: SocksMethod -> SocksMethod -> Ordering # (<) :: SocksMethod -> SocksMethod -> Bool # (<=) :: SocksMethod -> SocksMethod -> Bool # (>) :: SocksMethod -> SocksMethod -> Bool # (>=) :: SocksMethod -> SocksMethod -> Bool # max :: SocksMethod -> SocksMethod -> SocksMethod # min :: SocksMethod -> SocksMethod -> SocksMethod #
Show SocksMethod # |
Methods showsPrec :: Int -> SocksMethod -> ShowS # show :: SocksMethod -> String # showList :: [SocksMethod] -> ShowS #

data SocksHostAddress #

A Host address on the SOCKS protocol.

Constructors

SocksAddrIPV4 !HostAddress |
SocksAddrDomainName !ByteString |
SocksAddrIPV6 !HostAddress6 |

Instances

Eq SocksHostAddress # |
Methods (==) :: SocksHostAddress -> SocksHostAddress -> Bool # (/=) :: SocksHostAddress -> SocksHostAddress -> Bool #
Ord SocksHostAddress # |
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 # |
Methods showsPrec :: Int -> SocksHostAddress -> ShowS # show :: SocksHostAddress -> String # showList :: [SocksHostAddress] -> ShowS #

data SocksAddress #

Describe a Socket address on the SOCKS protocol

Constructors

SocksAddress !SocksHostAddress !PortNumber |

Instances

Eq SocksAddress # |
Methods (==) :: SocksAddress -> SocksAddress -> Bool # (/=) :: SocksAddress -> SocksAddress -> Bool #
Ord SocksAddress # |
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 # |
Methods showsPrec :: Int -> SocksAddress -> ShowS # show :: SocksAddress -> String # showList :: [SocksAddress] -> ShowS #

data SocksReply #

Type of reply on the SOCKS protocol

Constructors

SocksReplySuccess |
SocksReplyError SocksError |

Instances

Enum SocksReply # |
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 # |
Methods (==) :: SocksReply -> SocksReply -> Bool # (/=) :: SocksReply -> SocksReply -> Bool #
Data SocksReply # |
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 # |
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 # |
Methods showsPrec :: Int -> SocksReply -> ShowS # show :: SocksReply -> String # showList :: [SocksReply] -> ShowS #

data SocksVersionNotSupported #

Exception returned when using a SOCKS version that is not supported.

This package only implement version 5.

Constructors

SocksVersionNotSupported |

Instances

Data SocksVersionNotSupported # |
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SocksVersionNotSupported -> c SocksVersionNotSupported # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SocksVersionNotSupported # toConstr :: SocksVersionNotSupported -> Constr # dataTypeOf :: SocksVersionNotSupported -> DataType # dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SocksVersionNotSupported) # dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SocksVersionNotSupported) # gmapT :: (forall b. Data b => b -> b) -> SocksVersionNotSupported -> SocksVersionNotSupported # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SocksVersionNotSupported -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SocksVersionNotSupported -> r # gmapQ :: (forall d. Data d => d -> u) -> SocksVersionNotSupported -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SocksVersionNotSupported -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SocksVersionNotSupported -> m SocksVersionNotSupported # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SocksVersionNotSupported -> m SocksVersionNotSupported # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SocksVersionNotSupported -> m SocksVersionNotSupported #
Show SocksVersionNotSupported # |
Methods showsPrec :: Int -> SocksVersionNotSupported -> ShowS # show :: SocksVersionNotSupported -> String # showList :: [SocksVersionNotSupported] -> ShowS #
Exception SocksVersionNotSupported # |
Methods toException :: SocksVersionNotSupported -> SomeException # fromException :: SomeException -> Maybe SocksVersionNotSupported # displayException :: SocksVersionNotSupported -> String #

data SocksError #

SOCKS error that can be received or sent

Constructors

SocksErrorGeneralServerFailure |
SocksErrorConnectionNotAllowedByRule |
SocksErrorNetworkUnreachable |
SocksErrorHostUnreachable |
SocksErrorConnectionRefused |
SocksErrorTTLExpired |
SocksErrorCommandNotSupported |
SocksErrorAddrTypeNotSupported |
SocksErrorOther Word8 |

Instances

Enum SocksError # |
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 # |
Methods (==) :: SocksError -> SocksError -> Bool # (/=) :: SocksError -> SocksError -> Bool #
Data SocksError # |
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 # |
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 # |
Methods showsPrec :: Int -> SocksError -> ShowS # show :: SocksError -> String # showList :: [SocksError] -> ShowS #
Exception SocksError # |
Methods toException :: SocksError -> SomeException # fromException :: SomeException -> Maybe SocksError # displayException :: SocksError -> String #