Servant.API.IsSecure · servant-0.20.2

| Use IsSecure whenever your request handlers need to know whether the connection to the server is secure or not. This would make the request handlers receive an argument of type IsSecure, whose value can be one of Secure (HTTPS) or NotSecure (HTTP).

Example:

Example1 expression

>>> type API = "sensitive-data" :> IsSecure :> Get '[JSON] NationSecrets

datadata IsSecure

Was this request made over an SSL connection?

Note that this value will not tell you if the client originally made this request over SSL, but rather whether the current connection is SSL. The distinction lies with reverse proxies. In many cases, the client will connect to a load balancer over SSL, but connect to the WAI handler without SSL. In such a case, the handlers would get NotSecure, but from a user perspective, there is a secure connection.

Constructors

Secure
the connection to the server is secure (HTTPS)
NotSecure
the connection to the server is not secure (HTTP)

Instances8Eq, Ord, Read, Show, Generic, HasLink, …

Eq IsSecureDefined in servant-0.20.2 · Servant.API.IsSecure
Ord IsSecureDefined in servant-0.20.2 · Servant.API.IsSecure
Read IsSecureDefined in servant-0.20.2 · Servant.API.IsSecure
Show IsSecureDefined in servant-0.20.2 · Servant.API.IsSecure
Generic IsSecureDefined in servant-0.20.2 · Servant.API.IsSecure
HasLink sub => HasLink (IsSecure :> sub)Defined in servant-0.20.2 · Servant.Links
type Rep IsSecure = D1 ('MetaData "IsSecure" "Servant.API.IsSecure" "servant-0.20.2-kmMZib8zXn7e8NZPkSX15" 'False) (C1 ('MetaCons "Secure" 'PrefixI 'False) U1 :+: C1 ('MetaCons "NotSecure" 'PrefixI 'False) U1)Defined in servant-0.20.2 · Servant.API.IsSecure
type MkLink (IsSecure :> sub) a = MkLink sub aDefined in servant-0.20.2 · Servant.Links