https://github.com/auth0/JWTDecode.Android
A library to help you decode JWTs for Android
https://github.com/auth0/JWTDecode.Android
dx-sdk
Last synced: 5 months ago
JSON representation
A library to help you decode JWTs for Android
- Host: GitHub
- URL: https://github.com/auth0/JWTDecode.Android
- Owner: auth0
- License: mit
- Created: 2016-10-17T21:44:20.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2025-01-27T02:12:26.000Z (8 months ago)
- Last Synced: 2025-04-13T22:39:36.827Z (6 months ago)
- Topics: dx-sdk
- Language: Java
- Homepage: https://jwt.io
- Size: 341 KB
- Stars: 448
- Watchers: 25
- Forks: 80
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-java - JWTDecode
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://circleci.com/gh/auth0/JWTDecode.Android/tree/master)
[](https://search.maven.org/artifact/com.auth0.android/jwtdecode)
[](https://codecov.io/gh/auth0/JWTDecode.android)
[](https://javadoc.io/doc/com.auth0.android/jwtdecode)
📚 [Documentation](#documentation) • 🚀 [Getting Started](#getting-started) • 💬 [Feedback](#feedback)
## Documentation
- [Docs Site](https://auth0.github.io/react-native-auth0/)
- [API Reference](https://javadoc.io/doc/com.auth0.android/jwtdecode/latest/index.html)
- [Examples](https://github.com/auth0/JWTDecode.Android/blob/master/EXAMPLES.md)
## Getting Started
### Installation
The library is be available both in Maven Central and JCenter. To start using it add this line to your `build.gradle` dependencies file:
```groovy
implementation 'com.auth0.android:jwtdecode:2.0.2'
```
### Usage
Decode a JWT token
```java
String token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ";
JWT jwt = new JWT(token);
String issuer = jwt.getIssuer(); //get registered claims
String claim = jwt.getClaim("isAdmin").asString(); //get custom claims
boolean isExpired = jwt.isExpired(10); // Do time validation with 10 seconds leeway
```
A `DecodeException` will raise with a detailed message if the token has:
* An invalid part count.
* A part not encoded as Base64 + UTF-8.
* A Header or Payload without a valid JSON format.
Checkout [EXAMPLES](https://github.com/auth0/JWTDecode.Android/blob/master/EXAMPLES.md) for more details on how to use the library
## 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/JWTDecode.Android/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.