Big update!Introducing GitHub Bot Commands. Learn more
Socket
Log inDemoInstall

@aws-sdk/credential-provider-node

Package Overview
Dependencies
10
Maintainers
5
Versions
187
Issues
File Explorer

Advanced tools

@aws-sdk/credential-provider-node

AWS credential provider that sources credentials from a Node.JS environment.

    3.264.0latest
    Github

Version published
Maintainers
5
Weekly downloads
7,759,362
increased by9.94%

Weekly downloads

Changelog

Source

3.264.0 (2023-02-02)

Bug Fixes

  • s3-presigned-post: use endpoints 2.0 for custom endpoints (#4366) (5054ba5)

Features

  • client-appconfig: AWS AppConfig introduces KMS customer-managed key (CMK) encryption of configuration data, along with AWS Secrets Manager as a new configuration data source. S3 objects using SSE-KMS encryption and SSM Parameter Store SecureStrings are also now supported. (ab41e92)
  • client-connect: Enabled FIPS endpoints for GovCloud (US) regions in SDK. (c678efa)
  • client-ec2: Documentation updates for EC2. (3ff7382)
  • client-keyspaces: Enabled FIPS endpoints for GovCloud (US) regions in SDK. (175c1f1)
  • client-quicksight: QuickSight support for Radar Chart and Dashboard Publish Options (1f89298)
  • client-redshift: Enabled FIPS endpoints for GovCloud (US) regions in SDK. (9456476)
  • client-sso-admin: Enabled FIPS endpoints for GovCloud (US) regions in SDK. (075eee7)
  • clients: update client endpoints as of 2023-02-02 (323ff80)

Readme

Source

@aws-sdk/credential-provider-node

NPM version NPM downloads

AWS Credential Provider for Node.JS

This module provides a factory function, fromEnv, that will attempt to source AWS credentials from a Node.JS environment. It will attempt to find credentials from the following sources (listed in order of precedence):

  • Environment variables exposed via process.env
  • SSO credentials from token cache
  • Web identity token credentials
  • Shared credentials and config ini files
  • The EC2/ECS Instance Metadata Service

The default credential provider will invoke one provider at a time and only continue to the next if no credentials have been located. For example, if the process finds values defined via the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables, the files at ~/.aws/credentials and ~/.aws/config will not be read, nor will any messages be sent to the Instance Metadata Service.

If invalid configuration is encountered (such as a profile in ~/.aws/credentials specifying as its source_profile the name of a profile that does not exist), then the chained provider will be rejected with an error and will not invoke the next provider in the list.

IMPORTANT: if you intend to acquire credentials using EKS IAM Roles for Service Accounts then you must explicitly specify a value for roleAssumerWithWebIdentity. There is a default function available in @aws-sdk/client-sts package. An example of using this:

const { getDefaultRoleAssumerWithWebIdentity } = require("@aws-sdk/client-sts"); const { defaultProvider } = require("@aws-sdk/credential-provider-node"); const { S3Client, GetObjectCommand } = require("@aws-sdk/client-s3"); const provider = defaultProvider({ roleAssumerWithWebIdentity: getDefaultRoleAssumerWithWebIdentity(), }); const client = new S3Client({ credentialDefaultProvider: provider });

IMPORTANT: We provide a wrapper of this provider in @aws-sdk/credential-providers package to save you from importing getDefaultRoleAssumerWithWebIdentity() or getDefaultRoleAssume() from STS package. Similarly, you can do:

const { fromNodeProviderChain } = require("@aws-sdk/credential-providers"); const credentials = fromNodeProviderChain(); const client = new S3Client({ credentials });

Supported configuration

You may customize how credentials are resolved by providing an options hash to the defaultProvider factory function. The following options are supported:

  • profile - The configuration profile to use. If not specified, the provider will use the value in the AWS_PROFILE environment variable or a default of default.
  • filepath - The path to the shared credentials file. If not specified, the provider will use the value in the AWS_SHARED_CREDENTIALS_FILE environment variable or a default of ~/.aws/credentials.
  • configFilepath - The path to the shared config file. If not specified, the provider will use the value in the AWS_CONFIG_FILE environment variable or a default of ~/.aws/config.
  • mfaCodeProvider - A function that returns a a promise fulfilled with an MFA token code for the provided MFA Serial code. If a profile requires an MFA code and mfaCodeProvider is not a valid function, the credential provider promise will be rejected.
  • roleAssumer - A function that assumes a role and returns a promise fulfilled with credentials for the assumed role. If not specified, the SDK will create an STS client and call its assumeRole method.
  • roleArn - ARN to assume. If not specified, the provider will use the value in the AWS_ROLE_ARN environment variable.
  • webIdentityTokenFile - File location of where the OIDC token is stored. If not specified, the provider will use the value in the AWS_WEB_IDENTITY_TOKEN_FILE environment variable.
  • roleAssumerWithWebIdentity - A function that assumes a role with web identity and returns a promise fulfilled with credentials for the assumed role.
  • timeout - The connection timeout (in milliseconds) to apply to any remote requests. If not specified, a default value of 1000 (one second) is used.
  • maxRetries - The maximum number of times any HTTP connections should be retried. If not specified, a default value of 0 will be used.

Keywords

FAQs

What is @aws-sdk/credential-provider-node?

AWS credential provider that sources credentials from a Node.JS environment.

Is @aws-sdk/credential-provider-node popular?

The npm package @aws-sdk/credential-provider-node receives a total of 7,435,313 weekly downloads. As such, @aws-sdk/credential-provider-node popularity was classified as popular.

Is @aws-sdk/credential-provider-node well maintained?

We found that @aws-sdk/credential-provider-node demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.It has 5 open source maintainers collaborating on the project.

Last updated on 02 Feb 2023

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket[email protected]

Product

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc