nodedb 0.4.0

Local-first, real-time, edge-to-cloud hybrid database for multi-modal workloads
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

//! Physical-plan authorization requirements.
//!
//! This deliberately does not use `shared::plan_util::extract_collection`: a
//! single collection cannot represent joins or source/target DML correctly.

#![deny(clippy::wildcard_enum_match_arm)]

use crate::control::security::identity::Permission;

mod collect;
mod order;
mod query;

pub use collect::plan_requirements;

/// A protected resource and the permission needed to use it.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum AuthorizationRequirement {
    /// A collection-scoped operation. The name is the physical-plan name and
    /// may be database-qualified; the authorization service normalizes it to
    /// the grant-store name before looking up grants.
    Collection {
        collection: String,
        permission: Permission,
    },
    /// An operation with no collection-level resource, such as an array or a
    /// tenant-wide maintenance action. It must still be authorized at tenant
    /// scope rather than silently allowed.
    Tenant { permission: Permission },
}

impl AuthorizationRequirement {
    fn collection(collection: impl Into<String>, permission: Permission) -> Self {
        Self::Collection {
            collection: collection.into(),
            permission,
        }
    }

    fn tenant(permission: Permission) -> Self {
        Self::Tenant { permission }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use nodedb_physical::physical_plan::{CrdtOp, DocumentOp, KvOp, MetaOp, QueryOp};

    #[test]
    fn insert_select_requires_source_read_and_target_write() {
        let plan = crate::bridge::envelope::PhysicalPlan::Document(DocumentOp::InsertSelect {
            target_collection: "target".into(),
            source_collection: "source".into(),
            source_filters: Vec::new(),
            source_limit: 0,
        });

        assert_eq!(
            plan_requirements(&plan),
            vec![
                AuthorizationRequirement::collection("source", Permission::Read),
                AuthorizationRequirement::collection("target", Permission::Write),
            ]
        );
    }

    fn provider_scan(provider: Option<&str>) -> crate::bridge::envelope::PhysicalPlan {
        crate::bridge::envelope::PhysicalPlan::Query(QueryOp::ProviderScan {
            provider: provider.map(str::to_owned),
            rows: Vec::new(),
            filters: Vec::new(),
            projection: Vec::new(),
            sort_keys: Vec::new(),
            limit: None,
            offset: 0,
            distinct: false,
        })
    }

    #[test]
    fn resource_less_provider_scan_requires_tenant_permission() {
        assert_eq!(
            plan_requirements(&provider_scan(Some("_system.audit_log"))),
            vec![AuthorizationRequirement::collection(
                "_system.audit_log",
                Permission::Read,
            )]
        );
        assert_eq!(
            plan_requirements(&provider_scan(None)),
            vec![AuthorizationRequirement::tenant(Permission::Read)]
        );
    }

    #[test]
    fn nested_resource_less_plan_keeps_tenant_fallback() {
        let plan = crate::bridge::envelope::PhysicalPlan::Meta(MetaOp::TransactionBatch {
            plans: vec![provider_scan(None)],
            txn_id: None,
        });
        assert_eq!(
            plan_requirements(&plan),
            vec![AuthorizationRequirement::tenant(Permission::Read)]
        );
    }

    #[test]
    fn crdt_constraint_reads_remain_collection_scoped() {
        let plan = crate::bridge::envelope::PhysicalPlan::Crdt(CrdtOp::ReadConstraints {
            collection: "documents".into(),
        });
        assert_eq!(
            plan_requirements(&plan),
            vec![AuthorizationRequirement::collection(
                "documents",
                Permission::Read,
            )]
        );
    }

    #[test]
    fn nested_collection_plan_does_not_require_tenant_permission() {
        let plan = crate::bridge::envelope::PhysicalPlan::Meta(MetaOp::TransactionBatch {
            plans: vec![crate::bridge::envelope::PhysicalPlan::Kv(KvOp::Get {
                collection: "orders".into(),
                key: Vec::new(),
                rls_filters: Vec::new(),
                surrogate_ceiling: None,
            })],
            txn_id: None,
        });
        assert_eq!(
            plan_requirements(&plan),
            vec![AuthorizationRequirement::collection(
                "orders",
                Permission::Read,
            )]
        );
    }
}