Merge branch 'feat_user_avatar_public_asset'

.dockerignore

@@ -0,0 +1,7 @@
+target
+.env
+tmp
+Dockerfile
+.dockerignore
+justfile
+config.toml

Cargo.lock

@@ -879,6 +879,12 @@ version = "0.4.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "7f24254aa9a54b5c858eaee2f5bccdb46aaf0e486a595ed5fd8f86ba55232a70"
 
+[[package]]
+name = "hex-literal"
+version = "0.4.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6fe2267d4ed49bc07b63801559be28c718ea06c4738b7a03c94df7386d2cde46"
+
 [[package]]
 name = "hkdf"
 version = "0.12.4"
@@ -1256,9 +1262,11 @@ dependencies = [
  "dotenvy",
  "env_logger",
  "fully_pub",
+ "hex-literal",
  "log",
  "serde",
  "serde_json",
+ "sha2",
  "sqlx",
  "strum",
  "strum_macros",

Cargo.toml

@@ -1,9 +1,11 @@
-cargo-features = ["codegen-backend"]
+# cargo-features = ["codegen-backend"]
 
-[profile.dev]
-codegen-backend = "cranelift"
+# [profile.dev]
+# codegen-backend = "cranelift"
+# # END OF
 
 [workspace]
+resolver = "2"
 members = [
     "lib/kernel",
     "lib/utils",
@@ -21,12 +23,14 @@ strum_macros = "0.26"
 uuid = { version = "1.8", features = ["serde", "v4"] }
 dotenvy = "0.15.7"
 url = "2.5.3"
+sha2 = "0.10"
+hex-literal = "0.4"
 
 # CLI
 argh = "0.1"
 
 # Async
-tokio = { version = "1.40.0", features = ["rt-multi-thread"] }
+tokio = { version = "1.40.0", features = ["rt-multi-thread", "macros"] }
 
 # Logging
 log = "0.4"

Dockerfile

@@ -0,0 +1,37 @@
+FROM rust:1.83-alpine3.20 AS builder
+
+WORKDIR /usr/src/minauthator
+COPY . .
+
+RUN apk add musl-dev
+
+RUN cargo install --bin minauthator-admin --locked --path lib/admin_cli
+RUN cargo install --bin minauthator-server --locked --path lib/http_server
+
+FROM alpine:3.20 AS base
+
+RUN apk add sqlite
+COPY --from=builder /usr/local/cargo/bin/minauthator-server /usr/local/bin/minauthator-server
+COPY --from=builder /usr/local/cargo/bin/minauthator-admin /usr/local/bin/minauthator-admin
+RUN mkdir -p \
+    /usr/local/src/minauthator/migrations \
+    /usr/local/lib/minauthator/assets \
+    /var/lib/minauthator \
+    /etc/minauthator
+COPY --from=builder /usr/src/minauthator/migrations/all.sql /usr/local/src/minauthator/migrations
+COPY --from=builder /usr/src/minauthator/init_db.sh /usr/local/bin/minauthator_init_db.sh
+COPY --from=builder /usr/src/minauthator/assets /usr/local/lib/minauthator/assets
+
+RUN addgroup -g 1000 app && \
+    adduser -S -u 1000 -G app -s /bin/sh app && \
+    chown -R app:app /var/lib/minauthator && \
+    chmod -R u=rwx,g=rwx,o= /var/lib/minauthator
+
+USER app:app
+ENV RUST_LOG=info
+ENV RUST_BACKTRACE=1
+ENV APP_JWT_SECRET="DummyAppSecret20241029"
+
+CMD ["minauthator-server", "--listen-host", "0.0.0.0", "--listen-port", "8080"]
+
+

README.md

@@ -1,24 +1,45 @@
 # Minauthator
 
-Minauthator is an identity provider supporting [OpenID Connect (OIDC)](https://en.wikipedia.org/wiki/OpenID_Connect).
+Minauthator is an identity provider server supporting [OpenID Connect (OIDC)](https://en.wikipedia.org/wiki/OpenID_Connect).
 
-This project aims to allow an organization to setup [single sign-on (SSO)](https://en.wikipedia.org/wiki/Single_sign-on) using a self-hosted free software.
+This project aims to allow an organization to setup [single sign-on (SSO)](https://en.wikipedia.org/wiki/Single_sign-on) using a self-hosted free software (FOSS).
+
+This project also aims to provide features while being frugal and minimalist.
 
 **Project status: *early development, work-in-progress***
 
 ## Features
 
-- Login
-- Register
-- OpenID Connect & OAuth 2.0
-- Activation token
-- Profile details
-- Static apps
-- User roles
-- MFA/TOTP
-- Email notifications
-- Login page customization
-- App carousel (App presentation to users)
+- [x] Login
+- [x] Register
+- [x] OpenID Connect & OAuth 2.0
+- [x] Activation token
+- [x] Profile details
+- [x] Static apps
+- [x] Admin CLI to manage user.
+- [x] User invitation with human token
+- [ ] User roles
+- [ ] User groups
+- [ ] MFA/TOTP
+- [ ] Email notifications
+- [ ] Login page customization
+- [x] App listing (App presentation to users)
+- [x] Implicit OAuth 2.0 flow
+- [ ] Email verification
+- [ ] GPG keys verification and signing
+- [ ] Docker deployment
+- [ ] Full user panel & user privacy control
+
+## Architecture
+
+- Sqlite DB
+- Kernel
+- Http server
+    - Public API
+    - User API
+    - Third-party OAuth2 app/client API
+    - Web GUI (no Javascript)
+- Admin CLI
 
 ## Deps
 
@@ -28,4 +49,4 @@ This project aims to allow an organization to setup [single sign-on (SSO)](https
 
 - [Authentik](https://goauthentik.io/)
 - [Keycloak](https://www.keycloak.org/)
-
+- [Kanidm](https://kanidm.com/)

TODO.md

@@ -1,5 +1,23 @@
 # TODO
 
+- [ ] i18n strings in the http website.
+
+- [ ] Instance customization support
+
+- [ ] Public endpoint to get user avatar by id
+- [ ] Rework avatar upload to limit size and process the image?
+
+- Authorize form
+    - [ ] Show details about permissions
+    - [ ] Show app logo
+
+- [ ] Support error responses by https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.2.1
+
+- [ ] feat(perms): add groups and roles
+
+- [ ] UserWebGUI: add TOTP
+- [ ] send emails to users
+
 - [x] Login form
 - [x] Register form
 - [x] Redirect to login form if unauthenticated
@@ -13,20 +31,12 @@
 - [x] Support OpenID to use with demo client [oauth2c](https://github.com/cloudentity/oauth2c)
     - .well-known/openid-configuration
 
+- [x] architecture refactor
+- [x] AdminCLI: init
+- [x] AdminCLI: list users
+- [x] AdminCLI: create and invite user
 
-- [ ] i18n strings in the http website.
-
-- [ ] App config
-    - Add app logo (URI?)
-
-- [ ] Public endpoint to get user avatar by id
-- [ ] Rework avatar upload to limit size and process the image?
-
-- [ ] Authorize form
-    - Show details about permissions
-    - Show app logo
-
-- [ ] Support error responses by https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.2.1
+- [x] UserWebGUI: Invitation
 
 - [x] UserWebGUI: Redirect to login when JWT expire
 - [x] UserWebGUI: Show user authorizations.
@@ -37,14 +47,6 @@
 
 - [x] UserWebGUI: activate account with token
 
-- [ ] feat(perms): add groups and roles
-
-- [ ] UserWebGUI: add TOTP
-- [ ] send emails to users
-
-- Architecture: do we have an admin API?
-
-- [ ] AdminCLI: init
-- [ ] AdminWebGUI: List users
-- [ ] AdminWebGUI: Assign groups to users
-- [ ] AdminWebGUI: Create invitation
+- [X] basic docker setup
+- [ ] make `docker stop` working (handle SIGTERM/SIGINT)
+- [ ] implement docker secrets. https://docs.docker.com/engine/swarm/secrets/

init_db.sh

@@ -0,0 +1,10 @@
+#!/bin/sh
+
+DEFAULT_DB_PATH="/var/lib/minauthator/minauthator.db"
+DEFAULT_MIGRATION_PATH="/usr/local/src/minauthator/migrations/all.sql"
+
+DB_PATH="${DB_PATH:-$DEFAULT_DB_PATH}"
+MIGRATION_PATH="${MIGRATION_PATH:-$DEFAULT_MIGRATION_PATH}"
+
+sqlite3 $DB_PATH < $MIGRATION_PATH
+

justfile

@@ -1,6 +1,6 @@
 export RUST_BACKTRACE := "1"
 export RUST_LOG := "trace"
-export CONTEXT_ARGS := "--config ./config.toml --database ./tmp/dbs/minauthator.db --static-assets ./assets"
+export CONTEXT_ARGS := "--config config.toml --database tmp/dbs/minauthator.db --static-assets ./assets"
 
 watch-server:
     cargo-watch -x "run --bin minauthator-server -- $CONTEXT_ARGS"
@@ -11,14 +11,22 @@ server:
 admin:
     cargo run --bin minauthator-admin -- $CONTEXT_ARGS
 
-docker-run:
-    docker run -p 3085:8080 -v ./tmp/docker/config:/etc/minauthator -v ./tmp/docker/db:/var/lib/minauthator minauthator
+docker-build:
+    docker build -t lefuturiste/minauthator .
 
 docker-init-db:
-    docker run -v ./tmp/docker/config:/etc/minauthator -v ./tmp/docker/db:/var/lib/minauthator minauthator /usr/local/bin/minauthator_init_db.sh
+    docker run \
+        -v ./tmp/docker/config:/etc/minauthator \
+        -v minauthator-db:/var/lib/minauthator \
+        lefuturiste/minauthator \
+        /usr/local/bin/minauthator_init_db.sh
 
-docker-build:
-    docker build -t minauthator .
+docker-run:
+    docker run \
+        -p 127.0.0.1:3085:8080 \
+        -v ./tmp/docker/config:/etc/minauthator \
+        -v minauthator-db:/var/lib/minauthator \
+        lefuturiste/minauthator
 
 init-db:
     sqlite3 -echo tmp/dbs/minauthator.db < migrations/all.sql

lib/http_server/src/controllers/api/mod.rs

@@ -2,3 +2,4 @@ pub mod index;
 pub mod oauth2;
 pub mod read_user;
 pub mod openid;
+pub mod public_assets;

lib/http_server/src/controllers/api/public_assets.rs

@@ -0,0 +1,27 @@
+use axum::{extract::{Path, State}, http::{header, HeaderMap, HeaderValue, StatusCode}, response::{Html, IntoResponse}};
+use kernel::repositories::users::get_user_asset_by_id;
+
+use crate::AppState;
+
+pub async fn get_user_asset(
+    State(app_state): State<AppState>,
+    Path(asset_id): Path<String>
+) -> impl IntoResponse {
+    let user_asset = match get_user_asset_by_id(&app_state.db, &asset_id).await {
+        Err(_) => {
+            return (
+                StatusCode::NOT_FOUND,
+                Html("Could not find user asset")
+            ).into_response();
+        },
+        Ok(ua) => ua
+    };
+
+    let mut hm = HeaderMap::new();
+    hm.insert(
+        header::CONTENT_TYPE,
+        HeaderValue::from_str(&user_asset.mime_type).expect("Constructing header value.")
+    );
+    
+    (hm, user_asset.content).into_response()
+}

lib/http_server/src/controllers/ui/me.rs

@@ -1,7 +1,8 @@
+use anyhow::Context;
 use axum::{body::Bytes, extract::State, response::IntoResponse, Extension};
 use axum_typed_multipart::{FieldData, TryFromMultipart, TypedMultipart};
 use fully_pub::fully_pub;
-use log::error;
+use log::{error, info};
 use minijinja::context;
 
 use crate::{
@@ -9,7 +10,7 @@ use crate::{
     renderer::TemplateRenderer,
     AppState
 };
-use kernel::models::user::User;
+use kernel::{models::{user::User, user_asset::UserAsset}, repositories::users::create_user_asset};
 
 pub async fn me_page(
     State(app_state): State<AppState>,
@@ -61,7 +62,7 @@ struct UserDetailsUpdateForm {
     website: String,
 
     #[form_data(limit = "5MiB")]
-    picture: FieldData<Bytes>
+    avatar: FieldData<Bytes>
 }
 
 
@@ -73,17 +74,41 @@ pub async fn me_perform_update_details(
 ) -> impl IntoResponse {
     let template_path = "pages/me/details-form";
 
-    let update_res = sqlx::query("UPDATE users SET handle = $2, email = $3, full_name = $4, website = $5, picture = $6 WHERE id = $1")
+    let user = sqlx::query_as::<_, User>("SELECT * FROM users WHERE id = $1")
+        .bind(&token_claims.sub)
+        .fetch_one(&app_state.db.0)
+        .await
+        .expect("To get user from claim");
+
+    let update_res = sqlx::query("UPDATE users SET handle = $2, email = $3, full_name = $4, website = $5 WHERE id = $1")
         .bind(&token_claims.sub)
         .bind(details_update.handle)
         .bind(details_update.email)
         .bind(details_update.full_name)
         .bind(details_update.website)
-        .bind(details_update.picture.contents.to_vec())
         .execute(&app_state.db.0)
         .await;
 
-    let user_res = sqlx::query_as::<_, User>("SELECT * FROM users WHERE id = $1")
+    if !details_update.avatar.contents.is_empty() {
+        let user_asset = UserAsset::new(
+            &user,
+            details_update.avatar.contents.to_vec(),
+            details_update.avatar.metadata.content_type.expect("Expected mimetype on avatar content"),
+            details_update.avatar.metadata.name
+        );
+        let _update_res = sqlx::query("UPDATE users SET avatar_asset_id = $2 WHERE id = $1")
+            .bind(&token_claims.sub)
+            .bind(user_asset.id.clone())
+            .execute(&app_state.db.0)
+            .await;
+        // TODO: handle possible error
+        let _ = create_user_asset(&app_state.db, user_asset)
+            .await
+            .context("Creating user avatar asset.");
+        info!("Uploaded new avatar as user asset");
+    }
+
+    let user = sqlx::query_as::<_, User>("SELECT * FROM users WHERE id = $1")
         .bind(&token_claims.sub)
         .fetch_one(&app_state.db.0)
         .await
@@ -95,7 +120,7 @@ pub async fn me_perform_update_details(
                 template_path,
                 context!(
                     success => true,
-                    user => user_res
+                    user => user
                 )
             )
         },
@@ -105,7 +130,7 @@ pub async fn me_perform_update_details(
                 template_path,
                 context!(
                     error => Some("Cannot update user details.".to_string()),
-                    user => user_res
+                    user => user
                 )
             )
         }

lib/http_server/src/controllers/ui/register.rs

@@ -46,7 +46,7 @@ pub async fn perform_register(
         email: Some(register.email),
         handle: register.handle,
         full_name: None,
-        picture: None,
+        avatar_asset_id: None,
 
         password_hash,
         status: UserStatus::Active,

lib/http_server/src/router.rs

@@ -47,7 +47,8 @@ pub fn build_router(server_config: &ServerConfig, app_state: AppState) -> Router
     let api_user_routes = Router::new()
         .route("/api/user", get(api::read_user::read_user_basic))
         .layer(middleware::from_fn_with_state(app_state.clone(), app_auth::enforce_jwt_auth_middleware))
-        .route("/api", get(api::index::get_index));
+        .route("/api", get(api::index::get_index))
+        .route("/api/user-assets/:asset_id", get(api::public_assets::get_user_asset));
 
     let well_known_routes = Router::new()
         .route("/.well-known/openid-configuration", get(api::openid::well_known::get_well_known_openid_configuration));

lib/http_server/src/templates/pages/me/details-form.html

@@ -55,10 +55,9 @@
         />
     </div>
     <div class="mb-3">
-        <label for="picture">Profile picture</label>
-        <!-- for now, no JPEG -->
+        <label for="avatar">Profile picture</label>
         <input
-            id="picture" name="picture"
+            id="avatar" name="avatar"
             type="file"
             accept="image/gif, image/png, image/jpeg"
             class="form-control"

lib/http_server/src/templates/pages/me/index.html

@@ -5,9 +5,12 @@
 <a href="/me/details-form">Update details.</a>
 <a href="/me/authorizations">Manage authorizations.</a>
 
-<p>
-{% if user.picture %}
-    <img src="data:image/*;base64,{{ encode_b64str(user.picture) }}" style="width: 150px; height: 150px; object-fit: contain">
+{% if user.avatar_asset_id %}
+<div class="my-3">
+    <img
+        src="http://localhost:8085/api/user-assets/{{ user.avatar_asset_id }}"
+        style="width: 150px; height: 150px; object-fit: contain">
+</div>
 {% endif %}
 <ul>
     <li>

lib/kernel/Cargo.toml

@@ -18,6 +18,8 @@ chrono = { workspace = true }
 toml = { workspace = true }
 sqlx = { workspace = true }
 dotenvy = { workspace = true }
+sha2 = { workspace = true }
+hex-literal = { workspace = true }
 
 uuid = { workspace = true }
 url = { workspace = true }

lib/kernel/src/consts.rs

@@ -1,4 +1,4 @@
 pub const DEFAULT_DB_PATH: &str = "/var/lib/minauthator/minauthator.db";
 pub const DEFAULT_ASSETS_PATH: &str = "/usr/local/lib/minauthator/assets";
-pub const DEFAULT_CONFIG_PATH: &str = "/etc/minauthator/config.yaml";
+pub const DEFAULT_CONFIG_PATH: &str = "/etc/minauthator/config.toml";
 

lib/kernel/src/context.rs

@@ -50,9 +50,10 @@ pub async fn get_kernel_context(start_config: StartKernelConfig) -> Result<Kerne
     let config: Config = get_config(config_path)
         .expect("Cannot get config.");
 
-    dotenvy::dotenv().context("loading .env")?;
+    let _ = dotenvy::dotenv();
     let secrets = AppSecrets {
-        jwt_secret: env::var("APP_JWT_SECRET").context("Expecting APP_JWT_SECRET env var.")?
+        jwt_secret: env::var("APP_JWT_SECRET")
+            .context("Expected APP_JWT_SECRET environment variable to exists.")?
     };
 
     Ok(KernelContext {

lib/kernel/src/models/mod.rs

@@ -1,3 +1,4 @@
 pub mod config;
 pub mod user;
+pub mod user_asset;
 pub mod authorization;

lib/kernel/src/models/user.rs

@@ -23,7 +23,7 @@ struct User {
     full_name: Option<String>,
     email: Option<String>,
     website: Option<String>,
-    picture: Option<Vec<u8>>, // embeded blob to store profile pic
+    avatar_asset_id: Option<String>,
     password_hash: Option<String>, // argon2 password hash
     status: UserStatus,
     roles: Json<Vec<String>>,
@@ -43,7 +43,7 @@ impl User {
             full_name: None,
             email: None,
             website: None,
-            picture: None,
+            avatar_asset_id: None,
             password_hash: None,
             status: UserStatus::Disabled,
             roles: Json(Vec::new()),

lib/kernel/src/models/user_asset.rs

@@ -0,0 +1,41 @@
+use fully_pub::fully_pub;
+use chrono::{DateTime, Utc};
+use serde::{Deserialize, Serialize};
+use uuid::Uuid;
+use sha2::{Sha256, Digest};
+
+use super::user::User;
+
+
+#[derive(sqlx::FromRow, Deserialize, Serialize, Debug)]
+#[fully_pub]
+struct UserAsset {
+    /// uuid
+    id: String,
+    user_id: String,
+    mime_type: String,
+    fingerprint: String,
+    name: Option<String>,
+    content: Vec<u8>,
+    created_at: DateTime<Utc>
+}
+
+impl UserAsset {
+    pub fn new(
+        user: &User,
+        content: Vec<u8>,
+        mime_type: String,
+        name: Option<String>
+    ) -> UserAsset {
+        let digest = Sha256::digest(&content);
+        UserAsset {
+            id: Uuid::new_v4().to_string(),
+            user_id: user.id.clone(),
+            fingerprint: format!("{:x}", digest),
+            mime_type,
+            content,
+            name,
+            created_at: Utc::now()
+        }
+    }
+}

lib/kernel/src/repositories/users.rs

@@ -1,6 +1,6 @@
 // user repositories
 
-use crate::models::user::User;
+use crate::models::{user::User, user_asset::UserAsset};
 
 use super::storage::Storage;
 use anyhow::{Result, Context};
@@ -19,3 +19,30 @@ pub async fn get_users(storage: &Storage) -> Result<Vec<User>> {
         .await
         .context("To get users.")
 }
+
+pub async fn create_user_asset(storage: &Storage, asset: UserAsset) -> Result<()> {
+    sqlx::query("INSERT INTO user_assets
+        (id, user_id, mime_type, fingerprint, content, created_at)
+        VALUES ($1, $2, $3, $4, $5, $6)
+    ")
+        .bind(&asset.id)
+        .bind(&asset.user_id)
+        .bind(&asset.mime_type)
+        .bind(&asset.fingerprint)
+        .bind(&asset.content)
+        .bind(&asset.created_at)
+        .execute(&storage.0)
+        .await
+        .context("While inserting user asset.")?;
+            // .bind(details_update.avatar.contents.to_vec())
+    Ok(())
+}
+
+pub async fn get_user_asset_by_id(storage: &Storage, id: &str) -> Result<UserAsset> {
+    sqlx::query_as("SELECT * FROM user_assets WHERE id = $1")
+        .bind(id)
+        .fetch_one(&storage.0)
+        .await
+        .context("To get user asset by id.")
+}
+

migrations/all.sql

@@ -5,8 +5,8 @@ CREATE TABLE users (
     full_name            TEXT,
     email                TEXT UNIQUE,
     website              TEXT,
-    picture              BLOB,
     roles                TEXT NOT NULL, -- json array of user roles
+    avatar_asset_id      TEXT,
 
     status               TEXT CHECK(status IN ('Invited', 'Active', 'Disabled')) NOT NULL DEFAULT 'Disabled',
     password_hash        TEXT,
@@ -15,6 +15,17 @@ CREATE TABLE users (
     created_at           DATETIME NOT NULL
 );
 
+DROP TABLE IF EXISTS user_assets;
+CREATE TABLE user_assets (
+    id                   TEXT PRIMARY KEY,
+    user_id              TEXT NOT NULL,
+    mime_type            TEXT NOT NULL,
+    fingerprint          TEXT NOT NULL,
+    name                 TEXT, -- file name
+    content              BLOB NOT NULL,
+    created_at           DATETIME NOT NULL
+);
+
 DROP TABLE IF EXISTS authorizations;
 CREATE TABLE authorizations (
     id                  TEXT PRIMARY KEY,