mirror of
https://github.com/coder/coder.git
synced 2026-10-30 18:12:29 +08:00
Michael Suchacz
7ca7c30f40
Adds group and user ACLs to org-scoped MCP server configs so
organizations can restrict specific MCP servers to subsets of members,
mirroring the template ACL pattern.
## Summary
- Migration adds `group_acl`/`user_acl` JSONB columns (nested `{"<id>":
{"permissions": [...]}}` shape) and seeds every existing config with its
organization's Everyone group read entry (the Everyone group ID equals
the org ID), so member access is unchanged by default. Creation seeds
the same entry.
- The blanket org-member read grant from the base PR is replaced by ACL
evaluation: Rego requires org membership for every ACL grant, and
`GetAuthorizedMCPServerConfigs` compiles ACL-aware SQL filters.
- New `ActionShare` (org admins) gates `GET|PATCH
/api/experimental/organizations/{organization}/mcp-servers/{mcpserverconfig}/acl`
(nested under the organization like the rest of the config surface).
PATCH validates principals against the config's organization, merges
sparse updates under a row lock, stamps `updated_by`/`updated_at`, and
is audited as a Write with `Old` captured before authorization. A config
deleted concurrently between the middleware fetch and the locked
re-fetch is concealed as 404, matching the update and delete handlers.
ACL columns are tracked in the audit table.
- ACL management is available in all editions (no enterprise
entitlement), documented in the MCP servers page. Revoking an ACL does
not retro-strip already-selected configs from existing chats; new
selection is blocked at chat create.
- Force On respects the ACL: the forced set is loaded as the chat owner,
so a `force_on` server whose ACL denies the owner never attaches at
create, send, or generation time.
- No rolling-upgrade machinery: upgrades run in scheduled maintenance
downtime, so the migration only backfills existing rows; the API sets
the Everyone read grant explicitly on every insert.
Stacked on #27943. Part of the MCP org-separation stack.
Closes https://linear.app/codercom/issue/CODAGT-712
UAT: verified on a dogfood instance with two members and a custom group:
Everyone-seed default visibility, group grant with Everyone removal
(non-member loses list/fetch/selection), foreign-principal rejection,
non-admin share denial (audited 403 / concealed 404), user_acl restore,
and audited ACL diffs.
> Mux (AI agent) authored this PR on Mike's behalf.
<!-- mux-attribution: model=claude-fable-5 thinking=high -->
641 lines
28 KiB
Go
641 lines
28 KiB
Go
package audit
|
|
|
|
import (
|
|
"fmt"
|
|
"os"
|
|
"reflect"
|
|
"runtime"
|
|
"strings"
|
|
|
|
"github.com/coder/coder/v2/coderd/database"
|
|
"github.com/coder/coder/v2/coderd/idpsync"
|
|
"github.com/coder/coder/v2/codersdk"
|
|
)
|
|
|
|
// This mapping creates a relationship between an Auditable Resource
|
|
// and the Audit Actions we track for that resource.
|
|
// It is important to maintain this mapping when adding a new Auditable Resource to the
|
|
// AuditableResources map (below) as our documentation - generated in scripts/auditdocgen/main.go -
|
|
// depends upon it.
|
|
var AuditActionMap = map[string][]codersdk.AuditAction{
|
|
"GitSSHKey": {codersdk.AuditActionCreate},
|
|
"Template": {codersdk.AuditActionWrite, codersdk.AuditActionDelete},
|
|
"TemplateVersion": {codersdk.AuditActionCreate, codersdk.AuditActionWrite},
|
|
"User": {codersdk.AuditActionCreate, codersdk.AuditActionWrite, codersdk.AuditActionDelete},
|
|
"Workspace": {codersdk.AuditActionCreate, codersdk.AuditActionWrite, codersdk.AuditActionDelete},
|
|
"WorkspaceBuild": {codersdk.AuditActionStart, codersdk.AuditActionStop},
|
|
"Group": {codersdk.AuditActionCreate, codersdk.AuditActionWrite, codersdk.AuditActionDelete},
|
|
"APIKey": {codersdk.AuditActionLogin, codersdk.AuditActionLogout, codersdk.AuditActionRegister, codersdk.AuditActionCreate, codersdk.AuditActionWrite, codersdk.AuditActionDelete},
|
|
"License": {codersdk.AuditActionCreate, codersdk.AuditActionDelete},
|
|
"Task": {codersdk.AuditActionCreate, codersdk.AuditActionWrite, codersdk.AuditActionDelete},
|
|
"AISeatState": {codersdk.AuditActionCreate},
|
|
"AIProvider": {codersdk.AuditActionCreate, codersdk.AuditActionWrite, codersdk.AuditActionDelete},
|
|
"AIProviderKey": {codersdk.AuditActionCreate, codersdk.AuditActionDelete},
|
|
"AIGatewayKey": {codersdk.AuditActionCreate, codersdk.AuditActionDelete},
|
|
"AuditableGroupAIBudget": {codersdk.AuditActionWrite, codersdk.AuditActionDelete},
|
|
"AuditableUserAIBudgetOverride": {codersdk.AuditActionWrite, codersdk.AuditActionDelete},
|
|
"Chat": {codersdk.AuditActionCreate, codersdk.AuditActionWrite}, // chats get 'archived' by users, not deleted.
|
|
"MCPServerConfig": {codersdk.AuditActionCreate, codersdk.AuditActionWrite, codersdk.AuditActionDelete},
|
|
"UserSecret": {codersdk.AuditActionCreate, codersdk.AuditActionWrite, codersdk.AuditActionDelete},
|
|
"UserSkill": {codersdk.AuditActionCreate, codersdk.AuditActionWrite, codersdk.AuditActionDelete},
|
|
"ChatInstructionSettings": {codersdk.AuditActionWrite},
|
|
}
|
|
|
|
type Action string
|
|
|
|
const (
|
|
// ActionIgnore ignores diffing for the field.
|
|
ActionIgnore = "ignore"
|
|
// ActionTrack includes the value in the diff if the value changed.
|
|
ActionTrack = "track"
|
|
// ActionSecret includes a zero value of the same type if the value changed.
|
|
// It lets you indicate that a value changed, but without leaking its
|
|
// contents.
|
|
ActionSecret = "secret"
|
|
)
|
|
|
|
// Table is a map of struct names to a map of field names that indicate that
|
|
// field's AuditType.
|
|
type Table map[string]map[string]Action
|
|
|
|
// AuditableResources contains a definitive list of all auditable resources and
|
|
// which fields are auditable. All resource types must be valid audit.Auditable
|
|
// types.
|
|
var AuditableResources = auditMap(auditableResourcesTypes)
|
|
|
|
var auditableResourcesTypes = map[any]map[string]Action{
|
|
&database.AuditableOrganizationMember{}: {
|
|
"username": ActionTrack,
|
|
"user_id": ActionTrack,
|
|
"organization_id": ActionIgnore, // Never changes.
|
|
"created_at": ActionTrack,
|
|
"updated_at": ActionTrack,
|
|
"roles": ActionTrack,
|
|
},
|
|
&database.CustomRole{}: {
|
|
"name": ActionTrack,
|
|
"display_name": ActionTrack,
|
|
"site_permissions": ActionTrack,
|
|
"org_permissions": ActionTrack,
|
|
"user_permissions": ActionTrack,
|
|
"member_permissions": ActionTrack,
|
|
"organization_id": ActionIgnore, // Never changes.
|
|
"is_system": ActionIgnore, // Never changes.
|
|
|
|
"id": ActionIgnore,
|
|
"created_at": ActionIgnore,
|
|
"updated_at": ActionIgnore,
|
|
},
|
|
&database.GitSSHKey{}: {
|
|
"user_id": ActionTrack,
|
|
"created_at": ActionIgnore, // Never changes, but is implicit and not helpful in a diff.
|
|
"updated_at": ActionIgnore, // Changes, but is implicit and not helpful in a diff.
|
|
"private_key": ActionSecret, // We don't want to expose private keys in diffs.
|
|
"private_key_key_id": ActionIgnore, // Internal dbcrypt metadata, not useful in audit diffs.
|
|
"public_key": ActionTrack, // Public keys are ok to expose in a diff.
|
|
},
|
|
&database.Template{}: {
|
|
"id": ActionTrack,
|
|
"created_at": ActionIgnore, // Never changes, but is implicit and not helpful in a diff.
|
|
"updated_at": ActionIgnore, // Changes, but is implicit and not helpful in a diff.
|
|
"organization_id": ActionIgnore, /// Never changes.
|
|
"organization_name": ActionIgnore, // Ignore these changes
|
|
"organization_display_name": ActionIgnore, // Ignore these changes
|
|
"organization_icon": ActionIgnore, // Ignore these changes
|
|
"deleted": ActionIgnore, // Changes, but is implicit when a delete event is fired.
|
|
"name": ActionTrack,
|
|
"display_name": ActionTrack,
|
|
"provisioner": ActionTrack,
|
|
"active_version_id": ActionTrack,
|
|
"description": ActionTrack,
|
|
"icon": ActionTrack,
|
|
"default_ttl": ActionTrack,
|
|
"autostart_block_days_of_week": ActionTrack,
|
|
"autostop_requirement_days_of_week": ActionTrack,
|
|
"autostop_requirement_weeks": ActionTrack,
|
|
"created_by": ActionTrack,
|
|
"created_by_username": ActionIgnore,
|
|
"created_by_name": ActionIgnore,
|
|
"created_by_avatar_url": ActionIgnore,
|
|
"group_acl": ActionTrack,
|
|
"user_acl": ActionTrack,
|
|
"allow_user_autostart": ActionTrack,
|
|
"allow_user_autostop": ActionTrack,
|
|
"allow_user_cancel_workspace_jobs": ActionTrack,
|
|
"failure_ttl": ActionTrack,
|
|
"time_til_dormant": ActionTrack,
|
|
"time_til_dormant_autodelete": ActionTrack,
|
|
"require_active_version": ActionTrack,
|
|
"deprecated": ActionTrack,
|
|
"max_port_sharing_level": ActionTrack,
|
|
"activity_bump": ActionTrack,
|
|
"use_classic_parameter_flow": ActionTrack,
|
|
"cors_behavior": ActionTrack,
|
|
"disable_module_cache": ActionTrack,
|
|
"time_til_autostop_notify": ActionTrack,
|
|
"agents_allowed": ActionTrack,
|
|
},
|
|
&database.TemplateVersion{}: {
|
|
"id": ActionTrack,
|
|
"template_id": ActionTrack,
|
|
"organization_id": ActionIgnore, // Never changes.
|
|
"created_at": ActionIgnore, // Never changes, but is implicit and not helpful in a diff.
|
|
"updated_at": ActionIgnore, // Changes, but is implicit and not helpful in a diff.
|
|
"name": ActionTrack,
|
|
"message": ActionIgnore, // Never changes after creation.
|
|
"readme": ActionTrack,
|
|
"job_id": ActionIgnore, // Not helpful in a diff because jobs aren't tracked in audit logs.
|
|
"created_by": ActionTrack,
|
|
"external_auth_providers": ActionIgnore, // Not helpful because this can only change when new versions are added.
|
|
"created_by_avatar_url": ActionIgnore,
|
|
"created_by_username": ActionIgnore,
|
|
"created_by_name": ActionIgnore,
|
|
"archived": ActionTrack,
|
|
"source_example_id": ActionIgnore, // Never changes.
|
|
"has_ai_task": ActionIgnore, // Never changes.
|
|
"has_external_agent": ActionIgnore, // Never changes.
|
|
},
|
|
&database.User{}: {
|
|
"id": ActionTrack,
|
|
"email": ActionTrack,
|
|
"username": ActionTrack,
|
|
"hashed_password": ActionSecret, // Do not expose a users hashed password.
|
|
"created_at": ActionIgnore, // Never changes.
|
|
"updated_at": ActionIgnore, // Changes, but is implicit and not helpful in a diff.
|
|
"status": ActionTrack,
|
|
"rbac_roles": ActionTrack,
|
|
"login_type": ActionTrack,
|
|
"avatar_url": ActionIgnore,
|
|
"last_seen_at": ActionIgnore,
|
|
"deleted": ActionTrack,
|
|
"quiet_hours_schedule": ActionTrack,
|
|
"name": ActionTrack,
|
|
"github_com_user_id": ActionIgnore,
|
|
"hashed_one_time_passcode": ActionIgnore,
|
|
"one_time_passcode_expires_at": ActionTrack,
|
|
"is_system": ActionTrack, // Should never change, but track it anyway.
|
|
"is_service_account": ActionTrack, // Should never change, but track it anyway.
|
|
"chat_spend_limit_micros": ActionTrack,
|
|
},
|
|
&database.WorkspaceTable{}: {
|
|
"id": ActionTrack,
|
|
"created_at": ActionIgnore, // Never changes.
|
|
"updated_at": ActionIgnore, // Changes, but is implicit and not helpful in a diff.
|
|
"owner_id": ActionTrack,
|
|
"organization_id": ActionIgnore, // Never changes.
|
|
"template_id": ActionTrack,
|
|
"deleted": ActionIgnore, // Changes, but is implicit when a delete event is fired.
|
|
"name": ActionTrack,
|
|
"autostart_schedule": ActionTrack,
|
|
"ttl": ActionTrack,
|
|
"last_used_at": ActionIgnore,
|
|
"dormant_at": ActionTrack,
|
|
"deleting_at": ActionTrack,
|
|
"automatic_updates": ActionTrack,
|
|
"favorite": ActionTrack,
|
|
"next_start_at": ActionTrack,
|
|
"group_acl": ActionTrack,
|
|
"user_acl": ActionTrack,
|
|
},
|
|
&database.WorkspaceBuild{}: {
|
|
"id": ActionIgnore,
|
|
"created_at": ActionIgnore,
|
|
"updated_at": ActionIgnore,
|
|
"workspace_id": ActionIgnore,
|
|
"template_version_id": ActionTrack,
|
|
"build_number": ActionIgnore,
|
|
"transition": ActionIgnore,
|
|
"initiator_id": ActionIgnore,
|
|
"job_id": ActionIgnore,
|
|
"deadline": ActionIgnore,
|
|
"reason": ActionIgnore,
|
|
"daily_cost": ActionIgnore,
|
|
"max_deadline": ActionIgnore,
|
|
"initiator_by_avatar_url": ActionIgnore,
|
|
"initiator_by_username": ActionIgnore,
|
|
"initiator_by_name": ActionIgnore,
|
|
"template_version_preset_id": ActionIgnore, // Never changes.
|
|
"has_ai_task": ActionIgnore, // Never changes.
|
|
"has_external_agent": ActionIgnore, // Never changes.
|
|
"notified_autostop_deadline": ActionIgnore, // Updated by the notification system, not by user action.
|
|
},
|
|
&database.AuditableGroup{}: {
|
|
"id": ActionTrack,
|
|
"name": ActionTrack,
|
|
"display_name": ActionTrack,
|
|
"organization_id": ActionIgnore, // Never changes.
|
|
"avatar_url": ActionTrack,
|
|
"quota_allowance": ActionTrack,
|
|
"members": ActionTrack,
|
|
"source": ActionIgnore,
|
|
"chat_spend_limit_micros": ActionTrack,
|
|
},
|
|
&database.AuditableGroupAIBudget{}: {
|
|
"group_id": ActionIgnore, // Group name is already included in the title.
|
|
"spend_limit_micros": ActionIgnore,
|
|
"spend_limit": ActionTrack, // Track spend_limit, which is the human-readable version.
|
|
"group_name": ActionIgnore, // Group name is already included in the title.
|
|
"created_at": ActionIgnore, // Redundant with the audit log's own timestamp.
|
|
"updated_at": ActionIgnore, // Redundant with the audit log's own timestamp.
|
|
},
|
|
&database.AuditableUserAIBudgetOverride{}: {
|
|
"user_id": ActionIgnore, // Username is already included in the title.
|
|
"username": ActionIgnore, // Username is already included in the title.
|
|
"group_id": ActionTrack,
|
|
"group_name": ActionTrack,
|
|
"spend_limit_micros": ActionIgnore,
|
|
"spend_limit": ActionTrack, // Track spend_limit, the human-readable version.
|
|
"created_at": ActionIgnore, // Redundant with the audit log's own timestamp.
|
|
"updated_at": ActionIgnore, // Redundant with the audit log's own timestamp.
|
|
},
|
|
&database.APIKey{}: {
|
|
"id": ActionIgnore,
|
|
"hashed_secret": ActionIgnore,
|
|
"user_id": ActionTrack,
|
|
"last_used": ActionTrack,
|
|
"expires_at": ActionTrack,
|
|
"created_at": ActionTrack,
|
|
"updated_at": ActionIgnore,
|
|
"login_type": ActionIgnore,
|
|
"lifetime_seconds": ActionIgnore,
|
|
"ip_address": ActionIgnore,
|
|
"scopes": ActionIgnore,
|
|
"allow_list": ActionIgnore,
|
|
"token_name": ActionIgnore,
|
|
},
|
|
&database.AuditOAuthConvertState{}: {
|
|
"created_at": ActionTrack,
|
|
"expires_at": ActionTrack,
|
|
"from_login_type": ActionTrack,
|
|
"to_login_type": ActionTrack,
|
|
"user_id": ActionTrack,
|
|
},
|
|
&database.HealthSettings{}: {
|
|
"id": ActionIgnore,
|
|
"dismissed_healthchecks": ActionTrack,
|
|
},
|
|
&database.NotificationsSettings{}: {
|
|
"id": ActionIgnore,
|
|
"notifier_paused": ActionTrack,
|
|
},
|
|
&database.PrebuildsSettings{}: {
|
|
"id": ActionIgnore,
|
|
"reconciliation_paused": ActionTrack,
|
|
},
|
|
&database.OAuth2ProviderSettings{}: {
|
|
"id": ActionIgnore,
|
|
"dynamic_client_registration_enabled": ActionTrack,
|
|
},
|
|
&database.ChatInstructionSettings{}: {
|
|
"id": ActionIgnore,
|
|
"name": ActionIgnore,
|
|
"system_prompt": ActionTrack,
|
|
"include_default_system_prompt_set": ActionTrack,
|
|
"include_default_system_prompt": ActionTrack,
|
|
"plan_mode_instructions": ActionTrack,
|
|
},
|
|
// TODO: track an ID here when the below ticket is completed:
|
|
// https://github.com/coder/coder/pull/6012
|
|
&database.License{}: {
|
|
"id": ActionIgnore,
|
|
"uploaded_at": ActionTrack,
|
|
"jwt": ActionIgnore,
|
|
"exp": ActionTrack,
|
|
"uuid": ActionTrack,
|
|
},
|
|
&database.WorkspaceProxy{}: {
|
|
"id": ActionTrack,
|
|
"name": ActionTrack,
|
|
"display_name": ActionTrack,
|
|
"icon": ActionTrack,
|
|
"url": ActionTrack,
|
|
"wildcard_hostname": ActionTrack,
|
|
"created_at": ActionTrack,
|
|
"updated_at": ActionIgnore,
|
|
"deleted": ActionIgnore,
|
|
"token_hashed_secret": ActionSecret,
|
|
"derp_enabled": ActionTrack,
|
|
"derp_only": ActionTrack,
|
|
"region_id": ActionTrack,
|
|
"version": ActionTrack,
|
|
},
|
|
&database.OAuth2ProviderApp{}: {
|
|
"id": ActionIgnore,
|
|
"created_at": ActionIgnore,
|
|
"updated_at": ActionIgnore,
|
|
"name": ActionTrack,
|
|
"icon": ActionTrack,
|
|
"callback_url": ActionTrack,
|
|
"redirect_uris": ActionTrack,
|
|
"client_type": ActionTrack,
|
|
"dynamically_registered": ActionTrack,
|
|
// RFC 7591 Dynamic Client Registration fields
|
|
"client_id_issued_at": ActionIgnore, // Timestamp, not security relevant
|
|
"client_secret_expires_at": ActionTrack, // Security relevant - expiration policy
|
|
"grant_types": ActionTrack, // Security relevant - authorization capabilities
|
|
"response_types": ActionTrack, // Security relevant - response flow types
|
|
"token_endpoint_auth_method": ActionTrack, // Security relevant - auth method
|
|
"scope": ActionTrack, // Security relevant - permissions scope
|
|
"contacts": ActionTrack, // Contact info for responsible parties
|
|
"client_uri": ActionTrack, // Client identification info
|
|
"logo_uri": ActionTrack, // Client branding
|
|
"tos_uri": ActionTrack, // Legal compliance
|
|
"policy_uri": ActionTrack, // Legal compliance
|
|
"jwks_uri": ActionTrack, // Security relevant - key location
|
|
"jwks": ActionSecret, // Security sensitive - actual keys
|
|
"software_id": ActionTrack, // Client software identification
|
|
"software_version": ActionTrack, // Client software version
|
|
// RFC 7592 Management fields - sensitive data
|
|
"registration_access_token": ActionSecret, // Secret token for client management
|
|
"registration_client_uri": ActionTrack, // Management endpoint URI
|
|
},
|
|
&database.OAuth2ProviderAppSecret{}: {
|
|
"id": ActionIgnore,
|
|
"created_at": ActionIgnore,
|
|
"last_used_at": ActionIgnore,
|
|
"hashed_secret": ActionIgnore,
|
|
"display_secret": ActionIgnore,
|
|
"app_id": ActionIgnore,
|
|
"secret_prefix": ActionIgnore,
|
|
},
|
|
&database.Organization{}: {
|
|
"id": ActionIgnore,
|
|
"name": ActionTrack,
|
|
"description": ActionTrack,
|
|
"deleted": ActionTrack,
|
|
"created_at": ActionIgnore,
|
|
"updated_at": ActionTrack,
|
|
"is_default": ActionTrack,
|
|
"display_name": ActionTrack,
|
|
"icon": ActionTrack,
|
|
"shareable_workspace_owners": ActionTrack,
|
|
"default_org_member_roles": ActionTrack,
|
|
},
|
|
&database.NotificationTemplate{}: {
|
|
"id": ActionIgnore,
|
|
"name": ActionTrack,
|
|
"title_template": ActionTrack,
|
|
"body_template": ActionTrack,
|
|
"actions": ActionTrack,
|
|
"group": ActionTrack,
|
|
"method": ActionTrack,
|
|
"kind": ActionTrack,
|
|
"enabled_by_default": ActionTrack,
|
|
},
|
|
&idpsync.OrganizationSyncSettings{}: {
|
|
"field": ActionTrack,
|
|
"mapping": ActionTrack,
|
|
"assign_default": ActionTrack,
|
|
},
|
|
&idpsync.GroupSyncSettings{}: {
|
|
"field": ActionTrack,
|
|
"mapping": ActionTrack,
|
|
"regex_filter": ActionTrack,
|
|
"auto_create_missing_groups": ActionTrack,
|
|
// Configured in env vars
|
|
"legacy_group_name_mapping": ActionIgnore,
|
|
},
|
|
&idpsync.RoleSyncSettings{}: {
|
|
"field": ActionTrack,
|
|
"mapping": ActionTrack,
|
|
},
|
|
&database.AISeatState{}: {
|
|
"user_id": ActionTrack,
|
|
"first_used_at": ActionTrack,
|
|
"last_event_type": ActionTrack,
|
|
"last_event_description": ActionTrack,
|
|
|
|
// Since the audit log only fires on the first event, these fields will always
|
|
// match "first_used_at".
|
|
"last_used_at": ActionIgnore,
|
|
"updated_at": ActionIgnore,
|
|
},
|
|
&database.AIProvider{}: {
|
|
"id": ActionTrack,
|
|
"type": ActionTrack,
|
|
"name": ActionTrack,
|
|
"display_name": ActionTrack,
|
|
"icon": ActionTrack,
|
|
"enabled": ActionTrack,
|
|
"deleted": ActionTrack,
|
|
"base_url": ActionTrack,
|
|
"settings": ActionSecret, // Encrypted JSON blob may contain provider secrets (e.g. Bedrock access key + secret).
|
|
"settings_key_id": ActionIgnore, // dbcrypt key reference, derivable.
|
|
"created_at": ActionIgnore, // Implicit; not useful in a diff.
|
|
"updated_at": ActionIgnore, // Changes; not useful in a diff.
|
|
},
|
|
&database.AIProviderKey{}: {
|
|
"id": ActionTrack,
|
|
"provider_id": ActionTrack,
|
|
"api_key": ActionTrack, // Callers must pre-mask before auditing; the audit pipeline never sees plaintext.
|
|
"api_key_key_id": ActionIgnore, // dbcrypt key reference, derivable.
|
|
"created_at": ActionIgnore, // Implicit; not useful in a diff.
|
|
"updated_at": ActionIgnore, // Changes; not useful in a diff.
|
|
},
|
|
&database.AIGatewayKey{}: {
|
|
"id": ActionTrack,
|
|
"name": ActionTrack,
|
|
"secret_prefix": ActionTrack,
|
|
"hashed_secret": ActionSecret, // Bearer token hash, never expose.
|
|
"created_at": ActionIgnore, // Implicit; not useful in a diff.
|
|
"last_heartbeat_at": ActionIgnore, // Bumped on every heartbeat.
|
|
},
|
|
&database.TaskTable{}: {
|
|
"id": ActionTrack,
|
|
"organization_id": ActionIgnore, // Never changes.
|
|
"owner_id": ActionTrack,
|
|
"name": ActionTrack,
|
|
"display_name": ActionTrack,
|
|
"workspace_id": ActionTrack,
|
|
"template_version_id": ActionTrack,
|
|
"template_parameters": ActionTrack,
|
|
"prompt": ActionTrack,
|
|
"created_at": ActionIgnore, // Never changes.
|
|
"deleted_at": ActionIgnore, // Changes, but is implicit when a delete event is fired.
|
|
},
|
|
&database.Chat{}: {
|
|
"id": ActionTrack,
|
|
"owner_id": ActionTrack,
|
|
"owner_username": ActionIgnore,
|
|
"owner_name": ActionIgnore,
|
|
"organization_id": ActionIgnore, // Never changes after creation.
|
|
"workspace_id": ActionTrack,
|
|
"build_id": ActionIgnore, // Internal lifecycle.
|
|
"agent_id": ActionIgnore, // Internal lifecycle.
|
|
"title": ActionSecret, // May contain sensitive content.
|
|
"status": ActionIgnore, // Churns every message.
|
|
"worker_id": ActionIgnore, // Internal.
|
|
"started_at": ActionIgnore,
|
|
"heartbeat_at": ActionIgnore, // Internal.
|
|
"created_at": ActionIgnore, // Never changes.
|
|
"updated_at": ActionIgnore, // Bumped on every mutation.
|
|
"parent_chat_id": ActionIgnore, // Immutable after creation.
|
|
"root_chat_id": ActionIgnore, // Immutable after creation.
|
|
"last_model_config_id": ActionIgnore, // Churns every message.
|
|
"last_reasoning_effort": ActionIgnore, // Churns every message.
|
|
"archived": ActionTrack,
|
|
"last_error": ActionIgnore, // Internal.
|
|
"last_turn_summary": ActionIgnore, // Internal cached display text.
|
|
"summary": ActionIgnore, // Internal cached display text, generated asynchronously.
|
|
"summary_generated_at": ActionIgnore, // Internal freshness marker for the cached summary.
|
|
"mode": ActionTrack,
|
|
"mcp_server_ids": ActionTrack,
|
|
"labels": ActionTrack,
|
|
"user_acl": ActionTrack,
|
|
"group_acl": ActionTrack,
|
|
"pin_order": ActionTrack,
|
|
"last_read_message_id": ActionIgnore, // User-scoped read cursor.
|
|
"context_aggregate_hash": ActionIgnore, // Agent-pushed context snapshot state.
|
|
"context_dirty_since": ActionIgnore, // Agent-pushed context snapshot state.
|
|
"context_dirty_resources": ActionIgnore, // Agent-pushed context snapshot state.
|
|
"context_error": ActionIgnore, // Agent-pushed context snapshot state.
|
|
"dynamic_tools": ActionIgnore, // Internal lifecycle.
|
|
"plan_mode": ActionIgnore, // Can flip back and forth during a session.
|
|
"client_type": ActionIgnore, // Set at creation.
|
|
"snapshot_version": ActionIgnore, // Internal state machine version.
|
|
"history_version": ActionIgnore, // Internal state machine version.
|
|
"queue_version": ActionIgnore, // Internal state machine version.
|
|
"retry_state": ActionIgnore, // Internal transient retry UI state.
|
|
"retry_state_version": ActionIgnore, // Internal state machine version.
|
|
"generation_attempt": ActionIgnore, // Internal retry counter.
|
|
"runner_id": ActionIgnore, // Internal ownership identifier.
|
|
"requires_action_deadline_at": ActionIgnore, // Internal pending-action deadline.
|
|
"compaction_requested_at": ActionIgnore, // Internal one-shot manual compaction signal.
|
|
},
|
|
&database.MCPServerConfig{}: {
|
|
"id": ActionIgnore, // Conveyed by resource_id, not useful in a diff.
|
|
"display_name": ActionTrack,
|
|
"slug": ActionTrack,
|
|
"description": ActionTrack,
|
|
"icon_url": ActionTrack,
|
|
"transport": ActionTrack,
|
|
"url": ActionTrack,
|
|
"auth_type": ActionTrack,
|
|
"oauth2_client_id": ActionTrack,
|
|
"oauth2_client_secret": ActionSecret,
|
|
"oauth2_client_secret_key_id": ActionIgnore, // dbcrypt bookkeeping.
|
|
"oauth2_auth_url": ActionTrack,
|
|
"oauth2_token_url": ActionTrack,
|
|
"oauth2_scopes": ActionTrack,
|
|
"api_key_header": ActionTrack,
|
|
"api_key_value": ActionSecret,
|
|
"api_key_value_key_id": ActionIgnore, // dbcrypt bookkeeping.
|
|
"custom_headers": ActionSecret, // May contain credentials
|
|
"custom_headers_key_id": ActionIgnore, // dbcrypt bookkeeping.
|
|
"tool_allow_list": ActionTrack,
|
|
"tool_deny_list": ActionTrack,
|
|
"availability": ActionTrack,
|
|
"enabled": ActionTrack,
|
|
"created_by": ActionTrack,
|
|
"updated_by": ActionTrack,
|
|
"created_at": ActionIgnore,
|
|
"updated_at": ActionIgnore,
|
|
"model_intent": ActionTrack,
|
|
"allow_in_plan_mode": ActionTrack,
|
|
"forward_coder_headers": ActionTrack,
|
|
"group_acl": ActionTrack,
|
|
"user_acl": ActionTrack,
|
|
"oauth2_revocation_url": ActionTrack,
|
|
"organization_id": ActionIgnore,
|
|
},
|
|
&database.UserSkill{}: {
|
|
"id": ActionTrack,
|
|
"user_id": ActionTrack,
|
|
"name": ActionTrack,
|
|
"description": ActionTrack,
|
|
"content": ActionTrack,
|
|
"created_at": ActionIgnore,
|
|
"updated_at": ActionIgnore,
|
|
},
|
|
&database.UserSecret{}: {
|
|
"id": ActionTrack,
|
|
"user_id": ActionTrack,
|
|
"name": ActionTrack,
|
|
"description": ActionTrack,
|
|
"env_name": ActionTrack,
|
|
"file_path": ActionTrack,
|
|
"enabled": ActionTrack,
|
|
|
|
"value": ActionSecret,
|
|
|
|
"value_key_id": ActionIgnore,
|
|
"created_at": ActionIgnore,
|
|
"updated_at": ActionIgnore,
|
|
},
|
|
}
|
|
|
|
// auditMap converts a map of struct pointers to a map of struct names as
|
|
// strings. It's a convenience wrapper so that structs can be passed in by value
|
|
// instead of manually typing struct names as strings.
|
|
func auditMap(m map[any]map[string]Action) Table {
|
|
out := make(Table, len(m))
|
|
|
|
for k, v := range m {
|
|
tableKey, tableValue := entry(k, v)
|
|
out[tableKey] = tableValue
|
|
}
|
|
|
|
return out
|
|
}
|
|
|
|
// entry is a helper function that checks the json tags to make sure all fields
|
|
// are tracked. And no excess fields are tracked.
|
|
func entry(v any, f map[string]Action) (string, map[string]Action) {
|
|
vt := reflect.TypeOf(v)
|
|
for vt.Kind() == reflect.Ptr {
|
|
vt = vt.Elem()
|
|
}
|
|
|
|
// This should never happen because audit.Audible only allows structs in
|
|
// its union.
|
|
if vt.Kind() != reflect.Struct {
|
|
panic(fmt.Sprintf("audit table entry value must be a struct, got %T", v))
|
|
}
|
|
|
|
name := structName(vt)
|
|
|
|
// Use the flattenStructFields to recurse anonymously embedded structs
|
|
vv := reflect.ValueOf(v)
|
|
diffs, err := flattenStructFields(vv, vv)
|
|
if err != nil {
|
|
panic(fmt.Sprintf("audit table entry type %T failed to flatten", v))
|
|
}
|
|
|
|
fcpy := make(map[string]Action, len(f))
|
|
for k, v := range f {
|
|
fcpy[k] = v
|
|
}
|
|
for _, d := range diffs {
|
|
jsonTag := d.FieldType.Tag.Get("json")
|
|
if jsonTag == "-" {
|
|
// This field is explicitly ignored.
|
|
continue
|
|
}
|
|
jsonTag = strings.TrimSuffix(jsonTag, ",omitempty")
|
|
if _, ok := fcpy[jsonTag]; !ok {
|
|
_, _ = fmt.Fprintf(os.Stderr, "ERROR: Audit table entry missing action for field %q in type %q\nPlease update the auditable resource types in: %s\n", d.FieldType.Name, name, self())
|
|
//nolint:revive
|
|
os.Exit(1)
|
|
}
|
|
delete(fcpy, jsonTag)
|
|
}
|
|
|
|
// If there are any fields left in fcpy, they are extra fields that don't
|
|
// exist in the struct. Don't track them.
|
|
if len(fcpy) > 0 {
|
|
panic(fmt.Sprintf("audit table entry has extra actions for type %q: %v", name, fcpy))
|
|
}
|
|
|
|
return structName(vt), f
|
|
}
|
|
|
|
func (t Action) String() string {
|
|
return string(t)
|
|
}
|
|
|
|
func self() string {
|
|
//nolint:dogsled
|
|
_, file, _, _ := runtime.Caller(1)
|
|
return file
|
|
}
|