Skip to content

tighten internal-entity topic protection and drop dead pub api #63

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fabracht merged 1 commit into from
May 20, 2026
Merged

tighten internal-entity topic protection and drop dead pub api #63

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 9 additions & 70 deletions crates/mqdb-agent/src/topic_rules.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,26 +53,10 @@ pub const PROTECTED_TOPICS: &[TopicRule] = &[
pattern: "$SYS/#",
tier: ProtectionTier::ReadOnly,
},
TopicRule {
pattern: "$DB/_admin/#",
tier: ProtectionTier::AdminRequired,
},
TopicRule {
pattern: "$DB/_verify/#",
tier: ProtectionTier::AdminRequired,
},
TopicRule {
pattern: "$DB/_oauth_tokens/#",
tier: ProtectionTier::AdminRequired,
},
TopicRule {
pattern: "$DB/_identities/#",
tier: ProtectionTier::AdminRequired,
},
TopicRule {
pattern: "$DB/_identity_links/#",
tier: ProtectionTier::AdminRequired,
},
];

#[derive(Debug, Clone, PartialEq, Eq)]
Expand Down Expand Up @@ -202,22 +186,6 @@ pub fn check_topic_access(
Ok(())
}

#[must_use]
pub fn is_internal_entity(entity: &str) -> bool {
entity.starts_with('_')
}

/// # Errors
///
/// Returns `Err(BlockReason::InternalEntityAccess)` if the entity is internal and user is not admin.
pub fn check_entity_access(entity: &str, is_admin: bool) -> Result<(), BlockReason> {
if is_internal_entity(entity) && !is_admin {
Err(BlockReason::InternalEntityAccess)
} else {
Ok(())
}
}

#[cfg(test)]
mod tests {
use super::*;
Expand Down Expand Up @@ -337,24 +305,24 @@ mod tests {
}

#[test]
fn check_access_admin_required() {
fn check_access_admin_topics_block_non_admin() {
assert_eq!(
check_topic_access("$DB/_admin/backup", true, false),
Err(BlockReason::AdminRequired)
Err(BlockReason::InternalEntityAccess)
);
assert_eq!(
check_topic_access("$DB/_admin/backup", false, false),
Err(BlockReason::AdminRequired)
Err(BlockReason::InternalEntityAccess)
);
assert_eq!(check_topic_access("$DB/_admin/backup", true, true), Ok(()));
assert_eq!(check_topic_access("$DB/_admin/backup", false, true), Ok(()));
}

#[test]
fn check_access_oauth_tokens_admin_required() {
fn check_access_oauth_tokens_block_non_admin() {
assert_eq!(
check_topic_access("$DB/_oauth_tokens/list", true, false),
Err(BlockReason::AdminRequired)
Err(BlockReason::InternalEntityAccess)
);
assert_eq!(
check_topic_access("$DB/_oauth_tokens/abc123", true, true),
Expand All @@ -363,10 +331,10 @@ mod tests {
}

#[test]
fn check_access_identities_admin_required() {
fn check_access_identities_block_non_admin() {
assert_eq!(
check_topic_access("$DB/_identities/list", true, false),
Err(BlockReason::AdminRequired)
Err(BlockReason::InternalEntityAccess)
);
assert_eq!(
check_topic_access("$DB/_identities/create", true, true),
Expand All @@ -375,10 +343,10 @@ mod tests {
}

#[test]
fn check_access_identity_links_admin_required() {
fn check_access_identity_links_block_non_admin() {
assert_eq!(
check_topic_access("$DB/_identity_links/list", true, false),
Err(BlockReason::AdminRequired)
Err(BlockReason::InternalEntityAccess)
);
assert_eq!(
check_topic_access("$DB/_identity_links/google:123", true, true),
Expand Down Expand Up @@ -420,35 +388,6 @@ mod tests {
);
}

#[test]
fn check_entity_access_internal_blocked() {
assert_eq!(
check_entity_access("_sessions", false),
Err(BlockReason::InternalEntityAccess)
);
assert_eq!(
check_entity_access("_mqtt_subs", false),
Err(BlockReason::InternalEntityAccess)
);
assert_eq!(
check_entity_access("_topic_index", false),
Err(BlockReason::InternalEntityAccess)
);
}

#[test]
fn check_entity_access_admin_allowed() {
assert_eq!(check_entity_access("_sessions", true), Ok(()));
assert_eq!(check_entity_access("_mqtt_subs", true), Ok(()));
}

#[test]
fn check_entity_access_regular_allowed() {
assert_eq!(check_entity_access("users", false), Ok(()));
assert_eq!(check_entity_access("posts", false), Ok(()));
assert_eq!(check_entity_access("orders", true), Ok(()));
}

#[test]
fn check_access_internal_entity_topic() {
assert_eq!(
Expand Down
Loading