The spring-security-pac4j
project is an easy and powerful security library for Spring Security web applications and web services (with or without Spring Boot). It supports authentication and authorization, but also advanced features like session fixation and CSRF protection. It's based on Java 8, Spring Security 5 and on the pac4j security engine v5. It's available under the Apache 2 license.
For a new Spring Boot or Spring MVC project or if you intend to migrate your whole webapp to pac4j, you should use the spring-webmvc-pac4j library instead of this one, which offers similar capabilities, but is easier!
- 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 - 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
SecurityFilter
must be applied and can be used for additional web processing -
The
SecurityFilter
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
CallbackFilter
finishes the login process for an indirect client -
The
LogoutFilter
logs out the user from the application and triggers the logout at the identity provider level -
The
Pac4jEntryPoint
handles when the user is not authenticated -
The
JEEContext
and theProfileManager
components can be injected (for a Spring Boot/MVC webapp and using thespring-webmvc-pac4j
library) -
The
@RequireAnyRole
and@RequireAllRoles
annotations check the user roles (for a Spring Boot/MVC webapp and using thespring-webmvc-pac4j
library).
Usage
1) Add the required dependencies
2) Define:
- the security configuration
- the callback configuration, only for web applications
- the logout configuration
3) Apply security
4) Get the authenticated user profiles
Demos
The demo webapps for Spring Security without Spring Boot: spring-security-pac4j-demo or with Spring Boot: spring-security-pac4j-boot-demo are available for tests and implement many authentication mechanisms: Facebook, Twitter, form, basic auth, CAS, SAML, OpenID Connect, JWT...
Versions
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 spring-security-pac4j Javadoc.
See the migration guide as well.
Need help?
You can use the mailing lists or the commercial support.