fix(api): removed unused imports

Cargo.lock

@@ -476,13 +476,15 @@ checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd"
 
 [[package]]
 name = "chrono"
-version = "0.4.34"
+version = "0.4.35"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5bc015644b92d5890fab7489e49d21f879d5c990186827d42ec511919404f38b"
+checksum = "8eaf5903dcbc0a39312feb77df2ff4c76387d591b9fc7b04a238dcf8bb62639a"
 dependencies = [
  "android-tzdata",
  "iana-time-zone",
+ "js-sys",
  "num-traits",
+ "wasm-bindgen",
  "windows-targets 0.52.4",
 ]
 
@@ -1027,10 +1029,12 @@ dependencies = [
  "actix-web-httpauth",
  "anyhow",
  "argon2",
+ "chrono",
  "compile-time-run",
  "dotenvy",
  "env_logger",
  "log",
+ "rand",
  "serde",
  "sqlx",
  "thiserror",

Cargo.toml

@@ -9,14 +9,16 @@ license = "MIT"
 
 [dependencies]
 anyhow = "1.0.81"
-log = "0.4.21"
-env_logger = "0.11.3"
-dotenvy = "0.15.7"
-compile-time-run = "0.2.12"
-uuid = { version = "1.7.0", features = ["v4"] }
-thiserror = "1.0.58"
 argon2 = "0.5.3"
+chrono = "0.4.35"
+compile-time-run = "0.2.12"
+dotenvy = "0.15.7"
+env_logger = "0.11.3"
+log = "0.4.21"
+rand = "0.8.5"
 serde = { version = "1.0.197", features = ["default"] }
+thiserror = "1.0.58"
+uuid = { version = "1.7.0", features = ["v4"] }
 
 actix-web = "4.5.1"
 actix-web-httpauth = "0.8.1"

docs/api.md

@@ -0,0 +1,16 @@
+# ICRC API
+
+## Endpoint overview
+
+- /account
+    - [X] `POST` /register
+    - [ ] `POST` /auth
+    - [ ] `POST` /delete
+    - [ ] `GET`  /blob
+    - [ ] `POST` /blob
+    - /invite
+        - [X] `POST` new
+- /relay
+    - [ ] `POST` /create
+    - [ ] `POST` /join
+    - [ ] `POST` /leave

docs/concepts.md

@@ -0,0 +1,20 @@
+# ICRC - Concepts
+
+## Client
+
+A user or bot. Or to be more precise: the program something uses to communicate with the icrc server.
+
+## Relay
+
+A relay is like a group chat. Clients that are part of a relay have the key to it. The server proofs if a client has
+access to a relay by hashing the clients key to that relay and comparing it with a saved hash.
+
+### User index
+
+Every relay has their own user index, which has the following columns:
+
+- **userid_relay**: The id that other users use to identify a user in this relay.
+- **userid_main**: The users "real" id. (The id they use to authenticate.)
+- **name**: The users nickname in this relay.
+- **public_key**: The public key to exchange symmetric encryption keys with that user.
+

src/api/endpoints/account/invite.rs

@@ -0,0 +1,26 @@
+use crate::backend::Backend;
+use actix_web::{post, web, HttpResponse, Responder};
+use actix_web_httpauth::extractors::bearer::BearerAuth;
+use log::error;
+use serde::Serialize;
+
+#[derive(Debug, Serialize)]
+struct NewResponse {
+    token: String,
+}
+
+#[post("/account/invite/new")]
+pub async fn new(backend: web::Data<Backend>, auth: BearerAuth) -> impl Responder {
+    match backend.create_invite(auth.token()).await {
+        Err(e) => {
+            error!("{e}");
+            HttpResponse::InternalServerError().finish()
+        }
+        Ok(res) => match res {
+            Err(e) => e.into(),
+            Ok(uuid) => HttpResponse::Ok().json(NewResponse {
+                token: uuid.to_string(),
+            }),
+        },
+    }
+}

src/api/endpoints/account/mod.rs

@@ -1,23 +1,25 @@
-use crate::backend::{error::AccountRegisterError, Backend};
+pub mod invite;
+
+use crate::backend::Backend;
 use actix_web::{post, web, HttpResponse, Responder};
 use log::error;
 use serde::{Deserialize, Serialize};
 
 #[derive(Debug, Deserialize)]
-struct AccountRegisterRequest {
+struct RegisterRequest {
     token: String,
     password: String,
 }
 
 #[derive(Debug, Serialize)]
-struct AccountRegisterResponse {
+struct RegisterResponse {
     uuid: String,
 }
 
 #[post("/account/register")]
-pub async fn account_register(
+pub async fn register(
     backend: web::Data<Backend>,
-    body: web::Json<AccountRegisterRequest>,
+    body: web::Json<RegisterRequest>,
 ) -> impl Responder {
     let body = body.into_inner();
     match backend.account_register(body.token, body.password).await {
@@ -26,14 +28,8 @@ pub async fn account_register(
             HttpResponse::InternalServerError().finish()
         }
         Ok(res) => match res {
-            Err(e) => match e {
+            Err(e) => e.into(),
-                AccountRegisterError::InvalidToken => HttpResponse::Unauthorized().finish(),
+            Ok(uuid) => HttpResponse::Ok().json(RegisterResponse {
-                AccountRegisterError::SqlError(e) => {
-                    error!("{e}");
-                    HttpResponse::InternalServerError().finish()
-                }
-            },
-            Ok(uuid) => HttpResponse::Ok().json(AccountRegisterResponse {
                 uuid: uuid.to_string(),
             }),
         },

src/api/endpoints/mod.rs

@@ -0,0 +1 @@
+pub mod account;

src/api/mod.rs

@@ -10,7 +10,8 @@ pub async fn start(config: &Config, backend: Backend) -> Result<()> {
     let server = HttpServer::new(move || {
         App::new()
             .app_data(web::Data::new(backend.clone()))
-            .service(endpoints::account_register)
+            .service(endpoints::account::register)
+            .service(endpoints::account::invite::new)
     })
     .bind((config.addr.as_str(), config.port))?;
 

src/backend/db_structures.rs

@@ -1,11 +1,18 @@
 use sqlx::types::chrono::NaiveDateTime;
 
-pub struct ActivationTokensRow {
+pub struct InviteTokensRow {
     pub token: String,
     pub expire: NaiveDateTime,
 }
 
+pub struct AuthTokensRow {
+    pub token: String,
+    pub userid: String,
+    pub expire: NaiveDateTime,
+}
+
 pub struct UsersRow {
     pub userid: String,
     pub password: String,
+    pub permissions: u16,
 }

src/backend/error.rs

@@ -1,10 +1,40 @@
+use actix_web::HttpResponse;
+use serde::Serialize;
 use thiserror::Error;
 
-#[derive(Debug, Error)]
+#[derive(Debug, Error, Serialize, Copy, Clone)]
-pub enum AccountRegisterError {
+pub enum Error {
     #[error("The given token is invalid")]
     InvalidToken,
 
-    #[error("SQL Error: {0}")]
+    #[error("The given token is expired")]
-    SqlError(sqlx::Error),
+    TokenExpired,
+
+    #[error("Permission denied: {0}")]
+    PermissionDenied(&'static str),
+
+    #[error("The given user cannot be found")]
+    UserNotFound,
+}
+
+#[derive(Serialize)]
+struct ErrorResponse {
+    error: Error,
+    description: String,
+}
+
+impl Into<HttpResponse> for Error {
+    fn into(self) -> HttpResponse {
+        let body = ErrorResponse {
+            error: self,
+            description: self.to_string(),
+        };
+
+        match self {
+            Error::InvalidToken => HttpResponse::Unauthorized().json(body),
+            Error::TokenExpired => HttpResponse::Gone().json(body),
+            Error::PermissionDenied(_) => HttpResponse::Forbidden().json(body),
+            Error::UserNotFound => HttpResponse::NotFound().json(body),
+        }
+    }
 }

src/backend/mod.rs

@@ -1,16 +1,22 @@
 mod db_structures;
 pub mod error;
+mod permissions;
+mod user;
 
-use crate::backend::error::AccountRegisterError;
+use crate::backend::{error::Error, permissions::Permission, user::IntoUser};
 use crate::config::Config;
 use anyhow::Result;
 use argon2::{
     password_hash::{rand_core::OsRng, PasswordHasher, SaltString},
     Argon2,
 };
-use db_structures::{ActivationTokensRow, UsersRow};
+use chrono::Days;
+use db_structures::{AuthTokensRow, InviteTokensRow, UsersRow};
 use log::info;
+use rand::distributions::DistString;
 use sqlx::{types::chrono::Utc, MySqlPool};
+use std::str::FromStr;
+use user::User;
 use uuid::Uuid;
 
 #[derive(Debug, Clone)]
@@ -24,8 +30,9 @@ impl Backend {
 
         sqlx::query!(
             r#"CREATE TABLE IF NOT EXISTS Users (
-            userid      UUID            NOT NULL    PRIMARY KEY,
+            userid          UUID                NOT NULL    PRIMARY KEY,
-            password    VARCHAR(128)    NOT NULL
+            password        VARCHAR(128)        NOT NULL,
+            permissions     SMALLINT UNSIGNED   NOT NULL
         );"#
         )
         .execute(&pool)
@@ -41,7 +48,7 @@ impl Backend {
         .await?;
 
         sqlx::query!(
-            r#"CREATE TABLE IF NOT EXISTS ActivationTokens (
+            r#"CREATE TABLE IF NOT EXISTS InviteTokens (
             token       CHAR(48)    NOT NULL    PRIMARY KEY,
             expire      DATETIME    NOT NULL
         );"#
@@ -53,7 +60,7 @@ impl Backend {
             r#"CREATE TABLE IF NOT EXISTS AuthTokens (
             token       CHAR(48)    NOT NULL    PRIMARY KEY,
             userid      UUID        NOT NULL,
-            exipre      DATETIME    NOT NULL
+            expire      DATETIME    NOT NULL
         );"#
         )
         .execute(&pool)
@@ -64,33 +71,62 @@ impl Backend {
         Ok(Self { pool })
     }
 
-    async fn check_activation_token(&self, token: &str) -> Result<bool, sqlx::Error> {
+    /// Returns the UUID of the user who owns the auth token.
+    pub async fn resolve_auth_token(&self, token: &str) -> Result<Result<Uuid, Error>> {
         match sqlx::query_as!(
-            ActivationTokensRow,
+            AuthTokensRow,
-            r#"SELECT * FROM ActivationTokens WHERE token = ?;"#,
+            r#"SELECT * FROM AuthTokens WHERE token = ?;"#,
             token
         )
         .fetch_one(&self.pool)
         .await
         {
             Err(e) => match e {
-                sqlx::Error::RowNotFound => Ok(false),
+                sqlx::Error::RowNotFound => Ok(Err(Error::InvalidToken)),
-                _ => Err(e),
+                _ => Err(e.into()),
             },
             Ok(row) => {
-                sqlx::query!(r#"DELETE FROM ActivationTokens WHERE token = ?;"#, token)
-                    .execute(&self.pool)
-                    .await?;
                 if row.expire > Utc::now().naive_utc() {
-                    Ok(true)
+                    Ok(Ok(Uuid::from_str(&row.userid)?))
                 } else {
-                    Ok(false)
+                    sqlx::query!(r#"DELETE FROM AuthTokens WHERE token = ?;"#, token)
+                        .execute(&self.pool)
+                        .await?;
+                    Ok(Err(Error::TokenExpired))
                 }
             }
         }
     }
 
-    async fn get_user(&self, userid: Uuid) -> Result<Option<()>, sqlx::Error> {
+    /// Check whether an invite-token is valid or not.
+    async fn check_activation_token(&self, token: &str) -> Result<Result<(), Error>> {
+        match sqlx::query_as!(
+            InviteTokensRow,
+            r#"SELECT * FROM InviteTokens WHERE token = ?;"#,
+            token
+        )
+        .fetch_one(&self.pool)
+        .await
+        {
+            Err(e) => match e {
+                sqlx::Error::RowNotFound => Ok(Err(Error::InvalidToken)),
+                _ => Err(e.into()),
+            },
+            Ok(row) => {
+                sqlx::query!(r#"DELETE FROM InviteTokens WHERE token = ?;"#, token)
+                    .execute(&self.pool)
+                    .await?;
+                if row.expire > Utc::now().naive_utc() {
+                    Ok(Ok(()))
+                } else {
+                    Ok(Err(Error::TokenExpired))
+                }
+            }
+        }
+    }
+
+    /// Returns detailed information about the user identified by the UUID.
+    async fn get_user(&self, userid: Uuid) -> Result<Result<User, Error>> {
         match sqlx::query_as!(
             UsersRow,
             r#"SELECT * FROM Users WHERE userid = ?;"#,
@@ -100,20 +136,21 @@ impl Backend {
         .await
         {
             Err(e) => match e {
-                sqlx::Error::RowNotFound => Ok(None),
+                sqlx::Error::RowNotFound => Ok(Err(Error::UserNotFound)),
-                _ => Err(e),
+                _ => Err(e.into()),
             },
-            Ok(_row) => Ok(Some(())),
+            Ok(row) => Ok(Ok(row.try_into()?)),
         }
     }
 
+    /// Creates a new account and returns its UUID.
     pub async fn account_register(
         &self,
         token: String,
         password: String,
-    ) -> Result<Result<Uuid, error::AccountRegisterError>> {
+    ) -> Result<Result<Uuid, Error>> {
-        if !self.check_activation_token(&token).await? {
+        if let Err(e) = self.check_activation_token(&token).await? {
-            return Ok(Err(AccountRegisterError::InvalidToken));
+            return Ok(Err(e));
         }
 
         let salt = SaltString::generate(&mut OsRng);
@@ -126,7 +163,7 @@ impl Backend {
         let userid = Uuid::new_v4();
 
         sqlx::query!(
-            r#"INSERT INTO Users VALUES (?, ?);"#,
+            r#"INSERT INTO Users VALUES (?, ?, 0);"#,
             userid.as_bytes().as_slice(),
             hash
         )
@@ -135,4 +172,31 @@ impl Backend {
 
         Ok(Ok(userid))
     }
+
+    /// Generates a new invite token, if the user identified by the UUID has the permission to do so.
+    pub async fn create_invite(&self, user: impl IntoUser) -> Result<Result<String, Error>> {
+        let user = match user.into_user(&self).await? {
+            Ok(user) => user,
+            Err(e) => return Ok(Err(e)),
+        };
+
+        if !user.has_permission(Permission::GenerateInviteTokens) {
+            return Ok(Err(Error::PermissionDenied(
+                "This user is not authorized to generate invite codes",
+            )));
+        }
+
+        let token = rand::distributions::Alphanumeric.sample_string(&mut OsRng, 48);
+
+        // TODO: change days to 7
+        sqlx::query!(
+            r#"INSERT INTO InviteTokens VALUES (?, ?);"#,
+            token,
+            Utc::now().naive_utc().checked_add_days(Days::new(14))
+        )
+        .execute(&self.pool)
+        .await?;
+
+        Ok(Ok(token))
+    }
 }

src/backend/permissions.rs

@@ -0,0 +1,13 @@
+pub enum Permission {
+    GenerateInviteTokens,
+    PromoteUsers,
+}
+
+impl Permission {
+    pub fn as_u16(&self) -> u16 {
+        match self {
+            Permission::GenerateInviteTokens => 1,
+            Permission::PromoteUsers => 1 << 1,
+        }
+    }
+}

src/backend/user.rs

@@ -0,0 +1,67 @@
+use crate::backend::db_structures::UsersRow;
+use crate::backend::error::Error;
+use crate::backend::{permissions::Permission, Backend};
+use anyhow::Result;
+use std::str::FromStr;
+use uuid::Uuid;
+
+pub struct User {
+    uuid: Uuid,
+    password: String,
+    permissions: u16,
+}
+
+impl TryFrom<UsersRow> for User {
+    type Error = anyhow::Error;
+    fn try_from(value: UsersRow) -> std::result::Result<Self, Self::Error> {
+        Ok(Self {
+            uuid: Uuid::from_str(value.userid.as_str())?,
+            password: value.password,
+            permissions: value.permissions,
+        })
+    }
+}
+
+impl User {
+    pub fn has_permission(&self, permission: Permission) -> bool {
+        (self.permissions & permission.as_u16()) > 0
+    }
+
+    async fn flush(&self, backend: &Backend) -> Result<()> {
+        sqlx::query!(
+            r#"UPDATE Users SET password = ?, permissions = ? WHERE userid = ?;"#,
+            self.password,
+            self.permissions,
+            self.uuid.as_bytes().as_slice()
+        )
+        .execute(&backend.pool)
+        .await?;
+        Ok(())
+    }
+}
+
+pub trait IntoUser {
+    async fn into_user(self, backend: &Backend) -> Result<Result<User, Error>>;
+}
+
+impl IntoUser for Uuid {
+    async fn into_user(self, backend: &Backend) -> Result<Result<User, Error>> {
+        backend.get_user(self).await
+    }
+}
+
+impl IntoUser for &str {
+    async fn into_user(self, backend: &Backend) -> Result<Result<User, Error>> {
+        let userid = match backend.resolve_auth_token(self).await? {
+            Ok(userid) => userid,
+            Err(e) => return Ok(Err(e)),
+        };
+        userid.into_user(backend).await
+    }
+}
+
+impl IntoUser for User {
+    async fn into_user(self, _backend: &Backend) -> Result<Result<User, Error>> {
+        Ok(Ok(self))
+    }
+}