Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(cli): failure to get credentials when session token is not set #32134

Merged
merged 5 commits into from
Nov 14, 2024
Merged
Show file tree
Hide file tree
Changes from 3 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
5 changes: 4 additions & 1 deletion packages/aws-cdk/lib/api/aws-auth/awscli-compatible.ts
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,10 @@ function caBundlePathFromEnvironment(): string | undefined {
function shouldPrioritizeEnv() {
const id = process.env.AWS_ACCESS_KEY_ID || process.env.AMAZON_ACCESS_KEY_ID;
const key = process.env.AWS_SECRET_ACCESS_KEY || process.env.AMAZON_SECRET_ACCESS_KEY;
process.env.AWS_SESSION_TOKEN = process.env.AWS_SESSION_TOKEN || process.env.AMAZON_SESSION_TOKEN;
const sessionToken = process.env.AWS_SESSION_TOKEN || process.env.AMAZON_SESSION_TOKEN;
if (sessionToken) {
process.env.AWS_SESSION_TOKEN = sessionToken;
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why don't we do this inside the if that checks for id and key?

Why do we need to do this at all, anyway? Is it because AMAZON_ACCESS_KEY_ID is no longer supported, and it must be AWS_ACCESS_KEY_ID?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why don't we do this inside the if that checks for id and key?

Sure.

Why do we need to do this at all, anyway?

Because we want to keep it backward compatible and still support AMAZON_ACCESS_KEY_ID, but the SDK only reads from AWS_ACCESS_KEY_ID.


if (!!id && !!key) {
process.env.AWS_ACCESS_KEY_ID = id;
Expand Down
52 changes: 52 additions & 0 deletions packages/aws-cdk/test/api/aws-auth/awscli-compatible.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
import { AwsCliCompatible } from '../../../lib/api/aws-auth/awscli-compatible';

describe('Session token', () => {
test('does not mess up with session token env variables if they are undefined', async () => {
process.env.AWS_ACCESS_KEY_ID = 'foo';
process.env.SECRET_ACCESS_KEY = 'bar';

// Making sure these variables are not defined
delete process.env.AWS_SESSION_TOKEN;
delete process.env.AMAZON_SESSION_TOKEN;

await AwsCliCompatible.credentialChainBuilder();

expect(process.env.AWS_SESSION_TOKEN).toBeUndefined();
});

test('preserves AWS_SESSION_TOKEN if it is defined', async () => {
process.env.AWS_ACCESS_KEY_ID = 'foo';
process.env.SECRET_ACCESS_KEY = 'bar';

process.env.AWS_SESSION_TOKEN = 'aaa';
delete process.env.AMAZON_SESSION_TOKEN;

await AwsCliCompatible.credentialChainBuilder();

expect(process.env.AWS_SESSION_TOKEN).toEqual('aaa');
});

test('assigns AWS_SESSION_TOKEN if it is not defined but AMAZON_SESSION_TOKEN is', async () => {
process.env.AWS_ACCESS_KEY_ID = 'foo';
process.env.SECRET_ACCESS_KEY = 'bar';

delete process.env.AWS_SESSION_TOKEN;
process.env.AMAZON_SESSION_TOKEN = 'aaa';

await AwsCliCompatible.credentialChainBuilder();

expect(process.env.AWS_SESSION_TOKEN).toEqual('aaa');
});

test('preserves AWS_SESSION_TOKEN if both are defined', async () => {
process.env.AWS_ACCESS_KEY_ID = 'foo';
process.env.SECRET_ACCESS_KEY = 'bar';

process.env.AWS_SESSION_TOKEN = 'aaa';
process.env.AMAZON_SESSION_TOKEN = 'bbb';

await AwsCliCompatible.credentialChainBuilder();

expect(process.env.AWS_SESSION_TOKEN).toEqual('aaa');
});
});
Loading