https://github.com/ncrashed/servant-auth-token

Servant based API and server for token based authorisation
https://github.com/ncrashed/servant-auth-token

Last synced: 11 months ago
JSON representation

Servant based API and server for token based authorisation

• Host: GitHub
• URL: https://github.com/ncrashed/servant-auth-token
• Owner: NCrashed
• License: bsd-3-clause
• Created: 2016-08-01T08:11:00.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2019-09-21T03:18:03.000Z (over 6 years ago)
• Last Synced: 2025-06-10T04:07:07.928Z (12 months ago)
• Language: Haskell
• Size: 158 KB
• Stars: 14
• Watchers: 4
• Forks: 7
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# servant-auth-token

[![Build Status](https://travis-ci.org/NCrashed/servant-auth-token.svg?branch=master)](https://travis-ci.org/NCrashed/servant-auth-token)

The repo contains server implementation of [servant-auth-token-api](https://github.com/NCrashed/servant-auth-token-api).

# How to add to your server

At the moment you have two options for backend storage:

- [persistent backend](https://github.com/NCrashed/servant-auth-token/tree/master/servant-auth-token-persistent) - [persistent](https://hackage.haskell.org/package/persistent) backend, simple to integrate with your app.

- [acid-state backend](https://github.com/NCrashed/servant-auth-token/tree/master/servant-auth-token-acid) - [acid-state](https://hackage.haskell.org/package/acid-state) backend is light solution for in memory storage, but it is more difficult to integrate it with your app.

- Possible candidates for other storage backends: VCache, leveldb, JSON files. To see how to implement them, see [HasStorage](https://github.com/NCrashed/servant-auth-token/blob/master/src/Servant/Server/Auth/Token/Model.hs#L220) type class.

Now you can use 'guardAuthToken' to check authorization headers in endpoints of your server:

``` haskell

-- | Read a single customer from DB

customerGet :: CustomerId -- ^ Customer unique id

  -> MToken '["customer-read"] -- ^ Required permissions for auth token

  -> ServerM Customer -- ^ Customer data

customerGet i token = do

  guardAuthToken token

  runDB404 "customer" $ getCustomer i

```