keycloak-hs

[ bsd3, library, program, unclassified ] [ Propose Tags ]

Please see the README on GitHub at https://github.com/cdupont/keycloak-hs#readme


[Skip to Readme]
Versions [faq] 0.0.0.0, 0.0.0.1, 0.0.0.2, 0.0.0.3, 0.0.0.4, 0.0.0.5, 0.1.0.0, 0.1.1, 0.2.0, 1.0.0, 1.0.1, 1.1.0, 1.1.1, 2.0.0, 2.0.1, 2.0.2, 2.0.3, 2.1.0
Change log ChangeLog.md
Dependencies aeson (==1.4.*), aeson-casing (>=0.1 && <0.3), base (>=4.9.1.0 && <5), base64-bytestring (==1.0.*), bytestring (==0.10.*), containers (>=0.5.9 && <0.7), exceptions (==0.10.*), hslogger (>=1.2 && <1.4), http-api-data (==0.4.*), http-client (>=0.5 && <0.7), http-types (==0.12.*), jwt (==0.10.*), keycloak-hs, lens (>=4.17 && <4.19), mtl (==2.2.*), safe (==0.3.*), string-conversions (==0.4.*), text (==1.2.*), word8 (==0.1.*), wreq (==0.5.*) [details]
License BSD-3-Clause
Copyright 2019 Corentin Dupont
Author Corentin Dupont
Maintainer corentin.dupont@gmail.com
Home page https://github.com/cdupont/keycloak-hs#readme
Bug tracker https://github.com/cdupont/keycloak-hs/issues
Source repo head: git clone https://github.com/cdupont/keycloak-hs
Uploaded by CorentinDupont at 2019-11-10T22:57:30Z
Distributions NixOS:1.1.1
Executables example
Downloads 4364 total (35 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs available [build log]
Last success reported on 2019-11-10 [all 1 reports]

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for keycloak-hs-1.0.1

[back to package description]

Keycloak-hs

Keycloak-hs is an Haskell library for connecting to Keycloak. Keycloak allows to authenticate users and protect API resources.

Install

Installation follows the standard approach to installing Stack-based projects.

  1. Install the Haskell stack tool.
  2. Run stack install --fast to install this package.

Tutorial

In this tutorial we'll learn how to use Keycloak-hs with a small example. First you should install and run Keycloak: follow this tutorial. In Keycloak admin panel, create the following:

  • a realm named "demo"
  • a user "demo" with password "demo"
  • a client named "demo".

In the client "demo":

  • change "Access Type" to confidential
  • turn "Authorization Enabled" ON.

A new "Authorization" tab should appear.

Authorizations

Let's set up some authorization policies in order to demonstrate the capacity of Keycloak-hs. We want to authorize our user "demo" to "view" any resource. Frist go in the new "Authorization" tab that appeared.

Create a new Scope in the "Authorization Scopes" tab:

  • Name it "view".

Create a new "User" policy in the "Policies" tab with the following settings:

  • Name it "Demo user have access".
  • Select user "demo" in the drop box.
  • Logic should be positive.

Create a new scope-based permission in the "Permissions" tab:

  • Name it "View resources".
  • Select "view" in Scopes.
  • Select your previous policy "Demo user have access" in "Apply Policy".

That's it for the confguration of Keycloak. Keycloak is very complex, so you'll have fun exploring all the possibilities ;)

Example code

The folder example contains an exemple of usage. You should first input your "client secret", that can be found in the demo client "Credentials" tab in Keycloak admin panel.

Then run the example:

stack run example

The example first create a "client" token, necessary to create a resource in Keycloak. It then create a Resourse, with a name, an optional type, URIs, scopes, owner and attributes.

We can then check if our user can access this resource, according to policies. Finally, the example shows how to retrieve all permissions for a user.

Enjoy!