Network.Wai.Middleware.HttpAuth

wai-extra-3.1.17: Provides some basic WAI handlers and middleware.

Safe Haskell | None
Language | Haskell2010

Network.Wai.Middleware.HttpAuth

Contents

- Middleware
- Helping functions

Description

Implements HTTP Basic Authentication.

This module may add digest authentication in the future.

Synopsis

- basicAuth :: CheckCreds -> AuthSettings -> Middleware
- basicAuth' :: (Request -> CheckCreds) -> AuthSettings -> Middleware
- type CheckCreds = ByteString -> ByteString -> IO Bool
- data AuthSettings
- authRealm :: AuthSettings -> ByteString
- authOnNoAuth :: AuthSettings -> ByteString -> Application
- authIsProtected :: AuthSettings -> Request -> IO Bool
- extractBasicAuth :: ByteString -> Maybe (ByteString, ByteString)
- extractBearerAuth :: ByteString -> Maybe ByteString

# Middleware

basicAuth :: CheckCreds -> AuthSettings -> Middleware #

Perform basic authentication.

    basicAuth (\u p -> return $ u == "michael" && p == "mypass") "My Realm"

Since: 1.3.4

basicAuth' :: (Request -> CheckCreds) -> AuthSettings -> Middleware #

Like `basicAuth`, but also passes a request to the authentication function.

Since: 3.0.19

type CheckCreds = ByteString -> ByteString -> IO Bool #

Check if a given username and password is valid.

data AuthSettings #

Basic authentication settings. This value is an instance of `IsString`, so the recommended approach to create a value is to provide a string literal (which will be the realm) and then overriding individual fields.

    "My Realm" { authIsProtected = someFunc } :: AuthSettings

Since: 1.3.4

#### Instances

Instances details

IsString AuthSettings # |
Instance details Defined in Network.Wai.Middleware.HttpAuth Methods fromString :: String -> AuthSettings #

authRealm :: AuthSettings -> ByteString #

Since: 1.3.4

authOnNoAuth :: AuthSettings -> ByteString -> Application #

Takes the realm and returns an appropriate 401 response when authentication is not provided.

Since: 1.3.4

authIsProtected :: AuthSettings -> Request -> IO Bool #

Determine if access to the requested resource is restricted.

Default: always returns `True`.

Since: 1.3.4

# Helping functions

extractBasicAuth :: ByteString -> Maybe (ByteString, ByteString) #

Extract basic authentication data from usually Authorization header value. Returns username and password

Since: 3.0.5

extractBearerAuth :: ByteString -> Maybe ByteString #

Extract bearer authentication data from Authorization header value. Returns bearer token

Since: 3.0.5