4 releases

0.2.0 Sep 12, 2022
0.1.4 Mar 23, 2021
0.1.3 Oct 15, 2019
0.1.0 May 4, 2018

#177 in Cryptography

Download history 840/week @ 2022-08-05 398/week @ 2022-08-12 437/week @ 2022-08-19 417/week @ 2022-08-26 824/week @ 2022-09-02 982/week @ 2022-09-09 1229/week @ 2022-09-16 965/week @ 2022-09-23 967/week @ 2022-09-30 1326/week @ 2022-10-07 1067/week @ 2022-10-14 1036/week @ 2022-10-21 942/week @ 2022-10-28 966/week @ 2022-11-04 999/week @ 2022-11-11 844/week @ 2022-11-18

3,882 downloads per month
Used in 3 crates

MPL-2.0 license

25KB
448 lines

fernet-rs

dependency status

An implementation of fernet in Rust.

What is Fernet?

Fernet is a small library to help you encrypt parcels of data with optional expiry times. It's great for tokens or exchanging small strings or blobs of data. Fernet is designed to be easy to use, combining cryptographic primitives in a way that is hard to get wrong, prevents tampering and gives you confidence that the token is legitimate. You should consider this if you need:

  • Time limited authentication tokens in URLs or authorisation headers
  • To send small blobs of encrypted data between two points with a static key
  • Simple encryption of secrets to store to disk that can be read later
  • Many more ...

Great! How do I start?

Add fernet to your Cargo.toml:

[dependencies]
fernet = "0.1"

And then have a look at our [API documentation] online, or run "cargo doc --open" in your project.

Testing Token Expiry

By default fernet wraps operations in an attempt to be safe - you should never be able to "hold it incorrectly". But we understand that sometimes you need to be able to do some more complicated operations.

The major example of this is having your application test how it handles tokens that have expired past their ttl.

To support this, we allow you to pass in timestamps to the encrypt_at_time and decrypt_at_time functions, but these are behind a feature gate. To activate these api's you need to add the following to Cargo.toml

[dependencies]
fernet = { version = "0.1", features = ["fernet_danger_timestamps"] }

Dependencies

~2–2.8MB
~61K SLoC