Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/GildedHonour/frank_jwt
JSON Web Token implementation in Rust.
https://github.com/GildedHonour/frank_jwt
auth0-jwt authentication cryptography jwt jwt-token rust
Last synced: about 1 month ago
JSON representation
JSON Web Token implementation in Rust.
- Host: GitHub
- URL: https://github.com/GildedHonour/frank_jwt
- Owner: GildedHonour
- License: apache-2.0
- Created: 2014-10-21T23:45:01.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-11-24T14:06:15.000Z (6 months ago)
- Last Synced: 2024-04-01T20:51:32.732Z (2 months ago)
- Topics: auth0-jwt, authentication, cryptography, jwt, jwt-token, rust
- Language: Rust
- Homepage: https://jwt.io
- Size: 182 KB
- Stars: 250
- Watchers: 9
- Forks: 48
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-rust - GildedHonour/frank_jwt
- awesome-rust-zh - GildedHonour/frank_jwt - Rust 中的 JSON Web 令牌实现。[<img src="https://api.travis-ci.org/GildedHonour/frank_jwt.svg?branch=master">](https://travis-ci.org/GildedHonour/frank_jwt) (库 / 网页编程)
- awesome-rust - GildedHonour/frank_jwt - ci.org/GildedHonour/frank_jwt.svg?branch=master)](https://travis-ci.org/GildedHonour/frank_jwt) (Libraries / Web programming)
- awesome-stars - GildedHonour/frank_jwt - JSON Web Token implementation in Rust. (Rust)
- awesome-rust - GildedHonour/frank_jwt - ci.org/GildedHonour/frank_jwt.svg?branch=master">](https://travis-ci.org/GildedHonour/frank_jwt) (Libraries / Web programming)
- awesome-jwt - frank_jwt - Implementation in Rust. (Libraries / Rust)
- awesome-rust-cn - GildedHonour/frank_jwt - ci.org/GildedHonour/frank_jwt.svg?branch=master">](https://travis-ci.org/GildedHonour/frank_jwt) (Libraries / Web programming)
- awesome-rust - GildedHonour/frank_jwt - ci.org/GildedHonour/frank_jwt.svg?branch=master">](https://travis-ci.org/GildedHonour/frank_jwt) (库 Libraries / web编程 Web programming)
- awesome-rust-cn - GildedHonour/frank_jwt
- awesome-rust - GildedHonour/frank_jwt - ci.org/GildedHonour/frank_jwt.svg?branch=master)](https://travis-ci.org/GildedHonour/frank_jwt) (Libraries / Web programming)
README
Frank JWT [](https://travis-ci.org/GildedHonour/frank_jwt) [](https://crates.io/crates/frank_jwt)
================================================
Implementation of [JSON Web Tokens](https://jwt.io) in Rust.
## Algorithms and features supported
- [x] HS256
- [x] HS384
- [x] HS512
- [x] RS256
- [x] RS384
- [x] RS512
- [x] ES256
- [x] ES384
- [x] ES512
- [x] Sign
- [x] Verify
- [ ] iss (issuer) check
- [ ] sub (subject) check
- [ ] aud (audience) check
- [x] exp (expiration time) check
- [ ] nbf (not before time) check
- [ ] iat (issued at) check
- [ ] jti (JWT id) check
## Usage
Put this into your `Cargo.toml`:
```toml
[dependencies]
frank_jwt = ""
```
And this in your crate root:
```rust
extern crate frank_jwt;
#[macro_use] extern crate serde_json;
use frank_jwt::{Algorithm, encode, decode};
```
## Example
```rust
//HS256
let mut payload = json!({
"key1": "val1",
"key2": "val2"
});
let mut header = json!({});
let secret = "secret123";
let jwt = encode(&header, secret.to_string(), &payload, Algorithm::HS256);
//RS256
use std::env;
let mut payload = json!({
"key1": "val1",
"key2": "val2"
});
let mut header = json!({});
let mut keypath = env::current_dir().unwrap();
keypath.push("some_folder");
keypath.push("my_rsa_2048_key.pem");
let jwt = encode(&header, &keypath.to_path_buf(), &payload, Algorithm::RS256);
let (header, payload) = decode(&jwt, &keypath.to_path_buf(), Algorithm::RS256, &ValidationOptions::default());
```
## Validation Options
The ValidationOptions structure allows for control over which checks should be preformed when decoding a JWT. Calling new on this will provide a default set of values. There is also a dangerous function that will return validation options that doesn't perform any checking.
The default values are:
* Perform expiry check
* Allow 0 leeway for the expiry check.
It's worth noting that if the expiry check is requested and an exp claim is not within the JWT the check will fail validation.
## License
Apache 2.0
## Tests
```shell
cargo test
```
## Contributors
TODO