Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions packages/api/agent_vault.go
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand All @@ -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"`
Expand Down
18 changes: 18 additions & 0 deletions packages/api/agent_vault_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
46 changes: 45 additions & 1 deletion packages/cmd/agent_vault_run.go
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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))
Expand Down Expand Up @@ -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)")
Expand Down
78 changes: 78 additions & 0 deletions packages/cmd/agent_vault_run_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
40 changes: 27 additions & 13 deletions packages/cmd/agent_vault_sessions.go
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down Expand Up @@ -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)...)...)
Expand All @@ -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))

Expand All @@ -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
}

Expand Down Expand Up @@ -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
Expand All @@ -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)...)...)
}
Expand All @@ -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)")
Expand Down
Loading
Loading