shared

Documentation

Overview

Package shared holds value objects and errors common to all domain packages. It must not import any other internal package (innermost layer of the onion).

Index

• Variables
• func CVSSv3BaseScore(vector string) (float64, bool)
• func IsMachineActor(actor string) bool
• func SeverityRank(s Severity) int
• func WithTenant(ctx context.Context, tenantID ID) context.Context
• type Audit
• type ID
  • func TenantFrom(ctx context.Context) (ID, bool)
  • func TenantOrDefault(id ID) ID
  • func (id ID) IsZero() bool
  • func (id ID) String() string
• type Severity
  • func SeverityFromScore(score float64) Severity
  • func (s Severity) Valid() bool

Variables

var (
	ErrValidation = errors.New("validation error")
	ErrNotFound   = errors.New("not found")
	ErrForbidden  = errors.New("forbidden")        // scope / authorization-window violations
	ErrConflict   = errors.New("conflict")         // optimistic-concurrency version mismatch (lost-update guard)
	ErrSaturated  = errors.New("system saturated") // bounded admission rejected (backpressure → 503)
)

Sentinel errors mapped to transport status codes by the adapter layer.

Functions

func CVSSv3BaseScore

func CVSSv3BaseScore(vector string) (float64, bool)

CVSSv3BaseScore computes the CVSS v3.0/v3.1 base score from a vector string (e.g. "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H"). Returns (score, true) for a well-formed v3 vector, else (0, false). v4.0 vectors are not scored here.

func IsMachineActor

func IsMachineActor(actor string) bool

IsMachineActor reports whether actor belongs to one of Synapse's reserved non-human principal families. Human-only decisions use this shared predicate so a newly added machine namespace cannot accidentally be denied in one governance workflow but accepted in another. Empty or whitespace-only identities deliberately return true: an absent authenticated actor must fail closed at authorization boundaries. Existing AI-triage callers already validate non-empty actor text before this predicate.

func SeverityRank

func SeverityRank(s Severity) int

SeverityRank orders severity from unknown (0) to critical (5); used for thresholds and tie-breaks.

func WithTenant

func WithTenant(ctx context.Context, tenantID ID) context.Context

WithTenant binds an authenticated or durable-job tenant to ctx.

Types

type Audit

type Audit struct {
	CreatedAt time.Time
	UpdatedAt time.Time
	// CreatedBy / UpdatedBy attribute a record to the actor that created / last modified it
	// (ownership). Empty = system/unknown (legacy rows, or write paths not yet wired).
	// Engagements persist these; other record types carry the fields and adopt persistence
	// incrementally – the canonical home so ownership is one shape across the domain.
	CreatedBy string
	UpdatedBy string
}

Audit holds common audit timestamps embedded by entities.

type ID

type ID string

ID is a domain identifier (opaque string; generated by the platform layer).

const DefaultTenant ID = "default"

DefaultTenant is the non-empty tenant id the empty-string (single-tenant) default maps to. RLS tables treat the empty string as DENY, so the default deployment uses this id (it matches the fleet DefaultFleetTenant and the seeded 'default' tenant row). Use TenantOrDefault to normalize.

func TenantFrom

func TenantFrom(ctx context.Context) (ID, bool)

TenantFrom returns the explicitly bound tenant. Missing context is unsafe for RLS persistence.

func TenantOrDefault

func TenantOrDefault(id ID) ID

TenantOrDefault returns id, or DefaultTenant when id is empty — so a single-tenant empty tenant and the fleet 'default' tenant resolve to the same RLS partition (letting, e.g., an image scan and the cluster/host agent that observes it correlate under one tenant).

func (ID) IsZero

func (id ID) IsZero() bool

func (ID) String

func (id ID) String() string

type Severity

type Severity string

Severity is the normalized severity scale shared by findings and vulnerabilities.

const (
	SeverityCritical Severity = "critical"
	SeverityHigh     Severity = "high"
	SeverityMedium   Severity = "medium"
	SeverityLow      Severity = "low"
	SeverityInfo     Severity = "info"
	SeverityUnknown  Severity = "unknown"
)

func SeverityFromScore

func SeverityFromScore(score float64) Severity

SeverityFromScore maps a CVSS base score to the qualitative severity band.

func (Severity) Valid

func (s Severity) Valid() bool

Valid reports whether s is a known severity label.