WebGear.Core.Trait.Auth.Common

Common types and functions related to authorization.

Documentation

type AuthorizationHeader scheme = Header Optional Lenient "Authorization" (AuthToken scheme)

Trait for "Authorization" header

getAuthorizationHeaderTrait :: forall scheme h ts. Get h (AuthorizationHeader scheme) Request => h (Linked ts Request) (Maybe (Either Text (AuthToken scheme)))

Extract the "Authorization" header from a request by specifying an authentication scheme.

The header is split into the scheme and token parts and returned.

newtype Realm

The protection space for authentication

Constructors

Realm ByteString

Instances

IsString Realm

Defined in WebGear.Core.Trait.Auth.Common

Methods

fromString :: String -> Realm

Read Realm

Defined in WebGear.Core.Trait.Auth.Common

Methods

readsPrec :: Int -> ReadS Realm

readList :: ReadS [Realm]

readPrec :: ReadPrec Realm

readListPrec :: ReadPrec [Realm]

Show Realm

Defined in WebGear.Core.Trait.Auth.Common

Methods

showsPrec :: Int -> Realm -> ShowS

show :: Realm -> String

showList :: [Realm] -> ShowS

Eq Realm

Defined in WebGear.Core.Trait.Auth.Common

Methods

(==) :: Realm -> Realm -> Bool

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

Ord Realm

Defined in WebGear.Core.Trait.Auth.Common

Methods

compare :: Realm -> Realm -> Ordering

(<) :: Realm -> Realm -> Bool

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

(>) :: Realm -> Realm -> Bool

(>=) :: Realm -> Realm -> Bool

max :: Realm -> Realm -> Realm

min :: Realm -> Realm -> Realm

data AuthToken (scheme :: Symbol)

The components of Authorization request header

Constructors

AuthToken

Fields

• authScheme :: CI ByteString

  Authentication scheme

• authToken :: ByteString

  Authentication token

Instances

KnownSymbol scheme => FromHttpApiData (AuthToken scheme)

Defined in WebGear.Core.Trait.Auth.Common

Methods

parseUrlPiece :: Text -> Either Text (AuthToken scheme)

parseHeader :: ByteString -> Either Text (AuthToken scheme)

parseQueryParam :: Text -> Either Text (AuthToken scheme)

respondUnauthorized

Arguments

:: (Handler h m, Sets h [Status, RequiredHeader "Content-Type" Text, RequiredHeader "WWW-Authenticate" Text, Body Text] Response)

=> CI ByteString

The authentication scheme

-> Realm

The authentication realm

-> h a Response

Create a "401 Unauthorized" response.

The response will have a plain text body and an appropriate "WWW-Authenticate" header.