feat(config): session correlation header injection configuration #197
+754
−3
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,143 @@ | ||
| package config | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "net/url" | ||
| "strings" | ||
| ) | ||
|
|
||
| // Header names and paths for session correlation. | ||
| const ( | ||
| // SessionIDHeaderName is the fixed HTTP header name boundary injects to | ||
| // carry its session ID. Coder AI Gateway expects exactly this header name. | ||
| SessionIDHeaderName = "X-Coder-Agent-Firewall-Session-Id" | ||
|
|
||
| // SequenceNumberHeaderName is the fixed HTTP header name boundary injects | ||
| // to carry its per-session sequence number. Coder AI Gateway expects | ||
| // exactly this header name. | ||
| SequenceNumberHeaderName = "X-Coder-Agent-Firewall-Sequence-Number" | ||
|
|
||
| // DefaultAIBridgePath is the path glob used when auto-deriving an inject | ||
| // target from CODER_AGENT_URL. | ||
| DefaultAIBridgePath = "/api/v2/aibridge/*" | ||
|
|
||
| // CoderAgentURLEnv is the environment variable set by the Coder workspace | ||
| // agent that points to the control plane. Boundary uses it to derive a | ||
| // default inject target when none is explicitly configured. | ||
| CoderAgentURLEnv = "CODER_AGENT_URL" | ||
| ) | ||
|
|
||
| // InjectTarget represents a parsed target for session correlation header | ||
| // injection. Requests matching the domain (and optional path glob) will | ||
| // receive the session ID and sequence number headers. | ||
| type InjectTarget struct { | ||
|
Collaborator
There was a problem hiding this comment. I'm a bit concerned that rulesengine pkg is well documented, so customers will probably rely on it; and it will be confusing that |
||
| Domain string | ||
| Path string | ||
| } | ||
|
|
||
| // SessionCorrelationConfig holds configuration for session correlation | ||
| // header injection. When enabled, boundary injects its session ID and | ||
| // sequence number as custom headers on matching outbound requests so | ||
| // that an upstream AI Bridge can correlate the request back to the | ||
| // boundary audit event stream. | ||
| type SessionCorrelationConfig struct { | ||
| // Enabled controls whether session correlation headers are injected. | ||
| // Deployments without AI Bridge in front should set this to false. | ||
| Enabled bool | ||
|
|
||
| // InjectTargets is the list of domain/path patterns that should | ||
| // receive session correlation headers. | ||
| InjectTargets []InjectTarget | ||
| } | ||
|
|
||
| // ParseInjectTarget parses a string of the form "domain=... path=..." | ||
| // into an InjectTarget. The domain key is required; path is optional. | ||
| func ParseInjectTarget(raw string) (InjectTarget, error) { | ||
| raw = strings.TrimSpace(raw) | ||
| if raw == "" { | ||
| return InjectTarget{}, fmt.Errorf("inject target must not be empty") | ||
| } | ||
|
|
||
| var target InjectTarget | ||
| seen := make(map[string]bool) | ||
| for _, part := range strings.Fields(raw) { | ||
| key, value, ok := strings.Cut(part, "=") | ||
| if !ok { | ||
| return InjectTarget{}, fmt.Errorf( | ||
| "inject target: malformed key-value pair %q, expected key=value", part, | ||
| ) | ||
| } | ||
| if seen[key] { | ||
| return InjectTarget{}, fmt.Errorf( | ||
| "inject target: duplicate key %q (use separate flags for multiple targets)", key, | ||
| ) | ||
| } | ||
| seen[key] = true | ||
| switch key { | ||
| case "domain": | ||
|
SasSwart marked this conversation as resolved.
|
||
| if value == "" { | ||
| return InjectTarget{}, fmt.Errorf("inject target: domain must not be empty") | ||
| } | ||
| target.Domain = value | ||
| case "path": | ||
| target.Path = value | ||
| default: | ||
| return InjectTarget{}, fmt.Errorf("inject target: unknown key %q", key) | ||
| } | ||
| } | ||
|
|
||
| if target.Domain == "" { | ||
| return InjectTarget{}, fmt.Errorf("inject target: domain is required") | ||
| } | ||
|
|
||
| return target, nil | ||
| } | ||
|
|
||
| // DefaultInjectTargetFromEnv derives an InjectTarget from the CODER_AGENT_URL | ||
| // variable in the provided environment slice. It returns nil if the variable is | ||
| // absent, empty, or not a valid URL with a host. The derived target uses | ||
| // DefaultAIBridgePath as the path glob so that all AI Bridge traffic on the | ||
| // control-plane host is matched. | ||
| // | ||
| // The environ parameter is accepted rather than reading os.Environ directly so | ||
| // that callers (and tests) can supply an arbitrary environment. | ||
| func DefaultInjectTargetFromEnv(environ []string) *InjectTarget { | ||
| var raw string | ||
| for _, e := range environ { | ||
| k, v, ok := strings.Cut(e, "=") | ||
| if ok && k == CoderAgentURLEnv { | ||
| raw = v | ||
| break | ||
| } | ||
| } | ||
| if raw == "" { | ||
| return nil | ||
| } | ||
|
|
||
| u, err := url.Parse(raw) | ||
| if err != nil || u.Host == "" { | ||
| return nil | ||
| } | ||
|
|
||
| return &InjectTarget{ | ||
| Domain: u.Hostname(), | ||
|
SasSwart marked this conversation as resolved.
|
||
| Path: DefaultAIBridgePath, | ||
| } | ||
| } | ||
|
|
||
| // ValidateSessionCorrelation checks that the session correlation config | ||
| // is internally consistent. It returns an error describing the first | ||
| // problem found, or nil if the config is valid. | ||
| func ValidateSessionCorrelation(cfg SessionCorrelationConfig) error { | ||
| if !cfg.Enabled { | ||
| return nil | ||
| } | ||
|
|
||
| if len(cfg.InjectTargets) == 0 { | ||
| return fmt.Errorf( | ||
| "session correlation is enabled but no inject targets are configured", | ||
| ) | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.