Security library for Lagom
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.mvn/wrapper
lagom-pac4j_2.11
lagom-pac4j_2.12 [maven-release-plugin] prepare for next development iteration Nov 22, 2018
shared/src #6 Support JWT authenticator Nov 6, 2018
travis setup Travis CI Oct 30, 2018
.gitignore #2 Integration with Lagom Scala DSL Oct 31, 2018
.travis.yml setup Travis CI Oct 30, 2018
README.md #4 Write README.md (#7) Oct 30, 2018
findbugs-exclude.xml #2 Integration with Lagom Scala DSL Oct 31, 2018
mvnw #1 Integration with Lagom Java DSL (#5) Oct 30, 2018
mvnw.cmd #1 Integration with Lagom Java DSL (#5) Oct 30, 2018
pom.xml [maven-release-plugin] prepare for next development iteration Nov 22, 2018

README.md

The lagom-pac4j project is an easy and powerful security library for Lagom framework which supports authentication and authorization. It's based on Lagom 1.4 (and Scala 2.11 or Scala 2.12) and the pac4j security engine v3. It's available under the Apache 2 license.

Several versions of the library are available for the different versions of the Lagom framework:

Lagom version pac4j version lagom-pac4j version
1.4+ 3.4 1.0.x (Java & Scala)

Main concepts and components:

  1. A client represents an authentication mechanism. It performs the login process and returns a user profile. An indirect client is for web applications authentication while a direct client is for web services authentication:

▸ OAuth - SAML - CAS - OpenID Connect - HTTP - OpenID - Google App Engine - Kerberos - LDAP - SQL - JWT - MongoDB - CouchDB - IP address - REST API

  1. An authorizer is meant to check authorizations on the authenticated user profile(s) or on the current web context:

▸ Roles / permissions - Anonymous / remember-me / (fully) authenticated - Profile type, attribute - CORS - CSRF - Security headers - IP address, HTTP method

  1. The SecuredService interface/trait protect methods in Lagom service by checking that the user is authenticated and that the authorizations are valid, according to the clients and authorizers configuration. If the user is not authenticated, the method can be processed with an anonymous profile.

Usage

1) Add the required dependencies

2) Define:

- the security configuration

3) Apply security and get the authenticated user profiles

Demos

TODO: create demo in Lagom Recipes

Versions

The latest released version is the Maven The next version is under development.

See the release notes. Learn more by browsing the pac4j documentation and the lagom-pac4j Javadoc.

Need help?

If you need commercial support (premium support or new/specific features), contact us at info@pac4j.org.

If you have any questions, want to contribute or be notified about the new releases and security fixes, please subscribe to the following mailing lists: