[pbs-devel] [PATCH proxmox v5 1/2] fix #5379: api-types: add `default` field for all realm types

[Shannon Sterz]

On Fri Mar 21, 2025 at 2:45 PM CET, Christoph Heiss wrote:
> The field indicates whether the realm should be the default realm to
> select in the login dialog.
>
> Per definition, the field should only ever be set to `true` on exactly
> one realm - up to the consumer/storage to ensure that.
>
> Signed-off-by: Christoph Heiss <c.heiss at proxmox.com>
> ---
> Changes v4 -> v5:
>   * rebased to `proxmox` repo
>   * added "default" api type definition for `BasicRealmInfo`
>
>  pbs-api-types/src/ad.rs     | 7 +++++++
>  pbs-api-types/src/ldap.rs   | 7 +++++++
>  pbs-api-types/src/lib.rs    | 7 +++++++
>  pbs-api-types/src/openid.rs | 7 +++++++
>  4 files changed, 28 insertions(+)
>
> diff --git a/pbs-api-types/src/ad.rs b/pbs-api-types/src/ad.rs
> index 910571a0..5c236325 100644
> --- a/pbs-api-types/src/ad.rs
> +++ b/pbs-api-types/src/ad.rs
> @@ -16,6 +16,10 @@ use super::{
>              optional: true,
>              schema: SINGLE_LINE_COMMENT_SCHEMA,
>          },
> +        "default": {
> +            optional: true,
> +            default: false,
> +        },
>          "verify": {
>              optional: true,
>              default: false,
> @@ -64,6 +68,9 @@ pub struct AdRealmConfig {
>      /// Comment
>      #[serde(skip_serializing_if = "Option::is_none")]
>      pub comment: Option<String>,
> +    /// True if it should be the default realm to login in

tiniest of nit: "realm to login in" sounds wrong. I think you could just
remove everything after realm.

> +    #[serde(skip_serializing_if = "Option::is_none")]
> +    pub default: Option<bool>,
>      /// Connection security
>      #[serde(skip_serializing_if = "Option::is_none")]
>      pub mode: Option<LdapMode>,
> diff --git a/pbs-api-types/src/ldap.rs b/pbs-api-types/src/ldap.rs
> index a3e0407b..79735d93 100644
> --- a/pbs-api-types/src/ldap.rs
> +++ b/pbs-api-types/src/ldap.rs
> @@ -29,6 +29,10 @@ pub enum LdapMode {
>              optional: true,
>              schema: SINGLE_LINE_COMMENT_SCHEMA,
>          },
> +        "default": {
> +            optional: true,
> +            default: false,
> +        },
>          "verify": {
>              optional: true,
>              default: false,
> @@ -75,6 +79,9 @@ pub struct LdapRealmConfig {
>      /// Comment
>      #[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>,
>      /// Connection security
>      #[serde(skip_serializing_if = "Option::is_none")]
>      pub mode: Option<LdapMode>,
> diff --git a/pbs-api-types/src/lib.rs b/pbs-api-types/src/lib.rs
> index acc2fca3..e3896000 100644
> --- a/pbs-api-types/src/lib.rs
> +++ b/pbs-api-types/src/lib.rs
> @@ -356,18 +356,25 @@ serde_plain::derive_fromstr_from_deserialize!(RealmType);
>              optional: true,
>              schema: SINGLE_LINE_COMMENT_SCHEMA,
>          },
> +        "default": {
> +            optional: true,
> +            default: false,
> +        },
>      },
>  )]
>  #[derive(Deserialize, Serialize, Clone, PartialEq)]
>  #[serde(rename_all = "kebab-case")]
>  /// Basic Information about a realm
>  pub struct BasicRealmInfo {
> +    /// Realm name
>      pub realm: String,
> +    // Realm type

nit: this is not a doc-comment, just a regular one

>      #[serde(rename = "type")]
>      pub ty: RealmType,
>      /// True if it is the default realm
>      #[serde(skip_serializing_if = "Option::is_none")]
>      pub default: Option<bool>,
> +    /// Optional comment for this realm
>      #[serde(skip_serializing_if = "Option::is_none")]
>      pub comment: Option<String>,
>  }
> diff --git a/pbs-api-types/src/openid.rs b/pbs-api-types/src/openid.rs
> index 2c95c5c6..e8ec19d9 100644
> --- a/pbs-api-types/src/openid.rs
> +++ b/pbs-api-types/src/openid.rs
> @@ -80,6 +80,10 @@ pub const OPENID_USERNAME_CLAIM_SCHEMA: Schema = StringSchema::new(
>              optional: true,
>              schema: SINGLE_LINE_COMMENT_SCHEMA,
>          },
> +        "default": {
> +            optional: true,
> +            default: false,
> +        },
>          autocreate: {
>              optional: true,
>              default: false,
> @@ -111,6 +115,9 @@ pub struct OpenIdRealmConfig {
>      pub client_key: Option<String>,
>      #[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>,
>      /// Automatically create users if they do not exist.
>      #[serde(skip_serializing_if = "Option::is_none")]
>      pub autocreate: Option<bool>,