IHP Api Reference
Safe HaskellSafe-Inferred

IHP.Job.Dashboard.Auth

Description

 
Synopsis

Documentation

class AuthenticationMethod a where Source #

Defines one method, authenticate, called before every action. Use to authenticate user.

Three implementations are provided: - NoAuth : No authentication - BasicAuth : HTTP Basic Auth using environment variables - BasicAuthStatic : HTTP Basic Auth using static values

Define your own implementation to use custom authentication for production.

Methods

authenticate :: (?context :: ControllerContext, ?modelContext :: ModelContext) => IO () Source #

Instances

Instances details
AuthenticationMethod NoAuth Source # 
Instance details

Defined in IHP.Job.Dashboard.Auth

Methods

authenticate :: IO () Source #

(KnownSymbol userEnv, KnownSymbol passEnv) => AuthenticationMethod (BasicAuth userEnv passEnv :: Type) Source # 
Instance details

Defined in IHP.Job.Dashboard.Auth

Methods

authenticate :: IO () Source #

(KnownSymbol user, KnownSymbol pass) => AuthenticationMethod (BasicAuthStatic user pass :: Type) Source # 
Instance details

Defined in IHP.Job.Dashboard.Auth

Methods

authenticate :: IO () Source #

data NoAuth Source #

Don't use any authentication for jobs.

Instances

Instances details
AuthenticationMethod NoAuth Source # 
Instance details

Defined in IHP.Job.Dashboard.Auth

Methods

authenticate :: IO () Source #

data BasicAuth (userEnv :: Symbol) (passEnv :: Symbol) Source #

Authenticate using HTTP Basic Authentication by looking up username/password values in environment variables given as type-level strings.

Instances

Instances details
(KnownSymbol userEnv, KnownSymbol passEnv) => AuthenticationMethod (BasicAuth userEnv passEnv :: Type) Source # 
Instance details

Defined in IHP.Job.Dashboard.Auth

Methods

authenticate :: IO () Source #

data BasicAuthStatic (user :: Symbol) (pass :: Symbol) Source #

Authenticate using HTTP Basic Authentication using username/password given as type level strings. Meant for development only!

Instances

Instances details
(KnownSymbol user, KnownSymbol pass) => AuthenticationMethod (BasicAuthStatic user pass :: Type) Source # 
Instance details

Defined in IHP.Job.Dashboard.Auth

Methods

authenticate :: IO () Source #