From 03aa45c962b91c2fc3a82a6ed522b3cd17bbbfa5 Mon Sep 17 00:00:00 2001 From: Pierre Hubert Date: Sat, 29 Apr 2023 09:40:39 +0200 Subject: [PATCH] Ready to release --- .drone.yml | 1 + Cargo.lock | 2 +- Cargo.toml | 2 +- README.md | 4 +++- 4 files changed, 6 insertions(+), 3 deletions(-) diff --git a/.drone.yml b/.drone.yml index 1918bc9..c557a6b 100644 --- a/.drone.yml +++ b/.drone.yml @@ -9,6 +9,7 @@ steps: commands: - rustup component add clippy - cargo clippy --all-features -- -D warnings + - cargo clippy -- -D warnings - cargo test --all-features diff --git a/Cargo.lock b/Cargo.lock index 307451e..09b7438 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -478,7 +478,7 @@ checksum = "6a987beff54b60ffa6d51982e1aa1146bc42f19bd26be28b0586f252fccf5317" [[package]] name = "light-openid" -version = "0.3.0-alpha" +version = "1.0.0" dependencies = [ "aes-gcm", "base64", diff --git a/Cargo.toml b/Cargo.toml index 082366c..863a3f9 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "light-openid" -version = "0.3.0-alpha" +version = "1.0.0" edition = "2021" repository = "https://gitea.communiquons.org/pierre/light-openid" authors = ["Pierre HUBERT "] diff --git a/README.md b/README.md index 9b76c49..978f2ad 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,9 @@ fun test() { } ``` +> Note : In order to use `CryptoWrapper` on your own, you must add `bincode>=2.0` as one of your own dependencies. This is not required if you decide use `BasicStateManager`. + + `BasicStateManager` is a helper that uses `CryptoWrapper` to generate and validates states for OpenID authentication: ```rust @@ -56,7 +59,6 @@ let state = manager.gen_state(ip).unwrap(); assert!(manager.validate_state(ip, &state).is_ok()); ``` - ## Complete example A complete example usage of this crate can be found here: [https://gitea.communiquons.org/pierre/oidc-test-client](https://gitea.communiquons.org/pierre/oidc-test-client) \ No newline at end of file