diff --git a/CHANGELOG.md b/CHANGELOG.md --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,7 @@ +# 0.2.5.0 + +- Add `getAuthUserFromVault` for `Servant.Api.Vault` user. + # 0.2.4.0 - Add GitLab provider. diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # wai-middleware-auth -[![Build Status](https://dev.azure.com/fpco/wai-middleware-auth/_apis/build/status/fpco.wai-middleware-auth?branchName=master)](https://dev.azure.com/fpco/wai-middleware-auth/_build/latest?definitionId=4&branchName=master) +[![Build Status](https://github.com/fpco/wai-middleware-auth/actions/workflows/tests.yml/badge.svg)](https://github.com/fpco/wai-middleware-auth/actions/workflows/tests.yml) Middleware that secures WAI application diff --git a/src/Network/Wai/Middleware/Auth.hs b/src/Network/Wai/Middleware/Auth.hs --- a/src/Network/Wai/Middleware/Auth.hs +++ b/src/Network/Wai/Middleware/Auth.hs @@ -21,6 +21,7 @@ , smartAppRoot , waiMiddlewareAuthVersion , getAuthUser + , getAuthUserFromVault , getDeleteSessionHeader , decodeKey ) where @@ -315,6 +316,14 @@ getAuthUser :: Request -> Maybe AuthUser getAuthUser = Vault.lookup userKey . vault +-- | Get the username for the current user from the given Vault. +-- +-- My be used instead of 'getAuthUser' in libraries that do not provide a +-- 'Request' value, such as @Servant.Api.Vault@. +-- +-- @since 0.2.5.0 +getAuthUserFromVault :: Vault.Vault -> Maybe AuthUser +getAuthUserFromVault = Vault.lookup userKey -- | Current version -- diff --git a/wai-middleware-auth.cabal b/wai-middleware-auth.cabal --- a/wai-middleware-auth.cabal +++ b/wai-middleware-auth.cabal @@ -1,6 +1,6 @@ cabal-version: 1.18 name: wai-middleware-auth -version: 0.2.4.1 +version: 0.2.5.0 synopsis: Authentication middleware that secures WAI application description: Please see the README and Haddocks at license: MIT