Add the following to Cargo.toml:
toml
jsonwebtoken = "1"
rustc-serialize = "0.3"
There is a complete example in examples/claims.rs but here's a quick one.
In terms of imports: ```rust extern crate jsonwebtoken as jwt; extern crate rustc_serialize;
use jwt::{encode, decode, Header, Algorithm}; ```
Look at the examples directory for 2 examples: a basic one and one with a custom header.
rust
let token = encode(Header::default(), &my_claims, "secret".as_ref()).unwrap();
In that example, my_claims is an instance of a Claims struct that derives RustcEncodable and RustcDecodable.
The default algorithm is HS256.
Look at custom headers section to see how to change that.
rust
let token = decode::<Claims>(&token, "secret", Algorithm::HS256).unwrap();
// token is a struct with 2 params: header and claims
In addition to the normal base64/json decoding errors, decode can return two custom errors:
The library only validates the algorithm type used but does not verify claims such as expiration.
Feel free to add a validate method to your claims struct to handle that: there is an example of that in examples/claims.rs.
All the parameters from the RFC are supported but the default header only has typ and alg set: all the other fields are optional.
If you want to set the kid parameter for example:
rust
let mut header = Header::default();
header.kid = Some("blabla".to_owned());
header.alg = Algorithm::HS512;
let token = encode(header, &my_claims, "secret".as_ref()).unwrap();
Look at examples/custom_header.rs for a full working example.
Right now, only HMAC SHA family is supported: HMAC SHA256, HMAC SHA384 and HMAC SHA512.
On my thinkpad 440s for a 2 claims struct using HMAC SHA256:
test bench_decode ... bench: 4,947 ns/iter (+/- 611)
test bench_encode ... bench: 3,301 ns/iter (+/- 465)