Skip to content

armgit / Pulse

Public Imported from GitHub
0

Real-time monitoring dashboard for Proxmox VE, PBS, Docker, Kubernetes, TrueNAS and vSphere. Self-hosted, with alerts for failed backups, full disks, unhealthy containers and offline nodes.

3.8 KB
Raw Blame
package unifiedresources

import "time"

// DataSensitivity classifies data to govern what may leave the local boundary.
type DataSensitivity string

const (
	SensitivityPublic     DataSensitivity = "public"     // Completely safe for cloud model ingestion
	SensitivityInternal   DataSensitivity = "internal"   // Requires active "Cloud Export" organizational toggle
	SensitivitySensitive  DataSensitivity = "sensitive"  // Local or Private models only, unless explicitly redacted
	SensitivityRestricted DataSensitivity = "restricted" // Never allowed to leave the trust boundary (e.g. raw unstructured logs)
)

// ExportDecision defines the deterministic routing result for a piece of context.
type ExportDecision string

const (
	ExportAllowed         ExportDecision = "allowed"
	ExportRequiresConsent ExportDecision = "requires_consent"
	ExportRedacted        ExportDecision = "redacted"
	ExportDenied          ExportDecision = "denied"
)

// RedactionRule provides explicit structure on how to scrub outgoing data.
type RedactionRule struct {
	FieldPath            string            `json:"fieldPath"`     // e.g., "metadata.hostname"
	RedactionType        string            `json:"redactionType"` // e.g., "hash", "mask", "drop"
	ApplyToSensitivities []DataSensitivity `json:"applyToSensitivities"`
}

// ModelRouteDecision holds the result of the Privacy Engine's firewall evaluation.
type ModelRouteDecision struct {
	ResourceID        string         `json:"resourceId"`
	OriginalExport    ExportDecision `json:"originalExport"`
	FinalDecision     ExportDecision `json:"finalDecision"`
	AppliedRedactions []string       `json:"appliedRedactions,omitempty"`
	RoutingReason     string         `json:"routingReason"`
}

// ExportEnvelope represents the actual payload and its governing rules leaving the trust boundary.
type ExportEnvelope struct {
	DestinationModel string             `json:"destinationModel"` // e.g. "gpt-4-turbo" or "local-llama"
	DataPayload      map[string]any     `json:"dataPayload"`
	RouteDecision    ModelRouteDecision `json:"routeDecision"`
	SensitivityFloor DataSensitivity    `json:"sensitivityFloor"` // The highest classification within the payload
}

// ExportAuditRecord durably tracks data leaving the AI Firewall.
type ExportAuditRecord struct {
	ID           string         `json:"id"`
	Timestamp    time.Time      `json:"timestamp"`
	Actor        string         `json:"actor"`
	EnvelopeHash string         `json:"envelopeHash"`
	Decision     ExportDecision `json:"decision"`
	Destination  string         `json:"destination"`
	Redactions   []string       `json:"redactions,omitempty"`
}

// ExportSensitivityFloor returns the canonical highest data-sensitivity floor
// represented by the supplied resource sensitivity counts.
func ExportSensitivityFloor(counts map[ResourceSensitivity]int) DataSensitivity {
	if counts == nil {
		return SensitivityPublic
	}
	if counts[ResourceSensitivityRestricted] > 0 {
		return SensitivityRestricted
	}
	if counts[ResourceSensitivitySensitive] > 0 {
		return SensitivitySensitive
	}
	if counts[ResourceSensitivityInternal] > 0 {
		return SensitivityInternal
	}
	return SensitivityPublic
}

// ExportDecisionForContext returns the canonical export decision and reason for
// governed unified-resource context payloads.
func ExportDecisionForContext(sensitivityFloor DataSensitivity, localOnlyCount int, redactionCount int) (ExportDecision, string) {
	if localOnlyCount > 0 || redactionCount > 0 {
		return ExportRedacted, "governed unified resource context exported in redacted form"
	}

	switch sensitivityFloor {
	case SensitivityRestricted, SensitivitySensitive:
		return ExportRedacted, "governed unified resource context exported in redacted form"
	case SensitivityInternal:
		return ExportRequiresConsent, "internal unified resource context requires export consent"
	default:
		return ExportAllowed, "public unified resource context"
	}
}