fix: source aware api-key flag + redact api key value from logging #1819
+392
−79
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| { | ||
| "apiKeySecretArn": { | ||
| "secretArn": "arn:aws:secretsmanager:us-west-2:685197708687:secret:bedrock-agentcore-identity!default/apikey/agentcore-cli-identity-fixture-ceac1e1d-2BRhkE" | ||
| }, | ||
| "name": "agentcore-cli-identity-fixture", | ||
| "credentialProviderArn": "arn:aws:bedrock-agentcore:us-west-2:685197708687:token-vault/default/apikeycredentialprovider/agentcore-cli-identity-fixture", | ||
| "apiKeySecretSource": "MANAGED" | ||
| } |
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,8 @@ | ||
| { | ||
| "apiKeySecretArn": { | ||
| "secretArn": "arn:aws:secretsmanager:us-west-2:685197708687:secret:bedrock-agentcore-identity!default/apikey/agentcore-cli-identity-fixture-2-56db9332-Jv9u5N" | ||
| }, | ||
| "name": "agentcore-cli-identity-fixture-2", | ||
| "credentialProviderArn": "arn:aws:bedrock-agentcore:us-west-2:685197708687:token-vault/default/apikeycredentialprovider/agentcore-cli-identity-fixture-2", | ||
| "apiKeySecretSource": "MANAGED" | ||
| } |
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 |
|---|---|---|
| @@ -1,14 +1,14 @@ | ||
| { | ||
| "apiKeySecretArn": { | ||
| "secretArn": "arn:aws:secretsmanager:us-west-2:685197708687:secret:bedrock-agentcore-identity!default/apikey/agentcore-cli-identity-fixture-ceac1e1d-2BRhkE" | ||
| }, | ||
| "name": "agentcore-cli-identity-fixture", | ||
| "credentialProviderArn": "arn:aws:bedrock-agentcore:us-west-2:685197708687:token-vault/default/apikeycredentialprovider/agentcore-cli-identity-fixture", | ||
| "createdTime": { | ||
| "$date": "2026-07-23T19:31:48.713Z" | ||
| }, | ||
| "lastUpdatedTime": { | ||
| "$date": "2026-07-23T19:31:48.713Z" | ||
| }, | ||
| "apiKeySecretSource": "MANAGED" | ||
| } |
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
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,14 @@ | ||
| { | ||
| "apiKeySecretArn": { | ||
| "secretArn": "arn:aws:secretsmanager:us-west-2:685197708687:secret:bedrock-agentcore-identity!default/apikey/agentcore-cli-identity-fixture-ceac1e1d-2BRhkE" | ||
| }, | ||
| "name": "agentcore-cli-identity-fixture", | ||
| "credentialProviderArn": "arn:aws:bedrock-agentcore:us-west-2:685197708687:token-vault/default/apikeycredentialprovider/agentcore-cli-identity-fixture", | ||
| "createdTime": { | ||
| "$date": "2026-07-23T19:31:48.713Z" | ||
| }, | ||
| "lastUpdatedTime": { | ||
| "$date": "2026-07-23T19:31:48.713Z" | ||
| }, | ||
| "apiKeySecretSource": "MANAGED" | ||
| } |
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 |
|---|---|---|
| @@ -1,10 +1,10 @@ | ||
| { | ||
| "apiKeySecretArn": { | ||
| "secretArn": "arn:aws:secretsmanager:us-west-2:685197708687:secret:bedrock-agentcore-identity!default/apikey/agentcore-cli-identity-fixture-ceac1e1d-2BRhkE" | ||
| }, | ||
| "name": "agentcore-cli-identity-fixture", | ||
| "credentialProviderArn": "arn:aws:bedrock-agentcore:us-west-2:685197708687:token-vault/default/apikeycredentialprovider/agentcore-cli-identity-fixture", | ||
| "createdTime": "2026-07-23T19:31:48.713Z", | ||
| "lastUpdatedTime": "2026-07-23T19:31:48.713Z", | ||
| "apiKeySecretSource": "MANAGED" | ||
| } |
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
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 |
|---|---|---|
| @@ -1,10 +1,10 @@ | ||
| { | ||
| "apiKeySecretArn": { | ||
| "secretArn": "arn:aws:secretsmanager:us-west-2:685197708687:secret:bedrock-agentcore-identity!default/apikey/agentcore-cli-identity-fixture-ceac1e1d-2BRhkE" | ||
| }, | ||
| "name": "agentcore-cli-identity-fixture", | ||
| "credentialProviderArn": "arn:aws:bedrock-agentcore:us-west-2:685197708687:token-vault/default/apikeycredentialprovider/agentcore-cli-identity-fixture", | ||
| "createdTime": "2026-07-23T19:31:48.713Z", | ||
| "lastUpdatedTime": "2026-07-23T19:31:48.713Z", | ||
| "apiKeySecretSource": "MANAGED" | ||
| } |
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 |
|---|---|---|
| @@ -1,33 +1,74 @@ | ||
| import z from "zod"; | ||
| import { createHandler, flag } from "../../../../router"; | ||
| import { JsonRendererKey } from "../../../../tui"; | ||
| import type { AppIO, Core } from "../../../types"; | ||
| import { coreOptsFromCtx } from "../../../utils"; | ||
| import { readSourceText } from "../../../source"; | ||
| import { parseJsonFlag } from "../../../utils"; | ||
|
|
||
| export const createCreateApiKeyCredentialProviderHandler = (core: Core, io: AppIO) => | ||
| createHandler({ | ||
| name: "create", | ||
| description: "create an API key credential provider", | ||
| flags: [ | ||
| flag("name", "the name of the API key credential provider", z.string().optional()), | ||
| flag("api-key", "the API key value (inline, file://path, or -)", z.string().optional(), { | ||
| sensitive: true, | ||
| }), | ||
| flag("api-key-secret-arn", "existing Secrets Manager secret ARN", z.string().optional()), | ||
| flag( | ||
| "api-key-secret-json-key", | ||
| "JSON key containing the API key in the secret", | ||
| z.string().optional(), | ||
| ), | ||
| flag("tags", "tags as key=value (repeatable) or JSON object", z.string().optional()), | ||
|
Contributor
There was a problem hiding this comment. This advertises repeatable |
||
| ], | ||
| handle: async (ctx, flags) => { | ||
| if (!flags.name) { | ||
| throw new TypeError("required option '--name <name>' not specified"); | ||
| } | ||
|
|
||
| const hasApiKey = flags["api-key"] !== undefined; | ||
| const hasSecretArn = flags["api-key-secret-arn"] !== undefined; | ||
| const hasSecretJsonKey = flags["api-key-secret-json-key"] !== undefined; | ||
|
|
||
| if (hasApiKey && (hasSecretArn || hasSecretJsonKey)) { | ||
| throw new TypeError( | ||
| "--api-key and --api-key-secret-arn/--api-key-secret-json-key are mutually exclusive", | ||
| ); | ||
| } | ||
| if (!hasApiKey && !hasSecretArn) { | ||
| throw new TypeError( | ||
| "either --api-key or --api-key-secret-arn and --api-key-secret-json-key are required", | ||
| ); | ||
| } | ||
| if (hasSecretArn !== hasSecretJsonKey) { | ||
| throw new TypeError( | ||
| "--api-key-secret-arn and --api-key-secret-json-key must be specified together", | ||
| ); | ||
| } | ||
|
|
||
| const apiKey = hasApiKey ? await readSourceText(flags["api-key"]!, io.stdin) : undefined; | ||
|
|
||
| const apiKeySecretConfig = hasSecretArn | ||
| ? { secretId: flags["api-key-secret-arn"]!, jsonKey: flags["api-key-secret-json-key"]! } | ||
| : undefined; | ||
|
|
||
| const apiKeySecretSource = hasApiKey ? "MANAGED" : "EXTERNAL"; | ||
|
|
||
| const tags = parseJsonFlag<Record<string, string>>("tags", flags.tags); | ||
|
|
||
| ctx.require(JsonRendererKey).renderJson( | ||
| await core.identity.createApiKeyCredentialProvider( | ||
| { | ||
| name: flags.name, | ||
| apiKey, | ||
| apiKeySecretConfig, | ||
| apiKeySecretSource: apiKeySecretSource as any, | ||
| tags, | ||
| }, | ||
| coreOptsFromCtx(ctx), | ||
| ), | ||
| ); | ||
| }, | ||
| }); | ||
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the doc discussion, the preferred external-secret representation was one structured-reference flag rather than separate ARN and JSON-key flags. Could we use something like
--api-key-secret-reference '{"secretId":"...","jsonKey":"..."}'for create/update, mutually exclusive with--api-key? We should also have a successful external-reference request-mapping test, I think the current tests only cover invalid combinations.Update should first retrieve the provider and preserve its existing apiKeySecretSource. A MANAGED provider should accept only --api-key, while an EXTERNAL provider should accept only the structured secret reference. I think we should reject mismatched input locally and test both directions instead of deriving the source mode from the supplied flags.