Network.Wai.Auth.Executable

Documentation

mkMain

Arguments

:: AuthConfig

Use readAuthConfig to read config from a file.

-> [ProviderParser]

Parsers for supported providers. ProviderParser can be created with mkProviderParser.

-> (Port -> Application -> IO ())

Application runner, for instance Warp's run function.

-> IO ()

Construct a main function.

Since: 0.1.0

readAuthConfig :: FilePath -> IO AuthConfig

Read configuration from a yaml file with ability to use environment variables. See Data.Yaml.Config module for details.

Since: 0.1.0

serviceToApp :: Service -> IO Application

Create an Application from a Service

Since: 0.1.0

data AuthConfig

Configuration for wai-auth executable and any other, that is created using mkMain

Constructors

AuthConfig

Fields

• configAppRoot :: Maybe Text

  Root Url of the website, eg: http://example.com or https://example.com It will be used to perform redirects back from external authentication providers.

• configAppPort :: Int

  Port number. Default is 3000

• configRequireTls :: Bool

  Require requests come in over a secure connection (determined via headers). Will redirect to HTTPS if non-secure dedected. Default is False

• configSkipAuth :: Bool

  Turn off authentication middleware, useful for testing. Default is False

• configCookieAge :: Int

  Duration of the session in seconds. Default is one hour (3600 seconds).

• configSecretKey :: SecretKey

  Secret key. Default is "client_session_key.aes"

• configService :: Service
• configProviders :: Object

Instances

FromJSON AuthConfig

Methods

parseJSON :: Value -> Parser AuthConfig

parseJSONList :: Value -> Parser [AuthConfig]

data SecretKey

Configuration for a secret key that will be used to encrypt authenticated user as client side cookie.

Constructors

SecretKeyFile FilePath

Path to a secret key file in binary form, if it is malformed or doesn't exist it will be (re)created. If empty "client_session_key.aes" name will be used

SecretKey Key

Serialized and base64 encoded form of a secret key. Use encodeKey to get a proper encoded form.

data Service

Available services.

Constructors

ServiceFiles FileServer

ServiceProxy ReverseProxy

data FileServer

Configuration for reverse proxy application.

Constructors

FileServer

Fields

• fsRootFolder :: FilePath

  Path to a folder containing files that will be served by this app.

• fsRedirectToIndex :: Bool

  Redirect to the actual index file, not leaving the URL containing the directory name

• fsAddTrailingSlash :: Bool

  Add a trailing slash to directory names

Instances

ToJSON FileServer

Methods

toJSON :: FileServer -> Value

toEncoding :: FileServer -> Encoding

toJSONList :: [FileServer] -> Value

toEncodingList :: [FileServer] -> Encoding

FromJSON FileServer

Methods

parseJSON :: Value -> Parser FileServer

parseJSONList :: Value -> Parser [FileServer]

data ReverseProxy

Configuration for reverse proxy application.

Constructors

ReverseProxy

Fields

• rpHost :: Text

  Hostname of the webserver

• rpPort :: Int

  Port of the webserver

Instances

ToJSON ReverseProxy

Methods

toJSON :: ReverseProxy -> Value

toEncoding :: ReverseProxy -> Encoding

toJSONList :: [ReverseProxy] -> Value

toEncodingList :: [ReverseProxy] -> Encoding

FromJSON ReverseProxy

Methods

parseJSON :: Value -> Parser ReverseProxy

parseJSONList :: Value -> Parser [ReverseProxy]

encodeKey :: Key -> ByteString

Serialize and base64 encode a secret Key

decodeKey :: ByteString -> Either String Key

Decode a Key that is in a base64 encoded serialized form

type Port = Int