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 4FCE97488A for ; Fri, 9 Jul 2021 13:44:35 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 4112C2509B for ; Fri, 9 Jul 2021 13:44:05 +0200 (CEST) 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 id F382A24FD3 for ; Fri, 9 Jul 2021 13:44:02 +0200 (CEST) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id C3C6040EE0 for ; Fri, 9 Jul 2021 13:44:02 +0200 (CEST) From: Dominik Csapak To: pbs-devel@lists.proxmox.com Date: Fri, 9 Jul 2021 13:43:56 +0200 Message-Id: <20210709114401.277841-2-d.csapak@proxmox.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20210709114401.277841-1-d.csapak@proxmox.com> References: <20210709114401.277841-1-d.csapak@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL 0.635 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. [domain.rs] Subject: [pbs-devel] [PATCH proxmox-backup 1/6] api: access: domains: add BasicRealmInfo struct and use it 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: Fri, 09 Jul 2021 11:44:35 -0000 to have better type safety and as preparation for adding more types Signed-off-by: Dominik Csapak --- src/api2/access/domain.rs | 101 +++++++++++++++++++++++++------------- 1 file changed, 66 insertions(+), 35 deletions(-) diff --git a/src/api2/access/domain.rs b/src/api2/access/domain.rs index 69809acc..126cd8ff 100644 --- a/src/api2/access/domain.rs +++ b/src/api2/access/domain.rs @@ -2,33 +2,61 @@ use anyhow::{Error}; +use serde::{Deserialize, Serialize}; use serde_json::{json, Value}; -use proxmox::api::{api, Permission}; -use proxmox::api::router::Router; +use proxmox::api::{api, Permission, Router, RpcEnvironment}; use crate::api2::types::*; +#[api] +#[derive(Deserialize, Serialize, PartialEq, Eq)] +#[serde(rename_all = "lowercase")] +/// type of the realm +pub enum RealmType { + /// The PAM realm + Pam, + /// The PBS realm + Pbs, + /// An OpenID Connect realm + OpenId, +} + +#[api( + properties: { + realm: { + schema: REALM_ID_SCHEMA, + }, + "type": { + type: RealmType, + }, + comment: { + optional: true, + schema: SINGLE_LINE_COMMENT_SCHEMA, + }, + }, +)] +#[derive(Deserialize, Serialize)] +#[serde(rename_all = "kebab-case")] +/// Basic Information about a realm +pub struct BasicRealmInfo { + pub realm: String, + #[serde(rename = "type")] + pub ty: RealmType, + /// True if it is the default realm + #[serde(skip_serializing_if = "Option::is_none")] + pub default: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub comment: Option, +} + + #[api( returns: { - description: "List of realms.", + description: "List of realms with basic info.", type: Array, items: { - type: Object, - description: "User configuration (without password).", - properties: { - realm: { - schema: REALM_ID_SCHEMA, - }, - comment: { - schema: SINGLE_LINE_COMMENT_SCHEMA, - optional: true, - }, - default: { - description: "Default realm.", - type: bool, - } - }, + type: BasicRealmInfo, } }, access: { @@ -37,29 +65,32 @@ use crate::api2::types::*; } )] /// Authentication domain/realm index. -fn list_domains() -> Result { - +fn list_domains(mut rpcenv: &mut dyn RpcEnvironment) -> Result, Error> { let mut list = Vec::new(); - list.push(json!({ "realm": "pam", "comment": "Linux PAM standard authentication", "default": true })); - list.push(json!({ "realm": "pbs", "comment": "Proxmox Backup authentication server" })); - - let (config, _digest) = crate::config::domains::config()?; + list.push(serde_json::from_value(json!({ + "realm": "pam", + "type": "pam", + "comment": "Linux PAM standard authentication", + "default": Some(true), + }))?); + list.push(serde_json::from_value(json!({ + "realm": "pbs", + "type": "pbs", + "comment": "Proxmox Backup authentication server", + }))?); - for (realm, (section_type, v)) in config.sections.iter() { - let mut item = json!({ - "type": section_type, - "realm": realm, - }); - - if v["comment"].as_str().is_some() { - item["comment"] = v["comment"].clone(); - } - list.push(item); + let (config, digest) = config::domains::config()?; + for (_, (section_type, v)) in config.sections.iter() { + let mut entry = v.clone(); + entry["type"] = Value::from(section_type.clone()); + list.push(serde_json::from_value(entry)?); } - Ok(list.into()) + rpcenv["digest"] = proxmox::tools::digest_to_hex(&digest).into(); + + Ok(list) } pub const ROUTER: Router = Router::new() -- 2.30.2