diff --git a/packages/api/agent_vault.go b/packages/api/agent_vault.go index 59ce65eb..0c8c6aa2 100644 --- a/packages/api/agent_vault.go +++ b/packages/api/agent_vault.go @@ -304,10 +304,11 @@ func CallCreateAgentVaultSessionLogChunk(ctx context.Context, httpClient *resty. } type CreateAgentVaultSessionRequest struct { - ProjectID string `json:"projectId,omitempty"` - AccessBundle string `json:"accessBundle"` - TTL string `json:"ttl"` - Label string `json:"label,omitempty"` + ProjectID string `json:"projectId,omitempty"` + AccessBundle string `json:"accessBundle"` + TTL string `json:"ttl"` + Label string `json:"label,omitempty"` + Metadata map[string]string `json:"metadata,omitempty"` } type AgentVaultSessionAccessBundle struct { @@ -320,6 +321,7 @@ type AgentVaultSession struct { Token string `json:"token"` ProjectID string `json:"projectId"` Label *string `json:"label"` + Metadata map[string]string `json:"metadata"` AccessBundle *AgentVaultSessionAccessBundle `json:"accessBundle"` ExpiresAt *string `json:"expiresAt"` CreatedAt string `json:"createdAt"` diff --git a/packages/api/agent_vault_test.go b/packages/api/agent_vault_test.go index e6dd13a3..6e16aba3 100644 --- a/packages/api/agent_vault_test.go +++ b/packages/api/agent_vault_test.go @@ -76,6 +76,24 @@ func TestCreateAgentVaultSessionRequestSendsALabelOnlyWhenGiven(t *testing.T) { } } +func TestCreateAgentVaultSessionRequestSendsMetadataOnlyWhenGiven(t *testing.T) { + without, err := json.Marshal(CreateAgentVaultSessionRequest{AccessBundle: "coding-agent", TTL: "never"}) + if err != nil { + t.Fatal(err) + } + if strings.Contains(string(without), "metadata") { + t.Errorf("want no metadata key, got %s", without) + } + + with, err := json.Marshal(CreateAgentVaultSessionRequest{AccessBundle: "coding-agent", TTL: "never", Metadata: map[string]string{"runId": "8812"}}) + if err != nil { + t.Fatal(err) + } + if !strings.Contains(string(with), `"metadata":{"runId":"8812"}`) { + t.Errorf("want the metadata as an object in the body, got %s", with) + } +} + func TestCreateAgentVaultSessionRequestSendsTheProject(t *testing.T) { body, err := json.Marshal(CreateAgentVaultSessionRequest{ProjectID: "p1", AccessBundle: "coding-agent", TTL: "never"}) if err != nil { diff --git a/packages/cmd/agent_vault_run.go b/packages/cmd/agent_vault_run.go index 3610e745..5e8513f9 100644 --- a/packages/cmd/agent_vault_run.go +++ b/packages/cmd/agent_vault_run.go @@ -273,6 +273,45 @@ func resolveAgentVaultSessionLabel(cmd *cobra.Command, sessionToken string, toke return strings.TrimSpace(label), nil } +// resolveAgentVaultSessionMetadata returns the metadata to send when this command mints a session, refusing +// --metadata alongside a session token for the same reason as --label. +func resolveAgentVaultSessionMetadata(cmd *cobra.Command, sessionToken string, tokenSource agentVaultSource) (map[string]string, error) { + if sessionToken != "" && cmd.Flags().Changed("metadata") { + return nil, fmt.Errorf( + "--metadata applies to a session this command mints; edit the metadata of the one behind %s in the dashboard. Drop --metadata, or mint here with --access-bundle", + agentVaultSourceName(tokenSource, "--session-token", agentVaultSessionTokenEnv)) + } + values, _ := cmd.Flags().GetStringArray("metadata") + return parseAgentVaultSessionMetadata(values) +} + +// parseAgentVaultSessionMetadata splits each value on its first "=", so a value may itself contain "=" and a key +// can't. Other limits on keys and values are left to the server, which reports them. +func parseAgentVaultSessionMetadata(values []string) (map[string]string, error) { + if len(values) == 0 { + return nil, nil + } + metadata := make(map[string]string, len(values)) + for _, entry := range values { + key, value, found := strings.Cut(entry, "=") + key = strings.TrimSpace(key) + if !found || key == "" { + return nil, &util.CLIError{Code: errCodeInvalidFlagValue, Message: "--metadata takes key=value, such as --metadata runId=8812"} + } + if _, seen := metadata[key]; seen { + return nil, &util.CLIError{Code: errCodeInvalidFlagValue, + Message: fmt.Sprintf("--metadata sets %s more than once; pass each key once", quoted(key, "metadata key"))} + } + value = strings.TrimSpace(value) + if value == "" { + return nil, &util.CLIError{Code: errCodeInvalidFlagValue, + Message: "--metadata takes key=value with a non-empty value, such as --metadata runId=8812"} + } + metadata[key] = value + } + return metadata, nil +} + // None of these can reach a session minted in the dashboard: its expiry and project were fixed when it was // created, and this command never revokes it. func refuseAgentVaultMintOnlyFlags(cmd *cobra.Command, sessionToken string, tokenSource agentVaultSource) error { @@ -335,6 +374,10 @@ func runAgentVaultRun(cmd *cobra.Command, args []string) { if err != nil { util.HandleError(err) } + metadata, err := resolveAgentVaultSessionMetadata(cmd, sessionToken, tokenSource) + if err != nil { + util.HandleError(err) + } if err := refuseAgentVaultMintOnlyFlags(cmd, sessionToken, tokenSource); err != nil { util.HandleError(err) @@ -439,7 +482,7 @@ func runAgentVaultRun(cmd *cobra.Command, args []string) { var minted *api.AgentVaultSession if len(accessBundles) > 0 { identity := resolveAgentVaultIdentityToken(cmd) - minted = mintAgentVaultSessionOrExit(identity, project, accessBundles, ttl, label) + minted = mintAgentVaultSessionOrExit(identity, project, accessBundles, ttl, label, metadata) sessionToken = minted.Token Telemetry.SetActor(telemetry.IdentityClaimsFromToken(identity)) @@ -1002,6 +1045,7 @@ func init() { agentVaultRunCmd.Flags().Bool("keep-session", false, "leave a minted session active when the agent exits") agentVaultRunCmd.Flags().String("project-id", "", "Agent Vault project of the access bundle to mint over (falls back to "+agentVaultProjectIDEnv+", then INFISICAL_PROJECT_ID)") agentVaultRunCmd.Flags().String("label", "", "describe what the session this command creates is for (up to 128 characters)") + agentVaultRunCmd.Flags().StringArray("metadata", nil, "attach a key=value pair to the session this command creates, such as runId=8812 (repeatable, up to 20; the value can contain = but the key can't)") agentVaultRunCmd.Flags().String("proxy", "", "address of the Agent Vault proxy as host:port (falls back to "+agentVaultProxyAddressEnv+")") agentVaultRunCmd.Flags().String("ca-fingerprint", "", "abort unless the proxy's certificate authority matches this SHA256 fingerprint from Infisical") agentVaultRunCmd.Flags().String("no-proxy", "", "additional comma-separated hosts to bypass the proxy (always merged with localhost,127.0.0.1)") diff --git a/packages/cmd/agent_vault_run_test.go b/packages/cmd/agent_vault_run_test.go index 95c5e40b..decd0623 100644 --- a/packages/cmd/agent_vault_run_test.go +++ b/packages/cmd/agent_vault_run_test.go @@ -537,6 +537,84 @@ func TestResolveAgentVaultSessionLabelRefusesASessionToken(t *testing.T) { } } +func metadataCmd(t *testing.T, args ...string) *cobra.Command { + t.Helper() + cmd := &cobra.Command{Use: "run", Run: func(*cobra.Command, []string) {}} + cmd.Flags().StringArray("metadata", nil, "") + if err := cmd.Flags().Parse(args); err != nil { + t.Fatal(err) + } + return cmd +} + +func TestParseAgentVaultSessionMetadata(t *testing.T) { + got, err := parseAgentVaultSessionMetadata([]string{" runId = 8812 ", "query=a=b"}) + if err != nil { + t.Fatal(err) + } + want := map[string]string{"runId": "8812", "query": "a=b"} + if len(got) != len(want) { + t.Fatalf("got %v, want %v", got, want) + } + for key, value := range want { + if got[key] != value { + t.Errorf("%s = %q, want %q", key, got[key], value) + } + } + + if got, err := parseAgentVaultSessionMetadata(nil); err != nil || got != nil { + t.Errorf("no values: got %v, %v; want nil and no error", got, err) + } +} + +func TestParseAgentVaultSessionMetadataRefusesAMalformedPair(t *testing.T) { + for _, value := range []string{"runId", "=8812", " =8812", ""} { + _, err := parseAgentVaultSessionMetadata([]string{value}) + if err == nil || err.Error() != "--metadata takes key=value, such as --metadata runId=8812" { + t.Errorf("%q: err = %v", value, err) + } + } +} + +func TestParseAgentVaultSessionMetadataRefusesAnEmptyValue(t *testing.T) { + for _, value := range []string{"flag=", "flag= "} { + _, err := parseAgentVaultSessionMetadata([]string{value}) + if err == nil || err.Error() != "--metadata takes key=value with a non-empty value, such as --metadata runId=8812" { + t.Errorf("%q: err = %v", value, err) + } + } +} + +func TestParseAgentVaultSessionMetadataRefusesARepeatedKey(t *testing.T) { + _, err := parseAgentVaultSessionMetadata([]string{"runId=1", " runId =2"}) + if err == nil || !strings.Contains(err.Error(), `"runId"`) { + t.Errorf("err = %v, want one naming runId", err) + } +} + +func TestResolveAgentVaultSessionMetadataRefusesASessionToken(t *testing.T) { + for _, tc := range []struct { + source agentVaultSource + names string + }{ + {agentVaultSourceFlag, "--session-token"}, + {agentVaultSourceEnv, agentVaultSessionTokenEnv}, + } { + _, err := resolveAgentVaultSessionMetadata(metadataCmd(t, "--metadata", "runId=8812"), "agv_token", tc.source) + if err == nil { + t.Fatalf("token from %s: want an error", tc.names) + } + if !strings.Contains(err.Error(), tc.names) || !strings.Contains(err.Error(), "--metadata") { + t.Errorf("the message should name --metadata and %q, got %q", tc.names, err) + } + } + + metadata, err := resolveAgentVaultSessionMetadata(metadataCmd(t, "--metadata", "runId=8812"), "", agentVaultSourceNone) + if err != nil || metadata["runId"] != "8812" { + t.Errorf("minting: got %v, %v", metadata, err) + } +} + func TestAgentVaultLoginReadErrorShowsAllButAMissingLogin(t *testing.T) { if err := agentVaultLoginReadError(nil); err != nil { t.Fatalf("no error: %v", err) diff --git a/packages/cmd/agent_vault_sessions.go b/packages/cmd/agent_vault_sessions.go index d6f48ac7..300e6487 100644 --- a/packages/cmd/agent_vault_sessions.go +++ b/packages/cmd/agent_vault_sessions.go @@ -37,22 +37,23 @@ Only the token is printed, so it can be captured into a variable: export INFISICAL_AGENT_VAULT_SESSION_TOKEN=$(infisical agent-vault sessions create --access-bundle coding-agent --ttl 8h) -Pass -o json or -o yaml for the session's ID, project, access bundle, label and expiry as well. The session +Pass -o json or -o yaml for the session's ID, project, access bundle, label, metadata and expiry as well. The session stays active until it expires or you revoke it with 'infisical agent-vault sessions revoke'.`, Example: ` infisical agent-vault sessions create --access-bundle coding-agent --ttl 8h - infisical agent-vault sessions create --project-id 4f0c... --access-bundle coding-agent --label "nightly deploy" -o json`, + infisical agent-vault sessions create --project-id 4f0c... --access-bundle coding-agent --label "nightly deploy" --metadata runId=8812 -o json`, DisableFlagsInUseLine: true, Args: cobra.NoArgs, Run: runAgentVaultSessionsCreate, } type agentVaultSessionOutput struct { - ID string `json:"id"` - Token string `json:"token"` - ProjectID string `json:"projectId"` - AccessBundle string `json:"accessBundle"` - Label *string `json:"label"` - ExpiresAt *string `json:"expiresAt"` + ID string `json:"id"` + Token string `json:"token"` + ProjectID string `json:"projectId"` + AccessBundle string `json:"accessBundle"` + Label *string `json:"label"` + Metadata map[string]string `json:"metadata"` + ExpiresAt *string `json:"expiresAt"` } func runAgentVaultSessionsCreate(cmd *cobra.Command, args []string) { @@ -85,10 +86,15 @@ func runAgentVaultSessionsCreate(cmd *cobra.Command, args []string) { ttl, _ := cmd.Flags().GetString("ttl") label, _ := cmd.Flags().GetString("label") label = strings.TrimSpace(label) + metadataValues, _ := cmd.Flags().GetStringArray("metadata") + metadata, err := parseAgentVaultSessionMetadata(metadataValues) + if err != nil { + exitWithError(cmd, err) + } stdoutIsTerminal := isatty.IsTerminal(os.Stdout.Fd()) || isatty.IsCygwinTerminal(os.Stdout.Fd()) identity := resolveAgentVaultIdentity(cmd, stdoutIsTerminal) - minted, err := mintAgentVaultSession(newAgentVaultAPIClient(identity), project, accessBundles, ttl, label) + minted, err := mintAgentVaultSession(newAgentVaultAPIClient(identity), project, accessBundles, ttl, label, metadata) if err != nil { exitWithError(cmd, classifyAgentVaultAPIError(err, project, accessBundles[0]), append([]string{"Unable to mint an Agent Vault session"}, agentVaultProjectHints(err, project)...)...) @@ -100,6 +106,7 @@ func runAgentVaultSessionsCreate(cmd *cobra.Command, args []string) { Set("platform", runtime.GOOS). Set("ttl", ttl). Set("labeled", label != ""). + Set("hasMetadata", len(metadata) > 0). Set("projectSource", agentVaultProjectSourceKind(project)). Set("output", outputFormat)) @@ -121,11 +128,16 @@ func agentVaultSessionOutputFrom(minted api.AgentVaultSession, project agentVaul ProjectID: cmp.Or(minted.ProjectID, project.ID), AccessBundle: accessBundle, Label: minted.Label, + Metadata: minted.Metadata, ExpiresAt: minted.ExpiresAt, } if minted.AccessBundle != nil { out.AccessBundle = minted.AccessBundle.Name } + // An older server sends no metadata; print an empty object rather than null so scripts can always index it. + if out.Metadata == nil { + out.Metadata = map[string]string{} + } return out } @@ -250,12 +262,13 @@ func validateAgentVaultAccessBundles(bundles []string, source agentVaultSource) return nil } -func mintAgentVaultSession(httpClient *resty.Client, project agentVaultProject, accessBundles []string, ttl, label string) (api.AgentVaultSession, error) { +func mintAgentVaultSession(httpClient *resty.Client, project agentVaultProject, accessBundles []string, ttl, label string, metadata map[string]string) (api.AgentVaultSession, error) { created, err := api.CallCreateAgentVaultSession(httpClient, api.CreateAgentVaultSessionRequest{ ProjectID: project.ID, AccessBundle: accessBundles[0], TTL: ttl, Label: label, + Metadata: metadata, }) if err != nil { return api.AgentVaultSession{}, err @@ -272,8 +285,8 @@ func newAgentVaultAPIClient(identity string) *resty.Client { return httpClient } -func mintAgentVaultSessionOrExit(identity string, project agentVaultProject, accessBundles []string, ttl, label string) *api.AgentVaultSession { - minted, err := mintAgentVaultSession(newAgentVaultAPIClient(identity), project, accessBundles, ttl, label) +func mintAgentVaultSessionOrExit(identity string, project agentVaultProject, accessBundles []string, ttl, label string, metadata map[string]string) *api.AgentVaultSession { + minted, err := mintAgentVaultSession(newAgentVaultAPIClient(identity), project, accessBundles, ttl, label, metadata) if err != nil { util.HandleError(err, append([]string{"Unable to mint an Agent Vault session"}, agentVaultProjectHints(err, project)...)...) } @@ -285,9 +298,10 @@ func init() { agentVaultSessionsCreateCmd.Flags().StringArray("access-bundle", nil, "create the session over the access bundle with this `name` (falls back to "+agentVaultAccessBundleEnv+")") agentVaultSessionsCreateCmd.Flags().String("ttl", "never", "lifetime of the session: one number and one unit, such as 30m, 8h or 7d (not 2h30m), or never") agentVaultSessionsCreateCmd.Flags().String("label", "", "describe what the session is for (up to 128 characters)") + agentVaultSessionsCreateCmd.Flags().StringArray("metadata", nil, "attach a key=value pair to the session, such as runId=8812 (repeatable, up to 20; the value can contain = but the key can't)") agentVaultSessionsCreateCmd.Flags().String("client-id", "", "universal auth client id of the machine identity that creates the session (falls back to INFISICAL_UNIVERSAL_AUTH_CLIENT_ID)") agentVaultSessionsCreateCmd.Flags().String("client-secret", "", "universal auth client secret of that machine identity (falls back to INFISICAL_UNIVERSAL_AUTH_CLIENT_SECRET)") - agentVaultSessionsCreateCmd.Flags().StringP("output", "o", "", "print the session's ID, token, project, access bundle, label and expiry as json or yaml, instead of only its token") + agentVaultSessionsCreateCmd.Flags().StringP("output", "o", "", "print the session's ID, token, project, access bundle, label, metadata and expiry as json or yaml, instead of only its token") agentVaultSessionsRevokeCmd.Flags().String("session-token", "", "revoke the session this session token belongs to, instead of naming it by ID (falls back to "+agentVaultSessionTokenEnv+" when no ID is given)") agentVaultSessionsRevokeCmd.Flags().String("client-id", "", "universal auth client id of the machine identity to revoke as (falls back to INFISICAL_UNIVERSAL_AUTH_CLIENT_ID)") diff --git a/packages/cmd/agent_vault_sessions_test.go b/packages/cmd/agent_vault_sessions_test.go index 686f4c7d..db467fbc 100644 --- a/packages/cmd/agent_vault_sessions_test.go +++ b/packages/cmd/agent_vault_sessions_test.go @@ -9,6 +9,7 @@ import ( "net/http/httptest" "os" "path/filepath" + "reflect" "strings" "testing" "time" @@ -38,7 +39,7 @@ func TestMintAgentVaultSessionSendsTheProject(t *testing.T) { config.INFISICAL_URL = srv.URL + "/api" t.Cleanup(func() { config.INFISICAL_URL = old }) - minted, err := mintAgentVaultSession(resty.New(), agentVaultProject{ID: projectFromFlag}, []string{"coding-agent"}, "8h", "") + minted, err := mintAgentVaultSession(resty.New(), agentVaultProject{ID: projectFromFlag}, []string{"coding-agent"}, "8h", "", nil) if err != nil { t.Fatal(err) } @@ -48,6 +49,9 @@ func TestMintAgentVaultSessionSendsTheProject(t *testing.T) { if _, ok := sent["label"]; ok { t.Fatalf("an empty label should stay out of the body: %v", sent) } + if _, ok := sent["metadata"]; ok { + t.Fatalf("no metadata should stay out of the body: %v", sent) + } if minted.Token != "agv_x" || minted.ProjectID != projectFromFlag || minted.AccessBundle == nil || minted.AccessBundle.Name != "coding-agent" { t.Fatalf("minted %+v", minted) } @@ -57,11 +61,12 @@ func TestAgentVaultSessionOutputFormats(t *testing.T) { label, expires := "nightly deploy", "2026-11-05T00:00:00Z" out := agentVaultSessionOutputFrom(api.AgentVaultSession{ ID: "s1", Token: "agv_x", ProjectID: projectFromFlag, Label: &label, ExpiresAt: &expires, + Metadata: map[string]string{"runId": "8812"}, AccessBundle: &api.AgentVaultSessionAccessBundle{ID: "b1", Name: "coding-agent"}, }, agentVaultProject{ID: projectFromFlag}, "coding-agent") want := map[string]any{ "id": "s1", "token": "agv_x", "projectId": projectFromFlag, "accessBundle": "coding-agent", - "label": label, "expiresAt": expires, + "label": label, "expiresAt": expires, "metadata": map[string]any{"runId": "8812"}, } for _, format := range []string{util.OUTPUT_FORMAT_JSON, util.OUTPUT_FORMAT_YAML} { @@ -82,19 +87,44 @@ func TestAgentVaultSessionOutputFormats(t *testing.T) { t.Fatalf("%s: keys %v, want %v", format, got, want) } for key, value := range want { - if got[key] != value { + if !reflect.DeepEqual(got[key], value) { t.Errorf("%s: %s = %v, want %v", format, key, got[key], value) } } } } +func TestMintAgentVaultSessionSendsMetadataAsAnObject(t *testing.T) { + var sent map[string]any + srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + body, _ := io.ReadAll(r.Body) + _ = json.Unmarshal(body, &sent) + w.Header().Set("Content-Type", "application/json") + _, _ = w.Write([]byte(`{"session":{"id":"s1","token":"agv_x","projectId":"` + projectFromFlag + `","label":null,"metadata":{"runId":"8812"},"expiresAt":null,"createdAt":"2026-11-04T00:00:00Z","accessBundle":null}}`)) + })) + t.Cleanup(srv.Close) + old := config.INFISICAL_URL + config.INFISICAL_URL = srv.URL + "/api" + t.Cleanup(func() { config.INFISICAL_URL = old }) + + minted, err := mintAgentVaultSession(resty.New(), agentVaultProject{ID: projectFromFlag}, []string{"coding-agent"}, "8h", "", map[string]string{"runId": "8812"}) + if err != nil { + t.Fatal(err) + } + if sentMetadata, ok := sent["metadata"].(map[string]any); !ok || sentMetadata["runId"] != "8812" || len(sentMetadata) != 1 { + t.Fatalf("metadata in body = %v, want {runId: 8812}", sent["metadata"]) + } + if minted.Metadata["runId"] != "8812" { + t.Fatalf("minted metadata = %v", minted.Metadata) + } +} + func TestAgentVaultSessionOutputWithNoExpiryOrLabelPrintsNull(t *testing.T) { formatted, err := util.FormatOutput(util.OUTPUT_FORMAT_JSON, agentVaultSessionOutputFrom(api.AgentVaultSession{ID: "s1", Token: "agv_x"}, agentVaultProject{ID: projectFromFlag}, "coding-agent"), nil) if err != nil { t.Fatal(err) } - for _, part := range []string{`"expiresAt":null`, `"label":null`, `"projectId":"` + projectFromFlag + `"`, `"accessBundle":"coding-agent"`} { + for _, part := range []string{`"expiresAt":null`, `"label":null`, `"metadata":{}`, `"projectId":"` + projectFromFlag + `"`, `"accessBundle":"coding-agent"`} { if !strings.Contains(formatted, part) { t.Errorf("want %s in %s", part, formatted) } diff --git a/packages/cmd/testdata/command_surface.json b/packages/cmd/testdata/command_surface.json index 13a5cfbd..016a0d0e 100644 --- a/packages/cmd/testdata/command_surface.json +++ b/packages/cmd/testdata/command_surface.json @@ -54,6 +54,7 @@ "client-secret": "|string|", "keep-session": "|bool|false", "label": "|string|", + "metadata": "|stringArray|[]", "no-agent-vault-skill": "|bool|false", "no-ca-trust": "|bool|false", "no-mcp-servers": "|bool|false", @@ -71,6 +72,7 @@ "client-id": "|string|", "client-secret": "|string|", "label": "|string|", + "metadata": "|stringArray|[]", "output": "o|string|", "project-id": "|string|", "ttl": "|string|never" @@ -118,6 +120,7 @@ "client-secret": "|string|", "keep-session": "|bool|false", "label": "|string|", + "metadata": "|stringArray|[]", "no-agent-vault-skill": "|bool|false", "no-ca-trust": "|bool|false", "no-mcp-servers": "|bool|false", @@ -135,6 +138,7 @@ "client-id": "|string|", "client-secret": "|string|", "label": "|string|", + "metadata": "|stringArray|[]", "output": "o|string|", "project-id": "|string|", "ttl": "|string|never"