Skip to content

chore(credential-provider-imds): use arrow+async functions in fromContainerMetadata #2142

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

Merged
merged 3 commits into from
Apr 8, 2021
Merged

chore(credential-provider-imds): use arrow+async functions in fromContainerMetadata #2142

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
13b6225
chore: arrow+async functions
trivikr Jul 2, 2020
ec8ebbc
chore: replace Promise resolve/reject with async
trivikr Jul 2, 2020
2182404
chore(credential-provider-imds): remove redundant async/await
trivikr Mar 16, 2021
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
73 changes: 33 additions & 40 deletions packages/credential-provider-imds/src/fromContainerMetadata.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,34 +16,33 @@ export const ENV_CMDS_AUTH_TOKEN = "AWS_CONTAINER_AUTHORIZATION_TOKEN";
* Creates a credential provider that will source credentials from the ECS
* Container Metadata Service
*/
export function fromContainerMetadata(init: RemoteProviderInit = {}): CredentialProvider {
export const fromContainerMetadata = (init: RemoteProviderInit = {}): CredentialProvider => {
const { timeout, maxRetries } = providerConfigFromInit(init);
return () => {
return getCmdsUri().then((url) =>
retry(async () => {
const credsResponse = JSON.parse(await requestFromEcsImds(timeout, url));
if (!isImdsCredentials(credsResponse)) {
throw new ProviderError("Invalid response received from instance metadata service.");
}

return fromImdsCredentials(credsResponse);
}, maxRetries)
);
};
}
return () =>
retry(async () => {
const requestOptions = await getCmdsUri();
Copy link
Contributor

Choose a reason for hiding this comment

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

Moving getCmdUri() into function is fine as it only loads values from environmental variables.

const credsResponse = JSON.parse(await requestFromEcsImds(timeout, requestOptions));
if (!isImdsCredentials(credsResponse)) {
throw new ProviderError("Invalid response received from instance metadata service.");
}
return fromImdsCredentials(credsResponse);
}, maxRetries);
};

function requestFromEcsImds(timeout: number, options: RequestOptions): Promise<string> {
const requestFromEcsImds = async (timeout: number, options: RequestOptions): Promise<string> => {
if (process.env[ENV_CMDS_AUTH_TOKEN]) {
const { headers = {} } = options;
headers.Authorization = process.env[ENV_CMDS_AUTH_TOKEN];
options.headers = headers;
options.headers = {
...options.headers,
Authorization: process.env[ENV_CMDS_AUTH_TOKEN],
};
}

return httpRequest({
const buffer = await httpRequest({
...options,
timeout,
}).then((buffer) => buffer.toString());
}
});
return buffer.toString();
};

const CMDS_IP = "169.254.170.2";
const GREENGRASS_HOSTS = {
Expand All @@ -55,40 +54,34 @@ const GREENGRASS_PROTOCOLS = {
"https:": true,
};

function getCmdsUri(): Promise<RequestOptions> {
const getCmdsUri = async (): Promise<RequestOptions> => {
if (process.env[ENV_CMDS_RELATIVE_URI]) {
return Promise.resolve({
return {
hostname: CMDS_IP,
path: process.env[ENV_CMDS_RELATIVE_URI],
});
};
}

if (process.env[ENV_CMDS_FULL_URI]) {
const parsed = parse(process.env[ENV_CMDS_FULL_URI]!);
if (!parsed.hostname || !(parsed.hostname in GREENGRASS_HOSTS)) {
return Promise.reject(
new ProviderError(`${parsed.hostname} is not a valid container metadata service hostname`, false)
);
throw new ProviderError(`${parsed.hostname} is not a valid container metadata service hostname`, false);
}

if (!parsed.protocol || !(parsed.protocol in GREENGRASS_PROTOCOLS)) {
return Promise.reject(
new ProviderError(`${parsed.protocol} is not a valid container metadata service protocol`, false)
);
throw new ProviderError(`${parsed.protocol} is not a valid container metadata service protocol`, false);
}

return Promise.resolve({
return {
...parsed,
port: parsed.port ? parseInt(parsed.port, 10) : undefined,
});
};
}

return Promise.reject(
new ProviderError(
"The container metadata credential provider cannot be used unless" +
` the ${ENV_CMDS_RELATIVE_URI} or ${ENV_CMDS_FULL_URI} environment` +
" variable is set",
false
)
throw new ProviderError(
"The container metadata credential provider cannot be used unless" +
` the ${ENV_CMDS_RELATIVE_URI} or ${ENV_CMDS_FULL_URI} environment` +
" variable is set",
false
);
}
};