asap 0.3.0

An implementation of ASAP for rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

# ASAP for Rust

[![crates.io](https://img.shields.io/crates/v/asap.svg)](https://crates.io/crates/asap)
[![dependency status](https://deps.rs/repo/bitbucket/cosmotherly/rust-asap/status.svg)](https://deps.rs/repo/bitbucket/cosmotherly/rust-asap)

[Documentation](https://docs.rs/asap).

This is a rust library for generating and validating ASAP tokens. It provides options for doing so that are compliant with the [ASAP specification](https://s2sauth.bitbucket.io/spec/).

**Why should you use this library?**

* Do you want to generate 1 ASAP token/millisecond?
* Do you want to validate 5 ASAP tokens/millisecond?
* Do you want to bring your own token `Claims` in whatever format you'd like?
* Do you want/need to use ASAP with one of the greatest languages ever?

Basically, yes. Yes, you should use this library if you want ASAP and use Rust.

## Usage

### Installation

To install, add the following lines to your `Cargo.toml`:

```toml
asap = "0.2"
# These crates are required for defining your own `Claims` struct which needs
# to be serialised into the token (and deserialised out of it).
serde_derive = "1"
serde = "1"
```

### Documentation

And see [the documentation and API](https://docs.rs/asap) which should be straightforward enough for anything you'd need.

### Requirements

This crate currently depends on a valid installation of `openssl`. See the [`openssl` crate's repo](https://github.com/sfackler/rust-openssl) for more installation details relating to `openssl`. 
It depends on `openssl` in order to convert a PEM-encoded private key to DER when instantiating from environment variables (see [`Generator::from_env()`](./src/generator.rs)).

Other than that, this crate simply provides an ASAP `Generator` and an ASAP `Validator`, which generate and validate ASAP tokens according [to the specification](https://s2sauth.bitbucket.io/spec/).

## Development/Testing

Currently, running the tests has some limitations:

* The tests need a local keyserver running at `http://localhost:8000`
	- [A sample mini-keyserver is provided](./support/keyserver) in this repository
* The tests need to be run serially
	- Since they also test that requests were made to the keyserver, etc.

To run the tests, perform the following:

```bash
# Runs a simple keyserver.
cargo run -p keyserver

# In a different shell, run the tests with the following command:
./support/test.sh
```

## References

* ASAP Spec: https://s2sauth.bitbucket.io/spec/
* JWT Spec: https://tools.ietf.org/html/rfc7519
* JWS Spec: https://tools.ietf.org/html/rfc7515

## License

[MIT](./LICENSE.md)