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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239

// SPDX-License-Identifier: BUSL-1.1

//! Protocol-neutral EXPLAIN PERMISSION and policy introspection DDL commands.
//!
//! ```sql
//! EXPLAIN PERMISSION READ ON orders FOR AUTH USER 'user_123'
//! EXPLAIN SCOPE FOR AUTH USER 'user_123'
//! ```
//!
//! Ported from the pgwire `ddl::explain_ddl` handlers. The permission /
//! scope evaluation reads and the synthetic-identity construction are
//! preserved verbatim; only the result construction changed from pgwire
//! `Response` / `QueryResponse` to the protocol-neutral `DdlResult` over
//! `ShapedRows`.

use serde_json::{Map, Value as JsonValue};

use crate::control::security::identity::AuthenticatedIdentity;
use crate::control::server::response_shape::types::ShapedRows;
use crate::control::state::SharedState;

use super::super::result::{DdlError, DdlResult};

/// Build a [`DdlError`] from an ANSI SQLSTATE code and a message.
///
/// Preserves the exact SQLSTATE / message the pgwire explain handlers
/// produced (via `sqlstate_error`), so error parity stays byte-identical
/// after the migration off the pgwire router.
fn ddl_err(sqlstate: &str, message: impl Into<String>) -> DdlError {
    DdlError {
        sqlstate: sqlstate.to_string(),
        message: message.into(),
    }
}

/// EXPLAIN PERMISSION <perm> ON <collection> FOR AUTH USER '<id>'
pub fn explain_permission(
    state: &SharedState,
    identity: &AuthenticatedIdentity,
    parts: &[&str],
) -> Result<Vec<DdlResult>, DdlError> {
    // EXPLAIN PERMISSION READ ON orders FOR AUTH USER 'user_123'
    if parts.len() < 8 {
        return Err(ddl_err(
            "42601",
            "syntax: EXPLAIN PERMISSION <perm> ON <collection> FOR AUTH USER '<id>'",
        ));
    }
    let perm = parts[2];
    let collection = parts[4];
    let user_id_str = parts.get(7).map(|s| s.trim_matches('\'')).unwrap_or("");

    // Build a synthetic identity for the target user.
    let target_identity = if let Some(user) = state.credentials.get_user(user_id_str) {
        {
            let is_su = user.is_superuser;
            crate::control::security::identity::AuthenticatedIdentity {
                user_id: user.user_id,
                username: user.username.clone(),
                tenant_id: user.tenant_id,
                auth_method: crate::control::security::identity::AuthMethod::Trust,
                roles: user.roles.clone(),
                is_superuser: is_su,
                default_database: None,
                accessible_databases:
                    crate::control::security::identity::AuthenticatedIdentity::default_database_set(
                        is_su,
                    ),
            }
        }
    } else {
        // Unknown user — use the requesting identity.
        identity.clone()
    };

    let auth_ctx = crate::control::server::session_auth::build_auth_context(&target_identity);
    let explanation = crate::control::security::explain::explain_permission(
        perm,
        collection,
        &target_identity,
        &auth_ctx,
        state,
    );

    let columns = vec![
        "check".to_string(),
        "result".to_string(),
        "source".to_string(),
    ];

    let mut rows: Vec<Map<String, JsonValue>> = explanation
        .steps
        .iter()
        .map(|s| {
            let mut row = Map::new();
            row.insert("check".to_string(), JsonValue::String(s.check.clone()));
            row.insert("result".to_string(), JsonValue::String(s.result.clone()));
            row.insert("source".to_string(), JsonValue::String(s.source.clone()));
            row
        })
        .collect();

    // Final result row.
    let mut row = Map::new();
    row.insert("check".to_string(), JsonValue::String("FINAL".to_string()));
    row.insert(
        "result".to_string(),
        JsonValue::String((if explanation.allowed { "ALLOW" } else { "DENY" }).to_string()),
    );
    row.insert(
        "source".to_string(),
        JsonValue::String(format!("{} on {}", perm, collection)),
    );
    rows.push(row);

    Ok(vec![DdlResult::Rows(ShapedRows {
        columns,
        column_types: ShapedRows::text_types(3),
        rows,
        notice: None,
    })])
}

/// EXPLAIN SCOPE FOR AUTH USER '<id>'
pub fn explain_scope(
    state: &SharedState,
    _identity: &AuthenticatedIdentity,
    parts: &[&str],
) -> Result<Vec<DdlResult>, DdlError> {
    if parts.len() < 6 {
        return Err(ddl_err(
            "42601",
            "syntax: EXPLAIN SCOPE FOR AUTH USER '<id>'",
        ));
    }
    let user_id = parts.get(5).map(|s| s.trim_matches('\'')).unwrap_or("");
    let org_ids = state.orgs.orgs_for_user(user_id);
    let effective = state.scope_grants.effective_scopes(user_id, &org_ids);

    let columns = vec![
        "scope".to_string(),
        "source".to_string(),
        "resolved_grants".to_string(),
    ];

    let rows: Vec<Map<String, JsonValue>> = effective
        .iter()
        .map(|scope_name| {
            let source = if state
                .scope_grants
                .scopes_for("user", user_id)
                .contains(scope_name)
            {
                "direct (user)"
            } else {
                "inherited (org)"
            };
            let resolved = state.scope_defs.resolve(scope_name);
            let grants_str: Vec<String> = resolved
                .iter()
                .map(|(p, c)| format!("{p} ON {c}"))
                .collect();

            let mut row = Map::new();
            row.insert("scope".to_string(), JsonValue::String(scope_name.clone()));
            row.insert("source".to_string(), JsonValue::String(source.to_string()));
            row.insert(
                "resolved_grants".to_string(),
                JsonValue::String(grants_str.join(", ")),
            );
            row
        })
        .collect();

    Ok(vec![DdlResult::Rows(ShapedRows {
        columns,
        column_types: ShapedRows::text_types(3),
        rows,
        notice: None,
    })])
}

/// `SELECT nodedb_assert_visible('<collection>', '<row_id>', '<user_id>')`
///
/// Test helper: returns true/false whether a row is visible to a user under RLS.
pub fn assert_visible(
    state: &SharedState,
    _identity: &AuthenticatedIdentity,
    parts: &[&str],
) -> Result<Vec<DdlResult>, DdlError> {
    // Parse: nodedb_assert_visible('collection', 'row_id', 'user_id')
    if parts.len() < 4 {
        return Err(ddl_err(
            "42601",
            "syntax: SELECT nodedb_assert_visible('<collection>', '<row_id>', '<user_id>')",
        ));
    }

    let collection = parts[1].trim_matches('\'').trim_end_matches(',');
    let _row_id = parts[2].trim_matches('\'').trim_end_matches(',');
    let user_id = parts[3].trim_matches('\'').trim_end_matches(')');

    // Build AuthContext for the target user.
    let target_identity = crate::control::security::identity::AuthenticatedIdentity {
        user_id: user_id.parse().unwrap_or(0),
        username: user_id.to_string(),
        tenant_id: crate::types::TenantId::new(1),
        auth_method: crate::control::security::identity::AuthMethod::Trust,
        roles: vec![crate::control::security::identity::Role::ReadWrite],
        is_superuser: false,
        default_database: None,
        accessible_databases: crate::control::security::identity::DatabaseSet::Some(
            smallvec::smallvec![nodedb_types::id::DatabaseId::DEFAULT],
        ),
    };
    let auth_ctx = crate::control::server::session_auth::build_auth_context(&target_identity);

    // Check if RLS policies would filter this user.
    let rls_bytes = state.rls.combined_read_predicate_with_auth(
        target_identity.tenant_id.as_u64(),
        collection,
        &auth_ctx,
    );

    let visible = rls_bytes.is_some_and(|b| b.is_empty()); // No filters = visible.

    let mut row = Map::new();
    row.insert(
        "visible".to_string(),
        JsonValue::String(visible.to_string()),
    );

    Ok(vec![DdlResult::Rows(ShapedRows {
        columns: vec!["visible".to_string()],
        column_types: ShapedRows::text_types(1),
        rows: vec![row],
        notice: None,
    })])
}