From d811b36749da18817139099c2e7afb14c468ead9 Mon Sep 17 00:00:00 2001 From: MedzikUser Date: Sat, 11 Jun 2022 16:59:20 +0200 Subject: [PATCH] add json web token --- Cargo.lock | 390 ++++++++++++++++++++++++++++++++++++++++++++ Cargo.toml | 6 +- src/jsonwebtoken.rs | 137 ++++++++++++++++ src/lib.rs | 28 ++++ 4 files changed, 560 insertions(+), 1 deletion(-) create mode 100644 src/jsonwebtoken.rs diff --git a/Cargo.lock b/Cargo.lock index 08efb77..01b519a 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -2,6 +2,18 @@ # It is not intended for manual editing. version = 3 +[[package]] +name = "autocfg" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d468802bab17cbc0cc575e9b053f41e72aa36bfa6b7f55e3529ffa43161b97fa" + +[[package]] +name = "base64" +version = "0.13.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "904dfeac50f3cdaba28fc6f57fdcddb75f49ed61346676a78c4ffe55877802fd" + [[package]] name = "block-buffer" version = "0.10.2" @@ -11,12 +23,37 @@ dependencies = [ "generic-array", ] +[[package]] +name = "bumpalo" +version = "3.10.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "37ccbd214614c6783386c1af30caf03192f17891059cecc394b4fb119e363de3" + +[[package]] +name = "cc" +version = "1.0.73" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2fff2a6927b3bb87f9595d67196a70493f627687a71d87a0d692242c33f58c11" + [[package]] name = "cfg-if" version = "1.0.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd" +[[package]] +name = "chrono" +version = "0.4.19" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "670ad68c9088c2a963aaa298cb369688cf3f9465ce5e2d4ca10e6e0098a1ce73" +dependencies = [ + "libc", + "num-integer", + "num-traits", + "time 0.1.44", + "winapi", +] + [[package]] name = "cpufeatures" version = "0.2.2" @@ -40,7 +77,10 @@ dependencies = [ name = "crypto-utils" version = "0.1.0" dependencies = [ + "chrono", "hex", + "jsonwebtoken", + "serde", "sha1", "sha2", ] @@ -71,12 +111,180 @@ version = "0.4.3" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "7f24254aa9a54b5c858eaee2f5bccdb46aaf0e486a595ed5fd8f86ba55232a70" +[[package]] +name = "itoa" +version = "1.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "112c678d4050afce233f4f2852bb2eb519230b3cf12f33585275537d7e41578d" + +[[package]] +name = "js-sys" +version = "0.3.57" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "671a26f820db17c2a2750743f1dd03bafd15b98c9f30c7c2628c024c05d73397" +dependencies = [ + "wasm-bindgen", +] + +[[package]] +name = "jsonwebtoken" +version = "8.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cc9051c17f81bae79440afa041b3a278e1de71bfb96d32454b477fd4703ccb6f" +dependencies = [ + "base64", + "pem", + "ring", + "serde", + "serde_json", + "simple_asn1", +] + +[[package]] +name = "lazy_static" +version = "1.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e2abad23fbc42b3700f2f279844dc832adb2b2eb069b2df918f455c4e18cc646" + [[package]] name = "libc" version = "0.2.126" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "349d5a591cd28b49e1d1037471617a32ddcda5731b99419008085f72d5a53836" +[[package]] +name = "log" +version = "0.4.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "abb12e687cfb44aa40f41fc3978ef76448f9b6038cad6aef4259d3c095a2382e" +dependencies = [ + "cfg-if", +] + +[[package]] +name = "num-bigint" +version = "0.4.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f93ab6289c7b344a8a9f60f88d80aa20032336fe78da341afc91c8a2341fc75f" +dependencies = [ + "autocfg", + "num-integer", + "num-traits", +] + +[[package]] +name = "num-integer" +version = "0.1.45" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "225d3389fb3509a24c93f5c29eb6bde2586b98d9f016636dff58d7c6f7569cd9" +dependencies = [ + "autocfg", + "num-traits", +] + +[[package]] +name = "num-traits" +version = "0.2.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "578ede34cf02f8924ab9447f50c28075b4d3e5b269972345e7e0372b38c6cdcd" +dependencies = [ + "autocfg", +] + +[[package]] +name = "num_threads" +version = "0.1.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2819ce041d2ee131036f4fc9d6ae7ae125a3a40e97ba64d04fe799ad9dabbb44" +dependencies = [ + "libc", +] + +[[package]] +name = "once_cell" +version = "1.12.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7709cef83f0c1f58f666e746a08b21e0085f7440fa6a29cc194d68aac97a4225" + +[[package]] +name = "pem" +version = "1.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e9a3b09a20e374558580a4914d3b7d89bd61b954a5a5e1dcbea98753addb1947" +dependencies = [ + "base64", +] + +[[package]] +name = "proc-macro2" +version = "1.0.39" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c54b25569025b7fc9651de43004ae593a75ad88543b17178aa5e1b9c4f15f56f" +dependencies = [ + "unicode-ident", +] + +[[package]] +name = "quote" +version = "1.0.18" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a1feb54ed693b93a84e14094943b84b7c4eae204c512b7ccb95ab0c66d278ad1" +dependencies = [ + "proc-macro2", +] + +[[package]] +name = "ring" +version = "0.16.20" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3053cf52e236a3ed746dfc745aa9cacf1b791d846bdaf412f60a8d7d6e17c8fc" +dependencies = [ + "cc", + "libc", + "once_cell", + "spin", + "untrusted", + "web-sys", + "winapi", +] + +[[package]] +name = "ryu" +version = "1.0.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f3f6f92acf49d1b98f7a81226834412ada05458b7364277387724a237f062695" + +[[package]] +name = "serde" +version = "1.0.137" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "61ea8d54c77f8315140a05f4c7237403bf38b72704d031543aa1d16abbf517d1" +dependencies = [ + "serde_derive", +] + +[[package]] +name = "serde_derive" +version = "1.0.137" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1f26faba0c3959972377d3b2d306ee9f71faee9714294e41bb777f83f88578be" +dependencies = [ + "proc-macro2", + "quote", + "syn", +] + +[[package]] +name = "serde_json" +version = "1.0.81" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9b7ce2b32a1aed03c558dc61a5cd328f15aff2dbc17daad8fb8af04d2100e15c" +dependencies = [ + "itoa", + "ryu", + "serde", +] + [[package]] name = "sha1" version = "0.10.1" @@ -99,14 +307,196 @@ dependencies = [ "digest", ] +[[package]] +name = "simple_asn1" +version = "0.6.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "adc4e5204eb1910f40f9cfa375f6f05b68c3abac4b6fd879c8ff5e7ae8a0a085" +dependencies = [ + "num-bigint", + "num-traits", + "thiserror", + "time 0.3.9", +] + +[[package]] +name = "spin" +version = "0.5.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6e63cff320ae2c57904679ba7cb63280a3dc4613885beafb148ee7bf9aa9042d" + +[[package]] +name = "syn" +version = "1.0.96" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0748dd251e24453cb8717f0354206b91557e4ec8703673a4b30208f2abaf1ebf" +dependencies = [ + "proc-macro2", + "quote", + "unicode-ident", +] + +[[package]] +name = "thiserror" +version = "1.0.31" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bd829fe32373d27f76265620b5309d0340cb8550f523c1dda251d6298069069a" +dependencies = [ + "thiserror-impl", +] + +[[package]] +name = "thiserror-impl" +version = "1.0.31" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0396bc89e626244658bef819e22d0cc459e795a5ebe878e6ec336d1674a8d79a" +dependencies = [ + "proc-macro2", + "quote", + "syn", +] + +[[package]] +name = "time" +version = "0.1.44" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6db9e6914ab8b1ae1c260a4ae7a49b6c5611b40328a735b21862567685e73255" +dependencies = [ + "libc", + "wasi", + "winapi", +] + +[[package]] +name = "time" +version = "0.3.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c2702e08a7a860f005826c6815dcac101b19b5eb330c27fe4a5928fec1d20ddd" +dependencies = [ + "itoa", + "libc", + "num_threads", + "time-macros", +] + +[[package]] +name = "time-macros" +version = "0.2.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "42657b1a6f4d817cda8e7a0ace261fe0cc946cf3a80314390b22cc61ae080792" + [[package]] name = "typenum" version = "1.15.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "dcf81ac59edc17cc8697ff311e8f5ef2d99fcbd9817b34cec66f90b6c3dfd987" +[[package]] +name = "unicode-ident" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d22af068fba1eb5edcb4aea19d382b2a3deb4c8f9d475c589b6ada9e0fd493ee" + +[[package]] +name = "untrusted" +version = "0.7.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a156c684c91ea7d62626509bce3cb4e1d9ed5c4d978f7b4352658f96a4c26b4a" + [[package]] name = "version_check" version = "0.9.4" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "49874b5167b65d7193b8aba1567f5c7d93d001cafc34600cee003eda787e483f" + +[[package]] +name = "wasi" +version = "0.10.0+wasi-snapshot-preview1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1a143597ca7c7793eff794def352d41792a93c481eb1042423ff7ff72ba2c31f" + +[[package]] +name = "wasm-bindgen" +version = "0.2.80" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "27370197c907c55e3f1a9fbe26f44e937fe6451368324e009cba39e139dc08ad" +dependencies = [ + "cfg-if", + "wasm-bindgen-macro", +] + +[[package]] +name = "wasm-bindgen-backend" +version = "0.2.80" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "53e04185bfa3a779273da532f5025e33398409573f348985af9a1cbf3774d3f4" +dependencies = [ + "bumpalo", + "lazy_static", + "log", + "proc-macro2", + "quote", + "syn", + "wasm-bindgen-shared", +] + +[[package]] +name = "wasm-bindgen-macro" +version = "0.2.80" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "17cae7ff784d7e83a2fe7611cfe766ecf034111b49deb850a3dc7699c08251f5" +dependencies = [ + "quote", + "wasm-bindgen-macro-support", +] + +[[package]] +name = "wasm-bindgen-macro-support" +version = "0.2.80" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "99ec0dc7a4756fffc231aab1b9f2f578d23cd391390ab27f952ae0c9b3ece20b" +dependencies = [ + "proc-macro2", + "quote", + "syn", + "wasm-bindgen-backend", + "wasm-bindgen-shared", +] + +[[package]] +name = "wasm-bindgen-shared" +version = "0.2.80" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d554b7f530dee5964d9a9468d95c1f8b8acae4f282807e7d27d4b03099a46744" + +[[package]] +name = "web-sys" +version = "0.3.57" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7b17e741662c70c8bd24ac5c5b18de314a2c26c32bf8346ee1e6f53de919c283" +dependencies = [ + "js-sys", + "wasm-bindgen", +] + +[[package]] +name = "winapi" +version = "0.3.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5c839a674fcd7a98952e593242ea400abe93992746761e38641405d28b00f419" +dependencies = [ + "winapi-i686-pc-windows-gnu", + "winapi-x86_64-pc-windows-gnu", +] + +[[package]] +name = "winapi-i686-pc-windows-gnu" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6" + +[[package]] +name = "winapi-x86_64-pc-windows-gnu" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f" diff --git a/Cargo.toml b/Cargo.toml index a42ae46..ff33556 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -12,12 +12,16 @@ edition = "2021" [features] default = ["full"] -full = ["sha"] +full = ["sha", "jwt"] sha = ["sha1", "sha2"] +jwt = ["chrono", "serde", "jsonwebtoken"] [dependencies] sha1 = { version = "0.10.1", optional = true } sha2 = { version = "0.10.2", optional = true } +chrono = { version = "0.4.19", optional = true } +serde = { version = "1.0.137", optional = true } +jsonwebtoken = { version = "8.1.0", optional = true } [dev-dependencies] hex = { version = "0.4.3" } diff --git a/src/jsonwebtoken.rs b/src/jsonwebtoken.rs new file mode 100644 index 0000000..3b30554 --- /dev/null +++ b/src/jsonwebtoken.rs @@ -0,0 +1,137 @@ +use chrono::{Duration, Utc}; +use jsonwebtoken::{ + errors::Error, Algorithm, DecodingKey, EncodingKey, Header, TokenData, Validation, +}; +use serde::{Deserialize, Serialize}; + +/// Json Web Token Claims +#[derive(Debug, PartialEq, Serialize, Deserialize, Clone)] +pub struct Claims { + /// Token value + pub sub: String, + /// Expire time of the token + pub exp: i64, + /// Token creation time + pub iat: i64, +} + +impl Claims { + /// Create a new Json Web Token Claims. + /// ``` + /// use crypto_utils::jsonwebtoken::Claims; + /// + /// let user_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"; + /// + /// Claims::new(user_id, 24); + /// ``` + pub fn new(sub: &str, expire_hours: i64) -> Self { + let iat = Utc::now(); + let exp = iat + Duration::hours(expire_hours); + + Self { + sub: sub.to_string(), + iat: iat.timestamp(), + exp: exp.timestamp(), + } + } +} + +/// Json Web Token +#[derive(Debug, PartialEq, Serialize, Deserialize, Clone)] +pub struct Token { + /// Token Header + header: Header, + /// Token claims + pub claims: Claims, + /// Encoded token to a String + pub encoded: String, +} + +impl Token { + /// Create a new token + /// ``` + /// use crypto_utils::jsonwebtoken::{Claims, Token}; + /// + /// // jwt secret + /// let secret = b"secret"; + /// + /// // token claims + /// let claims = Claims::new("user_id_1234", 24); + /// + /// // create token + /// let token = Token::new(secret, claims).unwrap(); + /// ``` + pub fn new(key: &[u8], claims: Claims) -> Result { + // generate token header + let header = Header::new(Algorithm::HS256); + + // encode token + let encoded = jsonwebtoken::encode(&header, &claims, &EncodingKey::from_secret(key))?; + + Ok(Self { + header, + claims, + encoded, + }) + } + + /// Decode token + /// ``` + /// use crypto_utils::jsonwebtoken::{Claims, Token}; + /// + /// // jwt secret + /// let secret = b"secret"; + /// + /// // token claims + /// let claims = Claims::new("user_id_1234", 24); + /// + /// // create token + /// let token = Token::new(secret, claims).unwrap(); + /// + /// // decode token + /// let decoded = Token::decode(secret, token.encoded).unwrap(); + /// ``` + pub fn decode(key: &[u8], token: String) -> Result, Error> { + jsonwebtoken::decode::( + &token, + &DecodingKey::from_secret(key), + &Validation::default(), + ) + } +} + +#[cfg(test)] +mod tests { + use super::{Claims, Token}; + + /// Decode token with invalid secret + #[test] + fn decode_secret_invalid() { + let secret = b"secret"; + + // create claims + let claims = Claims::new("user_id_1234", 24); + + // create token + let token = Token::new(secret, claims).unwrap(); + + // unwrap error when decoding token + let err = Token::decode(b"other secret", token.encoded).unwrap_err(); + + assert_eq!(err.to_string(), "InvalidSignature"); + } + + /// Decode expired token + #[test] + fn decode_expired() { + let key = b"key"; + + // create a token that expired an hour ago + let token = Token::new(key, Claims::new("test", -1)).expect("generate token"); + + // unwrap error when decoding token + let err = Token::decode(key, token.encoded).unwrap_err(); + + assert_eq!(err.to_string(), "ExpiredSignature"); + } +} diff --git a/src/lib.rs b/src/lib.rs index c7d054b..6c0abaa 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -46,6 +46,34 @@ //! //! assert_eq!(hash, "21bd12dc183f740ee76f27b78eb39c8ad972a757".to_string()) //! ``` +//! +//! ### Json Web Token +//! +//! Add `jwt` features (is enabled by default) +//! +//! ```toml +//! [dependencies] +//! crypto-utils = { version = "...", features = ["jwt"] } +//! ``` +//! +//! Create and decode a token +//! +//! ``` +//! use crypto_utils::jsonwebtoken::{Claims, Token}; +//! +//! let user_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"; +//! +//! // create claims +//! let claims = Claims::new(user_id, 24); +//! +//! // create token +//! let token = Token::new(secret, claims).unwrap(); +//! +//! // decode token +//! let decoded = Token::decode(secret, token.encoded).unwrap(); +//! ``` +#[cfg(feature = "jwt")] +pub mod jsonwebtoken; #[cfg(feature = "sha")] pub mod sha;