# vertx-pac4j

**Repository Path**: mirrors/vertx-pac4j

## Basic Information

- **Project Name**: vertx-pac4j
- **Description**: vertx-pac4j 项目是 Vert.x 3 Web 应用程序的一个简单而强大的安全库，它支持身份验证和授权，还支持应用程序注销以及 CSRF 保护等高级功能
- **Primary Language**: Kotlin
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: https://www.oschina.net/p/vertx-pac4j
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2018-05-16
- **Last Updated**: 2026-01-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p align="center">
  <img src="https://pac4j.github.io/pac4j/img/logo-vertx.png" width="300" />
</p>


The `vertx-pac4j` project is an **easy and powerful security library for Vert.x, 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 17, Vert.x 5.0 and on the **[pac4j security engine](https://github.com/pac4j/pac4j) v6**. 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:

&#9656; 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:

&#9656; 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 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).

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