From 9d2dc6972a8e437229bcff473176b5b07c6a62a6 Mon Sep 17 00:00:00 2001 From: seebees Date: Sat, 16 Mar 2019 06:27:02 -0700 Subject: [PATCH 01/12] kms-keyring-browser initial comit --- modules/kms-keyring-browser/.gitignore | 3 + modules/kms-keyring-browser/.npmignore | 3 + modules/kms-keyring-browser/LICENSE | 202 ++++++++++++++++++ modules/kms-keyring-browser/NOTICE | 2 + modules/kms-keyring-browser/package.json | 48 +++++ modules/kms-keyring-browser/src/index.ts | 43 ++++ modules/kms-keyring-browser/tsconfig.json | 13 ++ .../kms-keyring-browser/tsconfig.module.json | 12 ++ 8 files changed, 326 insertions(+) create mode 100644 modules/kms-keyring-browser/.gitignore create mode 100644 modules/kms-keyring-browser/.npmignore create mode 100644 modules/kms-keyring-browser/LICENSE create mode 100644 modules/kms-keyring-browser/NOTICE create mode 100644 modules/kms-keyring-browser/package.json create mode 100644 modules/kms-keyring-browser/src/index.ts create mode 100644 modules/kms-keyring-browser/tsconfig.json create mode 100644 modules/kms-keyring-browser/tsconfig.module.json diff --git a/modules/kms-keyring-browser/.gitignore b/modules/kms-keyring-browser/.gitignore new file mode 100644 index 000000000..6498d2c9d --- /dev/null +++ b/modules/kms-keyring-browser/.gitignore @@ -0,0 +1,3 @@ +/node_modules/ +/build/ +/.nyc_output \ No newline at end of file diff --git a/modules/kms-keyring-browser/.npmignore b/modules/kms-keyring-browser/.npmignore new file mode 100644 index 000000000..f39dee960 --- /dev/null +++ b/modules/kms-keyring-browser/.npmignore @@ -0,0 +1,3 @@ +/src/ +/coverage/ +/test/ \ No newline at end of file diff --git a/modules/kms-keyring-browser/LICENSE b/modules/kms-keyring-browser/LICENSE new file mode 100644 index 000000000..d64569567 --- /dev/null +++ b/modules/kms-keyring-browser/LICENSE @@ -0,0 +1,202 @@ + + 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 [yyyy] [name of copyright owner] + + 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. diff --git a/modules/kms-keyring-browser/NOTICE b/modules/kms-keyring-browser/NOTICE new file mode 100644 index 000000000..a95284f35 --- /dev/null +++ b/modules/kms-keyring-browser/NOTICE @@ -0,0 +1,2 @@ +AWS Encryption SDK for Javascript +Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved. diff --git a/modules/kms-keyring-browser/package.json b/modules/kms-keyring-browser/package.json new file mode 100644 index 000000000..f82f11de0 --- /dev/null +++ b/modules/kms-keyring-browser/package.json @@ -0,0 +1,48 @@ +{ + "name": "@aws-crypto/kms-keyring-browser", + "private": true, + "version": "0.0.1", + "scripts": { + "prepublishOnly": "tsc -p tsconfig.json && tsc -p tsconfig.module.json", + "lint": "standard src/*.ts test/**/*.ts", + "mocha": "mocha --require ts-node/register test/**/*test.ts", + "test": "npm run lint && npm run coverage", + "coverage": "nyc -e .ts npm run mocha" + }, + "author": { + "name": "AWS Crypto Tools Team", + "email": "aws-crypto-tools-team@amazon.com", + "url": "https://github.com/awslabs/aws-encryption-sdk-javascript" + }, + "license": "Apache-2.0", + "dependencies": { + "@aws-crypto/material-management-browser": "^0.0.1", + "@aws-crypto/kms-keyring": "^0.0.1", + "@aws-sdk/types": "0.1.0-preview.1", + "tslib": "^1.9.3" + }, + "devDependencies": { + "@types/chai": "^4.1.4", + "@types/mocha": "^5.2.5", + "@types/node": "^8.10.40", + "@typescript-eslint/eslint-plugin": "^1.4.2", + "@typescript-eslint/parser": "^1.4.2", + "aws-sdk": "^2.412.0", + "chai": "^4.1.2", + "mocha": "^5.2.0", + "nyc": "^12.0.2", + "standard": "^12.0.1", + "ts-node": "^7.0.1", + "typescript": "^3.2.0" + }, + "sideEffects": false, + "main": "./build/main/index.js", + "module": "./build/module/index.js", + "types": "./build/main/index.d.ts", + "standard": { + "parser": "@typescript-eslint/parser", + "plugins": [ + "@typescript-eslint" + ] + } +} diff --git a/modules/kms-keyring-browser/src/index.ts b/modules/kms-keyring-browser/src/index.ts new file mode 100644 index 000000000..862d209ef --- /dev/null +++ b/modules/kms-keyring-browser/src/index.ts @@ -0,0 +1,43 @@ +/* + * Copyright 2018 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. A copy of the License is + * located at + * + * http://aws.amazon.com/apache2.0/ + * + * or in the "license" file accompanying this file. This file 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. + */ + +import { + KmsKeyring, + KmsKeyringInput, + KMSConstructible, + KmsClientSupplier, + getClient, + limitRegions, + excludeRegions, + cacheClients +} from '@aws-crypto/kms-keyring' +import { + WebCryptoAlgorithmSuite, + immutableClass +} from '@aws-crypto/material-management-browser' +import {KMS, KMSConfiguration} from '@aws-sdk/client-kms-browser' + +export type KmsKeyringWebCryptoInput = KmsKeyringInput +export type KMSWebCryptoConstructible = KMSConstructible +export type KmsWebCryptoClientSupplier = KmsClientSupplier + +export class KmsKeyringNode extends KmsKeyring { + constructor(input: KmsKeyringWebCryptoInput){ + super(input) + } +} +immutableClass(KmsKeyringNode) + +export {getClient, limitRegions, excludeRegions, cacheClients} diff --git a/modules/kms-keyring-browser/tsconfig.json b/modules/kms-keyring-browser/tsconfig.json new file mode 100644 index 000000000..17e7e8b5c --- /dev/null +++ b/modules/kms-keyring-browser/tsconfig.json @@ -0,0 +1,13 @@ +{ + "extends": "../tsconfig.settings.json", + "compilerOptions": { + "outDir": "build/main", + "rootDir": "./src" + }, + "include": ["src/**/*.ts"], + "exclude": ["node_modules/**"], + "references": [ + { "path": "../material-management-browser" }, + { "path": "../kms-keyring" } + ] +} \ No newline at end of file diff --git a/modules/kms-keyring-browser/tsconfig.module.json b/modules/kms-keyring-browser/tsconfig.module.json new file mode 100644 index 000000000..50bf04db4 --- /dev/null +++ b/modules/kms-keyring-browser/tsconfig.module.json @@ -0,0 +1,12 @@ +{ + "extends": "./tsconfig", + "compilerOptions": { + "target": "esnext", + "outDir": "build/module", + "module": "esnext", + "allowSyntheticDefaultImports": true + }, + "exclude": [ + "node_modules/**" + ] +} \ No newline at end of file From 6d47acdb775284051303a748c71833c93993c070 Mon Sep 17 00:00:00 2001 From: seebees Date: Thu, 21 Mar 2019 17:33:42 -0700 Subject: [PATCH 02/12] lint and import Browsers import a crypto key --- modules/kms-keyring-browser/package.json | 6 ++- modules/kms-keyring-browser/src/index.ts | 56 ++++++++++++++++++++---- 2 files changed, 51 insertions(+), 11 deletions(-) diff --git a/modules/kms-keyring-browser/package.json b/modules/kms-keyring-browser/package.json index f82f11de0..303dca993 100644 --- a/modules/kms-keyring-browser/package.json +++ b/modules/kms-keyring-browser/package.json @@ -3,7 +3,8 @@ "private": true, "version": "0.0.1", "scripts": { - "prepublishOnly": "tsc -p tsconfig.json && tsc -p tsconfig.module.json", + "prepublishOnly": "npm run build", + "build": "tsc -b tsconfig.json && tsc -b tsconfig.module.json", "lint": "standard src/*.ts test/**/*.ts", "mocha": "mocha --require ts-node/register test/**/*test.ts", "test": "npm run lint && npm run coverage", @@ -18,13 +19,14 @@ "dependencies": { "@aws-crypto/material-management-browser": "^0.0.1", "@aws-crypto/kms-keyring": "^0.0.1", + "@aws-crypto/web-crypto-backend": "^0.0.1", "@aws-sdk/types": "0.1.0-preview.1", "tslib": "^1.9.3" }, "devDependencies": { "@types/chai": "^4.1.4", "@types/mocha": "^5.2.5", - "@types/node": "^8.10.40", + "@types/node": "^11.11.4", "@typescript-eslint/eslint-plugin": "^1.4.2", "@typescript-eslint/parser": "^1.4.2", "aws-sdk": "^2.412.0", diff --git a/modules/kms-keyring-browser/src/index.ts b/modules/kms-keyring-browser/src/index.ts index 862d209ef..f7a771f9b 100644 --- a/modules/kms-keyring-browser/src/index.ts +++ b/modules/kms-keyring-browser/src/index.ts @@ -15,29 +15,67 @@ import { KmsKeyring, - KmsKeyringInput, - KMSConstructible, - KmsClientSupplier, + KmsKeyringInput, // eslint-disable-line no-unused-vars + KMSConstructible, // eslint-disable-line no-unused-vars + KmsClientSupplier, // eslint-disable-line no-unused-vars getClient, limitRegions, excludeRegions, cacheClients } from '@aws-crypto/kms-keyring' import { - WebCryptoAlgorithmSuite, - immutableClass + WebCryptoAlgorithmSuite, // eslint-disable-line no-unused-vars + WebCryptoEncryptionMaterial, // eslint-disable-line no-unused-vars + WebCryptoDecryptionMaterial, // eslint-disable-line no-unused-vars + EncryptionContext, // eslint-disable-line no-unused-vars + EncryptedDataKey, // eslint-disable-line no-unused-vars + immutableClass, + importCryptoKey } from '@aws-crypto/material-management-browser' -import {KMS, KMSConfiguration} from '@aws-sdk/client-kms-browser' +import { getWebCryptoBackend } from '@aws-crypto/web-crypto-backend' +import { KMS, KMSConfiguration } from '@aws-sdk/client-kms-browser' // eslint-disable-line no-unused-vars export type KmsKeyringWebCryptoInput = KmsKeyringInput export type KMSWebCryptoConstructible = KMSConstructible export type KmsWebCryptoClientSupplier = KmsClientSupplier export class KmsKeyringNode extends KmsKeyring { - constructor(input: KmsKeyringWebCryptoInput){ - super(input) + async _onEncrypt (material: WebCryptoEncryptionMaterial, context?: EncryptionContext) { + const _material = await super._onEncrypt(material, context) + + /* Check for early return (Postcondition): If a cryptoKey has already been imported, return. */ + if (_material.hasUnencryptedDataKey && _material.hasCryptoKey) { + return _material + } + + const backend = await getWebCryptoBackend() + const cryptoKey = await importCryptoKey(backend, _material) + // The trace is only set when the material does not already have + // an hasUnencryptedDataKey. This is an implementation detail :( + const [trace] = _material.keyringTrace + + return _material.setCryptoKey(cryptoKey, trace) + } + + async _onDecrypt (material: WebCryptoDecryptionMaterial, encryptedDataKeys: EncryptedDataKey[], context?: EncryptionContext) { + const _material = await super._onDecrypt(material, encryptedDataKeys, context) + + /* Check for early return (Postcondition): If a cryptoKey has already been imported, return. */ + if (_material.hasUnencryptedDataKey && _material.hasCryptoKey) { + return _material + } + + const backend = await getWebCryptoBackend() + const cryptoKey = await importCryptoKey(backend, _material) + // Now that a cryptoKey has been imported, the unencrypted data key can be zeroed. + _material.zeroUnencryptedDataKey() + // The trace is only set when the material does not already have + // an hasUnencryptedDataKey. This is an implementation detail :( + const [trace] = _material.keyringTrace + + return _material.setCryptoKey(cryptoKey, trace) } } immutableClass(KmsKeyringNode) -export {getClient, limitRegions, excludeRegions, cacheClients} +export { getClient, limitRegions, excludeRegions, cacheClients } From e8380243617ac353dc2447ca9cb44916a475f498 Mon Sep 17 00:00:00 2001 From: seebees Date: Sat, 23 Mar 2019 15:10:54 -0700 Subject: [PATCH 03/12] kms-keyring-browser cache client default kms-keyring-browser --- modules/kms-keyring-browser/src/index.ts | 67 +------------ .../src/kms_keyring_browser.ts | 93 +++++++++++++++++++ 2 files changed, 94 insertions(+), 66 deletions(-) create mode 100644 modules/kms-keyring-browser/src/kms_keyring_browser.ts diff --git a/modules/kms-keyring-browser/src/index.ts b/modules/kms-keyring-browser/src/index.ts index f7a771f9b..8b66aeb13 100644 --- a/modules/kms-keyring-browser/src/index.ts +++ b/modules/kms-keyring-browser/src/index.ts @@ -13,69 +13,4 @@ * limitations under the License. */ -import { - KmsKeyring, - KmsKeyringInput, // eslint-disable-line no-unused-vars - KMSConstructible, // eslint-disable-line no-unused-vars - KmsClientSupplier, // eslint-disable-line no-unused-vars - getClient, - limitRegions, - excludeRegions, - cacheClients -} from '@aws-crypto/kms-keyring' -import { - WebCryptoAlgorithmSuite, // eslint-disable-line no-unused-vars - WebCryptoEncryptionMaterial, // eslint-disable-line no-unused-vars - WebCryptoDecryptionMaterial, // eslint-disable-line no-unused-vars - EncryptionContext, // eslint-disable-line no-unused-vars - EncryptedDataKey, // eslint-disable-line no-unused-vars - immutableClass, - importCryptoKey -} from '@aws-crypto/material-management-browser' -import { getWebCryptoBackend } from '@aws-crypto/web-crypto-backend' -import { KMS, KMSConfiguration } from '@aws-sdk/client-kms-browser' // eslint-disable-line no-unused-vars - -export type KmsKeyringWebCryptoInput = KmsKeyringInput -export type KMSWebCryptoConstructible = KMSConstructible -export type KmsWebCryptoClientSupplier = KmsClientSupplier - -export class KmsKeyringNode extends KmsKeyring { - async _onEncrypt (material: WebCryptoEncryptionMaterial, context?: EncryptionContext) { - const _material = await super._onEncrypt(material, context) - - /* Check for early return (Postcondition): If a cryptoKey has already been imported, return. */ - if (_material.hasUnencryptedDataKey && _material.hasCryptoKey) { - return _material - } - - const backend = await getWebCryptoBackend() - const cryptoKey = await importCryptoKey(backend, _material) - // The trace is only set when the material does not already have - // an hasUnencryptedDataKey. This is an implementation detail :( - const [trace] = _material.keyringTrace - - return _material.setCryptoKey(cryptoKey, trace) - } - - async _onDecrypt (material: WebCryptoDecryptionMaterial, encryptedDataKeys: EncryptedDataKey[], context?: EncryptionContext) { - const _material = await super._onDecrypt(material, encryptedDataKeys, context) - - /* Check for early return (Postcondition): If a cryptoKey has already been imported, return. */ - if (_material.hasUnencryptedDataKey && _material.hasCryptoKey) { - return _material - } - - const backend = await getWebCryptoBackend() - const cryptoKey = await importCryptoKey(backend, _material) - // Now that a cryptoKey has been imported, the unencrypted data key can be zeroed. - _material.zeroUnencryptedDataKey() - // The trace is only set when the material does not already have - // an hasUnencryptedDataKey. This is an implementation detail :( - const [trace] = _material.keyringTrace - - return _material.setCryptoKey(cryptoKey, trace) - } -} -immutableClass(KmsKeyringNode) - -export { getClient, limitRegions, excludeRegions, cacheClients } +export * from './kms_keyring_browser' diff --git a/modules/kms-keyring-browser/src/kms_keyring_browser.ts b/modules/kms-keyring-browser/src/kms_keyring_browser.ts new file mode 100644 index 000000000..e19948866 --- /dev/null +++ b/modules/kms-keyring-browser/src/kms_keyring_browser.ts @@ -0,0 +1,93 @@ +/* + * Copyright 2018 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. A copy of the License is + * located at + * + * http://aws.amazon.com/apache2.0/ + * + * or in the "license" file accompanying this file. This file 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. + */ + +import { + KmsKeyring, + KmsKeyringInput, // eslint-disable-line no-unused-vars + KMSConstructible, // eslint-disable-line no-unused-vars + KmsClientSupplier, // eslint-disable-line no-unused-vars + getClient, + limitRegions, + excludeRegions, + cacheClients +} from '@aws-crypto/kms-keyring' +import { + WebCryptoAlgorithmSuite, // eslint-disable-line no-unused-vars + WebCryptoEncryptionMaterial, // eslint-disable-line no-unused-vars + WebCryptoDecryptionMaterial, // eslint-disable-line no-unused-vars + EncryptionContext, // eslint-disable-line no-unused-vars + EncryptedDataKey, // eslint-disable-line no-unused-vars + immutableClass, + importCryptoKey +} from '@aws-crypto/material-management-browser' +import { getWebCryptoBackend } from '@aws-crypto/web-crypto-backend' +import { KMS, KMSConfiguration } from '@aws-sdk/client-kms-browser' // eslint-disable-line no-unused-vars + +const getKmsClient = getClient(KMS) +const cacheKmsClients = cacheClients(getKmsClient) + +export type KmsKeyringWebCryptoInput = Partial> +export type KMSWebCryptoConstructible = KMSConstructible +export type KmsWebCryptoClientSupplier = KmsClientSupplier + +export class KmsKeyringNode extends KmsKeyring { + constructor ({ + clientProvider = cacheKmsClients, + kmsKeys, + generatorKmsKey, + grantTokens + }: KmsKeyringWebCryptoInput) { + super({ clientProvider, kmsKeys, generatorKmsKey, grantTokens }) + } + + async _onEncrypt (material: WebCryptoEncryptionMaterial, context?: EncryptionContext) { + const _material = await super._onEncrypt(material, context) + + /* Check for early return (Postcondition): If a cryptoKey has already been imported, return. */ + if (_material.hasUnencryptedDataKey && _material.hasCryptoKey) { + return _material + } + + const backend = await getWebCryptoBackend() + const cryptoKey = await importCryptoKey(backend, _material) + // The trace is only set when the material does not already have + // an hasUnencryptedDataKey. This is an implementation detail :( + const [trace] = _material.keyringTrace + + return _material.setCryptoKey(cryptoKey, trace) + } + + async _onDecrypt (material: WebCryptoDecryptionMaterial, encryptedDataKeys: EncryptedDataKey[], context?: EncryptionContext) { + const _material = await super._onDecrypt(material, encryptedDataKeys, context) + + /* Check for early return (Postcondition): If a cryptoKey has already been imported, return. */ + if (_material.hasUnencryptedDataKey && _material.hasCryptoKey) { + return _material + } + + const backend = await getWebCryptoBackend() + const cryptoKey = await importCryptoKey(backend, _material) + // Now that a cryptoKey has been imported, the unencrypted data key can be zeroed. + _material.zeroUnencryptedDataKey() + // The trace is only set when the material does not already have + // an hasUnencryptedDataKey. This is an implementation detail :( + const [trace] = _material.keyringTrace + + return _material.setCryptoKey(cryptoKey, trace) + } +} +immutableClass(KmsKeyringNode) + +export { getClient, cacheKmsClients, limitRegions, excludeRegions, cacheClients } From 7f2c75c5dccdefe273dc69c00f2a20d883162a65 Mon Sep 17 00:00:00 2001 From: seebees Date: Wed, 27 Mar 2019 06:47:29 -0700 Subject: [PATCH 04/12] kms-keyring-browser --- .../src/kms_keyring_browser.ts | 10 +++++-- .../test/kms_keyring_browser.test.ts | 28 +++++++++++++++++++ 2 files changed, 36 insertions(+), 2 deletions(-) create mode 100644 modules/kms-keyring-browser/test/kms_keyring_browser.test.ts diff --git a/modules/kms-keyring-browser/src/kms_keyring_browser.ts b/modules/kms-keyring-browser/src/kms_keyring_browser.ts index e19948866..d319761c8 100644 --- a/modules/kms-keyring-browser/src/kms_keyring_browser.ts +++ b/modules/kms-keyring-browser/src/kms_keyring_browser.ts @@ -30,7 +30,8 @@ import { EncryptionContext, // eslint-disable-line no-unused-vars EncryptedDataKey, // eslint-disable-line no-unused-vars immutableClass, - importCryptoKey + importCryptoKey, + WebCryptoKeyring } from '@aws-crypto/material-management-browser' import { getWebCryptoBackend } from '@aws-crypto/web-crypto-backend' import { KMS, KMSConfiguration } from '@aws-sdk/client-kms-browser' // eslint-disable-line no-unused-vars @@ -48,7 +49,7 @@ export class KmsKeyringNode extends KmsKeyring { kmsKeys, generatorKmsKey, grantTokens - }: KmsKeyringWebCryptoInput) { + }: KmsKeyringWebCryptoInput = {}) { super({ clientProvider, kmsKeys, generatorKmsKey, grantTokens }) } @@ -87,6 +88,11 @@ export class KmsKeyringNode extends KmsKeyring { return _material.setCryptoKey(cryptoKey, trace) } + + [Symbol.hasInstance] (obj: any) { + return obj instanceof WebCryptoKeyring || + Function.prototype[Symbol.hasInstance].call(this, obj) + } } immutableClass(KmsKeyringNode) diff --git a/modules/kms-keyring-browser/test/kms_keyring_browser.test.ts b/modules/kms-keyring-browser/test/kms_keyring_browser.test.ts new file mode 100644 index 000000000..491f04aa6 --- /dev/null +++ b/modules/kms-keyring-browser/test/kms_keyring_browser.test.ts @@ -0,0 +1,28 @@ +/* + * Copyright 2018 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. A copy of the License is + * located at + * + * http://aws.amazon.com/apache2.0/ + * + * or in the "license" file accompanying this file. This file 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. + */ + +/* eslint-env mocha */ + +import { expect } from 'chai' +import 'mocha' +import { KmsKeyringNode } from '../src/kms_keyring_browser' +import { WebCryptoKeyring} from '@aws-crypto/material-management-browser' + +describe('KmsKeyringNode', () => { + it('instance of WebCryptoKeyring', () => { + const test = new KmsKeyringNode() + expect(test instanceof WebCryptoKeyring).to.equal(true) + }) +}) From 6dfb0e2627ed0ca23f2981a07a6976a22a851de7 Mon Sep 17 00:00:00 2001 From: seebees Date: Wed, 27 Mar 2019 11:01:11 -0700 Subject: [PATCH 05/12] kms-keyring-browser --- modules/kms-keyring-browser/test/kms_keyring_browser.test.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/kms-keyring-browser/test/kms_keyring_browser.test.ts b/modules/kms-keyring-browser/test/kms_keyring_browser.test.ts index 491f04aa6..851232e31 100644 --- a/modules/kms-keyring-browser/test/kms_keyring_browser.test.ts +++ b/modules/kms-keyring-browser/test/kms_keyring_browser.test.ts @@ -18,7 +18,7 @@ import { expect } from 'chai' import 'mocha' import { KmsKeyringNode } from '../src/kms_keyring_browser' -import { WebCryptoKeyring} from '@aws-crypto/material-management-browser' +import { WebCryptoKeyring } from '@aws-crypto/material-management-browser' describe('KmsKeyringNode', () => { it('instance of WebCryptoKeyring', () => { From 11771a5b462cf3fd3cfc022aa738d9e24acc06d8 Mon Sep 17 00:00:00 2001 From: seebees Date: Wed, 27 Mar 2019 14:23:05 -0700 Subject: [PATCH 06/12] kms-keyring-browser kms client --- modules/kms-keyring-browser/package.json | 1 + 1 file changed, 1 insertion(+) diff --git a/modules/kms-keyring-browser/package.json b/modules/kms-keyring-browser/package.json index 303dca993..cce416de9 100644 --- a/modules/kms-keyring-browser/package.json +++ b/modules/kms-keyring-browser/package.json @@ -20,6 +20,7 @@ "@aws-crypto/material-management-browser": "^0.0.1", "@aws-crypto/kms-keyring": "^0.0.1", "@aws-crypto/web-crypto-backend": "^0.0.1", + "@aws-sdk/client-kms-browser": "^0.1.0-preview.2", "@aws-sdk/types": "0.1.0-preview.1", "tslib": "^1.9.3" }, From 66ed55b32a469750f8bbec0eaaf7a6ef4b9920a6 Mon Sep 17 00:00:00 2001 From: seebees Date: Thu, 28 Mar 2019 14:11:55 -0700 Subject: [PATCH 07/12] kms-keyring-browser --- .../src/kms_keyring_browser.ts | 20 ++++++++----------- .../test/kms_keyring_browser.test.ts | 10 +++++----- 2 files changed, 13 insertions(+), 17 deletions(-) diff --git a/modules/kms-keyring-browser/src/kms_keyring_browser.ts b/modules/kms-keyring-browser/src/kms_keyring_browser.ts index d319761c8..1cc85df03 100644 --- a/modules/kms-keyring-browser/src/kms_keyring_browser.ts +++ b/modules/kms-keyring-browser/src/kms_keyring_browser.ts @@ -14,7 +14,8 @@ */ import { - KmsKeyring, + KmsKeyringClass, + KeyRingConstructible, // eslint-disable-line no-unused-vars KmsKeyringInput, // eslint-disable-line no-unused-vars KMSConstructible, // eslint-disable-line no-unused-vars KmsClientSupplier, // eslint-disable-line no-unused-vars @@ -31,7 +32,7 @@ import { EncryptedDataKey, // eslint-disable-line no-unused-vars immutableClass, importCryptoKey, - WebCryptoKeyring + KeyringWebCrypto // eslint-disable-line no-unused-vars } from '@aws-crypto/material-management-browser' import { getWebCryptoBackend } from '@aws-crypto/web-crypto-backend' import { KMS, KMSConfiguration } from '@aws-sdk/client-kms-browser' // eslint-disable-line no-unused-vars @@ -43,14 +44,14 @@ export type KmsKeyringWebCryptoInput = Partial> export type KMSWebCryptoConstructible = KMSConstructible export type KmsWebCryptoClientSupplier = KmsClientSupplier -export class KmsKeyringNode extends KmsKeyring { +export class KmsKeyringBrowser extends KmsKeyringClass(KeyringWebCrypto as KeyRingConstructible) { constructor ({ clientProvider = cacheKmsClients, - kmsKeys, - generatorKmsKey, + keyIds, + generatorKeyId, grantTokens }: KmsKeyringWebCryptoInput = {}) { - super({ clientProvider, kmsKeys, generatorKmsKey, grantTokens }) + super({ clientProvider, keyIds, generatorKeyId, grantTokens }) } async _onEncrypt (material: WebCryptoEncryptionMaterial, context?: EncryptionContext) { @@ -88,12 +89,7 @@ export class KmsKeyringNode extends KmsKeyring { return _material.setCryptoKey(cryptoKey, trace) } - - [Symbol.hasInstance] (obj: any) { - return obj instanceof WebCryptoKeyring || - Function.prototype[Symbol.hasInstance].call(this, obj) - } } -immutableClass(KmsKeyringNode) +immutableClass(KmsKeyringBrowser) export { getClient, cacheKmsClients, limitRegions, excludeRegions, cacheClients } diff --git a/modules/kms-keyring-browser/test/kms_keyring_browser.test.ts b/modules/kms-keyring-browser/test/kms_keyring_browser.test.ts index 851232e31..16b53707f 100644 --- a/modules/kms-keyring-browser/test/kms_keyring_browser.test.ts +++ b/modules/kms-keyring-browser/test/kms_keyring_browser.test.ts @@ -17,12 +17,12 @@ import { expect } from 'chai' import 'mocha' -import { KmsKeyringNode } from '../src/kms_keyring_browser' -import { WebCryptoKeyring } from '@aws-crypto/material-management-browser' +import { KmsKeyringBrowser } from '../src/kms_keyring_browser' +import { KeyringWebCrypto } from '@aws-crypto/material-management-browser' describe('KmsKeyringNode', () => { - it('instance of WebCryptoKeyring', () => { - const test = new KmsKeyringNode() - expect(test instanceof WebCryptoKeyring).to.equal(true) + it('instance of KeyringWebCrypto', () => { + const test = new KmsKeyringBrowser() + expect(test instanceof KeyringWebCrypto).to.equal(true) }) }) From 4726a2f384db712bf3f7652c3bd539961e608b62 Mon Sep 17 00:00:00 2001 From: seebees Date: Fri, 29 Mar 2019 07:37:33 -0700 Subject: [PATCH 08/12] housekeeping --- NOTICE | 2 +- modules/kms-keyring-browser/.gitignore | 3 --- modules/kms-keyring-browser/.npmignore | 3 --- modules/kms-keyring-browser/NOTICE | 2 +- modules/kms-keyring-browser/package.json | 1 + modules/kms-keyring-browser/src/index.ts | 2 +- modules/kms-keyring-browser/src/kms_keyring_browser.ts | 2 +- modules/kms-keyring-browser/test/kms_keyring_browser.test.ts | 2 +- 8 files changed, 6 insertions(+), 11 deletions(-) delete mode 100644 modules/kms-keyring-browser/.gitignore delete mode 100644 modules/kms-keyring-browser/.npmignore diff --git a/NOTICE b/NOTICE index a95284f35..88f7bea1e 100644 --- a/NOTICE +++ b/NOTICE @@ -1,2 +1,2 @@ AWS Encryption SDK for Javascript -Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved. +Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. diff --git a/modules/kms-keyring-browser/.gitignore b/modules/kms-keyring-browser/.gitignore deleted file mode 100644 index 6498d2c9d..000000000 --- a/modules/kms-keyring-browser/.gitignore +++ /dev/null @@ -1,3 +0,0 @@ -/node_modules/ -/build/ -/.nyc_output \ No newline at end of file diff --git a/modules/kms-keyring-browser/.npmignore b/modules/kms-keyring-browser/.npmignore deleted file mode 100644 index f39dee960..000000000 --- a/modules/kms-keyring-browser/.npmignore +++ /dev/null @@ -1,3 +0,0 @@ -/src/ -/coverage/ -/test/ \ No newline at end of file diff --git a/modules/kms-keyring-browser/NOTICE b/modules/kms-keyring-browser/NOTICE index a95284f35..88f7bea1e 100644 --- a/modules/kms-keyring-browser/NOTICE +++ b/modules/kms-keyring-browser/NOTICE @@ -1,2 +1,2 @@ AWS Encryption SDK for Javascript -Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved. +Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. diff --git a/modules/kms-keyring-browser/package.json b/modules/kms-keyring-browser/package.json index cce416de9..6f677195b 100644 --- a/modules/kms-keyring-browser/package.json +++ b/modules/kms-keyring-browser/package.json @@ -42,6 +42,7 @@ "main": "./build/main/index.js", "module": "./build/module/index.js", "types": "./build/main/index.d.ts", + "files": ["./build/**/*"], "standard": { "parser": "@typescript-eslint/parser", "plugins": [ diff --git a/modules/kms-keyring-browser/src/index.ts b/modules/kms-keyring-browser/src/index.ts index 8b66aeb13..9812ea8c1 100644 --- a/modules/kms-keyring-browser/src/index.ts +++ b/modules/kms-keyring-browser/src/index.ts @@ -1,5 +1,5 @@ /* - * Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved. + * Copyright 2019 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. A copy of the License is diff --git a/modules/kms-keyring-browser/src/kms_keyring_browser.ts b/modules/kms-keyring-browser/src/kms_keyring_browser.ts index 1cc85df03..82294c136 100644 --- a/modules/kms-keyring-browser/src/kms_keyring_browser.ts +++ b/modules/kms-keyring-browser/src/kms_keyring_browser.ts @@ -1,5 +1,5 @@ /* - * Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved. + * Copyright 2019 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. A copy of the License is diff --git a/modules/kms-keyring-browser/test/kms_keyring_browser.test.ts b/modules/kms-keyring-browser/test/kms_keyring_browser.test.ts index 16b53707f..f482e909c 100644 --- a/modules/kms-keyring-browser/test/kms_keyring_browser.test.ts +++ b/modules/kms-keyring-browser/test/kms_keyring_browser.test.ts @@ -1,5 +1,5 @@ /* - * Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved. + * Copyright 2019 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. A copy of the License is From 36d3c2d8713894f36edcc6be80706e10cc870630 Mon Sep 17 00:00:00 2001 From: seebees Date: Fri, 29 Mar 2019 15:19:37 -0700 Subject: [PATCH 09/12] kms-keyring-browser --- modules/kms-keyring-browser/src/kms_keyring_browser.ts | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/modules/kms-keyring-browser/src/kms_keyring_browser.ts b/modules/kms-keyring-browser/src/kms_keyring_browser.ts index 82294c136..f65ba9be6 100644 --- a/modules/kms-keyring-browser/src/kms_keyring_browser.ts +++ b/modules/kms-keyring-browser/src/kms_keyring_browser.ts @@ -49,9 +49,10 @@ export class KmsKeyringBrowser extends KmsKeyringClass(KeyringWebCrypto as KeyRi clientProvider = cacheKmsClients, keyIds, generatorKeyId, - grantTokens + grantTokens, + discovery }: KmsKeyringWebCryptoInput = {}) { - super({ clientProvider, keyIds, generatorKeyId, grantTokens }) + super({ clientProvider, keyIds, generatorKeyId, grantTokens, discovery }) } async _onEncrypt (material: WebCryptoEncryptionMaterial, context?: EncryptionContext) { From 112c13ad45c59228db6925d76617542365a122b6 Mon Sep 17 00:00:00 2001 From: seebees Date: Sat, 30 Mar 2019 17:27:10 -0700 Subject: [PATCH 10/12] kms-keyring-browser --- modules/kms-keyring-browser/test/kms_keyring_browser.test.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/kms-keyring-browser/test/kms_keyring_browser.test.ts b/modules/kms-keyring-browser/test/kms_keyring_browser.test.ts index f482e909c..9172df2ce 100644 --- a/modules/kms-keyring-browser/test/kms_keyring_browser.test.ts +++ b/modules/kms-keyring-browser/test/kms_keyring_browser.test.ts @@ -22,7 +22,7 @@ import { KeyringWebCrypto } from '@aws-crypto/material-management-browser' describe('KmsKeyringNode', () => { it('instance of KeyringWebCrypto', () => { - const test = new KmsKeyringBrowser() + const test = new KmsKeyringBrowser({discovery: true}) expect(test instanceof KeyringWebCrypto).to.equal(true) }) }) From 89d033290b1ae766ec4f0fb8d19d8811647f0c07 Mon Sep 17 00:00:00 2001 From: seebees Date: Tue, 2 Apr 2019 16:40:38 -0700 Subject: [PATCH 11/12] kms-keyring-node --- modules/kms-keyring-browser/src/kms_keyring_browser.ts | 4 ++-- modules/kms-keyring-browser/test/kms_keyring_browser.test.ts | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/kms-keyring-browser/src/kms_keyring_browser.ts b/modules/kms-keyring-browser/src/kms_keyring_browser.ts index f65ba9be6..fe98805db 100644 --- a/modules/kms-keyring-browser/src/kms_keyring_browser.ts +++ b/modules/kms-keyring-browser/src/kms_keyring_browser.ts @@ -58,7 +58,7 @@ export class KmsKeyringBrowser extends KmsKeyringClass(KeyringWebCrypto as KeyRi async _onEncrypt (material: WebCryptoEncryptionMaterial, context?: EncryptionContext) { const _material = await super._onEncrypt(material, context) - /* Check for early return (Postcondition): If a cryptoKey has already been imported, return. */ + /* Check for early return (Postcondition): If a cryptoKey has already been imported for encrypt, return. */ if (_material.hasUnencryptedDataKey && _material.hasCryptoKey) { return _material } @@ -75,7 +75,7 @@ export class KmsKeyringBrowser extends KmsKeyringClass(KeyringWebCrypto as KeyRi async _onDecrypt (material: WebCryptoDecryptionMaterial, encryptedDataKeys: EncryptedDataKey[], context?: EncryptionContext) { const _material = await super._onDecrypt(material, encryptedDataKeys, context) - /* Check for early return (Postcondition): If a cryptoKey has already been imported, return. */ + /* Check for early return (Postcondition): If a cryptoKey has already been imported for decrypt, return. */ if (_material.hasUnencryptedDataKey && _material.hasCryptoKey) { return _material } diff --git a/modules/kms-keyring-browser/test/kms_keyring_browser.test.ts b/modules/kms-keyring-browser/test/kms_keyring_browser.test.ts index 9172df2ce..a27b4103d 100644 --- a/modules/kms-keyring-browser/test/kms_keyring_browser.test.ts +++ b/modules/kms-keyring-browser/test/kms_keyring_browser.test.ts @@ -22,7 +22,7 @@ import { KeyringWebCrypto } from '@aws-crypto/material-management-browser' describe('KmsKeyringNode', () => { it('instance of KeyringWebCrypto', () => { - const test = new KmsKeyringBrowser({discovery: true}) + const test = new KmsKeyringBrowser({ discovery: true }) expect(test instanceof KeyringWebCrypto).to.equal(true) }) }) From f5f54c1f70a8f3ed732009da7869f23f1ce5a6b7 Mon Sep 17 00:00:00 2001 From: seebees Date: Thu, 4 Apr 2019 16:25:35 -0700 Subject: [PATCH 12/12] right logic --- modules/kms-keyring-browser/src/kms_keyring_browser.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/kms-keyring-browser/src/kms_keyring_browser.ts b/modules/kms-keyring-browser/src/kms_keyring_browser.ts index fe98805db..6feb1c2e1 100644 --- a/modules/kms-keyring-browser/src/kms_keyring_browser.ts +++ b/modules/kms-keyring-browser/src/kms_keyring_browser.ts @@ -76,9 +76,9 @@ export class KmsKeyringBrowser extends KmsKeyringClass(KeyringWebCrypto as KeyRi const _material = await super._onDecrypt(material, encryptedDataKeys, context) /* Check for early return (Postcondition): If a cryptoKey has already been imported for decrypt, return. */ - if (_material.hasUnencryptedDataKey && _material.hasCryptoKey) { - return _material - } + if (_material.hasValidKey()) return _material + /* Check for early return (Postcondition): If no key was able to be decrypted, return. */ + if (!_material.hasUnencryptedDataKey) return _material const backend = await getWebCryptoBackend() const cryptoKey = await importCryptoKey(backend, _material)