tsk-61: Updating readme

Closes #55

Reviewed-on: #72
Co-authored-by: phoenix <kundeng00@pm.me>
Co-committed-by: phoenix <kundeng00@pm.me>

.env.docker.sample

@@ -10,3 +10,4 @@ POSTGRES_AUTH_PASSWORD=password
 POSTGRES_AUTH_DB=icarus_auth_db
 POSTGRES_AUTH_HOST=auth_db
 DATABASE_URL=postgresql://${POSTGRES_AUTH_USER}:${POSTGRES_AUTH_PASSWORD}@${POSTGRES_AUTH_HOST}:5432/${POSTGRES_AUTH_DB}
+ENABLE_REGISTRATION=TRUE

.env.local.sample

@@ -10,3 +10,4 @@ POSTGRES_AUTH_PASSWORD=password
 POSTGRES_AUTH_DB=icarus_auth_test_db
 POSTGRES_AUTH_HOST=localhost
 DATABASE_URL=postgresql://${POSTGRES_AUTH_USER}:${POSTGRES_AUTH_PASSWORD}@${POSTGRES_AUTH_HOST}:5432/${POSTGRES_AUTH_DB}
+ENABLE_REGISTRATION=TRUE

Cargo.lock

@@ -748,7 +748,7 @@ dependencies = [
 
 [[package]]
 name = "icarus_auth"
-version = "0.6.1"
+version = "0.6.2"
 dependencies = [
  "argon2",
  "axum",

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "icarus_auth"
-version = "0.6.1"
+version = "0.6.2"
 edition = "2024"
 rust-version = "1.90"
 

README.md

@@ -8,22 +8,26 @@ need to be modified. The `SECRET_KEY` variable should be changed since it will b
 generation. The `SECRET_PASSPHASE` should also be changed when in production mode, but make sure
 the respective `passphrase` database table record exists.
 
-Build image
+To enable or disable registrations, use `TRUE` or `FALSE` for the `ENABLE_REGISTRATION` variable.
+By default it is `TRUE`.
+
+
+### Build image
 ```
 docker compose build
 ```
 
-Start images
+### Start images
 ```
 docker compose up -d --force-recreate
 ```
 
-Bring it down
+### Bring it down
 ```
 docker compose down -v
 ```
 
-Pruning
+### Pruning
 ```
 docker system prune -a
 ```

src/callers/register.rs

@@ -52,8 +52,8 @@ pub async fn register_user(
     axum::Extension(pool): axum::Extension<sqlx::PgPool>,
     Json(payload): Json<request::Request>,
 ) -> (StatusCode, Json<response::Response>) {
+    if is_registration_enabled() {
         let mut user = icarus_models::user::User {
-        id: uuid::Uuid::nil(),
             username: payload.username.clone(),
             password: payload.password.clone(),
             email: payload.email.clone(),
@@ -62,19 +62,17 @@ pub async fn register_user(
             lastname: payload.lastname.clone(),
             status: String::from("Active"),
             email_verified: true,
-        date_created: Some(time::OffsetDateTime::now_utc()),
+            ..Default::default()
-        last_login: None,
-        salt_id: uuid::Uuid::nil(),
         };
 
         match repo::user::exists(&pool, &user.username).await {
             Ok(res) => {
                 if res {
                     (
-                    StatusCode::NOT_FOUND,
+                        StatusCode::BAD_REQUEST,
                         Json(response::Response {
                             message: String::from("Error"),
-                        data: vec![user],
+                            data: Vec::new(),
                         }),
                     )
                 } else {
@@ -89,8 +87,9 @@ pub async fn register_user(
                     user.password = hashed_password;
 
                     match repo::user::insert(&pool, &user).await {
-                    Ok(id) => {
+                        Ok((id, date_created)) => {
                             user.id = id;
+                            user.date_created = date_created;
                             (
                                 StatusCode::CREATED,
                                 Json(response::Response {
@@ -117,4 +116,10 @@ pub async fn register_user(
                 }),
             ),
         }
+    } else {
+        (axum::http::StatusCode::NOT_ACCEPTABLE, Json(response::Response{
+            message: String::from("Registration is not enabled"),
+            data:: Vec::new()
+        }))
+    }
 }

src/repo/mod.rs

@@ -94,7 +94,7 @@ pub mod user {
     pub async fn insert(
         pool: &sqlx::PgPool,
         user: &icarus_models::user::User,
-    ) -> Result<uuid::Uuid, sqlx::Error> {
+    ) -> Result<(uuid::Uuid, std::option::Option<time::OffsetDateTime>), sqlx::Error> {
         let row = sqlx::query(
             r#"
                 INSERT INTO "user" (username, password, email, phone, firstname, lastname, email_verified, status, salt_id) 
@@ -124,10 +124,10 @@ pub mod user {
                 .map_err(|_e| sqlx::Error::RowNotFound)?,
         };
 
-        if !result.id.is_nil() {
+        if result.id.is_nil() && result.date_created.is_none() {
-            Ok(result.id)
-        } else {
             Err(sqlx::Error::RowNotFound)
+        } else {
+            Ok((result.id, result.date_created))
         }
     }
 }