WebGear.Middlewares.Auth.Basic

Basic authentication support.

Documentation

data BasicAuth

Trait for HTTP basic authentication: https://tools.ietf.org/html/rfc7617

Instances

Monad m => Trait BasicAuth Request m

Defined in WebGear.Middlewares.Auth.Basic

Associated Types

type Attribute BasicAuth Request

type Absence BasicAuth Request

Methods

toAttribute :: Request -> m (Result BasicAuth Request)

type Attribute BasicAuth Request

Defined in WebGear.Middlewares.Auth.Basic

type Attribute BasicAuth Request = Credentials

type Absence BasicAuth Request

Defined in WebGear.Middlewares.Auth.Basic

type Absence BasicAuth Request = BasicAuthError

newtype Realm

The protection space for basic authentication

Constructors

Realm ByteString

Instances

Eq Realm

Defined in WebGear.Middlewares.Auth.Basic

Methods

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

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

Ord Realm

Defined in WebGear.Middlewares.Auth.Basic

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

Read Realm

Defined in WebGear.Middlewares.Auth.Basic

Methods

readsPrec :: Int -> ReadS Realm

readList :: ReadS [Realm]

readPrec :: ReadPrec Realm

readListPrec :: ReadPrec [Realm]

Show Realm

Defined in WebGear.Middlewares.Auth.Basic

Methods

showsPrec :: Int -> Realm -> ShowS

show :: Realm -> String

showList :: [Realm] -> ShowS

IsString Realm

Defined in WebGear.Middlewares.Auth.Basic

Methods

fromString :: String -> Realm

newtype Username

Username for basic authentication. Valid usernames cannot contain ':' characters.

Constructors

Username ByteString

Instances

Eq Username

Defined in WebGear.Middlewares.Auth.Basic

Methods

(==) :: Username -> Username -> Bool

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

Ord Username

Defined in WebGear.Middlewares.Auth.Basic

Methods

compare :: Username -> Username -> Ordering

(<) :: Username -> Username -> Bool

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

(>) :: Username -> Username -> Bool

(>=) :: Username -> Username -> Bool

max :: Username -> Username -> Username

min :: Username -> Username -> Username

Read Username

Defined in WebGear.Middlewares.Auth.Basic

Methods

readsPrec :: Int -> ReadS Username

readList :: ReadS [Username]

readPrec :: ReadPrec Username

readListPrec :: ReadPrec [Username]

Show Username

Defined in WebGear.Middlewares.Auth.Basic

Methods

showsPrec :: Int -> Username -> ShowS

show :: Username -> String

showList :: [Username] -> ShowS

IsString Username

Defined in WebGear.Middlewares.Auth.Basic

Methods

fromString :: String -> Username

newtype Password

Password for basic authentication.

Constructors

Password ByteString

Instances

Eq Password

Defined in WebGear.Middlewares.Auth.Basic

Methods

(==) :: Password -> Password -> Bool

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

Ord Password

Defined in WebGear.Middlewares.Auth.Basic

Methods

compare :: Password -> Password -> Ordering

(<) :: Password -> Password -> Bool

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

(>) :: Password -> Password -> Bool

(>=) :: Password -> Password -> Bool

max :: Password -> Password -> Password

min :: Password -> Password -> Password

Read Password

Defined in WebGear.Middlewares.Auth.Basic

Methods

readsPrec :: Int -> ReadS Password

readList :: ReadS [Password]

readPrec :: ReadPrec Password

readListPrec :: ReadPrec [Password]

Show Password

Defined in WebGear.Middlewares.Auth.Basic

Methods

showsPrec :: Int -> Password -> ShowS

show :: Password -> String

showList :: [Password] -> ShowS

IsString Password

Defined in WebGear.Middlewares.Auth.Basic

Methods

fromString :: String -> Password

data Credentials

Basic authentication credentials retrieved from an HTTP request

Constructors

Credentials

Fields

• credentialsUsername :: !Username
• credentialsPassword :: !Password

Instances

Eq Credentials

Defined in WebGear.Middlewares.Auth.Basic

Methods

(==) :: Credentials -> Credentials -> Bool

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

Ord Credentials

Defined in WebGear.Middlewares.Auth.Basic

Methods

compare :: Credentials -> Credentials -> Ordering

(<) :: Credentials -> Credentials -> Bool

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

(>) :: Credentials -> Credentials -> Bool

(>=) :: Credentials -> Credentials -> Bool

max :: Credentials -> Credentials -> Credentials

min :: Credentials -> Credentials -> Credentials

Read Credentials

Defined in WebGear.Middlewares.Auth.Basic

Methods

readsPrec :: Int -> ReadS Credentials

readList :: ReadS [Credentials]

readPrec :: ReadPrec Credentials

readListPrec :: ReadPrec [Credentials]

Show Credentials

Defined in WebGear.Middlewares.Auth.Basic

Methods

showsPrec :: Int -> Credentials -> ShowS

show :: Credentials -> String

showList :: [Credentials] -> ShowS

data BasicAuthError

Error extracting credentials from an HTTP request

Constructors

AuthHeaderError

Authorization header is missing or badly formatted

AuthSchemeMismatch

Authorization scheme is not Basic

Instances

Eq BasicAuthError

Defined in WebGear.Middlewares.Auth.Basic

Methods

(==) :: BasicAuthError -> BasicAuthError -> Bool

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

Ord BasicAuthError

Defined in WebGear.Middlewares.Auth.Basic

Methods

compare :: BasicAuthError -> BasicAuthError -> Ordering

(<) :: BasicAuthError -> BasicAuthError -> Bool

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

(>) :: BasicAuthError -> BasicAuthError -> Bool

(>=) :: BasicAuthError -> BasicAuthError -> Bool

max :: BasicAuthError -> BasicAuthError -> BasicAuthError

min :: BasicAuthError -> BasicAuthError -> BasicAuthError

Read BasicAuthError

Defined in WebGear.Middlewares.Auth.Basic

Methods

readsPrec :: Int -> ReadS BasicAuthError

readList :: ReadS [BasicAuthError]

readPrec :: ReadPrec BasicAuthError

readListPrec :: ReadPrec [BasicAuthError]

Show BasicAuthError

Defined in WebGear.Middlewares.Auth.Basic

Methods

showsPrec :: Int -> BasicAuthError -> ShowS

show :: BasicAuthError -> String

showList :: [BasicAuthError] -> ShowS

basicAuth :: forall m req a. MonadRouter m => Realm -> (Credentials -> m Bool) -> RequestMiddleware' m req (BasicAuth ': req) a

Middleware to add basic authentication protection for a handler.

Example usage:

basicAuth "realm" isValidCredentials handler

This middleware returns a 401 response if no credentials are found in the request. It returns a 403 response if credentials are present but isValidCredentials returns False.