org.pac4j:resteasy-pac4j

Security library for JAX-RS based on pac4j

License	The Apache Software License, Version 2.0
Categories	RESTEasy Program Interface REST Frameworks pac4j Security
GroupId	org.pac4j
ArtifactId	resteasy-pac4j
Last Version	4.0.0
Release Date	Sep 11, 2020
Type	jar
Description	Security library for JAX-RS based on pac4j
Project Organization	pac4j

Download resteasy-pac4j

Filename	Size
resteasy-pac4j-4.0.0.pom
resteasy-pac4j-4.0.0.jar	6 KB
resteasy-pac4j-4.0.0-sources.jar	4 KB
resteasy-pac4j-4.0.0-javadoc.jar	40 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.pac4j/resteasy-pac4j/ -->
<dependency>
    <groupId>org.pac4j</groupId>
    <artifactId>resteasy-pac4j</artifactId>
    <version>4.0.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.pac4j/resteasy-pac4j/
implementation 'org.pac4j:resteasy-pac4j:4.0.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.pac4j/resteasy-pac4j/
implementation ("org.pac4j:resteasy-pac4j:4.0.0")

Apache Buildr

'org.pac4j:resteasy-pac4j:jar:4.0.0'

Apache Ivy

<dependency org="org.pac4j" name="resteasy-pac4j" rev="4.0.0">
  <artifact name="resteasy-pac4j" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.pac4j', module='resteasy-pac4j', version='4.0.0')
)

Scala SBT

libraryDependencies += "org.pac4j" % "resteasy-pac4j" % "4.0.0"

Leiningen

[org.pac4j/resteasy-pac4j "4.0.0"]

Dependencies

compile (1)

Group / Artifact	Type	Version
org.pac4j.jax-rs : core	jar	4.0.0

provided (1)

Group / Artifact	Type	Version
org.jboss.resteasy : resteasy-jaxrs	jar

test (7)

Group / Artifact	Type	Version
org.pac4j.jax-rs : testing	jar	4.0.0
org.jboss.resteasy : resteasy-undertow	jar
org.jboss.resteasy : resteasy-cdi	jar	3.13.0.Final
javax : javaee-api	jar	8.0
io.undertow : undertow-servlet	jar	2.0.23.Final
org.jboss.weld.servlet : weld-servlet	jar	2.4.8.Final
org.glassfish.jersey.core : jersey-client	jar	2.25.1

Project Modules

There are no modules declared in this project.

The jax-rs-pac4j project is an easy and powerful security library for JAX-RS web applications and web services which supports authentication and authorization, but also logout and advanced features like session fixation and CSRF protection. It's based on Java 8, servlet 3 (when present), JAX-RS 2 and on the pac4j security engine v4. It's available under the Apache 2 license.

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 UI authentication while a direct client is for web services authentication:

▸ OAuth - SAML - CAS - OpenID Connect - HTTP - OpenID - Google App Engine - LDAP - SQL - JWT - MongoDB - Stormpath - IP address

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

3. A matcher defines whether the SecurityFilter must be applied and can be used for additional web processing

4. Filters protect resources and map some of them to login processes.

• The SecurityFilter protects a resource 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.

These filters can be directly registered by hand, or instead, the following features can be used.

5. Generic JAX-RS Providers and Features activate the use of some of the filters on the JAX-RS implementation based on various conditions

• The JaxRsContextFactoryProvider enables generic JAX-RS based pac4j functioning, without session handling (i.e., it will only work with direct clients)
• The Pac4JSecurityFeature enables annotation-based activation of the filters at the resource method level
• The Pac4JSecurityFilterFeature activates a global filter that will be applied to every resources.

6. Container/Implementation-specific Providers and Features extend the basic functionality provided by the generic ones

• The Pac4JValueFactoryProvider enables injection of the security profile in resource method
• The ServletJaxRsContextFactoryProvider provides session handling (and thus indirect clients support) by replacing the generic JaxRsContextFactoryProvider (for Servlet-based JAX-RS implementations, e.g., Jersey on Netty or Grizzly Servlet, Resteasy on Undertow).
• The GrizzlyJaxRsContextFactoryProvider provides session handling (and thus indirect clients support) by replacing the generic JaxRsContextFactoryProvider (for Grizzly2 without Servlet support).

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

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 jax-rs-pac4j Javadoc.

See the migration guide as well.

Need help?

If you need commercial support (premium support or new/specific features), contact us at [email protected].

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:

• pac4j-users
• pac4j-developers
• pac4j-announce
• pac4j-security

PAC4J

The security library for Java

Versions

Version
4.0.0 Sep 11, 2020
3.0.3 Apr 6, 2020
3.0.2 Mar 26, 2020
3.0.1 Oct 7, 2019
3.0.0 Jun 19, 2018
3.0.0-RC1 Apr 26, 2018
2.3.0 Jun 19, 2018
2.2.0 Apr 25, 2018