Merge branch 'main' into wip/messaging

Reviewed-on: #11

Cargo.toml

@@ -9,6 +9,7 @@ lto = true
 codegen-units = 1
 
 [dependencies]
+actix-cors = "0.7.1"
 actix-web = "4.10"
 argon2 = { version = "0.5.3", features = ["std"] }
 clap = { version = "4.5.37", features = ["derive"] }
@@ -21,6 +22,7 @@ serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 simple_logger = "5.0.0"
 sqlx = { version = "0.8", features = ["runtime-tokio", "tls-native-tls", "postgres"] }
+redis = { version = "0.30", features= ["tokio-comp"] }
 tokio-tungstenite = { version = "0.26", features = ["native-tls", "url"] }
 toml = "0.8"
 url = { version = "2.5", features = ["serde"] }

Dockerfile

@@ -18,6 +18,12 @@ RUN useradd --create-home --home-dir /gorb gorb
 
 USER gorb
 
-ENV DATABASE_USERNAME="gorb" DATABASE_PASSWORD="gorb" DATABASE="gorb" DATABASE_HOST="localhost" DATABASE_PORT="5432"
+ENV DATABASE_USERNAME="gorb" \
+DATABASE_PASSWORD="gorb" \
+DATABASE="gorb" \
+DATABASE_HOST="database" \
+DATABASE_PORT="5432" \
+CACHE_DB_HOST="valkey" \
+CACHE_DB_PORT="6379"
 
 ENTRYPOINT ["/usr/bin/entrypoint.sh"]

compose.dev.yml

@@ -34,3 +34,8 @@ services:
       - POSTGRES_USER=gorb
       - POSTGRES_PASSWORD=gorb
       - POSTGRES_DB=gorb
+  valkey:
+    image: valkey/valkey
+    restart: always
+    networks:
+      - gorb

compose.yml

@@ -32,3 +32,8 @@ services:
       - POSTGRES_USER=gorb
       - POSTGRES_PASSWORD=gorb
       - POSTGRES_DB=gorb
+  valkey:
+    image: valkey/valkey
+    restart: always
+    networks:
+      - gorb

entrypoint.sh

@@ -16,6 +16,10 @@ password = "${DATABASE_PASSWORD}"
 database = "${DATABASE}"
 host = "${DATABASE_HOST}"
 port = ${DATABASE_PORT}
+
+[cache_database]
+host = "${CACHE_DB_HOST}"
+port = ${CACHE_DB_PORT}
 EOF
 fi
 

src/api/v1/auth/login.rs

@@ -7,7 +7,7 @@ use log::error;
 use serde::Deserialize;
 
 use crate::{
-    api::v1::auth::{EMAIL_REGEX, PASSWORD_REGEX, USERNAME_REGEX}, crypto::{generate_access_token, generate_refresh_token}, utils::refresh_token_cookie, Data
+    api::v1::auth::{EMAIL_REGEX, PASSWORD_REGEX, USERNAME_REGEX}, utils::{generate_access_token, generate_refresh_token, refresh_token_cookie}, Data
 };
 
 use super::Response;

src/api/v1/auth/mod.rs

@@ -25,8 +25,7 @@ static EMAIL_REGEX: LazyLock<Regex> = LazyLock::new(|| {
     Regex::new(r"[-A-Za-z0-9!#$%&'*+/=?^_`{|}~]+(?:\.[-A-Za-z0-9!#$%&'*+/=?^_`{|}~]+)*@(?:[A-Za-z0-9](?:[-A-Za-z0-9]*[A-Za-z0-9])?\.)+[A-Za-z0-9](?:[-A-Za-z0-9]*[A-Za-z0-9])?").unwrap()
 });
 
-// FIXME: This regex doesnt seem to be working
-static USERNAME_REGEX: LazyLock<Regex> = LazyLock::new(|| Regex::new(r"[a-zA-Z0-9.-_]").unwrap());
+static USERNAME_REGEX: LazyLock<Regex> = LazyLock::new(|| Regex::new(r"^[a-z0-9_.-]+$").unwrap());
 
 // Password is expected to be hashed using SHA3-384
 static PASSWORD_REGEX: LazyLock<Regex> = LazyLock::new(|| Regex::new(r"[0-9a-f]{96}").unwrap());

src/api/v1/auth/refresh.rs

@@ -3,7 +3,7 @@ use log::error;
 use std::time::{SystemTime, UNIX_EPOCH};
 
 use crate::{
-    crypto::{generate_access_token, generate_refresh_token}, utils::refresh_token_cookie, Data
+    utils::{generate_access_token, generate_refresh_token, refresh_token_cookie}, Data
 };
 
 use super::Response;

src/api/v1/auth/register.rs

@@ -12,7 +12,7 @@ use uuid::Uuid;
 
 use super::Response;
 use crate::{
-    api::v1::auth::{EMAIL_REGEX, PASSWORD_REGEX, USERNAME_REGEX}, crypto::{generate_access_token, generate_refresh_token}, utils::refresh_token_cookie, Data
+    api::v1::auth::{EMAIL_REGEX, PASSWORD_REGEX, USERNAME_REGEX}, utils::{generate_access_token, generate_refresh_token, refresh_token_cookie}, Data
 };
 
 #[derive(Deserialize)]

src/api/v1/users/uuid.rs

@@ -5,7 +5,7 @@ use uuid::Uuid;
 
 use crate::{Data, api::v1::auth::check_access_token, utils::get_auth_header};
 
-#[derive(Serialize)]
+#[derive(Serialize, Clone)]
 struct Response {
     uuid: String,
     username: String,
@@ -34,6 +34,12 @@ pub async fn res(
         return Ok(error);
     }
 
+    let cache_result = data.get_cache_key(uuid.to_string()).await;
+
+    if let Ok(cache_hit) = cache_result {
+        return Ok(HttpResponse::Ok().content_type("application/json").body(cache_hit))
+    }
+
     let row = sqlx::query_as(&format!(
         "SELECT username, display_name FROM users WHERE uuid = '{}'",
         uuid
@@ -48,9 +54,18 @@ pub async fn res(
 
     let (username, display_name): (String, Option<String>) = row.unwrap();
 
-    Ok(HttpResponse::Ok().json(Response {
+    let user = Response {
         uuid: uuid.to_string(),
         username,
         display_name: display_name.unwrap_or_default(),
-    }))
+    };
+
+    let cache_result = data.set_cache_key(uuid.to_string(), user.clone(), 1800).await;
+
+    if let Err(error) = cache_result {
+        error!("{}", error);
+        return Ok(HttpResponse::InternalServerError().finish());
+    }
+
+    Ok(HttpResponse::Ok().json(user))
 }

src/config.rs

@@ -7,6 +7,7 @@ use tokio::fs::read_to_string;
 #[derive(Debug, Deserialize)]
 pub struct ConfigBuilder {
     database: Database,
+    cache_database: CacheDatabase,
     web: Option<WebBuilder>,
 }
 
@@ -19,6 +20,15 @@ pub struct Database {
     port: u16,
 }
 
+#[derive(Debug, Deserialize, Clone)]
+pub struct CacheDatabase {
+    username: Option<String>,
+    password: Option<String>,
+    host: String,
+    database: Option<String>,
+    port: u16,
+}
+
 #[derive(Debug, Deserialize)]
 struct WebBuilder {
     url: Option<String>,
@@ -51,6 +61,7 @@ impl ConfigBuilder {
 
         Config {
             database: self.database,
+            cache_database: self.cache_database,
             web,
         }
     }
@@ -59,6 +70,7 @@ impl ConfigBuilder {
 #[derive(Debug, Clone)]
 pub struct Config {
     pub database: Database,
+    pub cache_database: CacheDatabase,
     pub web: Web,
 }
 
@@ -78,3 +90,33 @@ impl Database {
             .port(self.port)
     }
 }
+
+impl CacheDatabase {
+    pub fn url(&self) -> String {
+        let mut url = String::from("redis://");
+
+        if let Some(username) = &self.username {
+            url += username;
+        }
+
+        if let Some(password) = &self.password {
+            url += ":";
+            url += password;
+        }
+
+        if self.username.is_some() || self.password.is_some() {
+            url += "@";
+        }
+
+        url += &self.host;
+        url += ":";
+        url += &self.port.to_string();
+
+        if let Some(database) = &self.database {
+            url += "/";
+            url += database;
+        }
+
+        url
+    }
+}

src/crypto.rs

@@ -1,14 +0,0 @@
-use getrandom::fill;
-use hex::encode;
-
-pub fn generate_access_token() -> Result<String, getrandom::Error> {
-    let mut buf = [0u8; 16];
-    fill(&mut buf)?;
-    Ok(encode(buf))
-}
-
-pub fn generate_refresh_token() -> Result<String, getrandom::Error> {
-    let mut buf = [0u8; 32];
-    fill(&mut buf)?;
-    Ok(encode(buf))
-}

src/main.rs

@@ -1,3 +1,4 @@
+use actix_cors::Cors;
 use actix_web::{App, HttpServer, web};
 use argon2::Argon2;
 use clap::Parser;
@@ -7,7 +8,7 @@ use std::time::SystemTime;
 mod config;
 use config::{Config, ConfigBuilder};
 mod api;
-pub mod crypto;
+
 pub mod utils;
 
 type Error = Box<dyn std::error::Error>;
@@ -22,6 +23,7 @@ struct Args {
 #[derive(Clone)]
 struct Data {
     pub pool: Pool<Postgres>,
+    pub cache_pool: redis::Client,
     pub _config: Config,
     pub argon2: Argon2<'static>,
     pub start_time: SystemTime,
@@ -43,6 +45,8 @@ async fn main() -> Result<(), Error> {
 
     let pool = PgPool::connect_with(config.database.connect_options()).await?;
 
+    let cache_pool = redis::Client::open(config.cache_database.url())?;
+
     /*
     TODO: Figure out if a table should be used here and if not then what.
     Also figure out if these should be different types from what they currently are and if we should add more "constraints"
@@ -153,15 +157,45 @@ async fn main() -> Result<(), Error> {
 
     let data = Data {
         pool,
+        cache_pool,
         _config: config,
         // TODO: Possibly implement "pepper" into this (thinking it could generate one if it doesnt exist and store it on disk)
         argon2: Argon2::default(),
         start_time: SystemTime::now(),
     };
 
+    
     HttpServer::new(move || {
+        // Set CORS headers
+        let cors = Cors::default()
+            /*
+                Set Allowed-Control-Allow-Origin header to whatever
+                the request's Origin header is. Must be done like this
+                rather than setting it to "*" due to CORS not allowing
+                sending of credentials (cookies) with wildcard origin.
+            */
+            .allowed_origin_fn(|_origin, _req_head| {
+                true
+            })
+            /*
+                Allows any request method in CORS preflight requests.
+                This will be restricted to only ones actually in use later.
+            */
+            .allow_any_method()
+            /*
+                Allows any header(s) in request in CORS preflight requests.
+                This wll be restricted to only ones actually in use later.
+            */
+            .allow_any_header()
+            /*
+                Allows browser to include cookies in requests.
+                This is needed for receiving the secure HttpOnly refresh_token cookie.
+            */
+            .supports_credentials();
+
         App::new()
             .app_data(web::Data::new(data.clone()))
+            .wrap(cors)
             .service(api::web())
     })
     .bind((web.url, web.port))?

src/utils.rs

@@ -1,4 +1,10 @@
 use actix_web::{cookie::{time::Duration, Cookie, SameSite}, http::header::HeaderMap, HttpResponse};
+use getrandom::fill;
+use hex::encode;
+use redis::RedisError;
+use serde::Serialize;
+
+use crate::Data;
 
 pub fn get_auth_header(headers: &HeaderMap) -> Result<&str, HttpResponse> {
     let auth_token = headers.get(actix_web::http::header::AUTHORIZATION);
@@ -30,4 +36,39 @@ pub fn refresh_token_cookie(refresh_token: String) -> Cookie<'static> {
         .path("/api")
         .max_age(Duration::days(30))
         .finish()
-} 
+}
+
+pub fn generate_access_token() -> Result<String, getrandom::Error> {
+    let mut buf = [0u8; 16];
+    fill(&mut buf)?;
+    Ok(encode(buf))
+}
+
+pub fn generate_refresh_token() -> Result<String, getrandom::Error> {
+    let mut buf = [0u8; 32];
+    fill(&mut buf)?;
+    Ok(encode(buf))
+}
+
+impl Data {
+    pub async fn set_cache_key(&self, key: String, value: impl Serialize, expire: u32) -> Result<(), RedisError> {
+        let mut conn = self.cache_pool.get_multiplexed_tokio_connection().await?;
+
+        let key_encoded = encode(key);
+
+        let value_json = serde_json::to_string(&value).unwrap();
+
+        redis::cmd("SET",).arg(&[key_encoded.clone(), value_json]).exec_async(&mut conn).await?;
+
+        redis::cmd("EXPIRE").arg(&[key_encoded, expire.to_string()]).exec_async(&mut conn).await
+    }
+
+    pub async fn get_cache_key(&self, key: String) -> Result<String, RedisError> {
+        let mut conn = self.cache_pool.get_multiplexed_tokio_connection().await?;
+
+        let key_encoded = encode(key);
+
+        redis::cmd("GET").arg(key_encoded).query_async(&mut conn).await
+    }
+}
+