medallion/README.md

15 lines
840 B
Markdown
Raw Normal View History

2017-02-15 20:46:23 +00:00
# Medallion [![Build Status](https://travis-ci.org/commandline/medallion.svg?branch=master)](https://travis-ci.org/commandline/medallion)
2017-02-13 23:40:07 +00:00
A JWT library for rust using serde, serde_json and openssl.
2017-02-15 20:42:06 +00:00
## Documentation
2017-02-15 20:46:23 +00:00
- [Documentation] (https://commandline.github.io/medallion/)
2017-02-15 20:42:06 +00:00
2017-02-13 23:40:07 +00:00
## Usage
The library provides a `Token` type that wraps a header and claims. The claims can be any type that implements the `Component` trait, which is automatically implemented for types that implement the `Sized`, `Encodable`,
and `Decodable` traits. Header can be any type that implements `Component` and `Header`. `Header` ensures that the required algorithm is available for signing and verification. `HS256`, `HS384`, `HS512`, `RS256`, `RS384`, and `RS512` are supported. See the examples.
This library was originally forked from @mikkyang's rust-jwt.