From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id 619AB91BB8 for ; Thu, 9 Feb 2023 14:32:05 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id E023D24A31 for ; Thu, 9 Feb 2023 14:31:40 +0100 (CET) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [94.136.29.106]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS for ; Thu, 9 Feb 2023 14:31:37 +0100 (CET) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id F251F4655C for ; Thu, 9 Feb 2023 14:31:36 +0100 (CET) From: Lukas Wagner To: pbs-devel@lists.proxmox.com Date: Thu, 9 Feb 2023 14:31:20 +0100 Message-Id: <20230209133128.695211-11-l.wagner@proxmox.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20230209133128.695211-1-l.wagner@proxmox.com> References: <20230209133128.695211-1-l.wagner@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL -0.195 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record URIBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to URIBL was blocked. See http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block for more information. [proxmox-backup-manager.rs, domains.rs, mod.rs, ldap.rs] Subject: [pbs-devel] [PATCH v3 proxmox-backup 10/18] manager: add commands for managing LDAP realms X-BeenThere: pbs-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Backup Server development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 09 Feb 2023 13:32:05 -0000 Adds commands for managing LDAP realms, including user sync, to `proxmox-backup-manager`. Signed-off-by: Lukas Wagner --- pbs-config/src/domains.rs | 12 +- src/bin/proxmox-backup-manager.rs | 1 + src/bin/proxmox_backup_manager/ldap.rs | 152 +++++++++++++++++++++++++ src/bin/proxmox_backup_manager/mod.rs | 2 + 4 files changed, 165 insertions(+), 2 deletions(-) create mode 100644 src/bin/proxmox_backup_manager/ldap.rs diff --git a/pbs-config/src/domains.rs b/pbs-config/src/domains.rs index 81d89d5d..521bf206 100644 --- a/pbs-config/src/domains.rs +++ b/pbs-config/src/domains.rs @@ -71,13 +71,13 @@ pub fn complete_realm_name(_arg: &str, _param: &HashMap) -> Vec< } } -pub fn complete_openid_realm_name(_arg: &str, _param: &HashMap) -> Vec { +fn complete_realm_of_type(realm_type: &str) -> Vec { match config() { Ok((data, _digest)) => data .sections .iter() .filter_map(|(id, (t, _))| { - if t == "openid" { + if t == realm_type { Some(id.to_string()) } else { None @@ -87,3 +87,11 @@ pub fn complete_openid_realm_name(_arg: &str, _param: &HashMap) Err(_) => Vec::new(), } } + +pub fn complete_openid_realm_name(_arg: &str, _param: &HashMap) -> Vec { + complete_realm_of_type("openid") +} + +pub fn complete_ldap_realm_name(_arg: &str, _param: &HashMap) -> Vec { + complete_realm_of_type("ldap") +} diff --git a/src/bin/proxmox-backup-manager.rs b/src/bin/proxmox-backup-manager.rs index 86adabe3..740fdc49 100644 --- a/src/bin/proxmox-backup-manager.rs +++ b/src/bin/proxmox-backup-manager.rs @@ -427,6 +427,7 @@ async fn run() -> Result<(), Error> { .insert("datastore", datastore_commands()) .insert("disk", disk_commands()) .insert("dns", dns_commands()) + .insert("ldap", ldap_commands()) .insert("network", network_commands()) .insert("node", node_commands()) .insert("user", user_commands()) diff --git a/src/bin/proxmox_backup_manager/ldap.rs b/src/bin/proxmox_backup_manager/ldap.rs new file mode 100644 index 00000000..538c313b --- /dev/null +++ b/src/bin/proxmox_backup_manager/ldap.rs @@ -0,0 +1,152 @@ +use anyhow::Error; +use serde_json::Value; + +use proxmox_router::{cli::*, ApiHandler, Permission, RpcEnvironment}; +use proxmox_schema::api; + +use pbs_api_types::{ + Realm, PRIV_PERMISSIONS_MODIFY, PROXMOX_UPID_REGEX, REALM_ID_SCHEMA, REMOVE_VANISHED_SCHEMA, +}; + +use proxmox_backup::api2; + +#[api( + input: { + properties: { + "output-format": { + schema: OUTPUT_FORMAT, + optional: true, + }, + } + } +)] +/// List configured LDAP realms +fn list_ldap_realms(param: Value, rpcenv: &mut dyn RpcEnvironment) -> Result { + let output_format = get_output_format(¶m); + + let info = &api2::config::access::ldap::API_METHOD_LIST_LDAP_REALMS; + let mut data = match info.handler { + ApiHandler::Sync(handler) => (handler)(param, info, rpcenv)?, + _ => unreachable!(), + }; + + let options = default_table_format_options() + .column(ColumnConfig::new("realm")) + .column(ColumnConfig::new("server1")) + .column(ColumnConfig::new("comment")); + + format_and_print_result_full(&mut data, &info.returns, &output_format, &options); + + Ok(Value::Null) +} +#[api( + input: { + properties: { + realm: { + schema: REALM_ID_SCHEMA, + }, + "output-format": { + schema: OUTPUT_FORMAT, + optional: true, + }, + } + } +)] + +/// Show LDAP realm configuration +fn show_ldap_realm(param: Value, rpcenv: &mut dyn RpcEnvironment) -> Result { + let output_format = get_output_format(¶m); + + let info = &api2::config::access::ldap::API_METHOD_READ_LDAP_REALM; + let mut data = match info.handler { + ApiHandler::Sync(handler) => (handler)(param, info, rpcenv)?, + _ => unreachable!(), + }; + + let options = default_table_format_options(); + format_and_print_result_full(&mut data, &info.returns, &output_format, &options); + + Ok(Value::Null) +} + +#[api( + protected: true, + input: { + properties: { + realm: { + type: Realm, + }, + "dry-run": { + type: bool, + description: "If set, do not create/delete anything", + default: false, + optional: true, + }, + "remove-vanished": { + optional: true, + schema: REMOVE_VANISHED_SCHEMA, + }, + "enable-new": { + description: "Enable newly synced users immediately", + optional: true, + type: bool, + } + }, + }, + access: { + permission: &Permission::Privilege(&["access", "users"], PRIV_PERMISSIONS_MODIFY, false), + }, +)] +/// Sync a given LDAP realm +async fn sync_ldap_realm(param: Value, rpcenv: &mut dyn RpcEnvironment) -> Result { + let info = &api2::access::domain::API_METHOD_SYNC_REALM; + let data = match info.handler { + ApiHandler::Sync(handler) => (handler)(param, info, rpcenv)?, + _ => unreachable!(), + }; + + if let Some(upid) = data.as_str() { + if PROXMOX_UPID_REGEX.is_match(upid) { + proxmox_rest_server::handle_worker(upid).await?; + } + } + + Ok(Value::Null) +} + +pub fn ldap_commands() -> CommandLineInterface { + let cmd_def = CliCommandMap::new() + .insert("list", CliCommand::new(&API_METHOD_LIST_LDAP_REALMS)) + .insert( + "show", + CliCommand::new(&API_METHOD_SHOW_LDAP_REALM) + .arg_param(&["realm"]) + .completion_cb("realm", pbs_config::domains::complete_ldap_realm_name), + ) + .insert( + "create", + CliCommand::new(&api2::config::access::ldap::API_METHOD_CREATE_LDAP_REALM) + .arg_param(&["realm"]) + .completion_cb("realm", pbs_config::domains::complete_ldap_realm_name), + ) + .insert( + "update", + CliCommand::new(&api2::config::access::ldap::API_METHOD_UPDATE_LDAP_REALM) + .arg_param(&["realm"]) + .completion_cb("realm", pbs_config::domains::complete_ldap_realm_name), + ) + .insert( + "delete", + CliCommand::new(&api2::config::access::ldap::API_METHOD_DELETE_LDAP_REALM) + .arg_param(&["realm"]) + .completion_cb("realm", pbs_config::domains::complete_ldap_realm_name), + ) + .insert( + "sync", + CliCommand::new(&API_METHOD_SYNC_LDAP_REALM) + .arg_param(&["realm"]) + .completion_cb("realm", pbs_config::domains::complete_ldap_realm_name), + ); + + cmd_def.into() +} diff --git a/src/bin/proxmox_backup_manager/mod.rs b/src/bin/proxmox_backup_manager/mod.rs index 9788f637..8a1c140c 100644 --- a/src/bin/proxmox_backup_manager/mod.rs +++ b/src/bin/proxmox_backup_manager/mod.rs @@ -8,6 +8,8 @@ mod datastore; pub use datastore::*; mod dns; pub use dns::*; +mod ldap; +pub use ldap::*; mod network; pub use network::*; mod prune; -- 2.30.2