Giter VIP home page Giter VIP logo

flowable-keycloak's Introduction

Flowable Keycloak integration library

This library allows to replace Flowable IDM with Keycloak integration (through OpenID Connect) to the Flowable Apps (https://flowable.com/open-source/docs/bpmn/ch14-Applications/).

Maven project

Maven Central

Add the following maven dependency to your project pom.xml:

<dependency>
   <groupId>com.premiumminds.flowable</groupId>
   <artifactId>flowable-keycloak</artifactId>
   <version>1.6</version>
</dependency>

Check out sonatype repository for latest snapshots and releases.

Example usage

This example works for the flowable-ui-* projects in the flowable repository:

Changes in the project

Add the flowable-keycloak library to the POM of the flowable-ui-*-conf project.

Changes in the SecurityConfiguration class in the flowable-ui-*-conf project:

  • Replace the class FlowableCookieFilterRegistrationBean with KeycloakCookieFilterRegistrationBean

Configurations

This library reads the following configurations:

keycloak.url = <keycloak url>
keycloak.realm = <realm>
keycloak.issuer-url = <realm url, usually something like: http://example.com/auth/realms/mycompany>
keycloak.client.client-id = <client id>
keycloak.client.client-secret = <client secret>
keycloak.client.scope = openid roles
keycloak.client.redirect-uri = ${flowable.common.app.redirect-on-auth-success}/callback 
keycloak.connect-timeout = 10000
keycloak.read-timeout = 10000

For testing, you can add this configurations to the file src/main/resources/flowable-default.properties in the "flowable-ui-*-app" project.

Keycloak roles

The library will add the client roles as flowable priviledges.

Flowable uses the following priviledges:

  • access-modeler
  • access-rest-api
  • access-admin
  • access-task

So you should have this as client roles in keycloak instance.

Continuous Integration

Build Status

CI is hosted by travis-ci.com

Licence

Copyright (C) 2020 Premium Minds

Licensed under the GNU Lesser General Public Licence

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.