model

package
v0.1.2 Latest Latest
Warning

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

 Go to latest Published: Jul 8, 2026 License: MIT Imports: 2 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	AuthModePassthrough            AuthMode   = "passthrough"
	AuthModeOverrideXAPIKey        AuthMode   = "override-x-api-key"
	AuthModeOverrideBearer         AuthMode   = "override-authorization-bearer"
	AuthModeUnsupported            AuthMode   = "unsupported"
	AuthSourceNone                 AuthSource = "none"
	AuthSourceAnthropicAPIKey      AuthSource = "ANTHROPIC_API_KEY"
	AuthSourceAnthropicToken       AuthSource = "ANTHROPIC_AUTH_TOKEN"
	AuthSourceClaudeOAuthToken     AuthSource = "CLAUDE_CODE_OAUTH_TOKEN"
	AuthSourceCCWRAPUpstreamAPIKey AuthSource = "CCWRAP_UPSTREAM_API_KEY"
	AuthSourceCCWRAPUpstreamToken  AuthSource = "CCWRAP_UPSTREAM_AUTH_TOKEN"
)
View Source 
const ControlAPIVersion = "v1"

Variables

This section is empty.

Functions

This section is empty.

Types

type AuthBootstrap 

type AuthBootstrap string
const (
	AuthBootstrapNotNeeded         AuthBootstrap = "not_needed"
	AuthBootstrapPlaceholderActive AuthBootstrap = "placeholder_active"
	AuthBootstrapMissing           AuthBootstrap = "missing"
)

type AuthBootstrapKind 

type AuthBootstrapKind string
const (
	AuthBootstrapKindNone    AuthBootstrapKind = "none"
	AuthBootstrapKindXAPIKey AuthBootstrapKind = "x_api_key"
	AuthBootstrapKindBearer  AuthBootstrapKind = "bearer"
)

type AuthMode 

type AuthMode string

type AuthOverride 

type AuthOverride struct {
	Mode              AuthMode          `json:"mode"`
	Source            AuthSource        `json:"source"`
	HeaderName        string            `json:"header_name"`
	HeaderValue       string            `json:"header_value"`
	AdditionalHeaders map[string]string `json:"additional_headers,omitempty"`
}

type AuthPolicy 

type AuthPolicy string
const (
	AuthPolicyFirstPartyPassthrough    AuthPolicy = "first_party_passthrough"
	AuthPolicyCCWRAPOverride           AuthPolicy = "ccwrap_override"
	AuthPolicyCCWRAPOverrideFailClosed AuthPolicy = "ccwrap_override_fail_closed"
	AuthPolicyUnsafePassthrough        AuthPolicy = "unsafe_passthrough"
)

type AuthSource 

type AuthSource string

type DiscoveredSession 

type DiscoveredSession struct {
	Manifest  SessionManifest `json:"manifest"`
	Reachable bool            `json:"reachable"`
	Stale     bool            `json:"stale"`
	Error     string          `json:"error,omitempty"`
}

type DoctorCheck 

type DoctorCheck struct {
	Name    string         `json:"name"`
	Status  string         `json:"status"`
	Summary string         `json:"summary"`
	Detail  string         `json:"detail,omitempty"`
	Fields  map[string]any `json:"fields,omitempty"`
}

type DoctorReport 

type DoctorReport struct {
	Overall string        `json:"overall"`
	Checks  []DoctorCheck `json:"checks"`
}

type EgressConfig 

type EgressConfig struct {
	Mode       string `json:"mode,omitempty"`
	HTTPProxy  string `json:"http_proxy,omitempty"`
	HTTPSProxy string `json:"https_proxy,omitempty"`
	NoProxy    string `json:"no_proxy,omitempty"`
	Source     string `json:"source,omitempty"`
	Summary    string `json:"summary,omitempty"`
}

type ErrorRecord 

type ErrorRecord struct {
	Timestamp       time.Time `json:"timestamp"`
	SessionID       string    `json:"session_id"`
	Severity        string    `json:"severity"`
	ErrorClass      string    `json:"error_class"`
	Summary         string    `json:"summary"`
	UpstreamHost    string    `json:"upstream_host,omitempty"`
	RetryState      string    `json:"retry_state,omitempty"`
	SuggestedAction string    `json:"suggested_action,omitempty"`
}

type ErrorsResponse 

type ErrorsResponse struct {
	SchemaVersion string        `json:"schema_version,omitempty"`
	Errors        []ErrorRecord `json:"errors"`
}

type Event 

type Event struct {
	ID        string      `json:"id"`
	Type      string      `json:"type"`
	Time      time.Time   `json:"time"`
	SessionID string      `json:"session_id,omitempty"`
	Data      interface{} `json:"data,omitempty"`
}

type FailPolicy 

type FailPolicy string
const (
	FailClosed FailPolicy = "fail-closed"
)

type ModelAliasConfig 

type ModelAliasConfig struct {
	Mode                     ModelAliasMode    `json:"mode,omitempty"`
	Source                   string            `json:"source,omitempty"`
	Strict                   bool              `json:"strict,omitempty"`
	ProviderModelPassthrough bool              `json:"provider_model_passthrough,omitempty"`
	AliasCount               int               `json:"alias_count,omitempty"`
	Fingerprint              string            `json:"fingerprint,omitempty"`
	Forward                  map[string]string `json:"forward,omitempty"`
}

type ModelAliasMode 

type ModelAliasMode string
const (
	ModelAliasDisabled ModelAliasMode = "disabled"
	ModelAliasRewrite  ModelAliasMode = "rewrite"
)

type RelaunchClass 

type RelaunchClass string

RelaunchClass classifies a posture transition (current → candidate profile) for the Provider Profiles feature. It is computed when a profile is selected and consumed by the live-swap and switcher logic. "live" = pure ccwrap-side hot rebind, no Claude restart. "needs_relaunch" = the transition changes what Claude's own process must hold (the narrow exception: hidden/CCWRAP-owned → first-party passthrough), so a fresh session is required. 

const (
	RelaunchLive          RelaunchClass = "live"
	RelaunchNeedsRelaunch RelaunchClass = "needs_relaunch"
)

type RequestBodyRef 

type RequestBodyRef struct {
	ID         string    `json:"id"`
	Size       int64     `json:"size"`
	SHA256     string    `json:"sha256"`
	CapturedAt time.Time `json:"captured_at"`
	Truncated  bool      `json:"truncated"`
}

RequestBodyRef is the in-ring reference to a request body spilled to a per-session file. The 250-ring carries only this, never the bytes. Truncated is set true on the telemetry-capture path when a captured body exceeds telemetryBodyCapBytes and is stored truncated; the (uncapped) request-body path leaves it false.

type RequestRecord 

type RequestRecord struct {
	Timestamp          time.Time       `json:"timestamp"`
	SessionID          string          `json:"session_id"`
	Method             string          `json:"method"`
	Synthetic          bool            `json:"synthetic,omitempty"`
	LogicalTargetHost  string          `json:"logical_target_host"`
	ActualUpstreamHost string          `json:"actual_upstream_host"`
	Path               string          `json:"path"`
	StatusCode         int             `json:"status_code"`
	LatencyMS          int64           `json:"latency_ms"`
	StreamState        StreamState     `json:"stream_state"`
	RequestHeaders     http.Header     `json:"request_headers,omitempty"`
	BodyRef            *RequestBodyRef `json:"body_ref,omitempty"`
	// UpstreamBodyRef is the body as it lands on the wire to the upstream
	// — captured AFTER all in-supervisor request mutators (modelalias
	// rewrite, system-block stripping). Set ONLY when capture is on AND
	// the rewrite pipeline actually changed the body; nil means "same as
	// BodyRef" (no ccwrap-side mutation occurred). The inspector drawer
	// surfaces a tab between client view (BodyRef) and upstream view.
	UpstreamBodyRef *RequestBodyRef `json:"upstream_body_ref,omitempty"`
	// ResponseBodyRef is the captured upstream RESPONSE body. It is spilled on
	// the Anthropic API MITM path when body capture is on (the streaming tee),
	// and on the transparent telemetry-MITM path when telemetry capture is on.
	// Nil when neither capture is active for this request.
	ResponseBodyRef *RequestBodyRef `json:"response_body_ref,omitempty"`
	// Identity captured at request time from the immutable *activePosture
	// so post-switch records carry the posture they ran under — never the
	// latest posture (timeline correctness).
	ActiveProfileName     string `json:"active_profile_name,omitempty"`
	ActiveProfileProvider string `json:"active_profile_provider,omitempty"`
}

func (RequestRecord) MethodLabel 

func (r RequestRecord) MethodLabel() string

MethodLabel returns the display label for the request's HTTP method. Synthetic responses surface as "SYNTHETIC" so UI consumers don't lose the visual cue, while the underlying Method field stores the real HTTP verb so programmatic filters by method behave correctly.

type RequestsResponse 

type RequestsResponse struct {
	SchemaVersion string          `json:"schema_version,omitempty"`
	Requests      []RequestRecord `json:"requests"`
}

type RouteClass 

type RouteClass string
const (
	RouteClassFirstParty           RouteClass = "first_party"
	RouteClassThirdPartyHidden     RouteClass = "third_party_hidden"
	RouteClassThirdPartyCompatible RouteClass = "third_party_compatible"
)

type RouteSource 

type RouteSource string
const (
	RouteSourceExplicit       RouteSource = "explicit"
	RouteSourceInheritedEnv   RouteSource = "inherited_env"
	RouteSourceClaudeSettings RouteSource = "claude_settings"
	RouteSourceFlagSettings   RouteSource = "flag_settings"
	RouteSourcePolicySettings RouteSource = "policy_settings"
	RouteSourceFallback       RouteSource = "fallback_default"
)

type Session 

type Session struct {
	ID                                 string            `json:"id"`
	Name                               string            `json:"name,omitempty"`
	CreatedAt                          time.Time         `json:"created_at"`
	UpdatedAt                          time.Time         `json:"updated_at"`
	EndedAt                            *time.Time        `json:"ended_at,omitempty"`
	State                              SessionState      `json:"state"`
	Health                             SessionHealth     `json:"session_health"`
	SupervisorPID                      int               `json:"supervisor_pid,omitempty"`
	LauncherPID                        int               `json:"launcher_pid,omitempty"`
	ClaudePID                          int               `json:"claude_pid,omitempty"`
	ClaudeStartToken                   string            `json:"claude_start_token,omitempty"`
	ProxyListenAddr                    string            `json:"proxy_listen_addr"`
	APIBaseURL                         string            `json:"api_base_url,omitempty"`
	RouteClass                         RouteClass        `json:"route_class,omitempty"`
	RouteSource                        RouteSource       `json:"route_source"`
	RouteConfigSource                  string            `json:"route_config_source,omitempty"`
	AuthMode                           AuthMode          `json:"auth_mode"`
	AuthSource                         AuthSource        `json:"auth_source"`
	AuthConfigSource                   string            `json:"auth_config_source,omitempty"`
	AuthPolicy                         AuthPolicy        `json:"auth_policy,omitempty"`
	AuthBootstrap                      AuthBootstrap     `json:"auth_bootstrap,omitempty"`
	AuthBootstrapKind                  AuthBootstrapKind `json:"auth_bootstrap_kind,omitempty"`
	ExactUpstreamHost                  string            `json:"exact_upstream_host,omitempty"`
	ExactUpstreamBase                  string            `json:"exact_upstream_base,omitempty"`
	EgressMode                         string            `json:"egress_mode,omitempty"`
	EgressSource                       string            `json:"egress_source,omitempty"`
	EgressSummary                      string            `json:"egress_summary,omitempty"`
	ModelAliasMode                     ModelAliasMode    `json:"model_alias_mode,omitempty"`
	ModelAliasCount                    int               `json:"model_alias_count,omitempty"`
	ModelAliasSource                   string            `json:"model_alias_source,omitempty"`
	ModelAliasStrict                   bool              `json:"model_alias_strict,omitempty"`
	ModelAliasProviderModelPassthrough bool              `json:"model_alias_provider_model_passthrough,omitempty"`
	ModelAliasFingerprint              string            `json:"model_alias_fingerprint,omitempty"`
	ModelAliasForward                  map[string]string `json:"model_alias_forward,omitempty"`
	UpstreamHeaderCount                int               `json:"upstream_header_count,omitempty"`
	UpstreamHeaderSource               string            `json:"upstream_header_source,omitempty"`
	UpstreamHeaderFingerprint          string            `json:"upstream_header_fingerprint,omitempty"`
	FailPolicy                         FailPolicy        `json:"fail_policy"`
	RecentErrorCount                   int               `json:"recent_error_count"`
	RecentRequestCount                 int               `json:"recent_request_count"`
	ActiveProfileName                  string            `json:"active_profile_name,omitempty"`
	ActiveProfileProvider              string            `json:"active_profile_provider,omitempty"`
	// CaptureBodies mirrors the per-session captureBodies routing flag so the
	// inspect-web ribbon can render a "Bodies: on/off" cell and the runtime
	// /capture/bodies toggle has a state to report. Launch-time initial value
	// comes from SessionRouteRequest.CaptureRequestBodies (set by the CCWRAP
	// launcher from --capture-request-bodies / CCWRAP_CAPTURE_BODIES); runtime
	// changes via Supervisor.SetCaptureBodies emit session_updated events
	// with this field flipped.
	CaptureBodies bool `json:"capture_bodies,omitempty"`
	// CaptureTelemetry mirrors the per-session captureTelemetry routing flag
	// (the opt-in transparent telemetry MITM) into the public projection so the
	// inspect ribbon + status reflect it; flips via Supervisor.SetCaptureTelemetry.
	CaptureTelemetry bool `json:"capture_telemetry,omitempty"`
	// NativeTLS surfaces the native-fingerprint TLS state the user opted into:
	// "" / "off" (feature inactive), "active" (CC's captured ClientHello is being
	// mirrored upstream — parity is being delivered), or "blocked: <reason>" (the
	// mirror could not be produced, so ccwrap BLOCKED the request fail-closed
	// rather than emit a de-anonymizing stdlib fingerprint — no request was sent).
	// A blocked state drives session Health to error so the loss of parity (and
	// the failing requests) is visible. This is a client property, preserved
	// across a profile switch by publishPosture.
	NativeTLS string `json:"native_tls,omitempty"`
	// NativeTLSLoaded is true when the mirrored hello was LOADED from
	// CCWRAP_NATIVE_TLS_HELLO, not captured from the live client. A client
	// property, preserved across a profile switch by publishPosture (sticky,
	// like NativeTLS).
	NativeTLSLoaded bool `json:"native_tls_loaded,omitempty"`
	// NativeTLSFallbacks counts native-TLS block EPISODES (transitions into a
	// blocked state) over the session's lifetime — NOT blocked dials, so a
	// persistent outage is one episode, not one-per-dial. Monotonic; surfaced
	// alongside NativeTLS so a single transient block is distinguishable from a
	// recurring one.
	NativeTLSFallbacks int `json:"native_tls_fallbacks,omitempty"`
	// CaptureBodiesUnmasked is set when the supervisor was launched with
	// CCWRAP_UNMASK_CREDENTIALS=1. The flag is
	// process-wide and immutable for the session; it bypasses the bodyredact
	// JSON-field redaction so OAuth refresh_token / access_token values
	// appear in plaintext in inspect drawer and spill files. The inspect
	// ribbon's Bodies cell renders a persistent danger-color "UNMASKED"
	// marker when this is true so the user does not forget the env flag.
	CaptureBodiesUnmasked bool `json:"capture_bodies_unmasked,omitempty"`
	// MissingAuthEnv names the env var the active profile asked ccwrap to
	// bootstrap auth from when no value was found. Empty in two cases:
	// (a) auth is fine (the common case) — distinguish via AuthBootstrap
	// != AuthBootstrapMissing; (b) AuthBootstrap == AuthBootstrapMissing
	// but the profile didn't name a specific env var (Case B — no auth
	// source configured at all). The UI branches on emptiness:
	//   AuthBootstrap=Missing, MissingAuthEnv="X"  → "needs $X"
	//   AuthBootstrap=Missing, MissingAuthEnv=""   → "no auth source configured"
	//
	// Fail-closed is enforced at forward-time rather than launch-time, so
	// AuthBootstrap==Missing is observable in a running session (launch
	// succeeds; requests fail).
	MissingAuthEnv string `json:"missing_auth_env,omitempty"`
}

type SessionAttachRequest 

type SessionAttachRequest struct {
	ClaudePID        int    `json:"claude_pid"`
	ClaudeStartToken string `json:"claude_start_token,omitempty"`
}

type SessionCloseRequest 

type SessionCloseRequest struct {
	Reason string `json:"reason,omitempty"`
}

type SessionCreateRequest 

type SessionCreateRequest struct {
	ID          string `json:"id,omitempty"`
	Name        string `json:"name,omitempty"`
	LauncherPID int    `json:"launcher_pid"`
}

type SessionCreateResponse 

type SessionCreateResponse struct {
	SchemaVersion string  `json:"schema_version,omitempty"`
	Session       Session `json:"session"`
}

type SessionHealth 

type SessionHealth string

SessionHealth is the orthogonal "is recent activity healthy" dimension, independent of lifecycle State. It reflects the result of the MOST RECENT activity: ok = last request succeeded; warn = last activity was a deliberate policy refusal (e.g. ccwrap_auth_missing); error = last activity was a real upstream/transport/config failure. Empty string is treated as ok at render. 

const (
	HealthOK    SessionHealth = "ok"
	HealthWarn  SessionHealth = "warn"
	HealthError SessionHealth = "error"
)

type SessionManifest 

type SessionManifest struct {
	SessionID                          string            `json:"session_id"`
	CreatedAt                          time.Time         `json:"created_at"`
	UpdatedAt                          time.Time         `json:"updated_at"`
	State                              SessionState      `json:"state"`
	SupervisorPID                      int               `json:"supervisor_pid"`
	SupervisorStartToken               string            `json:"supervisor_start_token,omitempty"`
	ClaudePID                          int               `json:"claude_pid,omitempty"`
	Name                               string            `json:"name,omitempty"`
	ControlSocket                      string            `json:"control_socket"`
	ProxyListenAddr                    string            `json:"proxy_listen_addr,omitempty"`
	ProxyInfoURL                       string            `json:"proxy_info_url,omitempty"`
	RouteClass                         RouteClass        `json:"route_class,omitempty"`
	RouteSource                        RouteSource       `json:"route_source,omitempty"`
	RouteConfigSource                  string            `json:"route_config_source,omitempty"`
	ExactUpstreamBase                  string            `json:"exact_upstream_base,omitempty"`
	AuthMode                           AuthMode          `json:"auth_mode,omitempty"`
	AuthSource                         AuthSource        `json:"auth_source,omitempty"`
	AuthConfigSource                   string            `json:"auth_config_source,omitempty"`
	AuthPolicy                         AuthPolicy        `json:"auth_policy,omitempty"`
	AuthBootstrap                      AuthBootstrap     `json:"auth_bootstrap,omitempty"`
	AuthBootstrapKind                  AuthBootstrapKind `json:"auth_bootstrap_kind,omitempty"`
	EgressMode                         string            `json:"egress_mode,omitempty"`
	EgressSource                       string            `json:"egress_source,omitempty"`
	EgressSummary                      string            `json:"egress_summary,omitempty"`
	ModelAliasMode                     ModelAliasMode    `json:"model_alias_mode,omitempty"`
	ModelAliasCount                    int               `json:"model_alias_count,omitempty"`
	ModelAliasSource                   string            `json:"model_alias_source,omitempty"`
	ModelAliasProviderModelPassthrough bool              `json:"model_alias_provider_model_passthrough,omitempty"`
	ModelAliasFingerprint              string            `json:"model_alias_fingerprint,omitempty"`
}

type SessionRouteRequest 

type SessionRouteRequest struct {
	APIBaseURL                string            `json:"api_base_url"`
	RouteClass                RouteClass        `json:"route_class,omitempty"`
	RouteSource               RouteSource       `json:"route_source"`
	RouteConfigSource         string            `json:"route_config_source,omitempty"`
	AuthMode                  AuthMode          `json:"auth_mode"`
	AuthSource                AuthSource        `json:"auth_source"`
	AuthConfigSource          string            `json:"auth_config_source,omitempty"`
	AuthPolicy                AuthPolicy        `json:"auth_policy,omitempty"`
	AuthBootstrap             AuthBootstrap     `json:"auth_bootstrap,omitempty"`
	AuthBootstrapKind         AuthBootstrapKind `json:"auth_bootstrap_kind,omitempty"`
	ExactUpstreamHost         string            `json:"exact_upstream_host,omitempty"`
	ExactUpstreamBase         string            `json:"exact_upstream_base,omitempty"`
	FailPolicy                FailPolicy        `json:"fail_policy"`
	OverrideAuth              *AuthOverride     `json:"override_auth,omitempty"`
	Egress                    EgressConfig      `json:"egress,omitempty"`
	ModelAlias                ModelAliasConfig  `json:"model_alias,omitempty"`
	UpstreamHeaders           map[string]string `json:"upstream_headers,omitempty"`
	UpstreamHeaderSource      string            `json:"upstream_header_source,omitempty"`
	UpstreamHeaderFingerprint string            `json:"upstream_header_fingerprint,omitempty"`
	CaptureRequestBodies      bool              `json:"capture_request_bodies,omitempty"`
	CaptureTelemetry          bool              `json:"capture_telemetry,omitempty"`
	NativeTLS                 bool              `json:"native_tls,omitempty"`
	// NativeTLSHello carries loaded ClientHello bytes that override live
	// capture; nil = capture the live client.
	NativeTLSHello        []byte `json:"native_tls_hello,omitempty"`
	ActiveProfileName     string `json:"active_profile_name,omitempty"`
	ActiveProfileProvider string `json:"active_profile_provider,omitempty"`
	// MissingAuthEnv mirrors preflight.Result.MissingAuthEnv across the
	// control socket so the supervisor session can carry the detail for UI
	// rendering. Empty in healthy / Case B; non-empty for Case A.
	MissingAuthEnv string `json:"missing_auth_env,omitempty"`
}

SessionRouteRequest is the /route control-op payload, RETAINED AS TEST-FIXTURE INFRA: production launch + SwitchProfile publish a routing posture directly from a *preflight.Result (supervisor.newResolved), so no production caller constructs this type. The supervisor's setRoute handler + control.Client.SetRoute remain so the test suite can configure a session's posture from a literal request (supervisor.resolvedFromRequest mirrors newResolved field-for-field).

type SessionState 

type SessionState string
const (
	StateCreated   SessionState = "created"
	StateLaunching SessionState = "launching"
	StateAttached  SessionState = "attached"
	StateActive    SessionState = "active"
	StateEnded     SessionState = "ended"
)

type SessionsResponse 

type SessionsResponse struct {
	SchemaVersion string    `json:"schema_version,omitempty"`
	Sessions      []Session `json:"sessions"`
}

type StatusResponse 

type StatusResponse struct {
	SchemaVersion    string    `json:"schema_version,omitempty"`
	Health           string    `json:"health"`
	StartedAt        time.Time `json:"started_at"`
	Timestamp        time.Time `json:"timestamp"`
	RuntimeDir       string    `json:"runtime_dir"`
	StateDir         string    `json:"state_dir"`
	SocketPath       string    `json:"socket_path"`
	SessionID        string    `json:"session_id,omitempty"`
	ProxyListenAddr  string    `json:"proxy_listen_addr,omitempty"`
	RecentErrorCount int       `json:"recent_error_count"`
}

type StreamState 

type StreamState string
const (
	StreamStateHTTP      StreamState = "http"
	StreamStateSSE       StreamState = "sse"
	StreamStateWebSocket StreamState = "websocket"
	StreamStateMultipart StreamState = "multipart"
	StreamStateUnknown   StreamState = "unknown"
)

type TraceRecord 

type TraceRecord struct {
	Timestamp time.Time `json:"timestamp"`
	SessionID string    `json:"session_id"`
	Category  string    `json:"category"`
	Summary   string    `json:"summary"`
	Detail    string    `json:"detail,omitempty"`
}

type TraceResponse 

type TraceResponse struct {
	SchemaVersion string        `json:"schema_version,omitempty"`
	Trace         []TraceRecord `json:"trace"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.