-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Abstraction over creating network connections with SOCKS5 and TLS
--   
--   This package provides an abstraction for communicating with
--   line-oriented network services while abstracting over the use of
--   SOCKS5 and TLS (via OpenSSL)
@package hookup
@version 0.2.3


-- | This module provides a uniform interface to network connections with
--   optional support for TLS and SOCKS.
--   
--   This library is careful to support both IPv4 and IPv6. It will attempt
--   to all of the addresses that a domain name resolves to until one the
--   first successful connection.
--   
--   Use <a>connect</a> and <a>close</a> to establish and close network
--   connections.
--   
--   Use <a>recv</a>, <a>recvLine</a>, and <a>send</a> to receive and
--   transmit data on an open network connection.
--   
--   TLS and SOCKS parameters can be provided. When both are provided a
--   connection will first be established to the SOCKS server and then the
--   TLS connection will be established through that proxy server. This is
--   most useful when connecting through a dynamic port forward of an SSH
--   client via the <tt>-D</tt> flag.
module Hookup

-- | A connection to a network service along with its read buffer used for
--   line-oriented protocols. The connection could be a plain network
--   connection, SOCKS connected, or TLS.
data Connection

-- | Open network connection to TCP service specified by the given
--   parameters.
--   
--   The resulting connection MUST be closed with <a>close</a> to avoid
--   leaking resources.
--   
--   Throws <a>IOError</a>, <a>SocksError</a>, <a>ProtocolError</a>,
--   <a>ConnectionFailure</a>
connect :: ConnectionParams -> IO Connection

-- | Create a new <a>Connection</a> using an already connected socket. This
--   will attempt to start TLS if configured but will ignore any SOCKS
--   server settings as it is assumed that the socket is already actively
--   connected to the intended service.
--   
--   Throws <a>ProtocolError</a>
connectWithSocket :: ConnectionParams -> Socket -> IO Connection

-- | Close network connection.
close :: Connection -> IO ()

-- | Receive the next chunk from the stream. This operation will first
--   return the buffer if it contains a non-empty chunk. Otherwise it will
--   request up to the requested number of bytes from the stream.
--   
--   Throws: <a>IOError</a>, <a>ConnectionAbruptlyTerminated</a>,
--   <a>ProtocolError</a>
recv :: Connection -> Int -> IO ByteString

-- | Receive a line from the network connection. Both <tt>"\r\n"</tt> and
--   <tt>"\n"</tt> are recognized.
--   
--   Returning <a>Nothing</a> means that the peer has closed its half of
--   the connection.
--   
--   Unterminated lines will raise a <a>LineTruncated</a> exception. This
--   can happen if the peer transmits some data and closes its end without
--   transmitting a line terminator.
--   
--   Throws: <a>ConnectionAbruptlyTerminated</a>, <a>ProtocolError</a>,
--   <a>ConnectionFailure</a>, <a>IOError</a>
recvLine :: Connection -> Int -> IO (Maybe ByteString)

-- | Send bytes on the network connection. This ensures the whole chunk is
--   transmitted, which might take multiple underlying sends.
--   
--   Throws: <a>IOError</a>, <a>ProtocolError</a>
send :: Connection -> ByteString -> IO ()

-- | Push a <a>ByteString</a> onto the buffer so that it will be the first
--   bytes to be read on the next receive operation. This could perhaps be
--   useful for putting the unused portion of a <a>recv</a> back into the
--   buffer for future <a>recvLine</a> or <a>recv</a> operations.
putBuf :: Connection -> ByteString -> IO ()

-- | Parameters for <a>connect</a>.
--   
--   Common defaults for fields: <a>defaultFamily</a>,
--   <a>defaultTlsParams</a>
--   
--   The address family can be specified in order to force only IPv4 or
--   IPv6 to be used. The default behavior is to support both. It can be
--   useful to specify exactly one of these in the case that the other is
--   misconfigured and a hostname is resolving to both.
--   
--   When a <a>SocksParams</a> is provided the connection will be
--   established using a SOCKS (version 5) proxy.
--   
--   When a <a>TlsParams</a> is provided the connection negotiate TLS at
--   connect time in order to protect the stream.
data ConnectionParams
ConnectionParams :: Family -> HostName -> PortNumber -> Maybe SocksParams -> Maybe TlsParams -> ConnectionParams

-- | IP Protocol family (default <tt>AF_UNSPEC</tt>)
[cpFamily] :: ConnectionParams -> Family

-- | Destination host
[cpHost] :: ConnectionParams -> HostName

-- | Destination TCP port
[cpPort] :: ConnectionParams -> PortNumber

-- | Optional SOCKS parameters
[cpSocks] :: ConnectionParams -> Maybe SocksParams

-- | Optional TLS parameters
[cpTls] :: ConnectionParams -> Maybe TlsParams

-- | SOCKS connection parameters
data SocksParams
SocksParams :: HostName -> PortNumber -> SocksParams

-- | SOCKS server host
[spHost] :: SocksParams -> HostName

-- | SOCKS server port
[spPort] :: SocksParams -> PortNumber

-- | TLS connection parameters. These parameters are passed to OpenSSL when
--   making a secure connection.
data TlsParams
TlsParams :: Maybe FilePath -> Maybe FilePath -> Maybe FilePath -> String -> Bool -> TlsParams

-- | Path to client certificate
[tpClientCertificate] :: TlsParams -> Maybe FilePath

-- | Path to client private key
[tpClientPrivateKey] :: TlsParams -> Maybe FilePath

-- | Path to CA certificate bundle
[tpServerCertificate] :: TlsParams -> Maybe FilePath

-- | OpenSSL cipher suite name (e.g. <tt>"HIGH"</tt>)
[tpCipherSuite] :: TlsParams -> String

-- | Disables certificate checking when <a>True</a>
[tpInsecure] :: TlsParams -> Bool

-- | Default <a>Family</a> value is unspecified and allows both INET and
--   INET6.
defaultFamily :: Family

-- | Default values for TLS that use no client certificates, use system CA
--   root, <tt>"HIGH"</tt> cipher suite, and which validate hostnames.
defaultTlsParams :: TlsParams

-- | Type for errors that can be thrown by this package.
data ConnectionFailure

-- | Failure during <tt>getAddrInfo</tt> resolving remote host
HostnameResolutionFailure :: IOError -> ConnectionFailure

-- | Failure during <a>connect</a> to remote host
ConnectionFailure :: [IOError] -> ConnectionFailure

-- | Failure during <a>recvLine</a>
LineTooLong :: ConnectionFailure

-- | Incomplete line during <a>recvLine</a>
LineTruncated :: ConnectionFailure

-- | Socks command rejected by server by given reply code
SocksError :: CommandReply -> ConnectionFailure

-- | Socks authentication method was not accepted
SocksAuthenticationError :: ConnectionFailure

-- | Socks server sent an invalid message or no message.
SocksProtocolError :: ConnectionFailure

-- | Domain name was too long for SOCKS protocol
SocksBadDomainName :: ConnectionFailure

-- | SOCKS command reply codes
newtype CommandReply
CommandReply :: Word8 -> CommandReply
pattern Succeeded :: () => () => CommandReply
pattern GeneralFailure :: () => () => CommandReply
pattern NotAllowed :: () => () => CommandReply
pattern NetUnreachable :: () => () => CommandReply
pattern HostUnreachable :: () => () => CommandReply
pattern ConnectionRefused :: () => () => CommandReply
pattern TTLExpired :: () => () => CommandReply
pattern CmdNotSupported :: () => () => CommandReply
pattern AddrNotSupported :: () => () => CommandReply

-- | Get peer certificate if one exists.
getPeerCertificate :: Connection -> IO (Maybe X509)
getPeerCertFingerprintSha1 :: Connection -> IO (Maybe ByteString)
getPeerCertFingerprintSha256 :: Connection -> IO (Maybe ByteString)
getPeerCertFingerprintSha512 :: Connection -> IO (Maybe ByteString)
getPeerPubkeyFingerprintSha1 :: Connection -> IO (Maybe ByteString)
getPeerPubkeyFingerprintSha256 :: Connection -> IO (Maybe ByteString)
getPeerPubkeyFingerprintSha512 :: Connection -> IO (Maybe ByteString)
instance GHC.Show.Show Hookup.ConnectionFailure
instance GHC.Exception.Type.Exception Hookup.ConnectionFailure