smallrye-jwt

smallrye-jwt copied to clipboard

:microprofile-jwt: https://github.com/eclipse/microprofile-jwt-auth/ :mp-jwt-name: Eclipse MicroProfile JWT RBAC :ci: https://github.com/smallrye/smallrye-jwt/actions?query=workflow%3A%22SmallRye+Build%22 :sonar: https://sonarcloud.io/dashboard?id=smallrye_smallrye-jwt

image:https://github.com/smallrye/smallrye-jwt/workflows/SmallRye%20Build/badge.svg?branch=main[link={ci}] image:https://sonarcloud.io/api/project_badges/measure?project=smallrye_smallrye-jwt&metric=alert_status["Quality Gate Status", link={sonar}] image:https://img.shields.io/github/license/smallrye/smallrye-jwt.svg["License", link="http://www.apache.org/licenses/LICENSE-2.0"] image:https://img.shields.io/maven-central/v/io.smallrye/smallrye-jwt?color=green[]

= SmallRye JWT

SmallRye JWT is a library for implementing the {microprofile-jwt}[{mp-jwt-name}]. Currently it is focused on supporting the MP-JWT 2.1 spec. It deals with the decryption and/or signature verification of the JWT token and parsing it into a JsonWebToken implementation.

== Instructions

Compile and install this project:

[source,bash]

mvn clean install

=== Project structure

• link:implementation[] - Implementation of the {mp-jwt-name} library ** link:implementation/common[] - Common utility classes. ** link:implementation/jwt-auth[] - Core library implementation. ** link:implementation/jwt-cdi[] - Support for registering the implementation as CDI extension. ** link:implementation/jwt-http-mechanism[] - Support for registering the implementation as HTTP Authentication Mechanism. ** link:implementation/jwt-jaxrs[] - Support for registering the implementation as JAX-RS feature and filters. ** link:implementation/jwt-build[] - Support for generating JWT tokens - this module is not related to MP JWT 1.2.
• link:testsuite[] - Test suites ** link:testsuite/basic[] Test suite with basic test cases. ** link:testsuite/tck[] Test suite to run the implementation against the {mp-jwt-name} TCK.
• link:doc[] - Project documentation.

=== Contributing

Please refer to our Wiki for the https://github.com/smallrye/smallrye-parent/wiki[Contribution Guidelines].

=== Links

• http://github.com/smallrye/smallrye-jwt/[Project Homepage]
• {microprofile-jwt}[{mp-jwt-name}]
• https://smallrye.io/docs/smallrye-jwt/index.html[Documentation]