sealed

package
v1.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 10, 2026 License: AGPL-3.0 Imports: 8 Imported by: 0

Documentation

Overview

Package sealed knows every value stored sealed with the instance's secret key (secrets.Box): the table, the column and the associated data each was sealed with. `reputecast secrets reseal` uses it to re-encrypt every value with the current key, so a previous key can be dropped, and `reputecast doctor` to check the key opens them (review 2026-11 OP-4, OP-5).

A new sealed column must be added here: TestEverySealedColumnIsKnown fails on a bytea column that is neither listed nor exempt.

Index

Constants

This section is empty.

Variables

View Source
var Columns = []Column{
	{Table: "adapter_runtimes", Column: "secret_enc", Key: ids("adapter_id:uuid"), AD: `'adapter:' || adapter_id::text || ':secret'`},
	{Table: "adapter_runtimes", Column: "previous_secret_enc", Key: ids("adapter_id:uuid"), AD: `'adapter:' || adapter_id::text || ':secret'`},
	{Table: "ai_connections", Column: "key_sealed", Key: ids("workspace_id:uuid"), AD: `'ai:' || workspace_id::text || ':key'`},
	{Table: "auth_challenges", Column: "data", JSONField: "secret", Where: "kind = 'totp_setup'", Key: ids("id:uuid"), AD: `'totp-pending:' || user_id::text`, ShortLived: true},
	{Table: "auth_challenges", Column: "data", JSONField: "invite_enc", Where: "kind = 'oidc_flow'", Key: ids("id:uuid"), AD: `'sso:invite'`, ShortLived: true},
	{Table: "automation_step_secrets", Column: "secret_enc", Key: ids("automation_id:uuid", "node_id:text"), AD: `'automation:' || automation_id::text || ':step:' || node_id || ':secret'`},
	{Table: "campaign_review_links", Column: "token_sealed", Key: ids("id:uuid"), AD: `'review-link:' || id::text`},
	{Table: "form_challenges", Column: "payload_enc", Key: ids("id:uuid"), AD: `'form_challenge:' || id::text`, ShortLived: true},
	{Table: "hostrepute_connections", Column: "token_enc", Key: ids("workspace_id:uuid"), AD: `'hostrepute:' || workspace_id::text || ':token'`},
	{Table: "hostrepute_connections", Column: "refresh_enc", Key: ids("workspace_id:uuid"), AD: `'hostrepute:' || workspace_id::text || ':refresh'`},
	{Table: "hostrepute_oauth_states", Column: "verifier_enc", Key: ids("id:uuid"), AD: `'hostrepute-oauth:' || id::text`, ShortLived: true},
	{Table: "imports", Column: "credentials_enc", Key: ids("id:uuid"), AD: `'import:' || id::text || ':credentials'`},
	{Table: "instance_settings", Column: "social_secrets_enc", Key: ids("id:boolean"), AD: `'instance:social_providers:secrets'`},
	{Table: "instance_settings", Column: "audit_stream_secret_enc", Key: ids("id:boolean"), AD: `'instance:audit_stream_secret'`},
	{Table: "invitations", Column: "token_enc", Key: ids("id:uuid"), AD: `'invitation:' || id::text || ':token'`},
	{Table: "partner_links", Column: "secret", Key: ids("id:uuid"), AD: `'partner_link:' || id::text || ':secret'`},
	{Table: "partner_links", Column: "prev_secret", Key: ids("id:uuid"), AD: `'partner_link:' || id::text || ':prev_secret'`},
	{Table: "partner_requests_out", Column: "email", Key: ids("id:uuid"), AD: `'partner_request:' || id::text || ':email'`},
	{Table: "payment_connections", Column: "key_sealed", Key: ids("id:uuid"), AD: `'payment_connection:' || id::text || ':key'`},
	{Table: "payment_connections", Column: "webhook_secret_sealed", Key: ids("id:uuid"), AD: `'payment_connection:' || id::text || ':webhook_secret'`},
	{Table: "placement_oauth_states", Column: "verifier_enc", Key: ids("state_hash:bytea"), AD: `'placement:oauth:' || encode(state_hash, 'hex')`, ShortLived: true},
	{Table: "placement_seeds", Column: "credentials_enc", Key: ids("id:uuid"), AD: `'placement:seed:' || id::text || ':credentials'`},
	{Table: "providers", Column: "credentials_enc", Key: ids("id:uuid"), AD: `'provider:' || id::text || ':credentials'`},
	{Table: "providers", Column: "webhook_secret_enc", Key: ids("id:uuid"), AD: `'provider:' || id::text || ':webhook_secret'`},
	{Table: "public_page_settings", Column: "turnstile_secret_enc", Key: ids("workspace_id:uuid"), AD: `'turnstile:' || workspace_id::text || ':secret'`},
	{Table: "push_keys", Column: "private_enc", Key: ids("id:uuid"), AD: `'push_key:' || id::text || ':private'`},
	{Table: "referral_milestones", Column: "webhook_secret", Key: ids("id:uuid"), AD: `'referral_milestone:' || id::text || ':webhook_secret'`},
	{Table: "referral_reward_codes", Column: "code", Key: ids("id:uuid"), AD: `'referral_milestone:' || milestone_id::text || ':code'`},
	{Table: "referral_rewards", Column: "answer", Key: ids("id:uuid"), AD: `'referral_reward:' || id::text || ':answer'`},
	{Table: "referral_rewards", Column: "address", Key: ids("id:uuid"), AD: `'referral_reward:' || id::text || ':address'`},
	{Table: "rendering_services", Column: "credentials", Key: ids("workspace_id:uuid"), AD: `'rendering:' || workspace_id::text || ':credentials'`},
	{Table: "report_shares", Column: "token_sealed", Key: ids("id:uuid"), AD: `'report_share:' || id::text || ':token'`},
	{Table: "sms_providers", Column: "credentials_enc", Key: ids("id:uuid"), AD: `'sms_provider:' || id::text || ':credentials'`},
	{Table: "sms_providers", Column: "webhook_secret_enc", Key: ids("id:uuid"), AD: `'sms_provider:' || id::text || ':webhook_secret'`},
	{Table: "smtp_relay_acme", Column: "sealed", Key: ids("key:text"), AD: `'smtp_relay_acme:' || key`},
	{Table: "sponsor_report_shares", Column: "token_sealed", Key: ids("id:uuid"), AD: `'sponsor_report_share:' || id::text || ':token'`},
	{Table: "sso_providers", Column: "client_secret_enc", Key: ids("id:uuid"), AD: `'sso:' || id::text || ':client_secret'`},
	{Table: "stores", Column: "credentials_sealed", Key: ids("id:uuid"), AD: `'store:' || id::text || ':credentials'`},
	{Table: "stores", Column: "webhook_secret_sealed", Key: ids("id:uuid"), AD: `'store:' || id::text || ':webhook_secret'`},
	{Table: "transactional_outbox", Column: "sealed", Key: ids("message_id:uuid"), AD: `'transactional:' || message_id::text || ':payload'`, ShortLived: true},
	{Table: "transactional_template_imports", Column: "credentials_enc", Key: ids("id:uuid"), AD: `'transactional_import:' || id::text || ':credentials'`},
	{Table: "users", Column: "totp_secret_enc", Key: ids("id:uuid"), AD: `'user:' || id::text || ':totp'`},
	{Table: "verification_services", Column: "credentials_enc", Key: ids("id:uuid"), AD: `'verification:' || workspace_id::text || ':' || service || ':credentials'`},
	{Table: "webhooks", Column: "secret_enc", Key: ids("id:uuid"), AD: `'webhook:' || id::text || ':secret'`},
	{Table: "webhooks", Column: "previous_secret_enc", Key: ids("id:uuid"), AD: `'webhook:' || id::text || ':secret'`},
	{Table: "whatsapp_accounts", Column: "credentials_enc", Key: ids("id:uuid"), AD: `'whatsapp_account:' || id::text || ':credentials'`},
	{Table: "whatsapp_accounts", Column: "callback_token_enc", Key: ids("id:uuid"), AD: `'whatsapp_account:' || id::text || ':callback_token'`},
	{Table: "workspaces", Column: "audit_stream_secret_enc", Key: ids("id:uuid"), AD: `'workspace:' || id::text || ':audit_stream_secret'`},
}

Columns lists every sealed value, by table.

Functions

This section is empty.

Types

type Column

type Column struct {
	Table, Column string
	// Key names the columns that identify a row, as "name:type".
	Key []string
	// AD is the SQL expression, over the row, of the associated data the
	// value was sealed with; it matches the Go helper byte for byte.
	AD string
	// JSONField, for a jsonb column, is the field holding the sealed value,
	// base64-encoded (Go's encoding of []byte).
	JSONField string
	// Where narrows the rows (a jsonb column's kinds).
	Where string
	// ShortLived values expire on their own within a day; reseal still
	// covers them.
	ShortLived bool
}

Column is one place sealed values live.

func (Column) Name

func (c Column) Name() string

Name is "table.column" (with the JSON field, if any).

type Result

type Result struct {
	Column Column
	// Checked values; Resealed with the current key; Unreadable by every
	// known key (sealed with a key that is gone, or damaged).
	Checked, Resealed, Unreadable int
	// Old values still sealed with a previous key (Check only).
	Old int
	// Missing: the table or column doesn't exist in this database.
	Missing bool
}

Result counts one column's values.

func Check

func Check(ctx context.Context, pool *pgxpool.Pool, box *secrets.Box, sample int) ([]Result, error)

Check opens up to sample values of every column with box, and counts the values still sealed with a previous key.

func Reseal

func Reseal(ctx context.Context, pool *pgxpool.Pool, box *secrets.Box, dryRun bool) ([]Result, error)

Reseal re-encrypts every value not sealed with box's current key. Each value is replaced only if it is still the one read, so a token the app refreshed meanwhile is kept. Values no known key opens are counted and left alone. With dryRun nothing is written.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL