https://github.com/pac4j/vertx-pac4j

Security library for Vert.x: OAuth, CAS, SAML, OpenID Connect, LDAP, JWT...
https://github.com/pac4j/vertx-pac4j

authentication authorization cas facebook java jwt ldap login logout mongodb oauth openid-connect saml security social-login sql twitter vertx

Last synced: 4 days ago
JSON representation

Security library for Vert.x: OAuth, CAS, SAML, OpenID Connect, LDAP, JWT...

• Host: GitHub
• URL: https://github.com/pac4j/vertx-pac4j
• Owner: pac4j
• License: apache-2.0
• Created: 2014-04-26T12:21:24.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2024-12-13T06:18:40.000Z (about 1 month ago)
• Last Synced: 2025-01-10T16:12:34.872Z (11 days ago)
• Topics: authentication, authorization, cas, facebook, java, jwt, ldap, login, logout, mongodb, oauth, openid-connect, saml, security, social-login, sql, twitter, vertx
• Language: Java
• Homepage: http://www.pac4j.org
• Size: 603 KB
• Stars: 125
• Watchers: 11
• Forks: 30
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• vertx-awesome - Vert.x-Pac4j - Vert.x authentication/authorisation implemented using [pac4j](http://www.pac4j.org/). (Authentication Authorisation)

README

        


  



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](https://github.com/pac4j/pac4j) v5**. It's available under the Apache 2 license.

[**Main concepts and components:**](http://www.pac4j.org/docs/main-concepts-and-components.html)

1) A [**client**](http://www.pac4j.org/docs/clients.html) 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

2) An [**authorizer**](http://www.pac4j.org/docs/authorizers.html) 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

3) A [**matcher**](http://www.pac4j.org/docs/matchers.html) defines whether the `SecurityHandler` must be applied and can be used for additional web processing

4) 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

5) The `CallbackHandler` finishes the login process for an indirect client

6) The `LogoutHandler` logs out the user from the application and triggers the logout at the identity provider level.

## Usage

### 1) [Add the required dependencies](https://github.com/pac4j/vertx-pac4j/wiki/Dependencies)

### 2) Define:

### - the [security configuration](https://github.com/pac4j/vertx-pac4j/wiki/Security-configuration)

### - the [callback configuration](https://github.com/pac4j/vertx-pac4j/wiki/Callback-configuration), only for web applications

### - the [logout configuration](https://github.com/pac4j/vertx-pac4j/wiki/Logout-configuration)

### 3) [Apply security](https://github.com/pac4j/vertx-pac4j/wiki/Apply-security)

### 4) [Get the authenticated user profiles](https://github.com/pac4j/vertx-pac4j/wiki/Get-the-authenticated-user-profiles)

## Demo

The demo webapp: [vertx-pac4j-demo](https://github.com/pac4j/vertx-pac4j-demo) is available for tests and implement many authentication mechanisms: Facebook, Twitter, form, basic auth, CAS, SAML, OpenID Connect, Strava, JWT...

## Versions

The latest released version is the [![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.pac4j/vertx-pac4j/badge.svg?style=flat)](https://maven-badges.herokuapp.com/maven-central/org.pac4j/vertx-pac4j), available in the [Maven central repository](https://repo.maven.apache.org/maven2).

The [next version](https://github.com/pac4j/vertx-pac4j/wiki/Next-version) is under development.

See the [release notes](https://github.com/pac4j/vertx-pac4j/wiki/Release-Notes). Learn more by browsing the [pac4j documentation](https://www.javadoc.io/doc/org.pac4j/pac4j-core/5.1.5/index.html) and the [vertx-pac4j Javadoc](http://www.javadoc.io/doc/org.pac4j/vertx-pac4j/6.0.0).

See the [migration guide](https://github.com/pac4j/vertx-pac4j/wiki/Migration-guide) as well.

## Need help?

You can use the [mailing lists](http://www.pac4j.org/mailing-lists.html) or the [commercial support](http://www.pac4j.org/commercial-support.html).