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.

Sign up for GitHub

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(toolkit): stop 'cdk doctor' from printing AWS_ variables #2357

Merged
merged 2 commits into from
Apr 23, 2019
+7 −1
Merged

fix(toolkit): stop 'cdk doctor' from printing AWS_ variables #2357

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
768c84e
fix(toolkit): stop 'cdk doctor' from printing AWS_ variables
rix0rrr Apr 23, 2019
3b5fb91
Use <redacted> instead of asterisks
rix0rrr Apr 23, 2019
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
9 changes: 8 additions & 1 deletion packages/aws-cdk/lib/commands/doctor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ function displayAwsEnvironmentVariables() {
}
print('ℹ️ AWS environment variables:');
for (const key of keys) {
print(` - ${colors.blue(key)} = ${colors.green(process.env[key]!)}`);
print(` - ${colors.blue(key)} = ${colors.green(anonymizeAwsVariable(key, process.env[key]!))}`);
}
return true;
}
Expand All @@ -68,3 +68,10 @@ function displayCdkEnvironmentVariables() {
}
return healthy;
}

function anonymizeAwsVariable(name: string, value: string) {
if (name === 'AWS_ACCESS_KEY_ID') { return value.substr(0, 4) + '*'.repeat(Math.max(0, value.length - 4)); }
Copy link
Contributor

Choose a reason for hiding this comment

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

And here, I would put ####<redacted>. I also don't know whether the "common" practice is to show few first or few last... Maybe should research some weak evidence of what others do (we don't want to cause leaking a head when other tools leak the tail - that'd be us giving out additional info)?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm leaking the first 4 characters on purpose, because they tell us the type of access key used:

  • AKIA for long-lived (user) keys.
  • ASIA for short-lived (session, role) keys.

These are standardized and not part of the secret material.

if (name === 'AWS_SECRET_ACCESS_KEY') { return '*'.repeat(value.length); }
Copy link
Contributor

Choose a reason for hiding this comment

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

No strong feelings, but I'd usually literally output <redacted> for those instead of a string of *s.

if (name === 'AWS_SESSION_TOKEN') { return '*'.repeat(50); }
Copy link
Contributor

Choose a reason for hiding this comment

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

No strong feelings, but I'd usually literally output <redacted> for those instead of a string of *s.

return value;
}