https://github.com/bendrucker/aws-sdk-js-v3-rds-signer
An AWS IAM database authentication token signer for RDS, implementing RDS.Signer for AWS SDK for JS v3
https://github.com/bendrucker/aws-sdk-js-v3-rds-signer
aws aws-iam aws-rds aws-sdk-js
Last synced: 6 months ago
JSON representation
An AWS IAM database authentication token signer for RDS, implementing RDS.Signer for AWS SDK for JS v3
- Host: GitHub
- URL: https://github.com/bendrucker/aws-sdk-js-v3-rds-signer
- Owner: bendrucker
- License: mit
- Created: 2021-08-16T18:22:30.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-02-17T18:00:49.000Z (over 2 years ago)
- Last Synced: 2025-04-15T00:03:30.309Z (6 months ago)
- Topics: aws, aws-iam, aws-rds, aws-sdk-js
- Language: JavaScript
- Homepage:
- Size: 14.6 KB
- Stars: 5
- Watchers: 4
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# aws-sdk-js-v3-rds-signer
> An [AWS IAM database authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) token signer for RDS, implementing `RDS.Signer` for AWS SDK for JS v3
## Deprecated
[`@aws-sdk/rds-signer`](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/modules/_aws_sdk_rds_signer.html) is now available.
## Installing
```sh
npm install --save aws-sdk-js-v3-rds-signer
```
This package provides an [ES Module](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules). Node.js 12.20 or later is required to `import` it.
## Usage
Construct a new `Signer`, then call `signer.getAuthToken()` to sign a token. Use the generated token as the password when connecting. A token will always be returned regardless of whether the principal is authorized to connect. If the principal is not authorized, the password will be rejected when attempting to connect to the database.
```js
import { Signer } from 'aws-sdk-js-v3-rds-signer'
const signer = new Signer({
hostname: 'host',
port: 5432,
region: 'us-east-1',
username: 'me'
})
const token = await signer.getAuthToken()
console.log(token)
// #=> host:5432/...
```
All options supported by the `Signer` constructor are also supported by the `getAuthToken` method and will override the instance options for a specific token.
## Background
An [`RDS.Signer`](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/RDS/Signer.html) class was included in the AWS SDK for JS v2. At the time this package was authored/published, [v3 did not provide a high level `Signer` implementation](https://github.com/aws/aws-sdk-js-v3/issues/1823). This package implements one using the low level packages from SDK v3.
## License
MIT © [Ben Drucker](http://bendrucker.me)