diff --git a/lib/lib-rds/.gitignore b/lib/lib-rds/.gitignore new file mode 100644 index 0000000000000..3d1714c9806ef --- /dev/null +++ b/lib/lib-rds/.gitignore @@ -0,0 +1,8 @@ +/node_modules/ +/build/ +/coverage/ +/docs/ +*.tsbuildinfo +*.tgz +*.log +package-lock.json diff --git a/lib/lib-rds/CHANGELOG.md b/lib/lib-rds/CHANGELOG.md new file mode 100644 index 0000000000000..767840ada8e04 --- /dev/null +++ b/lib/lib-rds/CHANGELOG.md @@ -0,0 +1,5 @@ +# Change Log + +All notable changes to this project will be documented in this file. +See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. + diff --git a/lib/lib-rds/LICENSE b/lib/lib-rds/LICENSE new file mode 100644 index 0000000000000..7b6491ba78762 --- /dev/null +++ b/lib/lib-rds/LICENSE @@ -0,0 +1,201 @@ +Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2018-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/lib/lib-rds/README.md b/lib/lib-rds/README.md new file mode 100644 index 0000000000000..9a70f853cca3f --- /dev/null +++ b/lib/lib-rds/README.md @@ -0,0 +1,6 @@ +# @aws-sdk/lib-rds + +[![NPM version](https://img.shields.io/npm/v/@aws-sdk/lib-rds/latest.svg)](https://www.npmjs.com/package/@aws-sdk/lib-rds) +[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/lib-rds.svg)](https://www.npmjs.com/package/@aws-sdk/lib-rds) + +## Overview diff --git a/lib/lib-rds/jest.config.js b/lib/lib-rds/jest.config.js new file mode 100644 index 0000000000000..a8d1c2e499123 --- /dev/null +++ b/lib/lib-rds/jest.config.js @@ -0,0 +1,5 @@ +const base = require("../../jest.config.base.js"); + +module.exports = { + ...base, +}; diff --git a/lib/lib-rds/package.json b/lib/lib-rds/package.json new file mode 100644 index 0000000000000..67428ca17e9aa --- /dev/null +++ b/lib/lib-rds/package.json @@ -0,0 +1,55 @@ +{ + "name": "@aws-sdk/lib-rds", + "version": "3.43.0", + "description": "RDS utility for generating a password that can be used for IAM authentication to an RDS DB.", + "main": "./dist-cjs/index.js", + "module": "./dist-es/index.js", + "types": "./dist-types/index.d.ts", + "scripts": { + "build": "yarn build:cjs && yarn build:es && yarn build:types", + "build:cjs": "tsc -p tsconfig.cjs.json", + "build:es": "tsc -p tsconfig.es.json", + "build:types": "tsc -p tsconfig.types.json", + "downlevel-dts": "downlevel-dts dist-types dist-types/ts3.4", + "test": "jest" + }, + "engines": { + "node": ">= 10.0.0" + }, + "author": { + "name": "AWS SDK for JavaScript Team", + "url": "https://aws.amazon.com/javascript/" + }, + "license": "Apache-2.0", + "dependencies": { + "@aws-sdk/signature-v4": "3.40.0", + "@aws-sdk/protocol-http": "3.40.0", + "tslib": "^2.3.0" + }, + "peerDependencies": { + "@aws-sdk/types": "^3.0.0" + }, + "devDependencies": { + "@aws-sdk/types": "3.40.0", + "@types/jest": "^26.0.4", + "@types/node": "^14.11.2", + "jest": "^26.4.2", + "typescript": "~4.3.5" + }, + "typesVersions": { + "<4.0": { + "dist-types/*": [ + "dist-types/ts3.4/*" + ] + } + }, + "files": [ + "dist-*" + ], + "homepage": "https://github.com/aws/aws-sdk-js-v3/tree/main/lib/lib-rds", + "repository": { + "type": "git", + "url": "https://github.com/aws/aws-sdk-js-v3.git", + "directory": "lib/lib-rds" + } +} diff --git a/lib/lib-rds/src/Signer.spec.ts b/lib/lib-rds/src/Signer.spec.ts new file mode 100644 index 0000000000000..6baf65ab997e6 --- /dev/null +++ b/lib/lib-rds/src/Signer.spec.ts @@ -0,0 +1,103 @@ +import { HttpRequest } from "@aws-sdk/protocol-http"; +import { SignatureV4 } from "@aws-sdk/signature-v4"; + +const mockPresign = jest.fn(); +jest.mock("@aws-sdk/signature-v4", () => { + return { + SignatureV4: jest.fn().mockImplementation(() => { + return { presign: mockPresign }; + }), + }; +}); + +jest.mock("@aws-sdk/credential-provider-node"); + +import { defaultProvider } from "@aws-sdk/credential-provider-node"; + +jest.mock("@aws-sdk/util-format-url"); + +import { formatUrl } from "@aws-sdk/util-format-url"; + +import { Signer, SignerInit } from "./Signer"; + +describe("lib-rds Signer", () => { + const minimalParams: SignerInit = { + region: "us-foo-1", + username: "testuser", + hostname: "https://testhost", + port: 5432, + }; + + beforeAll(() => { + (formatUrl as jest.Mock).mockReturnValue("https://testhost:5432?other=url¶meters=here"); + }); + + beforeEach(() => { + jest.clearAllMocks(); + }); + + it("should provide correct parameters to the SigV4 signer", async () => { + const signer = new Signer(minimalParams); + await signer.getAuthToken(); + //@ts-ignore + expect(SignatureV4.mock.calls[0][0].service).toEqual("rds-db"); + //@ts-ignore + expect(SignatureV4.mock.calls[0][0].region).toEqual("us-foo-1"); + //@ts-ignore + expect(defaultProvider).toBeCalledTimes(1); + }); + + it("should use supplied credentials if present", async () => { + const signer = new Signer({ + credentials: { + accessKeyId: "123", + secretAccessKey: "xyz", + }, + ...minimalParams, + }); + await signer.getAuthToken(); + //@ts-ignore + expect(SignatureV4.mock.calls[0][0].credentials).toEqual({ + accessKeyId: "123", + secretAccessKey: "xyz", + }); + //@ts-ignore + expect(defaultProvider).not.toBeCalled(); + }); + + it("should call SigV4 presign with a valid HttpRequest", async () => { + const signer = new Signer(minimalParams); + await signer.getAuthToken(); + expect(mockPresign).toBeCalledTimes(1); + expect(mockPresign).toBeCalledWith( + new HttpRequest({ + method: "GET", + protocol: "https:", + hostname: "https://testhost", + port: 5432, + query: { + Action: "connect", + DBUser: "testuser", + }, + headers: { + host: "https://testhost:5432", + }, + }), + { + expiresIn: 900, + } + ); + }); + + it("should format the resulting presigned url", async () => { + const signer = new Signer(minimalParams); + await signer.getAuthToken(); + expect(formatUrl).toBeCalledTimes(1); + }); + + it("should remove the protocol from the presigned url", async () => { + const signer = new Signer(minimalParams); + const token = await signer.getAuthToken(); + expect(token).toBe("testhost:5432?other=url¶meters=here"); + }); +}); diff --git a/lib/lib-rds/src/Signer.ts b/lib/lib-rds/src/Signer.ts new file mode 100644 index 0000000000000..d61f1885f5dbc --- /dev/null +++ b/lib/lib-rds/src/Signer.ts @@ -0,0 +1,61 @@ +import { Sha256 } from "@aws-crypto/sha256-js"; +import { defaultProvider } from "@aws-sdk/credential-provider-node"; +import { HttpRequest } from "@aws-sdk/protocol-http"; +import { SignatureV4 } from "@aws-sdk/signature-v4"; +import { CredentialProvider, Credentials } from "@aws-sdk/types"; +import { formatUrl } from "@aws-sdk/util-format-url"; + +export interface SignerInit { + credentials?: Credentials | CredentialProvider; + hostname: string; + port: number; + region: string; + username: string; +} + +export class Signer { + private readonly credentials: Credentials | CredentialProvider; + private readonly hostname: string; + private readonly port: number; + private readonly protocol: string = "https:"; + private readonly region: string; + private readonly service: string = "rds-db"; + private readonly username: string; + + constructor({ credentials, hostname, port, region, username }: SignerInit) { + this.credentials = credentials ?? defaultProvider(); + this.hostname = hostname; + this.port = port; + this.region = region; + this.username = username; + } + + public async getAuthToken(): Promise { + const signer = new SignatureV4({ + service: this.service, + region: this.region, + credentials: this.credentials, + sha256: Sha256, + }); + + const request = new HttpRequest({ + method: "GET", + protocol: this.protocol, + hostname: this.hostname, + port: this.port, + query: { + Action: "connect", + DBUser: this.username, + }, + headers: { + host: `${this.hostname}:${this.port}`, + }, + }); + + const presigned = await signer.presign(request, { + expiresIn: 900, + }); + + return formatUrl(presigned).replace(`${this.protocol}//`, ""); + } +} diff --git a/lib/lib-rds/src/index.spec.ts b/lib/lib-rds/src/index.spec.ts new file mode 100644 index 0000000000000..d1211d31b0afe --- /dev/null +++ b/lib/lib-rds/src/index.spec.ts @@ -0,0 +1,7 @@ +import * as libRds from "./index"; + +describe("lib-rds", () => { + it("has Signer", () => { + expect(libRds.Signer).toBeDefined(); + }); +}); diff --git a/lib/lib-rds/src/index.ts b/lib/lib-rds/src/index.ts new file mode 100644 index 0000000000000..d6f742487bfa4 --- /dev/null +++ b/lib/lib-rds/src/index.ts @@ -0,0 +1 @@ +export * from "./Signer"; diff --git a/lib/lib-rds/tsconfig.cjs.json b/lib/lib-rds/tsconfig.cjs.json new file mode 100644 index 0000000000000..96198be81644a --- /dev/null +++ b/lib/lib-rds/tsconfig.cjs.json @@ -0,0 +1,9 @@ +{ + "compilerOptions": { + "baseUrl": ".", + "outDir": "dist-cjs", + "rootDir": "src" + }, + "extends": "../../tsconfig.cjs.json", + "include": ["src/"] +} diff --git a/lib/lib-rds/tsconfig.es.json b/lib/lib-rds/tsconfig.es.json new file mode 100644 index 0000000000000..f4e77528ab3f4 --- /dev/null +++ b/lib/lib-rds/tsconfig.es.json @@ -0,0 +1,10 @@ +{ + "compilerOptions": { + "baseUrl": ".", + "lib": ["es5", "es2015.collection", "dom"], + "outDir": "dist-es", + "rootDir": "src" + }, + "extends": "../../tsconfig.es.json", + "include": ["src/"] +} diff --git a/lib/lib-rds/tsconfig.types.json b/lib/lib-rds/tsconfig.types.json new file mode 100644 index 0000000000000..6cdf9f52ea065 --- /dev/null +++ b/lib/lib-rds/tsconfig.types.json @@ -0,0 +1,9 @@ +{ + "compilerOptions": { + "baseUrl": ".", + "declarationDir": "dist-types", + "rootDir": "src" + }, + "extends": "../../tsconfig.types.json", + "include": ["src/"] +}