diff --git a/package.json b/package.json index a536ae07..c016590e 100644 --- a/package.json +++ b/package.json @@ -32,7 +32,8 @@ "@aws-crypto/sha256-browser": "file:packages/sha256-browser", "@aws-crypto/sha256-js": "file:packages/sha256-js", "@aws-crypto/sha256-universal": "file:packages/sha256-universal", - "@aws-crypto/supports-web-crypto": "file:packages/supports-web-crypto" + "@aws-crypto/supports-web-crypto": "file:packages/supports-web-crypto", + "@aws-crypto/util": "file:packages/util" }, "workspaces": [ "packages/*" diff --git a/packages/sha256-browser/package.json b/packages/sha256-browser/package.json index da6c9936..4c168ff5 100644 --- a/packages/sha256-browser/package.json +++ b/packages/sha256-browser/package.json @@ -22,8 +22,8 @@ "@aws-crypto/supports-web-crypto": "file:../supports-web-crypto", "@aws-sdk/types": "^3.1.0", "@aws-sdk/util-locate-window": "^3.0.0", - "@aws-sdk/util-utf8-browser": "^3.0.0", - "tslib": "^1.11.1" + "tslib": "^1.11.1", + "@aws-crypto/util": "file:../util" }, "main": "./build/index.js", "types": "./build/index.d.ts" diff --git a/packages/sha256-browser/src/webCryptoSha256.ts b/packages/sha256-browser/src/webCryptoSha256.ts index 6f74e957..a95911da 100644 --- a/packages/sha256-browser/src/webCryptoSha256.ts +++ b/packages/sha256-browser/src/webCryptoSha256.ts @@ -1,10 +1,9 @@ import { Hash, SourceData } from "@aws-sdk/types"; -import { fromUtf8 } from "@aws-sdk/util-utf8-browser"; -import { isEmptyData } from "./isEmptyData"; +import { isEmptyData, convertToBuffer } from "@aws-crypto/util"; import { EMPTY_DATA_SHA_256, SHA_256_HASH, - SHA_256_HMAC_ALGO + SHA_256_HMAC_ALGO, } from "./constants"; import { locateWindow } from "@aws-sdk/util-locate-window"; @@ -45,10 +44,10 @@ export class Sha256 implements Hash { digest(): Promise { if (this.key) { - return this.key.then(key => + return this.key.then((key) => locateWindow() .crypto.subtle.sign(SHA_256_HMAC_ALGO, key, this.toHash) - .then(data => new Uint8Array(data)) + .then((data) => new Uint8Array(data)) ); } @@ -60,22 +59,6 @@ export class Sha256 implements Hash { .then(() => locateWindow().crypto.subtle.digest(SHA_256_HASH, this.toHash) ) - .then(data => Promise.resolve(new Uint8Array(data))); + .then((data) => Promise.resolve(new Uint8Array(data))); } } - -function convertToBuffer(data: SourceData): Uint8Array { - if (typeof data === "string") { - return fromUtf8(data); - } - - if (ArrayBuffer.isView(data)) { - return new Uint8Array( - data.buffer, - data.byteOffset, - data.byteLength / Uint8Array.BYTES_PER_ELEMENT - ); - } - - return new Uint8Array(data); -} diff --git a/packages/sha256-js/package.json b/packages/sha256-js/package.json index 4b31e131..fab313da 100644 --- a/packages/sha256-js/package.json +++ b/packages/sha256-js/package.json @@ -20,7 +20,7 @@ "license": "Apache-2.0", "dependencies": { "@aws-sdk/types": "^3.1.0", - "@aws-sdk/util-utf8-browser": "^3.0.0", + "@aws-crypto/util": "file:../util", "tslib": "^1.11.1" } } diff --git a/packages/sha256-js/src/jsSha256.ts b/packages/sha256-js/src/jsSha256.ts index 5ff15cb4..7a331875 100644 --- a/packages/sha256-js/src/jsSha256.ts +++ b/packages/sha256-js/src/jsSha256.ts @@ -1,7 +1,7 @@ import { BLOCK_SIZE } from "./constants"; import { RawSha256 } from "./RawSha256"; import { Hash, SourceData } from "@aws-sdk/types"; -import { fromUtf8 } from "@aws-sdk/util-utf8-browser"; +import { isEmptyData, convertToBuffer } from "@aws-crypto/util"; export class Sha256 implements Hash { private readonly hash = new RawSha256(); @@ -84,27 +84,3 @@ function bufferFromSecret(secret: SourceData): Uint8Array { buffer.set(input); return buffer; } - -function isEmptyData(data: SourceData): boolean { - if (typeof data === "string") { - return data.length === 0; - } - - return data.byteLength === 0; -} - -function convertToBuffer(data: SourceData): Uint8Array { - if (typeof data === "string") { - return fromUtf8(data); - } - - if (ArrayBuffer.isView(data)) { - return new Uint8Array( - data.buffer, - data.byteOffset, - data.byteLength / Uint8Array.BYTES_PER_ELEMENT - ); - } - - return new Uint8Array(data); -} diff --git a/packages/util/.npmignore b/packages/util/.npmignore new file mode 100644 index 00000000..5897ccf6 --- /dev/null +++ b/packages/util/.npmignore @@ -0,0 +1,4 @@ +/test/ +/coverage/ +/docs/ +tsconfig.test.json \ No newline at end of file diff --git a/packages/util/LICENSE b/packages/util/LICENSE new file mode 100644 index 00000000..980a15ac --- /dev/null +++ b/packages/util/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 {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/packages/util/README.md b/packages/util/README.md new file mode 100644 index 00000000..2b8ef80c --- /dev/null +++ b/packages/util/README.md @@ -0,0 +1,16 @@ +# @aws-crypto/crc32c + +Pure JS implementation of CRC32-C https://en.wikipedia.org/wiki/Cyclic_redundancy_check + +## Usage + +``` +import { Crc32c } from '@aws-crypto/crc32c'; + +const crc32Digest = (new Crc32c).update(buffer).digest() + +``` + +## Test + +`npm test` diff --git a/packages/util/package.json b/packages/util/package.json new file mode 100644 index 00000000..63e6b50b --- /dev/null +++ b/packages/util/package.json @@ -0,0 +1,29 @@ +{ + "name": "@aws-crypto/util", + "version": "1.0.0", + "scripts": { + "prepublishOnly": "tsc", + "pretest": "tsc -p tsconfig.test.json", + "test": "mocha --require ts-node/register test/**/*test.ts" + }, + "main": "./build/index.js", + "types": "./build/index.d.ts", + "repository": { + "type": "git", + "url": "git@github.com:aws/aws-sdk-js-crypto-helpers.git" + }, + "author": { + "name": "AWS Crypto Tools Team", + "email": "aws-cryptools@amazon.com", + "url": "https://docs.aws.amazon.com/aws-crypto-tools/index.html?id=docs_gateway#lang/en_us" + }, + "license": "Apache-2.0", + "dependencies": { + "tslib": "^1.11.1", + "@aws-sdk/types": "^3.1.0", + "@aws-sdk/util-utf8-browser": "^3.0.0" + }, + "publishConfig": { + "access": "public" + } +} diff --git a/packages/util/src/convertToBuffer.ts b/packages/util/src/convertToBuffer.ts new file mode 100644 index 00000000..f202734f --- /dev/null +++ b/packages/util/src/convertToBuffer.ts @@ -0,0 +1,30 @@ +// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved. +// SPDX-License-Identifier: Apache-2.0 + +import { SourceData } from "@aws-sdk/types"; +import { fromUtf8 as fromUtf8Browser } from "@aws-sdk/util-utf8-browser"; + +// Quick polyfill +const fromUtf8 = + Buffer && Buffer.from + ? (input: string) => Buffer.from(input, "utf8") + : fromUtf8Browser; + +export function convertToBuffer(data: SourceData): Uint8Array { + // Already a Uint8, do nothing + if (data instanceof Uint8Array) return data; + + if (typeof data === "string") { + return fromUtf8(data); + } + + if (ArrayBuffer.isView(data)) { + return new Uint8Array( + data.buffer, + data.byteOffset, + data.byteLength / Uint8Array.BYTES_PER_ELEMENT + ); + } + + return new Uint8Array(data); +} diff --git a/packages/util/src/index.ts b/packages/util/src/index.ts new file mode 100644 index 00000000..435bce4f --- /dev/null +++ b/packages/util/src/index.ts @@ -0,0 +1,6 @@ +// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved. +// SPDX-License-Identifier: Apache-2.0 + +export { convertToBuffer } from "./convertToBuffer"; +export { isEmptyData } from "./isEmptyData"; +export { numToUint8 } from "./numToUint8"; diff --git a/packages/util/src/isEmptyData.ts b/packages/util/src/isEmptyData.ts new file mode 100644 index 00000000..089764de --- /dev/null +++ b/packages/util/src/isEmptyData.ts @@ -0,0 +1,12 @@ +// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved. +// SPDX-License-Identifier: Apache-2.0 + +import { SourceData } from "@aws-sdk/types"; + +export function isEmptyData(data: SourceData): boolean { + if (typeof data === "string") { + return data.length === 0; + } + + return data.byteLength === 0; +} diff --git a/packages/util/src/numToUint8.ts b/packages/util/src/numToUint8.ts new file mode 100644 index 00000000..2f40aceb --- /dev/null +++ b/packages/util/src/numToUint8.ts @@ -0,0 +1,11 @@ +// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved. +// SPDX-License-Identifier: Apache-2.0 + +export function numToUint8(num: number) { + return new Uint8Array([ + (num & 0xff000000) >> 24, + (num & 0x00ff0000) >> 16, + (num & 0x0000ff00) >> 8, + num & 0x000000ff, + ]); +} diff --git a/packages/util/test/convertToBuffer.test.ts b/packages/util/test/convertToBuffer.test.ts new file mode 100644 index 00000000..be66d4c1 --- /dev/null +++ b/packages/util/test/convertToBuffer.test.ts @@ -0,0 +1,41 @@ +// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved. +// SPDX-License-Identifier: Apache-2.0 + +import { expect } from "chai"; +import "mocha"; +import { convertToBuffer } from "../src/convertToBuffer"; + +describe("convertToBuffer", () => { + it("should return the same Uint8Array", () => { + const data = new Uint8Array(5); + const test = convertToBuffer(data); + + expect(test).to.equal(data); + }); + + it("should return a utf8 encoded Uint8Array", () => { + const data = "asdf"; + const test = convertToBuffer(data); + + expect(test).to.deep.equal(new Uint8Array([97, 115, 100, 102])); + }); + + it("should return a Uint8Array with the same buffer", () => { + const data = new Uint8Array(5).fill(1); + const test = convertToBuffer(data.buffer); + + expect(test.buffer).to.equal(data.buffer); + }); + + it("", () => { + const data = new Uint8Array(10).fill(2); + const view = new DataView( + new Uint8Array(data.buffer, 3, 5).fill(1).buffer, + 3, + 5 + ); + const test = convertToBuffer(view); + + expect(test).to.deep.equal(new Uint8Array([1, 1, 1, 1, 1])); + }); +}); diff --git a/packages/util/test/isEmptyData.test.ts b/packages/util/test/isEmptyData.test.ts new file mode 100644 index 00000000..4caeb9fd --- /dev/null +++ b/packages/util/test/isEmptyData.test.ts @@ -0,0 +1,32 @@ +// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved. +// SPDX-License-Identifier: Apache-2.0 + +import { expect } from "chai"; +import "mocha"; +import { isEmptyData } from "../src/isEmptyData"; + +describe("isEmptyData", () => { + it("should return true for an empty string", () => { + expect(isEmptyData("")).to.eql(true); + }); + + it("should return false for a non-empty string", () => { + expect(isEmptyData("foo")).to.eql(false); + }); + + it("should return true for an empty ArrayBuffer", () => { + expect(isEmptyData(new ArrayBuffer(0))).to.eql(true); + }); + + it("should return false for a non-empty ArrayBuffer", () => { + expect(isEmptyData(new ArrayBuffer(1))).to.eql(false); + }); + + it("should return true for an empty ArrayBufferView", () => { + expect(isEmptyData(new Uint8Array(0))).to.eql(true); + }); + + it("should return false for a non-empty ArrayBufferView", () => { + expect(isEmptyData(Uint8Array.from([0]))).to.eql(false); + }); +}); diff --git a/packages/util/tsconfig.json b/packages/util/tsconfig.json new file mode 100644 index 00000000..1691089a --- /dev/null +++ b/packages/util/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "target": "es5", + "module": "commonjs", + "declaration": true, + "strict": true, + "sourceMap": true, + "downlevelIteration": true, + "importHelpers": true, + "noEmitHelpers": true, + "lib": [ + "es5", + "es2015.promise", + "es2015.collection", + "es2015.iterable", + "es2015.symbol.wellknown" + ], + "rootDir": "./src", + "outDir": "./build" + }, + "include": ["src/**/*.ts"], + "exclude": ["node_modules/**"] +} diff --git a/packages/util/tsconfig.test.json b/packages/util/tsconfig.test.json new file mode 100644 index 00000000..57f7d5b1 --- /dev/null +++ b/packages/util/tsconfig.test.json @@ -0,0 +1,10 @@ +{ + "extends": "./tsconfig.json", + "compilerOptions": { + "sourceMap": false, + "inlineSourceMap": true, + "inlineSources": true, + "rootDir": "./src", + "outDir": "./build" + } +}