Closes the threat model's headline finding for the SQL query path:
enterprise/internal/tenantprovision does real CREATE DATABASE/USER/GRANT
against ClickHouse, and enterprise/internal/chrunner is a per-tenant
connection registry implementing api's SQLRunner interface, resolving
the tenant from the authenticated request identity -- never a
caller-suppliable parameter. Both are wired into a new binary,
enterprise/cmd/enterprise-api, alongside the unchanged single-tenant
api/cmd/api, since AGPL core can never import enterprise/ and Go's own
internal/ package visibility rules meant enterprise/ couldn't implement
core's SQLRunner interface without importing the package that defines
it. That required moving api/internal/{authz,queryapi,dashboards,
querylang/executor,searchclient,httpserver} out of internal/ -- the
minimal set enterprise-api needs to import; querylang's compiler
internals (planner/lexer/parser/ast/ir) and api's own config stay
internal, since nothing outside api needs them directly.
Also finally wires enterprise/internal/audit into queryapi.AuditLogger
(nil since Phase 4 task 4) via a new adapter, and adds live-ClickHouse
integration tests for two of the four adversarial probes named in
docs/phase-4-isolation-design.md's verification plan.
Corrected several overclaims in the docs while writing this up: an
earlier claim that rbacstore's CRUD was "verified against a live
Postgres" was never actually true in this environment (only
internal/audit was, earlier in this phase, before Docker access was
lost) -- threat-model.md, phase-4-runbook.md, CLAUDE.md, and
enterprise/README.md all now distinguish "a real integration test
exists" from "this was confirmed against a live database."
Still not built: Tantivy/free-text tenant isolation
(enterprise/internal/searchclient), and any deployment-topology
mechanism that actually routes traffic to enterprise-api instead of
plain api -- both binaries exist side by side today with nothing
enforcing or flagging which one a deployment runs.
367 lines
14 KiB
Go
367 lines
14 KiB
Go
// Package rbacstore is the pgx-backed CRUD layer over the tenant/user/
|
|
// role schema (metadata/migrations/0017-0021) described in
|
|
// /docs/phase-4-rbac-design.md: users (global SSO identity), tenants,
|
|
// and tenant_memberships (per-tenant role). It uses the same shared
|
|
// "sentry" Postgres role/pool every other metadata store does (unlike
|
|
// enterprise/internal/audit's deliberately separate, narrower-granted
|
|
// pool) -- ordinary read/write CRUD on control-plane config, not an
|
|
// append-only ledger, so it has no analogous reason to restrict its own
|
|
// write access.
|
|
//
|
|
// This package is the storage building block a future OIDC/SAML login
|
|
// HTTP handler would call to resolve "which tenant/role does this SSO
|
|
// identity map to" and issue a session (internal/session) accordingly --
|
|
// that handler itself isn't built yet (see cmd/enterprise-auth/main.go's
|
|
// doc comment), so today rbacstore's only production caller is
|
|
// -mint-service-token's future tenant-aware successor and its own tests.
|
|
// dashboard_permissions doesn't have CRUD here yet -- no caller reads
|
|
// per-resource grants (see api/dashboards/handler.go's doc
|
|
// comment). data_sources CRUD was added once enterprise/internal/
|
|
// chrunner needed a real place to read per-tenant ClickHouse credentials
|
|
// from at startup (see that package's doc comment).
|
|
package rbacstore
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
"time"
|
|
|
|
"github.com/google/uuid"
|
|
"github.com/jackc/pgx/v5"
|
|
"github.com/jackc/pgx/v5/pgxpool"
|
|
)
|
|
|
|
// ErrNotFound is returned by Get-shaped methods when the row doesn't exist.
|
|
var ErrNotFound = errors.New("rbacstore: not found")
|
|
|
|
type User struct {
|
|
ID string
|
|
Email string
|
|
DisplayName string
|
|
SSOSubject string
|
|
CreatedAt time.Time
|
|
UpdatedAt time.Time
|
|
}
|
|
|
|
type Tenant struct {
|
|
ID string
|
|
DisplayName string
|
|
Status string
|
|
OwnerUserID string // empty until a first Owner is assigned
|
|
CreatedAt time.Time
|
|
UpdatedAt time.Time
|
|
}
|
|
|
|
// Role mirrors api/authz.Role's string values, kept as a plain
|
|
// string here rather than importing authz -- rbacstore is enterprise
|
|
// code and api/authz is core; enterprise may depend on
|
|
// nothing-shaped-like-an-import-from-core per the module boundary
|
|
// (see /docs/phase-4-isolation-design.md), even though the reverse
|
|
// (core importing enterprise) is the one hack/check-tenant-boundary.sh
|
|
// actually enforces. Values must stay in sync with authz.Role's
|
|
// constants by convention, verified by rbacstore_test.go.
|
|
type Role string
|
|
|
|
const (
|
|
RoleViewer Role = "viewer"
|
|
RoleEditor Role = "editor"
|
|
RoleAdmin Role = "admin"
|
|
RoleOwner Role = "owner"
|
|
)
|
|
|
|
type Membership struct {
|
|
TenantID string
|
|
UserID string
|
|
Role Role
|
|
}
|
|
|
|
type Store struct {
|
|
pool *pgxpool.Pool
|
|
}
|
|
|
|
func NewStore(pool *pgxpool.Pool) *Store {
|
|
return &Store{pool: pool}
|
|
}
|
|
|
|
// UpsertUserBySSO finds an existing user by ssoSubject, falling back to
|
|
// email (covers a user pre-provisioned by an Admin before their first
|
|
// SSO login -- see 0017_create_users.sql's ssoSubject nullability
|
|
// comment), or creates a new row. This is the one place a user's
|
|
// display_name/ssoSubject are refreshed from IdP claims on every login,
|
|
// matching a typical SSO-managed-identity pattern (the IdP is the
|
|
// source of truth for name/email; role assignment stays local, per
|
|
// /docs/phase-4-rbac-design.md's "manual role assignment" baseline).
|
|
func (s *Store) UpsertUserBySSO(ctx context.Context, ssoSubject, email, displayName string) (*User, error) {
|
|
if ssoSubject == "" || email == "" {
|
|
return nil, fmt.Errorf("rbacstore: ssoSubject and email are required")
|
|
}
|
|
|
|
var u User
|
|
row := s.pool.QueryRow(ctx, `
|
|
INSERT INTO users (id, email, display_name, sso_subject)
|
|
VALUES ($1, $2, $3, $4)
|
|
ON CONFLICT (email) DO UPDATE
|
|
SET display_name = EXCLUDED.display_name,
|
|
sso_subject = EXCLUDED.sso_subject,
|
|
updated_at = now()
|
|
RETURNING id, email, display_name, sso_subject, created_at, updated_at`,
|
|
uuid.NewString(), email, displayName, ssoSubject)
|
|
if err := row.Scan(&u.ID, &u.Email, &u.DisplayName, &u.SSOSubject, &u.CreatedAt, &u.UpdatedAt); err != nil {
|
|
return nil, fmt.Errorf("rbacstore: upserting user: %w", err)
|
|
}
|
|
return &u, nil
|
|
}
|
|
|
|
func (s *Store) GetUser(ctx context.Context, id string) (*User, error) {
|
|
var u User
|
|
row := s.pool.QueryRow(ctx, `
|
|
SELECT id, email, display_name, sso_subject, created_at, updated_at
|
|
FROM users WHERE id = $1`, id)
|
|
if err := row.Scan(&u.ID, &u.Email, &u.DisplayName, &u.SSOSubject, &u.CreatedAt, &u.UpdatedAt); err != nil {
|
|
if errors.Is(err, pgx.ErrNoRows) {
|
|
return nil, ErrNotFound
|
|
}
|
|
return nil, fmt.Errorf("rbacstore: getting user: %w", err)
|
|
}
|
|
return &u, nil
|
|
}
|
|
|
|
// CreateTenant inserts a new tenant in 'provisioning' status -- callers
|
|
// (future tenant-provisioning code, per /docs/phase-4-isolation-design.md's
|
|
// ordered provisioning state machine) move it to 'active' via
|
|
// SetTenantStatus only after ClickHouse/Tantivy provisioning succeeds.
|
|
func (s *Store) CreateTenant(ctx context.Context, id, displayName string) (*Tenant, error) {
|
|
if id == "" || displayName == "" {
|
|
return nil, fmt.Errorf("rbacstore: id and displayName are required")
|
|
}
|
|
var t Tenant
|
|
row := s.pool.QueryRow(ctx, `
|
|
INSERT INTO tenants (id, display_name, status)
|
|
VALUES ($1, $2, 'provisioning')
|
|
RETURNING id, display_name, status, coalesce(owner_user_id::text, ''), created_at, updated_at`,
|
|
id, displayName)
|
|
if err := row.Scan(&t.ID, &t.DisplayName, &t.Status, &t.OwnerUserID, &t.CreatedAt, &t.UpdatedAt); err != nil {
|
|
return nil, fmt.Errorf("rbacstore: creating tenant: %w", err)
|
|
}
|
|
return &t, nil
|
|
}
|
|
|
|
func (s *Store) GetTenant(ctx context.Context, id string) (*Tenant, error) {
|
|
var t Tenant
|
|
row := s.pool.QueryRow(ctx, `
|
|
SELECT id, display_name, status, coalesce(owner_user_id::text, ''), created_at, updated_at
|
|
FROM tenants WHERE id = $1`, id)
|
|
if err := row.Scan(&t.ID, &t.DisplayName, &t.Status, &t.OwnerUserID, &t.CreatedAt, &t.UpdatedAt); err != nil {
|
|
if errors.Is(err, pgx.ErrNoRows) {
|
|
return nil, ErrNotFound
|
|
}
|
|
return nil, fmt.Errorf("rbacstore: getting tenant: %w", err)
|
|
}
|
|
return &t, nil
|
|
}
|
|
|
|
// SetTenantStatus is the only way a tenant's status column changes --
|
|
// every tenant-resolution path elsewhere must re-check this via
|
|
// GetTenant, never cache/assume 'active', per
|
|
// /docs/phase-4-isolation-design.md's provisioning gate.
|
|
func (s *Store) SetTenantStatus(ctx context.Context, id, status string) error {
|
|
tag, err := s.pool.Exec(ctx, `UPDATE tenants SET status = $2, updated_at = now() WHERE id = $1`, id, status)
|
|
if err != nil {
|
|
return fmt.Errorf("rbacstore: setting tenant status: %w", err)
|
|
}
|
|
if tag.RowsAffected() == 0 {
|
|
return ErrNotFound
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// SetOwner sets a tenant's owner_user_id -- separate from
|
|
// SetMembership because the schema's Owner is a tenant-level column
|
|
// (exactly one, non-removable except by itself/platform break-glass per
|
|
// /docs/phase-4-rbac-design.md), not just the highest tenant_memberships
|
|
// role. Callers are expected to also call SetMembership(tenantID,
|
|
// userID, RoleOwner) so the membership table and this column agree --
|
|
// this package doesn't wrap both in one method because tenant creation
|
|
// (no owner yet) and ownership transfer (existing owner changes) are
|
|
// different call sites with different validation needs.
|
|
func (s *Store) SetOwner(ctx context.Context, tenantID, userID string) error {
|
|
tag, err := s.pool.Exec(ctx, `UPDATE tenants SET owner_user_id = $2, updated_at = now() WHERE id = $1`, tenantID, userID)
|
|
if err != nil {
|
|
return fmt.Errorf("rbacstore: setting tenant owner: %w", err)
|
|
}
|
|
if tag.RowsAffected() == 0 {
|
|
return ErrNotFound
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// SetMembership upserts a user's role for a tenant -- the sole mutation
|
|
// path for tenant_memberships, so every role change naturally funnels
|
|
// through one method a future audit-log hook (EventRoleChange, see
|
|
// enterprise/internal/audit) can wrap.
|
|
func (s *Store) SetMembership(ctx context.Context, tenantID, userID string, role Role) error {
|
|
_, err := s.pool.Exec(ctx, `
|
|
INSERT INTO tenant_memberships (id, tenant_id, user_id, role)
|
|
VALUES ($1, $2, $3, $4)
|
|
ON CONFLICT (tenant_id, user_id) DO UPDATE
|
|
SET role = EXCLUDED.role, updated_at = now()`,
|
|
uuid.NewString(), tenantID, userID, string(role))
|
|
if err != nil {
|
|
return fmt.Errorf("rbacstore: setting membership: %w", err)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (s *Store) GetMembership(ctx context.Context, tenantID, userID string) (*Membership, error) {
|
|
var m Membership
|
|
var role string
|
|
row := s.pool.QueryRow(ctx, `
|
|
SELECT tenant_id, user_id, role FROM tenant_memberships
|
|
WHERE tenant_id = $1 AND user_id = $2`, tenantID, userID)
|
|
if err := row.Scan(&m.TenantID, &m.UserID, &role); err != nil {
|
|
if errors.Is(err, pgx.ErrNoRows) {
|
|
return nil, ErrNotFound
|
|
}
|
|
return nil, fmt.Errorf("rbacstore: getting membership: %w", err)
|
|
}
|
|
m.Role = Role(role)
|
|
return &m, nil
|
|
}
|
|
|
|
// ListMembershipsForUser supports "which tenants can this user act in,
|
|
// and at what role" -- the shape a login/session-issuance handler needs
|
|
// when a user belongs to more than one tenant and must pick (or be
|
|
// asked to pick) which one to act as for a given session.
|
|
func (s *Store) ListMembershipsForUser(ctx context.Context, userID string) ([]Membership, error) {
|
|
rows, err := s.pool.Query(ctx, `
|
|
SELECT tenant_id, user_id, role FROM tenant_memberships WHERE user_id = $1 ORDER BY tenant_id`, userID)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("rbacstore: listing memberships: %w", err)
|
|
}
|
|
defer rows.Close()
|
|
|
|
var out []Membership
|
|
for rows.Next() {
|
|
var m Membership
|
|
var role string
|
|
if err := rows.Scan(&m.TenantID, &m.UserID, &role); err != nil {
|
|
return nil, fmt.Errorf("rbacstore: scanning membership: %w", err)
|
|
}
|
|
m.Role = Role(role)
|
|
out = append(out, m)
|
|
}
|
|
return out, rows.Err()
|
|
}
|
|
|
|
// DataSource is one tenant's data-plane location -- today, exactly one
|
|
// ClickHouse database + one Tantivy index per tenant (see
|
|
// /docs/phase-4-rbac-design.md's "data_sources" extension-point
|
|
// section). ClickHouseUsername/Password are nil until
|
|
// enterprise/internal/tenantprovision actually provisions the
|
|
// ClickHouse-side user/database and calls SetDataSourceClickHouseCredentials.
|
|
type DataSource struct {
|
|
ID string
|
|
TenantID string
|
|
Name string
|
|
ClickHouseDatabaseName string
|
|
TantivyIndexPath string
|
|
ClickHouseUsername *string
|
|
ClickHousePassword *string
|
|
}
|
|
|
|
// CreateDataSource inserts the row tenantprovision will later attach
|
|
// credentials to (SetDataSourceClickHouseCredentials) -- split into two
|
|
// steps because the row (database name, index path) is decided before
|
|
// provisioning runs, but the ClickHouse-side username/password only
|
|
// exist after CREATE USER actually succeeds.
|
|
func (s *Store) CreateDataSource(ctx context.Context, tenantID, name, clickHouseDatabaseName, tantivyIndexPath string) (*DataSource, error) {
|
|
ds := DataSource{
|
|
ID: uuid.NewString(), TenantID: tenantID, Name: name,
|
|
ClickHouseDatabaseName: clickHouseDatabaseName, TantivyIndexPath: tantivyIndexPath,
|
|
}
|
|
_, err := s.pool.Exec(ctx, `
|
|
INSERT INTO data_sources (id, tenant_id, name, clickhouse_database_name, tantivy_index_path)
|
|
VALUES ($1, $2, $3, $4, $5)`,
|
|
ds.ID, ds.TenantID, ds.Name, ds.ClickHouseDatabaseName, ds.TantivyIndexPath)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("rbacstore: creating data source: %w", err)
|
|
}
|
|
return &ds, nil
|
|
}
|
|
|
|
// SetDataSourceClickHouseCredentials is the only way
|
|
// clickhouse_username/password change -- called once, right after
|
|
// enterprise/internal/tenantprovision.ProvisionClickHouse succeeds.
|
|
// Never called again for the same data source: rotating a live tenant's
|
|
// credential without first updating it on the ClickHouse side would
|
|
// just break every open connection, same reasoning as
|
|
// deploy/operator/internal/controller/tenant_controller.go's
|
|
// reconcileSecret.
|
|
func (s *Store) SetDataSourceClickHouseCredentials(ctx context.Context, id, username, password string) error {
|
|
tag, err := s.pool.Exec(ctx,
|
|
`UPDATE data_sources SET clickhouse_username = $2, clickhouse_password = $3 WHERE id = $1`,
|
|
id, username, password)
|
|
if err != nil {
|
|
return fmt.Errorf("rbacstore: setting data source credentials: %w", err)
|
|
}
|
|
if tag.RowsAffected() == 0 {
|
|
return ErrNotFound
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func scanDataSource(row pgx.Row) (*DataSource, error) {
|
|
var ds DataSource
|
|
if err := row.Scan(&ds.ID, &ds.TenantID, &ds.Name, &ds.ClickHouseDatabaseName, &ds.TantivyIndexPath,
|
|
&ds.ClickHouseUsername, &ds.ClickHousePassword); err != nil {
|
|
return nil, err
|
|
}
|
|
return &ds, nil
|
|
}
|
|
|
|
func (s *Store) GetDataSourceForTenant(ctx context.Context, tenantID string) (*DataSource, error) {
|
|
row := s.pool.QueryRow(ctx, `
|
|
SELECT id, tenant_id, name, clickhouse_database_name, tantivy_index_path, clickhouse_username, clickhouse_password
|
|
FROM data_sources WHERE tenant_id = $1 ORDER BY created_at LIMIT 1`, tenantID)
|
|
ds, err := scanDataSource(row)
|
|
if err != nil {
|
|
if errors.Is(err, pgx.ErrNoRows) {
|
|
return nil, ErrNotFound
|
|
}
|
|
return nil, fmt.Errorf("rbacstore: getting data source: %w", err)
|
|
}
|
|
return ds, nil
|
|
}
|
|
|
|
// ListProvisionedDataSources returns every data source for an active
|
|
// tenant that has already been provisioned (ClickHouse credentials set)
|
|
// -- exactly the set enterprise/internal/chrunner.NewRegistry needs at
|
|
// startup. A data source with no credentials yet (tenantprovision hasn't
|
|
// run for it) is deliberately excluded rather than returned with empty
|
|
// credentials -- chrunner has nothing safe to connect with for it, and
|
|
// silently including it would turn into a confusing empty-string
|
|
// connection attempt instead of a clear "not provisioned yet" absence.
|
|
func (s *Store) ListProvisionedDataSources(ctx context.Context) ([]DataSource, error) {
|
|
rows, err := s.pool.Query(ctx, `
|
|
SELECT ds.id, ds.tenant_id, ds.name, ds.clickhouse_database_name, ds.tantivy_index_path,
|
|
ds.clickhouse_username, ds.clickhouse_password
|
|
FROM data_sources ds
|
|
JOIN tenants t ON t.id = ds.tenant_id
|
|
WHERE t.status = 'active' AND ds.clickhouse_username IS NOT NULL AND ds.clickhouse_password IS NOT NULL`)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("rbacstore: listing provisioned data sources: %w", err)
|
|
}
|
|
defer rows.Close()
|
|
|
|
var out []DataSource
|
|
for rows.Next() {
|
|
ds, err := scanDataSource(rows)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("rbacstore: scanning data source: %w", err)
|
|
}
|
|
out = append(out, *ds)
|
|
}
|
|
return out, rows.Err()
|
|
}
|