Network.HTTP.ReverseProxy

Types

data ProxyDest

Host/port combination to which we want to proxy.

Constructors

ProxyDest

Fields

• pdHost :: !ByteString
• pdPort :: !Int

Instances

Generic ProxyDest

Defined in Network.HTTP.ReverseProxy

Associated Types

type Rep ProxyDest :: Type -> Type

Methods

from :: ProxyDest -> Rep ProxyDest x

to :: Rep ProxyDest x -> ProxyDest

Read ProxyDest

Defined in Network.HTTP.ReverseProxy

Methods

readsPrec :: Int -> ReadS ProxyDest

readList :: ReadS [ProxyDest]

readPrec :: ReadPrec ProxyDest

readListPrec :: ReadPrec [ProxyDest]

Show ProxyDest

Defined in Network.HTTP.ReverseProxy

Methods

showsPrec :: Int -> ProxyDest -> ShowS

show :: ProxyDest -> String

showList :: [ProxyDest] -> ShowS

Eq ProxyDest

Defined in Network.HTTP.ReverseProxy

Methods

(==) :: ProxyDest -> ProxyDest -> Bool

(/=) :: ProxyDest -> ProxyDest -> Bool

Ord ProxyDest

Defined in Network.HTTP.ReverseProxy

Methods

compare :: ProxyDest -> ProxyDest -> Ordering

(<) :: ProxyDest -> ProxyDest -> Bool

(<=) :: ProxyDest -> ProxyDest -> Bool

(>) :: ProxyDest -> ProxyDest -> Bool

(>=) :: ProxyDest -> ProxyDest -> Bool

max :: ProxyDest -> ProxyDest -> ProxyDest

min :: ProxyDest -> ProxyDest -> ProxyDest

type Rep ProxyDest

Defined in Network.HTTP.ReverseProxy

type Rep ProxyDest = D1 ('MetaData "ProxyDest" "Network.HTTP.ReverseProxy" "http-reverse-proxy-0.6.1.0-J5ylRimayk7GkRa7JUlwfB" 'False) (C1 ('MetaCons "ProxyDest" 'PrefixI 'True) (S1 ('MetaSel ('Just "pdHost") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ByteString) :*: S1 ('MetaSel ('Just "pdPort") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int)))

Raw

rawProxyTo

Arguments

:: MonadUnliftIO m

=> (RequestHeaders -> m (Either (AppData -> m ()) ProxyDest))

How to reverse proxy. A Left result will run the given Application, whereas a Right will reverse proxy to the given host/port.

-> AppData

-> m ()

Set up a reverse proxy server, which will have a minimal overhead.

This function uses raw sockets, parsing as little of the request as possible. The workflow is:

1. Parse the first request headers.
2. Ask the supplied function to specify how to reverse proxy.
3. Open up a connection to the given host/port.
4. Pass all bytes across the wire unchanged.

If you need more control, such as modifying the request or response, use waiProxyTo.

rawTcpProxyTo :: MonadIO m => ProxyDest -> AppData -> m ()

Set up a reverse tcp proxy server, which will have a minimal overhead.

This function uses raw sockets, parsing as little of the request as possible. The workflow is:

1. Open up a connection to the given host/port.
2. Pass all bytes across the wire unchanged.

If you need more control, such as modifying the request or response, use waiProxyTo.

Since: 0.4.4

WAI + http-conduit

waiProxyTo

Arguments

:: (Request -> IO WaiProxyResponse)

How to reverse proxy.

-> (SomeException -> Application)

How to handle exceptions when calling remote server. For a simple 502 error page, use defaultOnExc.

-> Manager

connection manager to utilize

-> Application

Creates a WAI Application which will handle reverse proxies.

Connections to the proxied server will be provided via http-conduit. As such, all requests and responses will be fully processed in your reverse proxy. This allows you much more control over the data sent over the wire, but also incurs overhead. For a lower-overhead approach, consider rawProxyTo.

Most likely, the given application should be run with Warp, though in theory other WAI handlers will work as well.

Note: This function will use chunked request bodies for communicating with the proxied server. Not all servers necessarily support chunked request bodies, so please confirm that yours does (Warp, Snap, and Happstack, for example, do).

defaultOnExc :: SomeException -> Application

Sends a simple 502 bad gateway error message with the contents of the exception.

waiProxyToSettings :: (Request -> IO WaiProxyResponse) -> WaiProxySettings -> Manager -> Application

data WaiProxyResponse

The different responses that could be generated by a waiProxyTo lookup function.

Since: 0.2.0

Constructors

WPRResponse Response

Respond with the given WAI Response.

Since: 0.2.0

WPRProxyDest ProxyDest

Send to the given destination.

Since: 0.2.0

WPRProxyDestSecure ProxyDest

Send to the given destination via HTTPS.

WPRModifiedRequest Request ProxyDest

Send to the given destination, but use the given modified Request for computing the reverse-proxied request. This can be useful for reverse proxying to a different path than the one specified. By the user. The path will be taken from rawPathInfo while the queryString from rawQueryString of the request.

Since: 0.2.0

WPRModifiedRequestSecure Request ProxyDest

Same as WPRModifiedRequest but send to the given destination via HTTPS.

WPRApplication Application

Respond with the given WAI Application.

Since: 0.4.0

Settings

data WaiProxySettings

defaultWaiProxySettings :: WaiProxySettings

Default value for WaiProxySettings

Since: 0.6.0

wpsOnExc :: WaiProxySettings -> SomeException -> Application

wpsTimeout :: WaiProxySettings -> Maybe Int

wpsSetIpHeader :: WaiProxySettings -> SetIpHeader

Set the X-Real-IP request header with the client's IP address.

Default: SIHFromSocket

Since: 0.2.0

wpsProcessBody :: WaiProxySettings -> Request -> Response () -> Maybe (ConduitT ByteString (Flush Builder) IO ())

Post-process the response body returned from the host. The API for this function changed to include the extra Request parameter in version 0.5.0.

Since: 0.2.1

wpsUpgradeToRaw :: WaiProxySettings -> Request -> Bool

Determine if the request should be upgraded to a raw proxy connection, as is needed for WebSockets. Requires WAI 2.1 or higher and a WAI handler with raw response support (e.g., Warp) to work.

Default: check if the upgrade header is websocket.

Since: 0.3.1

wpsGetDest :: WaiProxySettings -> Maybe (Request -> IO (LocalWaiProxySettings, WaiProxyResponse))

Allow to override proxy settings for each request. If you supply this field it will take precedence over getDest parameter in waiProxyToSettings

Default: have one global setting

Since: 0.4.2

wpsLogRequest :: WaiProxySettings -> Request -> IO ()

Function provided to log the Request that is constructed.

Default: no op

Since: 0.6.0.1

wpsModifyResponseHeaders :: WaiProxySettings -> Request -> Response () -> ResponseHeaders -> ResponseHeaders

Allow to override the response headers before the response is returned upstream. Useful for example to override overly-strict 'Content-Security-Policy' when the source is known to be trustworthy.

Default: no op

Since: 0.6.1.0

data SetIpHeader

How to set the X-Real-IP request header.

Since: 0.2.0

Constructors

SIHNone

Do not set the header

SIHFromSocket

Set it from the socket's address.

SIHFromHeader

Set it from either X-Real-IP or X-Forwarded-For, if present

Local settings

data LocalWaiProxySettings

defaultLocalWaiProxySettings :: LocalWaiProxySettings

Default value for LocalWaiProxySettings, same as def but with a more explicit name.

Since: 0.4.2

setLpsTimeBound :: Maybe Int -> LocalWaiProxySettings -> LocalWaiProxySettings

Allows to specify the maximum time allowed for the conection on per request basis.

Default: no timeouts

Since: 0.4.2