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 9579174968 for ; Tue, 22 Jun 2021 10:57:05 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 153272403B for ; Tue, 22 Jun 2021 10:56:35 +0200 (CEST) Received: from dev7.proxmox.com (unknown [94.136.29.99]) by firstgate.proxmox.com (Proxmox) with ESMTP id D6A8F23E64 for ; Tue, 22 Jun 2021 10:56:28 +0200 (CEST) Received: by dev7.proxmox.com (Postfix, from userid 0) id 89B7E80F4F; Tue, 22 Jun 2021 10:56:22 +0200 (CEST) From: Dietmar Maurer To: pbs-devel@lists.proxmox.com Date: Tue, 22 Jun 2021 10:56:12 +0200 Message-Id: <20210622085620.1551677-5-dietmar@proxmox.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20210622085620.1551677-1-dietmar@proxmox.com> References: <20210622085620.1551677-1-dietmar@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL 0.672 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 RDNS_NONE 0.793 Delivered to internal network by a host with no rDNS 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. [openid.rs, mod.rs] Subject: [pbs-devel] [PATH proxmox-backup v1 04/12] add API to manage openid 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: Tue, 22 Jun 2021 08:57:05 -0000 --- src/api2/config/access/mod.rs | 8 +- src/api2/config/access/openid.rs | 264 +++++++++++++++++++++++++++++++ 2 files changed, 271 insertions(+), 1 deletion(-) create mode 100644 src/api2/config/access/openid.rs diff --git a/src/api2/config/access/mod.rs b/src/api2/config/access/mod.rs index 659815e0..6e7d98be 100644 --- a/src/api2/config/access/mod.rs +++ b/src/api2/config/access/mod.rs @@ -1,9 +1,15 @@ use proxmox::api::{Router, SubdirMap}; use proxmox::list_subdirs_api_method; +use proxmox::{identity, sortable}; pub mod tfa; +pub mod openid; -const SUBDIRS: SubdirMap = &[("tfa", &tfa::ROUTER)]; +#[sortable] +const SUBDIRS: SubdirMap = &sorted!([ + ("openid", &openid::ROUTER), + ("tfa", &tfa::ROUTER), +]); pub const ROUTER: Router = Router::new() .get(&list_subdirs_api_method!(SUBDIRS)) diff --git a/src/api2/config/access/openid.rs b/src/api2/config/access/openid.rs new file mode 100644 index 00000000..15fddaf0 --- /dev/null +++ b/src/api2/config/access/openid.rs @@ -0,0 +1,264 @@ +/// Configure OpenId realms + +use anyhow::{bail, Error}; +use serde_json::Value; +use ::serde::{Deserialize, Serialize}; + +use proxmox::api::{api, Permission, Router, RpcEnvironment}; + +use crate::config::domains::{self, OpenIdRealmConfig}; +use crate::config::acl::{PRIV_SYS_AUDIT, PRIV_PERMISSIONS_MODIFY}; +use crate::api2::types::*; + +#[api( + input: { + properties: {}, + }, + returns: { + description: "List of configured OpenId realms.", + type: Array, + items: { type: OpenIdRealmConfig }, + }, + access: { + permission: &Permission::Privilege(&["access", "domains"], PRIV_SYS_AUDIT, false), + }, +)] +/// List configured OpenId realms +pub fn list_openid_realms( + _param: Value, + mut rpcenv: &mut dyn RpcEnvironment, +) -> Result, Error> { + + let (config, digest) = domains::config()?; + + let list = config.convert_to_typed_array("openid")?; + + rpcenv["digest"] = proxmox::tools::digest_to_hex(&digest).into(); + + Ok(list) +} + +#[api( + protected: true, + input: { + properties: { + config: { + type: OpenIdRealmConfig, + flatten: true, + }, + }, + }, + access: { + permission: &Permission::Privilege(&["access", "domains"], PRIV_PERMISSIONS_MODIFY, false), + }, +)] +/// Create a new OpenId realm +pub fn create_openid_realm(config: OpenIdRealmConfig) -> Result<(), Error> { + + let _lock = domains::lock_config()?; + + let (mut domains, _digest) = domains::config()?; + + if config.realm == "pbs" || + config.realm == "pam" || + domains.sections.get(&config.realm).is_some() + { + bail!("realm '{}' already exists.", config.realm); + } + + domains.set_data(&config.realm, "openid", &config)?; + + domains::save_config(&domains)?; + + Ok(()) +} + +#[api( + protected: true, + input: { + properties: { + realm: { + schema: REALM_ID_SCHEMA, + }, + digest: { + optional: true, + schema: PROXMOX_CONFIG_DIGEST_SCHEMA, + }, + }, + }, + access: { + permission: &Permission::Privilege(&["access", "domains"], PRIV_PERMISSIONS_MODIFY, false), + }, +)] +/// Remove a OpenID realm configuration +pub fn delete_openid_realm( + realm: String, + digest: Option, + _rpcenv: &mut dyn RpcEnvironment, +) -> Result<(), Error> { + + let _lock = domains::lock_config()?; + + let (mut domains, expected_digest) = domains::config()?; + + if let Some(ref digest) = digest { + let digest = proxmox::tools::hex_to_digest(digest)?; + crate::tools::detect_modified_configuration_file(&digest, &expected_digest)?; + } + + if domains.sections.remove(&realm).is_none() { + bail!("realm '{}' does not exist.", realm); + } + + domains::save_config(&domains)?; + + Ok(()) +} + +#[api( + input: { + properties: { + realm: { + schema: REALM_ID_SCHEMA, + }, + }, + }, + returns: { type: OpenIdRealmConfig }, + access: { + permission: &Permission::Privilege(&["access", "domains"], PRIV_SYS_AUDIT, false), + }, +)] +/// Read the OpenID realm configuration +pub fn read_openid_realm( + realm: String, + mut rpcenv: &mut dyn RpcEnvironment, +) -> Result { + + let (domains, digest) = domains::config()?; + + let config = domains.lookup("openid", &realm)?; + + rpcenv["digest"] = proxmox::tools::digest_to_hex(&digest).into(); + + Ok(config) +} + +#[api()] +#[derive(Serialize, Deserialize)] +#[serde(rename_all="kebab-case")] +#[allow(non_camel_case_types)] +/// Deletable property name +pub enum DeletableProperty { + /// Delete the client key. + client_key, + /// Delete the comment property. + comment, +} + +#[api( + protected: true, + input: { + properties: { + realm: { + schema: REALM_ID_SCHEMA, + }, + "issuer-url": { + description: "OpenID Issuer Url", + type: String, + optional: true, + }, + "client-id": { + description: "OpenID Client ID", + type: String, + optional: true, + }, + "client-key": { + description: "OpenID Client Key", + type: String, + optional: true, + }, + comment: { + schema: SINGLE_LINE_COMMENT_SCHEMA, + optional: true, + }, + delete: { + description: "List of properties to delete.", + type: Array, + optional: true, + items: { + type: DeletableProperty, + } + }, + digest: { + optional: true, + schema: PROXMOX_CONFIG_DIGEST_SCHEMA, + }, + }, + }, + returns: { type: OpenIdRealmConfig }, + access: { + permission: &Permission::Privilege(&["access", "domains"], PRIV_PERMISSIONS_MODIFY, false), + }, +)] +/// Update an OpenID realm configuration +pub fn update_openid_realm( + realm: String, + issuer_url: Option, + client_id: Option, + client_key: Option, + comment: Option, + delete: Option>, + digest: Option, + _rpcenv: &mut dyn RpcEnvironment, +) -> Result<(), Error> { + + let _lock = domains::lock_config()?; + + let (mut domains, expected_digest) = domains::config()?; + + if let Some(ref digest) = digest { + let digest = proxmox::tools::hex_to_digest(digest)?; + crate::tools::detect_modified_configuration_file(&digest, &expected_digest)?; + } + + let mut config: OpenIdRealmConfig = domains.lookup("openid", &realm)?; + + if let Some(delete) = delete { + for delete_prop in delete { + match delete_prop { + DeletableProperty::client_key => { config.client_key = None; }, + DeletableProperty::comment => { config.comment = None; }, + } + } + } + + if let Some(comment) = comment { + let comment = comment.trim().to_string(); + if comment.is_empty() { + config.comment = None; + } else { + config.comment = Some(comment); + } + } + + if let Some(issuer_url) = issuer_url { config.issuer_url = issuer_url; } + if let Some(client_id) = client_id { config.client_id = client_id; } + + if client_key.is_some() { config.client_key = client_key; } + + domains.set_data(&realm, "openid", &config)?; + + domains::save_config(&domains)?; + + Ok(()) +} + +const ITEM_ROUTER: Router = Router::new() + .get(&API_METHOD_READ_OPENID_REALM) + .put(&API_METHOD_UPDATE_OPENID_REALM) + .delete(&API_METHOD_DELETE_OPENID_REALM); + +pub const ROUTER: Router = Router::new() + .get(&API_METHOD_LIST_OPENID_REALMS) + .post(&API_METHOD_CREATE_OPENID_REALM) + .match_all("id", &ITEM_ROUTER); -- 2.30.2