uqa-sql 0.6.3

PostgreSQL-compatible SQL compiler built on libpg_query
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
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
//
// Unified Query Algebra
//
// Copyright (c) 2023-2026 Cognica, Inc.
//

//! Semantic base-column privilege analysis for query sources.

pub mod columns;
pub mod coverage;
mod enforcement;

use crate::catalog::roles::RoleReference;
use std::collections::BTreeSet;

use crate::plan::{QueryBlockPlan, QueryPlan, RelationalPlan, SourcePlan};
use crate::SQLError;
use crate::ScalarExpr;

pub mod context;
use context::PrivilegeScope as CteScope;
use enforcement::ensure_required_select;

mod lineage;
mod ownership;
#[cfg(test)]
mod ownership_tests;
use lineage::{
    function_lineage, join_lineage, opaque_columns, opaque_lineage, query_columns,
    relation_lineage, table_lineage, values_lineage,
};
use ownership::{insert_set, require, scopes, Required, SourceLineage};
use uqa_core::memory::{OwnedSet, ProductionControl};

fn is_system_column(column: &str) -> bool {
    matches!(
        column,
        "ctid" | "xmin" | "cmin" | "xmax" | "cmax" | "tableoid"
    )
}

fn collect_column(
    qualifier: Option<&str>,
    column: &str,
    scopes: &[&SourceLineage],
    required: &mut Required,
    control: &ProductionControl<'_>,
) -> Result<(), SQLError> {
    if let Some(qualifier) = qualifier {
        if let Some(scope) = scopes.iter().find(|scope| scope.has_qualifier(qualifier)) {
            scope.require_qualified(qualifier, column, required, control)?;
            if is_system_column(column) {
                scope.require_qualified_system(qualifier, column, required, control)?;
            }
        }
    } else if let Some(scope) = scopes.iter().find(|scope| scope.has_unqualified(column)) {
        scope.require_unqualified(column, required, control)?;
    } else if is_system_column(column) {
        if let Some(scope) = scopes
            .iter()
            .find(|scope| !scope.system_qualifiers.is_empty())
        {
            scope.require_unqualified_system(column, required, control)?;
        }
    }
    Ok(())
}

fn collect_expression_columns(
    expression: &ScalarExpr,
    scopes: &[&SourceLineage],
    direct_star: bool,
    required: &mut Required,
    control: &ProductionControl<'_>,
) -> Result<OwnedSet<usize>, SQLError> {
    control.check()?;
    if direct_star {
        match expression {
            ScalarExpr::Star => {
                if let Some(scope) = scopes.iter().find(|scope| !scope.output.is_empty()) {
                    scope.require_all(required, control)?;
                }
                return Ok(OwnedSet::new());
            }
            ScalarExpr::QualifiedStar(qualifier) => {
                if let Some(scope) = scopes.iter().find(|scope| scope.has_qualifier(qualifier)) {
                    scope.require_qualified_all(qualifier, required, control)?;
                }
                return Ok(OwnedSet::new());
            }
            _ => {}
        }
    }
    let mut subquery_ids = OwnedSet::new();
    expression.try_visit(&mut |node| {
        control.check()?;
        match node {
            ScalarExpr::Column(column) => collect_column(None, column, scopes, required, control)?,
            ScalarExpr::QualifiedColumn {
                qualifier, column, ..
            } => collect_column(Some(qualifier), column, scopes, required, control)?,
            ScalarExpr::QualifiedStar(qualifier) => {
                if let Some(scope) = scopes.iter().find(|scope| scope.has_qualifier(qualifier)) {
                    scope.require_qualified_all(qualifier, required, control)?;
                }
            }
            ScalarExpr::ScalarSubquery(subquery)
            | ScalarExpr::Exists { subquery, .. }
            | ScalarExpr::InSubquery { subquery, .. } => {
                insert_set(&mut subquery_ids, *subquery, control)?;
            }
            _ => {}
        }
        Ok::<bool, SQLError>(true)
    })?;
    Ok(subquery_ids)
}

fn collect_expression_and_subqueries(
    expression: &ScalarExpr,
    scopes: &[&SourceLineage],
    direct_star: bool,
    subqueries: &[QueryPlan],
    ctes: &CteScope<'_, impl AsRef<[QueryPlan]>>,
    universe: &mut SourceLineage,
    required: &mut Required,
) -> Result<(), SQLError> {
    for subquery in
        collect_expression_columns(expression, scopes, direct_star, required, &ctes.control())?
    {
        let plan = subqueries.get(subquery).ok_or_else(|| {
            SQLError::Internal(format!(
                "column privilege analysis cannot resolve scalar subquery slot {subquery}"
            ))
        })?;
        analyze_query_plan(plan, ctes, scopes, universe, required)?;
    }
    Ok(())
}

fn analyze_join_source_lineage(
    source: &SourcePlan,
    outer_scopes: &[&SourceLineage],
    subqueries: &[QueryPlan],
    ctes: &CteScope<'_, impl AsRef<[QueryPlan]>>,
    universe: &mut SourceLineage,
    required: &mut Required,
) -> Result<SourceLineage, SQLError> {
    let SourcePlan::Join {
        left,
        right,
        on,
        using,
        natural,
        alias,
        column_aliases,
        ..
    } = source
    else {
        unreachable!("join lineage helper requires a join source")
    };
    let left = analyze_source_lineage(left, outer_scopes, subqueries, ctes, universe, required)?;
    let right_scopes = scopes(&left, outer_scopes, ctes.control())?;
    let right = analyze_source_lineage(right, &right_scopes, subqueries, ctes, universe, required)?;
    if let Some(on) = on {
        let inputs = join_lineage(
            left.copy(&ctes.control())?,
            right.copy(&ctes.control())?,
            None,
            false,
            None,
            &[],
            &ctes.control(),
        )?;
        let condition_scopes = scopes(&inputs, outer_scopes, ctes.control())?;
        collect_expression_and_subqueries(
            on,
            &condition_scopes,
            false,
            subqueries,
            ctes,
            universe,
            required,
        )?;
    }
    if let Some(using) = using {
        for column in &using.columns {
            left.require_unqualified(column, required, &ctes.control())?;
            right.require_unqualified(column, required, &ctes.control())?;
        }
    } else if *natural {
        for column in left
            .output
            .iter()
            .filter(|left| right.output.iter().any(|right| right.name == left.name))
        {
            left.require_unqualified(&column.name, required, &ctes.control())?;
            right.require_unqualified(&column.name, required, &ctes.control())?;
        }
    }
    join_lineage(
        left,
        right,
        using.as_ref(),
        *natural,
        alias.as_deref(),
        column_aliases,
        &ctes.control(),
    )
}

fn analyze_function_group_lineage(
    source: &SourcePlan,
    outer_scopes: &[&SourceLineage],
    subqueries: &[QueryPlan],
    ctes: &CteScope<'_, impl AsRef<[QueryPlan]>>,
    universe: &mut SourceLineage,
    required: &mut Required,
) -> Result<SourceLineage, SQLError> {
    let SourcePlan::FunctionGroup {
        functions,
        alias,
        column_aliases,
        ..
    } = source
    else {
        unreachable!("function-group lineage helper requires a function group")
    };
    for expression in functions.iter().flat_map(|function| &function.args) {
        collect_expression_and_subqueries(
            expression,
            outer_scopes,
            false,
            subqueries,
            ctes,
            universe,
            required,
        )?;
    }
    let control = ctes.control();
    let columns = if column_aliases.is_empty() {
        opaque_columns(
            functions.iter().flat_map(|function| {
                let columns = if function.column_aliases.is_empty() {
                    std::slice::from_ref(&function.output_name)
                } else {
                    function.column_aliases.as_slice()
                };
                columns.iter().map(String::as_str)
            }),
            &control,
        )?
    } else {
        opaque_columns(column_aliases.iter().map(String::as_str), &control)?
    };
    opaque_lineage(columns, alias.as_deref(), &control)
}

fn analyze_source_lineage(
    source: &SourcePlan,
    outer_scopes: &[&SourceLineage],
    subqueries: &[QueryPlan],
    ctes: &CteScope<'_, impl AsRef<[QueryPlan]>>,
    universe: &mut SourceLineage,
    required: &mut Required,
) -> Result<SourceLineage, SQLError> {
    match source {
        crate::plan::SourcePlan::RetainedRows(_) => Ok(SourceLineage::default()),
        SourcePlan::Table {
            name,
            qualifier,
            alias,
            column_aliases,
            ..
        } => table_lineage(name, qualifier, alias.as_deref(), column_aliases, ctes),
        source @ SourcePlan::Join { .. } => {
            analyze_join_source_lineage(source, outer_scopes, subqueries, ctes, universe, required)
        }
        SourcePlan::Values {
            rows,
            alias,
            column_aliases,
            ..
        } => {
            for expression in rows.iter().flatten() {
                collect_expression_and_subqueries(
                    expression,
                    outer_scopes,
                    false,
                    subqueries,
                    ctes,
                    universe,
                    required,
                )?;
            }
            values_lineage(rows, alias.as_deref(), column_aliases, &ctes.control())
        }
        SourcePlan::Function {
            name,
            output_name,
            args,
            alias,
            column_aliases,
            ..
        } => {
            for expression in args {
                collect_expression_and_subqueries(
                    expression,
                    outer_scopes,
                    false,
                    subqueries,
                    ctes,
                    universe,
                    required,
                )?;
            }
            function_lineage(
                name,
                output_name,
                alias.as_deref(),
                column_aliases,
                &ctes.control(),
            )
        }
        source @ SourcePlan::FunctionGroup { .. } => analyze_function_group_lineage(
            source,
            outer_scopes,
            subqueries,
            ctes,
            universe,
            required,
        ),
        SourcePlan::Subquery {
            body,
            alias,
            column_aliases,
            ..
        } => {
            analyze_query_plan(body, ctes, outer_scopes, universe, required)?;
            let columns = query_columns(body, column_aliases, &ctes.control())?;
            opaque_lineage(columns, alias.as_deref(), &ctes.control())
        }
    }
}

fn analyze_query_block(
    block: &QueryBlockPlan,
    source: Option<&SourcePlan>,
    ctes: &CteScope<'_, impl AsRef<[QueryPlan]>>,
    outer_scopes: &[&SourceLineage],
    universe: &mut SourceLineage,
    required: &mut Required,
) -> Result<(), SQLError> {
    let lineage = source.map_or_else(
        || Ok(SourceLineage::default()),
        |source| {
            analyze_source_lineage(
                source,
                outer_scopes,
                &block.subqueries,
                ctes,
                universe,
                required,
            )
        },
    )?;
    universe.include_tables(&lineage, &ctes.control())?;
    let scopes = scopes(&lineage, outer_scopes, ctes.control())?;
    for column in block
        .privilege_columns
        .iter()
        .filter(|_| ctes.include_authorization_only_columns)
    {
        collect_column(
            column.qualifier(),
            column.column(),
            &scopes,
            required,
            &ctes.control(),
        )?;
    }
    for projection in &block.projections {
        collect_expression_and_subqueries(
            &projection.expr,
            &scopes,
            true,
            &block.subqueries,
            ctes,
            universe,
            required,
        )?;
    }
    for expression in block
        .r#where
        .iter()
        .chain(block.group_by.iter())
        .chain(block.grouping_sets.iter().flatten())
        .chain(block.having.iter())
        .chain(block.order_by.iter().map(|order| &order.expr))
        .chain(block.distinct_on.iter())
        .chain(block.limit.iter())
        .chain(block.offset.iter())
    {
        collect_expression_and_subqueries(
            expression,
            &scopes,
            false,
            &block.subqueries,
            ctes,
            universe,
            required,
        )?;
    }
    Ok(())
}

fn analyze_query_plan(
    plan: &QueryPlan,
    ctes: &CteScope<'_, impl AsRef<[QueryPlan]>>,
    outer_scopes: &[&SourceLineage],
    universe: &mut SourceLineage,
    required: &mut Required,
) -> Result<(), SQLError> {
    let mut root_ctes = ctes.reborrow()?;
    root_ctes
        .resolution
        .set_lookup_mode(if plan.relations_bound {
            crate::catalog::resolution::RelationLookupMode::Bound
        } else {
            crate::catalog::resolution::RelationLookupMode::Dynamic
        });
    if let Some(subject) = &plan.relation_privilege_subject {
        root_ctes.relation_privilege_subject = Some(subject.clone_with_control(&ctes.control())?);
        let mut owned_universe = SourceLineage::default();
        let mut owned_required = Required::new();
        analyze_query_plan_in_scope(
            plan,
            &root_ctes,
            outer_scopes,
            &mut owned_universe,
            &mut owned_required,
        )?;
        return ensure_required_select(&owned_universe, &owned_required, &root_ctes);
    }
    analyze_query_plan_in_scope(plan, &root_ctes, outer_scopes, universe, required)
}

fn analyze_query_plan_in_scope(
    plan: &QueryPlan,
    ctes: &CteScope<'_, impl AsRef<[QueryPlan]>>,
    outer_scopes: &[&SourceLineage],
    universe: &mut SourceLineage,
    required: &mut Required,
) -> Result<(), SQLError> {
    let reachable =
        crate::semantics::cte_order::analysis::CteAnalysis::query(plan, ctes.control())?
            .reachable()?;
    let mut root_ctes = ctes.reborrow()?;
    let mut preceding_ctes = root_ctes.reborrow()?;
    for (index, cte) in plan.ctes.iter().enumerate() {
        if reachable[index] {
            let mut definition_ctes = preceding_ctes.reborrow()?;
            if cte.recursive {
                for local in &plan.ctes {
                    definition_ctes.insert_deferred_ref(local)?;
                }
            }
            if let Some(query) = cte.body.query() {
                analyze_query_plan(query, &definition_ctes, outer_scopes, universe, required)?;
            }
        }
        preceding_ctes.insert_deferred_ref(cte)?;
    }
    for cte in &plan.ctes {
        root_ctes.insert_deferred_ref(cte)?;
    }
    match &plan.root {
        RelationalPlan::QueryBlock(block) => analyze_query_block(
            block,
            block.from.as_ref(),
            &root_ctes,
            outer_scopes,
            universe,
            required,
        ),
        RelationalPlan::SetOp {
            left,
            right,
            order_by,
            limit,
            offset,
            subqueries,
            ..
        } => {
            analyze_query_plan(left, &root_ctes, outer_scopes, universe, required)?;
            analyze_query_plan(right, &root_ctes, outer_scopes, universe, required)?;
            let result_scope = opaque_lineage(
                query_columns(left, &[], &ctes.control())?,
                None,
                &ctes.control(),
            )?;
            let scopes = scopes(&result_scope, outer_scopes, ctes.control())?;
            for expression in order_by
                .iter()
                .map(|order| &order.expr)
                .chain(limit.iter().map(Box::as_ref))
                .chain(offset.iter().map(Box::as_ref))
            {
                collect_expression_and_subqueries(
                    expression, &scopes, false, subqueries, &root_ctes, universe, required,
                )?;
            }
            Ok(())
        }
        RelationalPlan::Values { rows, subqueries } => {
            for expression in rows.iter().flatten() {
                collect_expression_and_subqueries(
                    expression,
                    outer_scopes,
                    false,
                    subqueries,
                    &root_ctes,
                    universe,
                    required,
                )?;
            }
            Ok(())
        }
    }
}

pub fn ensure_select_privileges_for_query(
    query: &QueryPlan,
    ctes: &CteScope<'_, impl AsRef<[QueryPlan]>>,
) -> Result<(), SQLError> {
    let mut universe = SourceLineage::default();
    let mut required = Required::new();
    analyze_query_plan(query, ctes, &[], &mut universe, &mut required)?;
    ensure_required_select(&universe, &required, ctes)
}

pub fn ensure_select_privileges_for_query_block(
    statement: &QueryBlockPlan,
    source: &SourcePlan,
    ctes: &CteScope<'_, impl AsRef<[QueryPlan]>>,
) -> Result<(), SQLError> {
    let mut universe = SourceLineage::default();
    let mut required = Required::new();
    analyze_query_block(
        statement,
        Some(source),
        ctes,
        &[],
        &mut universe,
        &mut required,
    )?;
    ensure_required_select(&universe, &required, ctes)
}

pub fn ensure_select_privileges_for_source_expressions(
    source: &SourcePlan,
    expressions: &[&ScalarExpr],
    ctes: &CteScope<'_, impl AsRef<[QueryPlan]>>,
) -> Result<(), SQLError> {
    let (universe, required) = source_expression_dependencies(source, expressions, ctes)?;
    ensure_required_select(&universe, &required, ctes)
}

fn source_expression_dependencies(
    source: &SourcePlan,
    expressions: &[&ScalarExpr],
    ctes: &CteScope<'_, impl AsRef<[QueryPlan]>>,
) -> Result<(SourceLineage, Required), SQLError> {
    let mut universe = SourceLineage::default();
    let mut required = Required::new();
    let lineage = analyze_source_lineage(
        source,
        &[],
        ctes.scalar_subqueries.as_ref(),
        ctes,
        &mut universe,
        &mut required,
    )?;
    universe.include_tables(&lineage, &ctes.control())?;
    let scopes = [&lineage];
    for expression in expressions {
        collect_expression_and_subqueries(
            expression,
            &scopes,
            matches!(expression, ScalarExpr::QualifiedStar(_)),
            ctes.scalar_subqueries.as_ref(),
            ctes,
            &mut universe,
            &mut required,
        )?;
    }
    Ok((universe, required))
}

pub fn ensure_select_privileges_for_table_expressions(
    table: &str,
    qualifiers: &BTreeSet<String>,
    expressions: &[&ScalarExpr],
    subqueries: &[QueryPlan],
    required_columns: &[String],
    ctes: &CteScope<'_, impl AsRef<[QueryPlan]>>,
) -> Result<(), SQLError> {
    let (universe, required) = table_expression_dependencies(
        table,
        qualifiers.iter().map(String::as_str),
        expressions,
        subqueries,
        required_columns,
        ctes,
    )?;
    ensure_required_select(&universe, &required, ctes)
}

fn table_expression_dependencies<'a>(
    table: &str,
    qualifiers: impl IntoIterator<Item = &'a str>,
    expressions: &[&ScalarExpr],
    subqueries: &[QueryPlan],
    required_columns: &[String],
    ctes: &CteScope<'_, impl AsRef<[QueryPlan]>>,
) -> Result<(SourceLineage, Required), SQLError> {
    let control = ctes.control();
    let mut resolution = ctes.resolution.copy_with_control(&control)?;
    resolution.set_lookup_mode(crate::catalog::resolution::RelationLookupMode::Bound);
    let Some(relation) = ctes
        .catalog
        .relation_with_control(&resolution, table, &control)?
    else {
        return Err(SQLError::UnknownTable(table.to_string()));
    };
    let lineage = relation_lineage(&relation, qualifiers, &[], &control)?;
    let mut universe = SourceLineage::default();
    let mut required = Required::new();
    for column in required_columns {
        require(&mut required, &relation.canonical, column, &control)?;
    }
    let scopes = [&lineage];
    for expression in expressions {
        collect_expression_and_subqueries(
            expression,
            &scopes,
            true,
            subqueries,
            ctes,
            &mut universe,
            &mut required,
        )?;
    }
    if required
        .iter()
        .any(|column| column.table.as_str() == relation.canonical)
    {
        universe.include_tables(&lineage, &ctes.control())?;
    }
    Ok((universe, required))
}

pub struct TargetSelectPrivilegeRequest<'a, 'expr> {
    pub table: &'a str,
    pub privilege_subject: Option<&'a RoleReference>,
    pub target_qualifier: &'a str,
    pub returning_aliases: &'a crate::ast::ReturningAliases,
    pub expressions: &'a [&'expr ScalarExpr],
    pub subqueries: &'a [QueryPlan],
    pub required_columns: &'a [String],
}

/// Target authorization borrows the command's arena and overrides only the requested authority.
pub fn ensure_target_select(
    request: TargetSelectPrivilegeRequest<'_, '_>,
    inherited: &CteScope<'_, impl AsRef<[QueryPlan]>>,
) -> Result<(), SQLError> {
    let control = inherited.control();
    control.check()?;
    let relation = uqa_core::RelationIdentity::try_borrowed_reference(request.table)
        .map_err(|error| SQLError::Internal(error.to_string()))?;
    let name = control.format(format_args!("{}", relation.name))?;
    let mut qualifiers = [
        request.target_qualifier,
        request.table,
        name.as_str(),
        request.returning_aliases.old.as_str(),
        request.returning_aliases.new.as_str(),
    ];
    qualifiers.sort_unstable();
    let mut scope = inherited.reborrow()?;
    scope.scalar_subqueries = request.subqueries;
    if let Some(subject) = request.privilege_subject {
        scope.relation_privilege_subject = Some(subject.clone_with_control(&control)?);
    }
    let (universe, required) = table_expression_dependencies(
        request.table,
        qualifiers.iter().enumerate().filter_map(|(index, value)| {
            (index == 0 || qualifiers[index - 1] != *value).then_some(*value)
        }),
        request.expressions,
        request.subqueries,
        request.required_columns,
        &scope,
    )?;
    ensure_required_select(&universe, &required, &scope)
}