/* * Author: Ruben Fiszel * Copyright: Windmill Labs, Inc 2022 * This file and its contents are licensed under the AGPLv3 License. * Please see the included NOTICE for copyright information and * LICENSE-AGPL for a copy of the license. */ use crate::db::ApiAuthed; use crate::{db::DB, utils::require_super_admin}; use axum::{ extract::{Extension, Path, Query}, routing::{delete, get, post}, Json, Router, }; use windmill_audit::audit_ee::audit_log; use windmill_audit::ActionKind; use windmill_common::worker::CLOUD_HOSTED; use windmill_common::{ auth::get_groups_for_user, error::{Error, JsonResult, Result}, utils::{not_found_if_none, paginate, Pagination}, }; use windmill_common::{db::UserDB, users::username_to_permissioned_as}; use serde::{Deserialize, Serialize}; use sqlx::{query_scalar, FromRow, Postgres, Transaction}; use windmill_git_sync::handle_deployment_metadata; pub fn workspaced_service() -> Router { Router::new() .route("/list", get(list_groups)) .route("/listnames", get(list_group_names)) .route("/create", post(create_group)) .route("/get/:name", get(get_group)) .route("/update/:name", post(update_group)) .route("/delete/:name", delete(delete_group)) .route("/adduser/:name", post(add_user)) .route("/removeuser/:name", post(remove_user)) .route("/is_owner", get(is_owner)) } pub fn global_service() -> Router { Router::new() .route("/list", get(list_igroups)) .route("/get/:name", get(get_igroup)) .route("/create", post(create_igroup)) .route("/update/:name", post(update_igroup)) .route("/delete/:name", delete(delete_igroup)) .route("/adduser/:name", post(add_user_igroup)) .route("/removeuser/:name", post(remove_user_igroup)) .route("/export", get(export_igroups)) .route("/overwrite", post(overwrite_igroups)) } #[derive(FromRow, Serialize, Deserialize)] pub struct Group { pub workspace_id: String, pub name: String, pub summary: Option, pub extra_perms: serde_json::Value, } #[derive(Deserialize)] pub struct NewGroup { pub name: String, pub summary: Option, } #[derive(Serialize)] pub struct GroupInfo { pub workspace_id: String, pub name: String, pub summary: Option, pub members: Vec, pub extra_perms: serde_json::Value, } #[derive(Deserialize)] pub struct EditGroup { pub summary: Option, } #[derive(Deserialize)] pub struct Username { pub username: String, } #[derive(Deserialize)] pub struct Email { pub email: String, } async fn list_groups( Extension(db): Extension, Path(w_id): Path, Query(pagination): Query, ) -> JsonResult> { let (per_page, offset) = paginate(pagination); let rows = sqlx::query_as!( Group, "SELECT * FROM group_ WHERE workspace_id = $1 ORDER BY name desc LIMIT $2 OFFSET $3", w_id, per_page as i64, offset as i64 ) .fetch_all(&db) .await?; Ok(Json(rows)) } #[derive(Deserialize)] struct QueryListGroup { pub only_member_of: Option, } async fn list_group_names( ApiAuthed { username, email, .. }: ApiAuthed, Extension(db): Extension, Query(QueryListGroup { only_member_of }): Query, Path(w_id): Path, ) -> JsonResult> { let rows = if !only_member_of.unwrap_or(false) { sqlx::query_scalar!( "SELECT name FROM group_ WHERE workspace_id = $1 UNION SELECT name FROM instance_group ORDER BY name desc", w_id ) .fetch_all(&db) .await? .into_iter() .filter_map(|x| x) .collect() } else { get_groups_for_user(&w_id, &username, &email, &db).await? }; Ok(Json(rows)) } async fn check_name_conflict<'c>( tx: &mut Transaction<'c, Postgres>, w_id: &str, name: &str, ) -> Result<()> { let exists = sqlx::query_scalar!( "SELECT EXISTS(SELECT 1 FROM group_ WHERE name = $1 AND workspace_id = $2)", name, w_id ) .fetch_one(&mut **tx) .await? .unwrap_or(false); if exists { return Err(windmill_common::error::Error::BadRequest(format!( "Group {} already exists", name ))); } return Ok(()); } pub async fn is_owner( ApiAuthed { username, is_admin, groups, .. }: ApiAuthed, Extension(db): Extension, Path((w_id, name)): Path<(String, String)>, ) -> JsonResult { if is_admin { Ok(Json(true)) } else { Ok(Json( require_is_owner(&name, &username, &groups, &w_id, &db) .await .is_ok(), )) } } pub async fn require_is_owner( group_name: &str, username: &str, groups: &Vec, w_id: &str, db: &DB, ) -> Result<()> { let is_owner = query_scalar!( "SELECT EXISTS(SELECT 1 FROM group_ WHERE (group_.extra_perms ->> CONCAT('u/', $1::text))::boolean AND name = $2 AND workspace_id = $4) OR exists( SELECT 1 FROM group_ g, jsonb_each_text(g.extra_perms) f WHERE $2 = g.name AND $4 = g.workspace_id AND SPLIT_PART(key, '/', 1) = 'g' AND key = ANY($3::text[]) AND value::boolean)", username, group_name, groups, w_id, ).fetch_one(db) .await? .unwrap_or(false); if !is_owner { Err(Error::BadRequest(format!( "{} is not an owner of {} and hence is not authorized to perform this operation", username, group_name ))) } else { Ok(()) } } async fn _check_nb_of_groups(db: &DB) -> Result<()> { let nb_groups = sqlx::query_scalar!("SELECT COUNT(*) FROM group_ WHERE name != 'all' AND name != 'error_handler' AND name != 'slack'",) .fetch_one(db) .await?; if nb_groups.unwrap_or(0) >= 3 { return Err(Error::BadRequest( "You have reached the maximum number of groups (3 outside of native groups 'all', 'slack' and 'error_handler') without an enterprise license" .to_string(), )); } return Ok(()); } async fn create_group( authed: ApiAuthed, Extension(_db): Extension, Extension(user_db): Extension, Path(w_id): Path, Json(ng): Json, ) -> Result { let mut tx = user_db.begin(&authed).await?; check_name_conflict(&mut tx, &w_id, &ng.name).await?; #[cfg(not(feature = "enterprise"))] _check_nb_of_groups(&_db).await?; sqlx::query!( "INSERT INTO group_ (workspace_id, name, summary, extra_perms) VALUES ($1, $2, $3, $4)", w_id, ng.name, ng.summary, serde_json::json!({username_to_permissioned_as(&authed.username): true}) ) .execute(&mut *tx) .await?; sqlx::query!( "INSERT INTO usr_to_group (workspace_id, usr, group_) VALUES ($1, $2, $3) ON CONFLICT DO NOTHING", &w_id, &authed.username, ng.name, ) .execute(&mut *tx) .await?; audit_log( &mut *tx, &authed, "group.create", ActionKind::Create, &w_id, Some(&ng.name.to_string()), None, ) .await?; tx.commit().await?; handle_deployment_metadata( &authed.email, &authed.username, &_db, &w_id, windmill_git_sync::DeployedObject::Group { name: ng.name.clone() }, Some(format!("Created group '{}'", &ng.name)), true, ) .await?; Ok(format!("Created group {}", ng.name)) } async fn create_igroup( authed: ApiAuthed, Extension(db): Extension, Json(ng): Json, ) -> Result { require_super_admin(&db, &authed.email).await?; let mut tx = db.begin().await?; sqlx::query!( "INSERT INTO instance_group (name, summary) VALUES ($1, $2) ON CONFLICT DO NOTHING", ng.name, ng.summary, ) .execute(&mut *tx) .await?; audit_log( &mut *tx, &authed, "igroup.create", ActionKind::Create, "global", Some(&ng.name.to_string()), None, ) .await?; tx.commit().await?; Ok(format!("Created group {}", ng.name)) } #[derive(Deserialize)] struct IGroupUpdate { new_summary: String, } async fn update_igroup( authed: ApiAuthed, Extension(db): Extension, Path(name): Path, Json(igroup_update): Json, ) -> Result { require_super_admin(&db, &authed.email).await?; let mut tx: Transaction<'_, Postgres> = db.begin().await?; let exists_opt = sqlx::query("SELECT 1 FROM instance_group WHERE name = $1") .bind(name.clone()) .fetch_optional(&mut *tx) .await?; not_found_if_none(exists_opt, "instance_group", name.clone())?; sqlx::query("UPDATE instance_group SET summary = $1 WHERE name = $2") .bind(igroup_update.new_summary) .bind(&name) .execute(&mut *tx) .await?; audit_log( &mut *tx, &authed, "igroup.updated", ActionKind::Delete, "global", Some(&name.to_string()), None, ) .await?; tx.commit().await?; Ok(format!("Deleted group {}", name)) } async fn delete_igroup( authed: ApiAuthed, Extension(db): Extension, Path(name): Path, ) -> Result { require_super_admin(&db, &authed.email).await?; let mut tx: Transaction<'_, Postgres> = db.begin().await?; sqlx::query!("DELETE FROM instance_group WHERE name = $1", name) .execute(&mut *tx) .await?; sqlx::query!("DELETE FROM email_to_igroup WHERE igroup = $1", name) .execute(&mut *tx) .await?; audit_log( &mut *tx, &authed, "igroup.delete", ActionKind::Delete, "global", Some(&name.to_string()), None, ) .await?; tx.commit().await?; Ok(format!("Deleted group {}", name)) } pub async fn get_group_opt<'c>( db: &mut Transaction<'c, Postgres>, w_id: &str, name: &str, ) -> Result> { let group_opt = sqlx::query_as!( Group, "SELECT * FROM group_ WHERE name = $1 AND workspace_id = $2", name, w_id ) .fetch_optional(&mut **db) .await?; Ok(group_opt) } async fn get_group( authed: ApiAuthed, Extension(user_db): Extension, Path((w_id, name)): Path<(String, String)>, ) -> JsonResult { if *CLOUD_HOSTED && w_id == "demo" && name == "all" && !authed.is_admin { return Ok(Json(GroupInfo { workspace_id: w_id, name: name, summary: Some("The group that contains all users".to_string()), members: vec!["redacted_in_demo_workspace".to_string()], extra_perms: serde_json::json!({}), })); } let mut tx = user_db.begin(&authed).await?; let group = not_found_if_none(get_group_opt(&mut tx, &w_id, &name).await?, "Group", &name)?; let members = sqlx::query_scalar!( "SELECT usr.username FROM usr_to_group LEFT JOIN usr ON usr_to_group.usr = usr.username AND usr_to_group.workspace_id = $2 WHERE group_ = $1 AND usr.workspace_id = $2 AND usr_to_group.workspace_id = $2", name, w_id ) .fetch_all(&mut *tx) .await?; tx.commit().await?; Ok(Json(GroupInfo { workspace_id: group.workspace_id, name: group.name, summary: group.summary, members, extra_perms: group.extra_perms, })) } async fn delete_group( authed: ApiAuthed, Extension(db): Extension, Extension(user_db): Extension, Path((w_id, name)): Path<(String, String)>, ) -> Result { let mut tx = user_db.begin(&authed).await?; if name == "all" { return Err(Error::BadRequest( "The group 'all' is a special group that contains all users and cannot be deleted" .to_string(), )); } if !authed.is_admin { require_is_owner(&name, &authed.username, &authed.groups, &w_id, &db).await?; } not_found_if_none(get_group_opt(&mut tx, &w_id, &name).await?, "Group", &name)?; sqlx::query!( "DELETE FROM usr_to_group WHERE group_ = $1 AND workspace_id = $2", name, w_id ) .execute(&mut *tx) .await?; sqlx::query!( "DELETE FROM group_ WHERE name = $1 AND workspace_id = $2", name, w_id ) .execute(&mut *tx) .await?; audit_log( &mut *tx, &authed, "group.delete", ActionKind::Delete, &w_id, Some(&name.to_string()), None, ) .await?; tx.commit().await?; handle_deployment_metadata( &authed.email, &authed.username, &db, &w_id, windmill_git_sync::DeployedObject::Group { name: name.clone() }, Some(format!("Deleted group '{}'", &name)), true, ) .await?; Ok(format!("delete group at name {}", name)) } async fn update_group( authed: ApiAuthed, Extension(db): Extension, Extension(user_db): Extension, Path((w_id, name)): Path<(String, String)>, Json(eg): Json, ) -> Result { let mut tx = user_db.begin(&authed).await?; if !authed.is_admin { require_is_owner(&name, &authed.username, &authed.groups, &w_id, &db).await?; } not_found_if_none(get_group_opt(&mut tx, &w_id, &name).await?, "Group", &name)?; sqlx::query!( "UPDATE group_ SET summary = $1 WHERE name = $2 AND workspace_id = $3", eg.summary, &name, &w_id ) .execute(&mut *tx) .await?; audit_log( &mut *tx, &authed, "group.edit", ActionKind::Update, &w_id, Some(&name.to_string()), None, ) .await?; tx.commit().await?; handle_deployment_metadata( &authed.email, &authed.username, &db, &w_id, windmill_git_sync::DeployedObject::Group { name: name.clone() }, Some(format!("Updated group '{}'", &name)), true, ) .await?; Ok(format!("Edited group {}", name)) } async fn add_user( authed: ApiAuthed, Extension(db): Extension, Extension(user_db): Extension, Path((w_id, name)): Path<(String, String)>, Json(Username { username: user_username }): Json, ) -> Result { let mut tx = user_db.begin(&authed).await?; if !authed.is_admin { require_is_owner(&name, &authed.username, &authed.groups, &w_id, &db).await?; } not_found_if_none(get_group_opt(&mut tx, &w_id, &name).await?, "Group", &name)?; sqlx::query!( "INSERT INTO usr_to_group (workspace_id, usr, group_) VALUES ($1, $2, $3) ON CONFLICT DO NOTHING", &w_id, user_username, name, ) .execute(&mut *tx) .await?; audit_log( &mut *tx, &authed, "group.adduser", ActionKind::Update, &w_id, Some(&name.to_string()), Some([("user", user_username.as_str())].into()), ) .await?; tx.commit().await?; handle_deployment_metadata( &authed.email, &authed.username, &db, &w_id, windmill_git_sync::DeployedObject::Group { name: name.clone() }, Some(format!("Added user to group '{}'", &name)), true, ) .await?; Ok(format!("Added {} to group {}", user_username, name)) } async fn add_user_igroup( authed: ApiAuthed, Extension(db): Extension, Path(name): Path, Json(Email { email }): Json, ) -> Result { require_super_admin(&db, &authed.email).await?; let mut tx: Transaction<'_, Postgres> = db.begin().await?; let group_opt = sqlx::query_scalar!("SELECT name FROM instance_group WHERE name = $1", name) .fetch_optional(&mut *tx) .await?; not_found_if_none(group_opt, "IGroup", &name)?; sqlx::query!( "INSERT INTO email_to_igroup (email, igroup) VALUES ($1, $2) ON CONFLICT DO NOTHING", email, name, ) .execute(&mut *tx) .await?; audit_log( &mut *tx, &authed, "igroup.adduser", ActionKind::Update, "global", Some(&name.to_string()), Some([("email", email.as_str())].into()), ) .await?; tx.commit().await?; Ok(format!("Added {} to igroup {}", email, name)) } #[derive(Serialize)] struct IGroup { name: String, summary: Option, emails: Option>, } async fn list_igroups(Extension(db): Extension) -> JsonResult> { let mut tx: Transaction<'_, Postgres> = db.begin().await?; let groups = sqlx::query_as!( IGroup, "SELECT name, summary, array_remove(array_agg(email_to_igroup.email), null) as emails FROM email_to_igroup RIGHT JOIN instance_group ON instance_group.name = email_to_igroup.igroup GROUP BY name" ) .fetch_all(&mut *tx) .await?; tx.commit().await?; return Ok(Json(groups)); } async fn get_igroup(Path(name): Path, Extension(db): Extension) -> JsonResult { let group = sqlx::query_as!( IGroup, "SELECT name, summary, array_remove(array_agg(email_to_igroup.email), null) as emails FROM email_to_igroup RIGHT JOIN instance_group ON instance_group.name = email_to_igroup.igroup WHERE name = $1 GROUP BY name", name ) .fetch_optional(&db) .await?; let group = not_found_if_none(group, "IGroup", &name)?; return Ok(Json(group)); } async fn remove_user_igroup( authed: ApiAuthed, Extension(db): Extension, Path(name): Path, Json(Email { email }): Json, ) -> Result { require_super_admin(&db, &authed.email).await?; let mut tx = db.begin().await?; let group_opt = sqlx::query_scalar!("SELECT name FROM instance_group WHERE name = $1", name,) .fetch_optional(&mut *tx) .await?; not_found_if_none(group_opt, "IGroup", &name)?; sqlx::query!( "DELETE FROM email_to_igroup WHERE email = $1 AND igroup = $2", email, name, ) .execute(&mut *tx) .await?; audit_log( &mut *tx, &authed, "igroup.removeuser", ActionKind::Update, "global", Some(&name.to_string()), Some([("email", email.as_str())].into()), ) .await?; tx.commit().await?; Ok(format!("Added {} to igroup {}", email, name)) } async fn remove_user( authed: ApiAuthed, Extension(db): Extension, Extension(user_db): Extension, Path((w_id, name)): Path<(String, String)>, Json(Username { username: user_username }): Json, ) -> Result { let mut tx = user_db.begin(&authed).await?; if !authed.is_admin { require_is_owner(&name, &authed.username, &authed.groups, &w_id, &db).await?; } not_found_if_none(get_group_opt(&mut tx, &w_id, &name).await?, "Group", &name)?; if &name == "all" { return Err(Error::BadRequest(format!("Cannot delete users from all"))); } sqlx::query!( "DELETE FROM usr_to_group WHERE usr = $1 AND group_ = $2 AND workspace_id = $3", user_username, name, &w_id, ) .execute(&mut *tx) .await?; audit_log( &mut *tx, &authed, "group.removeuser", ActionKind::Update, &w_id, Some(&name.to_string()), Some([("user", user_username.as_str())].into()), ) .await?; tx.commit().await?; handle_deployment_metadata( &authed.email, &authed.username, &db, &w_id, windmill_git_sync::DeployedObject::Group { name: name.clone() }, Some(format!("Removed user from group '{}'", &name)), true, ) .await?; Ok(format!("Removed {} to group {}", user_username, name)) } #[cfg(feature = "enterprise")] #[derive(Serialize, Deserialize)] struct ExportedIGroup { name: String, #[serde(skip_serializing_if = "Option::is_none")] summary: Option, #[serde(skip_serializing_if = "Option::is_none")] id: Option, #[serde(skip_serializing_if = "Option::is_none")] scim_display_name: Option, #[serde(skip_serializing_if = "Option::is_none")] external_id: Option, #[serde(skip_serializing_if = "Option::is_none")] emails: Option>, } #[cfg(feature = "enterprise")] async fn export_igroups( authed: ApiAuthed, Extension(db): Extension, ) -> JsonResult> { require_super_admin(&db, &authed.email).await?; let mut tx = db.begin().await?; let igroups = sqlx::query_as!( ExportedIGroup, "SELECT name, summary, array_remove(array_agg(email_to_igroup.email), null) as emails, id, scim_display_name, external_id FROM email_to_igroup RIGHT JOIN instance_group ON instance_group.name = email_to_igroup.igroup GROUP BY name", ).fetch_all(&mut *tx).await?; audit_log( &mut *tx, &authed, "igroups.export", ActionKind::Execute, "global", None, None, ) .await?; tx.commit().await?; Ok(Json(igroups)) } #[cfg(not(feature = "enterprise"))] async fn export_igroups() -> JsonResult { Err(Error::BadRequest( "This feature is only available in the enterprise version".to_string(), )) } #[cfg(feature = "enterprise")] async fn overwrite_igroups( authed: ApiAuthed, Extension(db): Extension, Json(igroups): Json>, ) -> Result { require_super_admin(&db, &authed.email).await?; let mut tx = db.begin().await?; sqlx::query!("DELETE FROM email_to_igroup") .execute(&mut *tx) .await?; sqlx::query!("DELETE FROM instance_group") .execute(&mut *tx) .await?; for igroup in igroups.iter() { sqlx::query!( "INSERT INTO instance_group (name, summary, id, scim_display_name, external_id) VALUES ($1, $2, $3, $4, $5)", igroup.name, igroup.summary, igroup.id, igroup.scim_display_name, igroup.external_id, ) .execute(&mut *tx) .await?; if let Some(emails) = &igroup.emails { for email in emails.iter() { sqlx::query!( "INSERT INTO email_to_igroup (email, igroup) VALUES ($1, $2)", email, igroup.name, ) .execute(&mut *tx) .await?; } } } audit_log( &mut *tx, &authed, "igroups.import", ActionKind::Create, "global", None, None, ) .await?; tx.commit().await?; Ok("Imported igroups".to_string()) } #[cfg(not(feature = "enterprise"))] async fn overwrite_igroups() -> JsonResult { Err(Error::BadRequest( "This feature is only available in the enterprise version".to_string(), )) }