From: Christoph Heiss <c.heiss@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH proxmox-backup 09/14] api-types: introduce proper types for PAM and PBS realms
Date: Tue, 16 Jul 2024 15:45:08 +0200 [thread overview]
Message-ID: <20240716134514.1656795-10-c.heiss@proxmox.com> (raw)
In-Reply-To: <20240716134514.1656795-1-c.heiss@proxmox.com>
Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
---
pbs-api-types/src/lib.rs | 76 ++++++++++++++++++++++++++++++++++++++++
1 file changed, 76 insertions(+)
diff --git a/pbs-api-types/src/lib.rs b/pbs-api-types/src/lib.rs
index 40bcd8f1..01f8eb74 100644
--- a/pbs-api-types/src/lib.rs
+++ b/pbs-api-types/src/lib.rs
@@ -1,6 +1,8 @@
//! Basic API types used by most of the PBS code.
use const_format::concatcp;
+use proxmox_schema::EnumEntry;
+use proxmox_schema::Updater;
use serde::{Deserialize, Serialize};
pub mod percent_encoding;
@@ -218,6 +220,20 @@ pub const REALM_ID_SCHEMA: Schema = StringSchema::new("Realm name.")
.max_length(32)
.schema();
+const PAM_REALM_ID_SCHEMA: Schema = StringSchema::new("Realm name.")
+ .format(&ApiStringFormat::Enum(&[EnumEntry::new(
+ "pam",
+ "Default PAM realm.",
+ )]))
+ .schema();
+
+const PBS_REALM_ID_SCHEMA: Schema = StringSchema::new("Realm name.")
+ .format(&ApiStringFormat::Enum(&[EnumEntry::new(
+ "pbs",
+ "Default PBS realm.",
+ )]))
+ .schema();
+
pub const SUBSCRIPTION_KEY_SCHEMA: Schema =
StringSchema::new("Proxmox Backup Server subscription key.")
.format(&SUBSCRIPTION_KEY_FORMAT)
@@ -394,3 +410,63 @@ pub struct BasicRealmInfo {
#[serde(skip_serializing_if = "Option::is_none")]
pub comment: Option<String>,
}
+
+#[api(
+ properties: {
+ "realm": {
+ schema: PAM_REALM_ID_SCHEMA,
+ },
+ "comment": {
+ optional: true,
+ schema: SINGLE_LINE_COMMENT_SCHEMA,
+ },
+ "default": {
+ optional: true,
+ default: false,
+ },
+ }
+)]
+#[derive(Serialize, Deserialize, Updater, Clone)]
+#[serde(rename_all = "kebab-case")]
+/// Built-in PAM realm configuration properties.
+pub struct PamRealmConfig {
+ /// Realm name. Always "pam".
+ #[updater(skip)]
+ pub realm: String,
+ /// Comment for this realm
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub comment: Option<String>,
+ /// True if it should be the default realm to login in
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub default: Option<bool>,
+}
+
+#[api(
+ properties: {
+ "realm": {
+ schema: PBS_REALM_ID_SCHEMA,
+ },
+ "comment": {
+ optional: true,
+ schema: SINGLE_LINE_COMMENT_SCHEMA,
+ },
+ "default": {
+ optional: true,
+ default: false,
+ },
+ }
+)]
+#[derive(Serialize, Deserialize, Updater, Clone)]
+#[serde(rename_all = "kebab-case")]
+/// Built-in Proxmox Backup Server realm configuration properties.
+pub struct PbsRealmConfig {
+ /// Realm name. Always "pbs".
+ #[updater(skip)]
+ pub realm: String,
+ /// Comment for this realm
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub comment: Option<String>,
+ /// True if it should be the default realm to login in
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub default: Option<bool>,
+}
--
2.45.1
_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel
next prev parent reply other threads:[~2024-07-16 13:45 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-07-16 13:44 [pbs-devel] [PATCH proxmox-backup/pwt 0/14] fix #5379: introduce default auth realm option Christoph Heiss
2024-07-16 13:45 ` [pbs-devel] [PATCH widget-toolkit 1/6] window: AuthEditBase: include more information in thrown errors Christoph Heiss
2024-07-16 13:45 ` [pbs-devel] [PATCH widget-toolkit 2/6] panel: AuthView: make `useTypeInUrl` property per-realm Christoph Heiss
2024-07-16 13:45 ` [pbs-devel] [PATCH widget-toolkit 3/6] window: add panel for editing simple, built-in realms Christoph Heiss
2024-07-16 13:45 ` [pbs-devel] [PATCH widget-toolkit 4/6] schema: make PAM realm editable using new AuthSimple panel Christoph Heiss
2024-07-16 13:45 ` [pbs-devel] [PATCH widget-toolkit 5/6] fix #5379: panel: AuthView: add column displaying whether the realm is default Christoph Heiss
2024-08-07 9:24 ` Lukas Wagner
2024-07-16 13:45 ` [pbs-devel] [PATCH widget-toolkit 6/6] fix #5379: window: AuthEdit{LDAP, OpenId}: add 'Default realm' checkbox Christoph Heiss
2024-07-16 13:45 ` [pbs-devel] [PATCH proxmox-backup 07/14] fix #5379: api-types: add `default` field to all realm types Christoph Heiss
2024-07-16 13:45 ` [pbs-devel] [PATCH proxmox-backup 08/14] fix #5379: api2: access: set default realm accordingly on individual update Christoph Heiss
2024-07-16 13:45 ` Christoph Heiss [this message]
2024-08-07 9:24 ` [pbs-devel] [PATCH proxmox-backup 09/14] api-types: introduce proper types for PAM and PBS realms Lukas Wagner
2024-07-16 13:45 ` [pbs-devel] [PATCH proxmox-backup 10/14] config: use new dedicated PAM and PBS realm types Christoph Heiss
2024-08-07 9:24 ` Lukas Wagner
2024-08-07 15:24 ` Christoph Heiss
2024-07-16 13:45 ` [pbs-devel] [PATCH proxmox-backup 11/14] api2: access: add update support for built-in PAM realm Christoph Heiss
2024-07-16 13:45 ` [pbs-devel] [PATCH proxmox-backup 12/14] api2: access: add update support for built-in PBS realm Christoph Heiss
2024-07-16 13:45 ` [pbs-devel] [PATCH proxmox-backup 13/14] www: AccessControl: make `useTypeInUrl` property per-realm Christoph Heiss
2024-07-16 13:45 ` [pbs-devel] [PATCH proxmox-backup 14/14] www: utils: make built-in pbs realm editable using new AuthSimplePanel Christoph Heiss
2024-08-07 9:23 ` [pbs-devel] [PATCH proxmox-backup/pwt 0/14] fix #5379: introduce default auth realm option Lukas Wagner
2024-08-07 15:27 ` Christoph Heiss
2024-08-08 14:25 ` Christoph Heiss
2024-08-09 11:12 ` Lukas Wagner
2024-08-12 13:57 ` Christoph Heiss
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240716134514.1656795-10-c.heiss@proxmox.com \
--to=c.heiss@proxmox.com \
--cc=pbs-devel@lists.proxmox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox