The vertx-pac4j
project is an easy and powerful security library for Vert.x 4 web applications and web services which supports authentication and authorization, but also application logout and advanced features like CSRF protection.
It supports authentication and authorization, but also advanced features like session fixation and CSRF protection.
It's based on Java 11, Vert.x 4.2 and on the pac4j security engine v5. It's available under the Apache 2 license.
- 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
- 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
-
A matcher defines whether the
SecurityHandler
must be applied and can be used for additional web processing -
The
SecurityHandler
protects an url 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, it performs authentication for direct clients or starts the login process for indirect clients -
The
CallbackHandler
finishes the login process for an indirect client -
The
LogoutHandler
logs out the user from the application and triggers the logout at the identity provider level.
- the security configuration
- the callback configuration, only for web applications
- the logout configuration
The demo webapp: vertx-pac4j-demo is available for tests and implement many authentication mechanisms: Facebook, Twitter, form, basic auth, CAS, SAML, OpenID Connect, Strava, JWT...
The latest released version is the , available in the Maven central repository. The next version is under development.
See the release notes. Learn more by browsing the pac4j documentation and the vertx-pac4j Javadoc.
See the migration guide as well.
You can use the mailing lists or the commercial support.