Merge pull request 'Release' (#50) from devel into main

Reviewed-on: #50

.gitea/workflows/tag_release.yaml

@@ -1,10 +1,9 @@
 name: Release Tagging
 
 on:
-  push:
+  pull_request:
     branches:
       - main
-      - devel
 
 jobs:
   release:
@@ -50,6 +49,3 @@ jobs:
           release_name: Release ${{ steps.version.outputs.project_tag_release }}
           body: |
            Release of version ${{ steps.version.outputs.project_tag_release }}
-          # draft: false
-          # prerelease: ${{ startsWith(github.ref, 'v') == false }} # prerelease if not a valid release tag
-

.gitea/workflows/workflow.yaml

@@ -4,11 +4,9 @@ on:
   push:
     branches:
       - main 
-      - devel
   pull_request:
     branches:
       - main 
-      - devel
 
 jobs:
   check:

Cargo.lock

@@ -2,6 +2,33 @@
 # It is not intended for manual editing.
 version = 4
 
+[[package]]
+name = "adler2"
+version = "2.0.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "320119579fcad9c21884f5c4861d16174d0e06250625266f50fe6898340abefa"
+
+[[package]]
+name = "aho-corasick"
+version = "1.1.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8e60d3430d3a69478ad0993f19238d2df97c507009a52b3c10addcd7f6bcb916"
+dependencies = [
+ "memchr",
+]
+
+[[package]]
+name = "anyhow"
+version = "1.0.98"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e16d2d3311acee920a9eb8d33b8cbc1787ce4a264e85f964c2404b969bdcd487"
+
+[[package]]
+name = "base64"
+version = "0.22.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "72b3254f16251a8381aa12e40e3c4d2f0199f8c6508fbecb9d91f575e0fbb8c6"
+
 [[package]]
 name = "bitflags"
 version = "2.9.0"
@@ -14,12 +41,30 @@ version = "3.19.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "46c5e41b57b8bba42a04676d81cb89e9ee8e859a1a66f80a5a72e1cb76b34d43"
 
+[[package]]
+name = "cc"
+version = "1.2.30"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "deec109607ca693028562ed836a5f1c4b8bd77755c4e132fc5ce11b0b6211ae7"
+dependencies = [
+ "shlex",
+]
+
 [[package]]
 name = "cfg-if"
 version = "1.0.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd"
 
+[[package]]
+name = "crc32fast"
+version = "1.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9481c1c90cbf2ac953f07c8d4a58aa3945c425b7185c9154d67a65e4230da511"
+dependencies = [
+ "cfg-if",
+]
+
 [[package]]
 name = "deranged"
 version = "0.4.0"
@@ -30,6 +75,12 @@ dependencies = [
  "serde",
 ]
 
+[[package]]
+name = "equivalent"
+version = "1.0.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "877a4ace8713b0bcf2a4e7eec82529c029f1d0619886d18145fea96c3ffe5c0f"
+
 [[package]]
 name = "errno"
 version = "0.3.10"
@@ -46,6 +97,31 @@ version = "2.3.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "37909eebbb50d72f9059c3b6d82c0463f2ff062c9e95845c43a6c9c0355411be"
 
+[[package]]
+name = "flate2"
+version = "1.1.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4a3d7db9596fecd151c5f638c0ee5d5bd487b6e0ea232e5dc96d5250f6f94b1d"
+dependencies = [
+ "crc32fast",
+ "miniz_oxide",
+]
+
+[[package]]
+name = "foreign-types"
+version = "0.3.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f6f339eb8adc052cd2ca78910fda869aefa38d22d5cb648e6485e4d3fc06f3b1"
+dependencies = [
+ "foreign-types-shared",
+]
+
+[[package]]
+name = "foreign-types-shared"
+version = "0.1.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "00b0228411908ca8685dba7fc2cdd70ec9990a6e753e89b6ac91a84c40fbaf4b"
+
 [[package]]
 name = "getrandom"
 version = "0.3.2"
@@ -58,10 +134,17 @@ dependencies = [
  "wasi",
 ]
 
+[[package]]
+name = "hashbrown"
+version = "0.15.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5971ac85611da7067dbfcabef3c70ebb5606018acd9e2a3903a0da507521e0d5"
+
 [[package]]
 name = "icarus_models"
-version = "0.4.3"
+version = "0.5.5"
 dependencies = [
+ "josekit",
  "rand",
  "serde",
  "serde_json",
@@ -70,12 +153,39 @@ dependencies = [
  "uuid",
 ]
 
+[[package]]
+name = "indexmap"
+version = "2.10.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "fe4cd85333e22411419a0bcae1297d25e58c9443848b11dc6a86fefe8c78a661"
+dependencies = [
+ "equivalent",
+ "hashbrown",
+]
+
 [[package]]
 name = "itoa"
 version = "1.0.15"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "4a5f13b858c8d314ee3e8f639011f7ccefe71f97f96e50151fb991f267928e2c"
 
+[[package]]
+name = "josekit"
+version = "0.10.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a808e078330e6af222eb0044b71d4b1ff981bfef43e7bc8133a88234e0c86a0c"
+dependencies = [
+ "anyhow",
+ "base64",
+ "flate2",
+ "openssl",
+ "regex",
+ "serde",
+ "serde_json",
+ "thiserror",
+ "time",
+]
+
 [[package]]
 name = "js-sys"
 version = "0.3.77"
@@ -110,6 +220,15 @@ version = "2.7.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "78ca9ab1a0babb1e7d5695e3530886289c18cf2f87ec19a575a0abdce112e3a3"
 
+[[package]]
+name = "miniz_oxide"
+version = "0.8.9"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1fa76a2c86f704bdb222d66965fb3d63269ce38518b83cb0575fca855ebb6316"
+dependencies = [
+ "adler2",
+]
+
 [[package]]
 name = "num-conv"
 version = "0.1.0"
@@ -122,6 +241,50 @@ version = "1.21.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "42f5e15c9953c5e4ccceeb2e7382a716482c34515315f7b03532b8b4e8393d2d"
 
+[[package]]
+name = "openssl"
+version = "0.10.73"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8505734d46c8ab1e19a1dce3aef597ad87dcb4c37e7188231769bd6bd51cebf8"
+dependencies = [
+ "bitflags",
+ "cfg-if",
+ "foreign-types",
+ "libc",
+ "once_cell",
+ "openssl-macros",
+ "openssl-sys",
+]
+
+[[package]]
+name = "openssl-macros"
+version = "0.1.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a948666b637a0f465e8564c73e89d4dde00d72d4d473cc972f390fc3dcee7d9c"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "openssl-sys"
+version = "0.9.109"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "90096e2e47630d78b7d1c20952dc621f957103f8bc2c8359ec81290d75238571"
+dependencies = [
+ "cc",
+ "libc",
+ "pkg-config",
+ "vcpkg",
+]
+
+[[package]]
+name = "pkg-config"
+version = "0.3.32"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7edddbd0b52d732b21ad9a5fab5c704c14cd949e5e9a1ec5929a24fded1b904c"
+
 [[package]]
 name = "powerfmt"
 version = "0.2.0"
@@ -190,6 +353,35 @@ dependencies = [
  "getrandom",
 ]
 
+[[package]]
+name = "regex"
+version = "1.11.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b544ef1b4eac5dc2db33ea63606ae9ffcfac26c1416a2806ae0bf5f56b201191"
+dependencies = [
+ "aho-corasick",
+ "memchr",
+ "regex-automata",
+ "regex-syntax",
+]
+
+[[package]]
+name = "regex-automata"
+version = "0.4.9"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "809e8dc61f6de73b46c85f4c96486310fe304c434cfa43669d7b40f711150908"
+dependencies = [
+ "aho-corasick",
+ "memchr",
+ "regex-syntax",
+]
+
+[[package]]
+name = "regex-syntax"
+version = "0.8.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2b15c43186be67a4fd63bee50d0303afffcef381492ebe2c5d87f324e1b8815c"
+
 [[package]]
 name = "rustix"
 version = "1.0.3"
@@ -241,12 +433,19 @@ version = "1.0.140"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "20068b6e96dc6c9bd23e01df8827e6c7e1f2fddd43c21810382803c136b99373"
 dependencies = [
+ "indexmap",
  "itoa",
  "memchr",
  "ryu",
  "serde",
 ]
 
+[[package]]
+name = "shlex"
+version = "1.3.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0fda2ff0d084019ba4d7c6f371c95d8fd75ce3524c3cb8fb653a3023f6323e64"
+
 [[package]]
 name = "syn"
 version = "2.0.100"
@@ -271,6 +470,26 @@ dependencies = [
  "windows-sys",
 ]
 
+[[package]]
+name = "thiserror"
+version = "2.0.12"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "567b8a2dae586314f7be2a752ec7474332959c6460e02bde30d702a66d488708"
+dependencies = [
+ "thiserror-impl",
+]
+
+[[package]]
+name = "thiserror-impl"
+version = "2.0.12"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7f7cf42b4507d8ea322120659672cf1b9dbb93f8f2d4ecfd6e51350ff5b17a1d"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
 [[package]]
 name = "time"
 version = "0.3.41"
@@ -320,6 +539,12 @@ dependencies = [
  "wasm-bindgen",
 ]
 
+[[package]]
+name = "vcpkg"
+version = "0.2.15"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "accd4ea62f7bb7a82fe23066fb0957d48ef677f6eeb8215f372f52e48bb32426"
+
 [[package]]
 name = "wasi"
 version = "0.14.2+wasi-0.2.4"

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "icarus_models"
-version = "0.4.3"
+version = "0.5.5"
 edition = "2024"
 rust-version = "1.88"
 description = "models used for the icarus project"
@@ -12,6 +12,7 @@ serde_json = { version = "1.0.140" }
 rand = { version = "0.9.1" }
 time = { version = "0.3.41", features = ["formatting", "macros", "parsing", "serde"] }
 uuid = { version = "1.17.0", features = ["v4", "serde"] }
+josekit = { version = "0.10.3" }
 
 [dev-dependencies]
 tempfile = { version = "3.20.0" }

README.md

@@ -0,0 +1,2 @@
+A library containing commonly used models and functions that is used throughout
+icarus projects. This reduces the amount of duplicated code without a benefit.

src/coverart.rs

@@ -6,8 +6,11 @@ use serde::{Deserialize, Serialize};
 pub struct CoverArt {
     pub id: uuid::Uuid,
     pub title: String,
+    #[serde(skip)]
     pub path: String,
+    #[serde(skip)]
     pub data: Vec<u8>,
+    pub song_id: uuid::Uuid,
 }
 
 pub mod init {
@@ -19,6 +22,7 @@ pub mod init {
             title: String::new(),
             path: path.clone(),
             data: Vec::new(),
+            song_id: uuid::Uuid::nil(),
         }
     }
 }

src/token.rs

@@ -62,10 +62,87 @@ impl Token {
     }
 }
 
+pub fn get_issued() -> time::Result<time::OffsetDateTime> {
+    Ok(time::OffsetDateTime::now_utc())
+}
+
+mod util {
+    pub fn time_to_std_time(
+        provided_time: &time::OffsetDateTime,
+    ) -> Result<std::time::SystemTime, std::time::SystemTimeError> {
+        let converted = std::time::SystemTime::from(*provided_time);
+        Ok(converted)
+    }
+}
+
+#[derive(Debug)]
+pub struct TokenResource {
+    pub message: String,
+    pub issuer: String,
+    pub audiences: Vec<String>,
+    pub id: uuid::Uuid,
+}
+
+pub const TOKEN_TYPE: &str = "JWT";
+
+pub fn create_token(
+    key: &String,
+    token_resource: &TokenResource,
+    duration: time::Duration,
+) -> Result<(String, i64), josekit::JoseError> {
+    let mut header = josekit::jws::JwsHeader::new();
+    header.set_token_type(TOKEN_TYPE);
+
+    let mut payload = josekit::jwt::JwtPayload::new();
+    let message = &token_resource.message;
+    let issuer = &token_resource.issuer;
+    let audiences: &Vec<String> = &token_resource.audiences;
+    payload.set_subject(message);
+    payload.set_issuer(issuer);
+    payload.set_audience(audiences.clone());
+    if !token_resource.id.is_nil() {
+        match payload.set_claim("id", Some(serde_json::json!(token_resource.id))) {
+            Ok(_) => {}
+            Err(err) => {
+                return Err(err);
+            }
+        }
+    }
+    match get_issued() {
+        Ok(issued) => {
+            let expire = issued + duration;
+            payload.set_issued_at(&util::time_to_std_time(&issued).unwrap());
+            payload.set_expires_at(&util::time_to_std_time(&expire).unwrap());
+
+            let signer = josekit::jws::alg::hmac::HmacJwsAlgorithm::Hs256
+                .signer_from_bytes(key.as_bytes())
+                .unwrap();
+            Ok((
+                josekit::jwt::encode_with_signer(&payload, &header, &signer).unwrap(),
+                (expire - time::OffsetDateTime::UNIX_EPOCH).whole_seconds(),
+            ))
+        }
+        Err(e) => Err(josekit::JoseError::InvalidClaim(e.into())),
+    }
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;
 
+    fn test_key() -> String {
+        String::from("c3092urmc2219ix320i40m293ic29IM09IN0u879Y8B98YB8yb86TN7B55R4yv4RCVU6Bi8YO8U")
+    }
+
+    fn test_resource() -> TokenResource {
+        TokenResource {
+            issuer: String::from("icarus_auth_test"),
+            message: String::from("Authorization"),
+            audiences: vec![String::from("icarus_test")],
+            id: uuid::Uuid::nil(),
+        }
+    }
+
     #[test]
     fn test_token_scope_check() {
         let mut token = Token::default();
@@ -80,4 +157,45 @@ mod tests {
             check_scope, token.scope
         );
     }
+
+    #[test]
+    fn test_token_creation() {
+        let key = test_key();
+        let test_token_resource = test_resource();
+        let token_expiration_duration = time::Duration::hours(2);
+
+        match create_token(&key, &test_token_resource, token_expiration_duration) {
+            Ok((token, expire_duration)) => {
+                assert_eq!(false, token.is_empty(), "Error: Token is empty");
+                assert!(
+                    expire_duration > 0,
+                    "Token expire duration is invalid {expire_duration:?}"
+                );
+            }
+            Err(err) => {
+                assert!(false, "Error: {err:?}");
+            }
+        }
+    }
+
+    #[test]
+    fn test_token_creation_with_id() {
+        let key = test_key();
+        let mut test_token_resource = test_resource();
+        test_token_resource.id = uuid::Uuid::new_v4();
+        let token_expiration_duration = time::Duration::hours(2);
+
+        match create_token(&key, &test_token_resource, token_expiration_duration) {
+            Ok((token, expire_duration)) => {
+                assert_eq!(false, token.is_empty(), "Error: Token is empty");
+                assert!(
+                    expire_duration > 0,
+                    "Token expire duration is invalid {expire_duration:?}"
+                );
+            }
+            Err(err) => {
+                assert!(false, "Error: {err:?}");
+            }
+        }
+    }
 }