Network.Wai.Middleware.Auth.Provider

Documentation

class AuthProvider ap where

Core Authentication class, that allows for extensibility of the Auth middleware created by mkAuthMiddleware. Most important function is handleLogin, which implements the actual behavior of a provider. It's function arguments in order:

• ap - Current provider.
• Request - Request made to the login page
• [Text] - Url suffix, i.e. last part of the Url split by '/' character, for instance ["login", "complete"] suffix in the example below.

• Render ProviderUrl - Url renderer. It takes desired suffix as first argument and produces an absolute Url renderer. It can further be used to generate provider urls, for instance in Hamlet templates as will result in "https://approot.com/_auth_middleware/providerName/login/complete?user=Hamlet" or generate Urls for callbacks.

  @?{(ProviderUrl ["login", "complete"], [("user", Hamlet)])}
  

• (AuthLoginState -> IO Response) - Action to call on a successfull login.
• (Status -> ByteString -> IO Response) - Should be called in case of a failure with login process by supplying a status and a short error message.

Minimal complete definition

getProviderName, getProviderInfo, handleLogin

Methods

getProviderName :: ap -> Text

Return a name for the provider. It will be used as a unique identifier for this provider. Argument should not be evaluated, as there are many places were undefined value is passed to this function.

Since: 0.1.0

getProviderInfo :: ap -> ProviderInfo

Get info about the provider. It will be used in rendering the web page with a list of providers.

Since: 0.1.0

handleLogin :: ap -> Request -> [Text] -> Render ProviderUrl -> (AuthLoginState -> IO Response) -> (Status -> ByteString -> IO Response) -> IO Response

Handle a login request in a custom manner. Can be used to render a login page with a form or redirect to some other authentication service like OpenID or OAuth2.

Since: 0.1.0

refreshLoginState :: ap -> Request -> AuthUser -> IO (Maybe (Request, AuthUser))

Check if the login state in a session is still valid, and have the opportunity to update it. Return Nothing to indicate a session has expired, and the user will be directed to re-authenticate.

The default implementation never invalidates a session once set.

Since: 0.2.3.0

Instances

AuthProvider Provider

Defined in Network.Wai.Middleware.Auth.Provider

Methods

getProviderName :: Provider -> Text

getProviderInfo :: Provider -> ProviderInfo

handleLogin :: Provider -> Request -> [Text] -> Render ProviderUrl -> (AuthLoginState -> IO Response) -> (Status -> ByteString -> IO Response) -> IO Response

refreshLoginState :: Provider -> Request -> AuthUser -> IO (Maybe (Request, AuthUser))

AuthProvider OAuth2

Defined in Network.Wai.Middleware.Auth.OAuth2

Methods

getProviderName :: OAuth2 -> Text

getProviderInfo :: OAuth2 -> ProviderInfo

handleLogin :: OAuth2 -> Request -> [Text] -> Render ProviderUrl -> (AuthLoginState -> IO Response) -> (Status -> ByteString -> IO Response) -> IO Response

refreshLoginState :: OAuth2 -> Request -> AuthUser -> IO (Maybe (Request, AuthUser))

AuthProvider OpenIDConnect

Defined in Network.Wai.Middleware.Auth.OIDC

Methods

getProviderName :: OpenIDConnect -> Text

getProviderInfo :: OpenIDConnect -> ProviderInfo

handleLogin :: OpenIDConnect -> Request -> [Text] -> Render ProviderUrl -> (AuthLoginState -> IO Response) -> (Status -> ByteString -> IO Response) -> IO Response

refreshLoginState :: OpenIDConnect -> Request -> AuthUser -> IO (Maybe (Request, AuthUser))

AuthProvider Google

Defined in Network.Wai.Middleware.Auth.OAuth2.Google

Methods

getProviderName :: Google -> Text

getProviderInfo :: Google -> ProviderInfo

handleLogin :: Google -> Request -> [Text] -> Render ProviderUrl -> (AuthLoginState -> IO Response) -> (Status -> ByteString -> IO Response) -> IO Response

refreshLoginState :: Google -> Request -> AuthUser -> IO (Maybe (Request, AuthUser))

AuthProvider Gitlab

Defined in Network.Wai.Middleware.Auth.OAuth2.Gitlab

Methods

getProviderName :: Gitlab -> Text

getProviderInfo :: Gitlab -> ProviderInfo

handleLogin :: Gitlab -> Request -> [Text] -> Render ProviderUrl -> (AuthLoginState -> IO Response) -> (Status -> ByteString -> IO Response) -> IO Response

refreshLoginState :: Gitlab -> Request -> AuthUser -> IO (Maybe (Request, AuthUser))

AuthProvider Github

Defined in Network.Wai.Middleware.Auth.OAuth2.Github

Methods

getProviderName :: Github -> Text

getProviderInfo :: Github -> ProviderInfo

handleLogin :: Github -> Request -> [Text] -> Render ProviderUrl -> (AuthLoginState -> IO Response) -> (Status -> ByteString -> IO Response) -> IO Response

refreshLoginState :: Github -> Request -> AuthUser -> IO (Maybe (Request, AuthUser))

Provider

data Provider where

Generic authentication provider wrapper.

Constructors

Provider :: AuthProvider p => p -> Provider

Instances

AuthProvider Provider

Defined in Network.Wai.Middleware.Auth.Provider

Methods

getProviderName :: Provider -> Text

getProviderInfo :: Provider -> ProviderInfo

handleLogin :: Provider -> Request -> [Text] -> Render ProviderUrl -> (AuthLoginState -> IO Response) -> (Status -> ByteString -> IO Response) -> IO Response

refreshLoginState :: Provider -> Request -> AuthUser -> IO (Maybe (Request, AuthUser))

newtype ProviderUrl

Data type for rendering Provider specific urls.

Constructors

ProviderUrl [Text]

data ProviderInfo

Provider information used for rendering a page with list of supported providers.

Constructors

ProviderInfo

Fields

• providerTitle :: Text
• providerLogoUrl :: Text
• providerDescr :: Text

Instances

Show ProviderInfo

Defined in Network.Wai.Middleware.Auth.Provider

Methods

showsPrec :: Int -> ProviderInfo -> ShowS

show :: ProviderInfo -> String

showList :: [ProviderInfo] -> ShowS

ToJSON ProviderInfo

Defined in Network.Wai.Middleware.Auth.Provider

Methods

toJSON :: ProviderInfo -> Value

toEncoding :: ProviderInfo -> Encoding

toJSONList :: [ProviderInfo] -> Value

toEncodingList :: [ProviderInfo] -> Encoding

FromJSON ProviderInfo

Defined in Network.Wai.Middleware.Auth.Provider

Methods

parseJSON :: Value -> Parser ProviderInfo

parseJSONList :: Value -> Parser [ProviderInfo]

type Providers = HashMap Text Provider

Collection of supported providers.

Provider Parsing

type ProviderParser = (Text, Value -> Parser Provider)

Aeson parser for a provider with unique provider name (same as returned by getProviderName)

mkProviderParser :: forall ap. (FromJSON ap, AuthProvider ap) => Proxy ap -> ProviderParser

First argument is not evaluated and is only needed for restricting the type.

parseProviders :: Object -> [ProviderParser] -> Result Providers

Parse configuration for providers from an Object.

User

data AuthUser

Representation of a user for a particular Provider.

Constructors

AuthUser

Fields

• authLoginState :: !UserIdentity
• authProviderName :: !ByteString
• authLoginTime :: !Int64

Instances

Eq AuthUser

Defined in Network.Wai.Middleware.Auth.Provider

Methods

(==) :: AuthUser -> AuthUser -> Bool

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

Show AuthUser

Defined in Network.Wai.Middleware.Auth.Provider

Methods

showsPrec :: Int -> AuthUser -> ShowS

show :: AuthUser -> String

showList :: [AuthUser] -> ShowS

Generic AuthUser

Defined in Network.Wai.Middleware.Auth.Provider

Associated Types

type Rep AuthUser :: Type -> Type

Methods

from :: AuthUser -> Rep AuthUser x

to :: Rep AuthUser x -> AuthUser

Binary AuthUser

Defined in Network.Wai.Middleware.Auth.Provider

Methods

put :: AuthUser -> Put

get :: Get AuthUser

putList :: [AuthUser] -> Put

type Rep AuthUser

Defined in Network.Wai.Middleware.Auth.Provider

type Rep AuthUser = D1 ('MetaData "AuthUser" "Network.Wai.Middleware.Auth.Provider" "wai-middleware-auth-0.2.5.1-F1Bn5lnBBs5AFHcEWAgbkV" 'False) (C1 ('MetaCons "AuthUser" 'PrefixI 'True) (S1 ('MetaSel ('Just "authLoginState") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 UserIdentity) :*: (S1 ('MetaSel ('Just "authProviderName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ByteString) :*: S1 ('MetaSel ('Just "authLoginTime") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int64))))

type AuthLoginState = ByteString

An arbitrary state that comes with logged in user, eg. a username, token or an email address.

type UserIdentity = ByteString

Deprecated: In favor of AuthLoginState

authUserIdentity :: AuthUser -> UserIdentity

Deprecated: In favor of authLoginState

Template

mkRouteRender :: Maybe Text -> Text -> [Text] -> Render Provider

Create a url renderer for a provider.

providersTemplate

Arguments

:: Maybe Text

Error message to display, if any.

-> Render Provider

Renderer function for provider urls.

-> Providers

List of available providers.

-> Builder

Template for the providers page