servant-auth-token-persistent: Persistent backend for servant-auth-token server

[ bsd3, library, web ] [ Propose Tags ] [ Report a vulnerability ]

Please see README.md


[Skip to Readme]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

  • No Candidates
Versions [RSS] 0.4.0.0, 0.5.0.0, 0.5.1.0, 0.5.1.1, 0.6.0.0, 0.6.1.0, 0.6.2.0, 0.6.3.0, 0.7.0.0
Change log CHANGELOG.md
Dependencies aeson-injector (>=1.0 && <1.2), base (>=4.7 && <5), bytestring (>=0.10 && <0.11), containers (>=0.5 && <0.6), exceptions (>=0.8 && <0.11), mtl (>=2.2 && <2.3), persistent (>=2.2 && <2.9), persistent-template (>=2.1 && <2.7), servant-auth-token (>=0.5 && <0.6), servant-auth-token-api (>=0.5 && <0.6), servant-server (>=0.9 && <0.15), text (>=1.2 && <1.3), time (>=1.5 && <1.9), transformers (>=0.4 && <0.6), unliftio-core (>=0.1 && <0.3), uuid (>=1.3 && <1.4) [details]
License BSD-3-Clause
Copyright 2016 Anton Gushcha
Author NCrashed
Maintainer ncrashed@gmail.com
Category Web
Home page https://github.com/ncrashed/servant-auth-token#readme
Source repo head: git clone https://github.com/ncrashed/servant-auth-token
Uploaded by NCrashed at 2018-09-13T17:40:10Z
Distributions
Reverse Dependencies 1 direct, 0 indirect [details]
Downloads 5025 total (5 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2018-09-13 [all 1 reports]

Readme for servant-auth-token-persistent-0.7.0.0

[back to package description]

servant-auth-token-persistent

Storage backend on persistent for servant-auth-token server.

An itegration of the backend is simple:

-- | Special monad for authorisation actions
newtype AuthM a = AuthM { unAuthM :: PersistentBackendT IO a }
  deriving (Functor, Applicative, Monad, MonadIO, MonadError ServantErr, HasStorage, HasAuthConfig)

-- | Execution of authorisation actions that require 'AuthHandler' context
runAuth :: AuthM a -> ServerM a
runAuth m = do
  cfg <- asks envAuthConfig
  pool <- asks envPool
  liftHandler $ ExceptT $ runPersistentBackendT cfg pool $ unAuthM m

Don't forget to add migration to your server startup (if you actually want automatic migrations):

-- | Create new server environment
newServerEnv :: MonadIO m => ServerConfig -> m ServerEnv
newServerEnv cfg = do
  let authConfig = defaultAuthConfig
  pool <- liftIO $ do
    pool <- createPool cfg
    -- run migrations
    flip runSqlPool pool $ runMigration S.migrateAllAuth
    -- create default admin if missing one
    _ <- runPersistentBackendT authConfig pool $ ensureAdmin 17 "admin" "123456" "admin@localhost"
    return pool
  let env = ServerEnv {
        envConfig = cfg
      , envAuthConfig = authConfig
      , envPool = pool
      }
  return env

See a full example in servant-auth-token-example-persistent.