Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/auth0/java-jwt
Java implementation of JSON Web Token (JWT)
https://github.com/auth0/java-jwt
dx-sdk java jwt
Last synced: 3 days ago
JSON representation
Java implementation of JSON Web Token (JWT)
- Host: GitHub
- URL: https://github.com/auth0/java-jwt
- Owner: auth0
- License: mit
- Created: 2014-03-07T15:06:11.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2024-10-28T18:41:27.000Z (about 1 month ago)
- Last Synced: 2024-10-29T09:08:37.806Z (about 1 month ago)
- Topics: dx-sdk, java, jwt
- Language: Java
- Homepage:
- Size: 1.39 MB
- Stars: 5,879
- Watchers: 217
- Forks: 921
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome - auth0/java-jwt - Java implementation of JSON Web Token (JWT) (Java)
- awesome-jwt - java-jwt - Java implementation of JSON Web Token (JWT). (Libraries / Java)
README
> **Note**
> As part of our ongoing commitment to best security practices, we have rotated the signing keys used to sign previous releases of this SDK. As a result, new patch builds have been released using the new signing key. Please upgrade at your earliest convenience.
>
> While this change won't affect most developers, if you have implemented a dependency signature validation step in your build process, you may notice a warning that past releases can't be verified. This is expected, and a result of the key rotation process. Updating to the latest version will resolve this for you.
[](https://codecov.io/github/auth0/java-jwt)
[](https://doge.mit-license.org/)
[](https://mvnrepository.com/artifact/com.auth0/java-jwt)
[](https://javadoc.io/doc/com.auth0/java-jwt)
:books: [Documentation](#documentation) - :rocket: [Getting Started](#getting-started) - :computer: [API Reference](#api-reference) :speech_balloon: [Feedback](#feedback)
## Documentation
- [Examples](./EXAMPLES.md) - code samples for common java-jwt scenarios.
- [Docs site](https://www.auth0.com/docs) - explore our docs site and learn more about Auth0.
## Getting Started
### Requirements
This library is supported for Java LTS versions 8, 11, and 17. For issues on non-LTS versions above 8, consideration will be given on a case-by-case basis.
> `java-jwt` is intended for server-side JVM applications. Android applications should use [JWTDecode.Android](https://github.com/auth0/JWTDecode.Android).
`java-jwt` supports the following algorithms for both signing and verification:
| JWS | Algorithm | Description |
| :-------------: | :-------------: | :----- |
| HS256 | HMAC256 | HMAC with SHA-256 |
| HS384 | HMAC384 | HMAC with SHA-384 |
| HS512 | HMAC512 | HMAC with SHA-512 |
| RS256 | RSA256 | RSASSA-PKCS1-v1_5 with SHA-256 |
| RS384 | RSA384 | RSASSA-PKCS1-v1_5 with SHA-384 |
| RS512 | RSA512 | RSASSA-PKCS1-v1_5 with SHA-512 |
| ES256 | ECDSA256 | ECDSA with curve P-256 and SHA-256 |
| ES384 | ECDSA384 | ECDSA with curve P-384 and SHA-384 |
| ES512 | ECDSA512 | ECDSA with curve P-521 and SHA-512 |
> Note - Support for ECDSA with curve secp256k1 and SHA-256 (ES256K) has been dropped since it has been [disabled in Java 15](https://www.oracle.com/java/technologies/javase/15-relnote-issues.html#JDK-8237219)
> :warning: **Important security note:** JVM has a critical vulnerability for ECDSA Algorithms - [CVE-2022-21449](https://nvd.nist.gov/vuln/detail/CVE-2022-21449). Please review the details of the vulnerability and update your environment.
### Installation
Add the dependency via Maven:
```xml
com.auth0
java-jwt
4.4.0
```
or Gradle:
```gradle
implementation 'com.auth0:java-jwt:4.4.0'
```
### Create a JWT
Use `JWT.create()`, configure the claims, and then call `sign(algorithm)` to sign the JWT.
The example below demonstrates this using the `RS256` signing algorithm:
```java
try {
Algorithm algorithm = Algorithm.RSA256(rsaPublicKey, rsaPrivateKey);
String token = JWT.create()
.withIssuer("auth0")
.sign(algorithm);
} catch (JWTCreationException exception){
// Invalid Signing configuration / Couldn't convert Claims.
}
```
### Verify a JWT
Create a `JWTVerifier` passing the `Algorithm`, and specify any required claim values.
The following example uses `RS256` to verify the JWT.
```java
String token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXUyJ9.eyJpc3MiOiJhdXRoMCJ9.AbIJTDMFc7yUa5MhvcP03nJPyCPzZtQcGEp-zWfOkEE";
DecodedJWT decodedJWT;
try {
Algorithm algorithm = Algorithm.RSA256(rsaPublicKey, rsaPrivateKey);
JWTVerifier verifier = JWT.require(algorithm)
// specify any specific claim validations
.withIssuer("auth0")
// reusable verifier instance
.build();
decodedJWT = verifier.verify(token);
} catch (JWTVerificationException exception){
// Invalid signature/claims
}
```
If the token has an invalid signature or the Claim requirement is not met, a `JWTVerificationException` will be thrown.
See the [examples](./EXAMPLES.md) and [JavaDocs](https://javadoc.io/doc/com.auth0/java-jwt/latest) for additional documentation.
## API Reference
- [java-jwt JavaDocs](https://javadoc.io/doc/com.auth0/java-jwt/latest)
## Feedback
### Contributing
We appreciate feedback and contribution to this repo! Before you get started, please see the following:
- [Auth0's general contribution guidelines](https://github.com/auth0/open-source-template/blob/master/GENERAL-CONTRIBUTING.md)
- [Auth0's code of conduct guidelines]((https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md))
### Raise an issue
To provide feedback or report a bug, [please raise an issue on our issue tracker](https://github.com/auth0/java-jwt/issues).
### Vulnerability Reporting
Please do not report security vulnerabilities on the public Github issue tracker. The [Responsible Disclosure Program](https://auth0.com/whitehat) details the procedure for disclosing security issues.
---
Auth0 is an easy to implement, adaptable authentication and authorization platform. To learn more checkout Why Auth0?
This project is licensed under the MIT license. See the LICENSE file for more info.