diff --git a/README.md b/README.md index 821934c45b41..c5df9a108d93 100644 --- a/README.md +++ b/README.md @@ -645,6 +645,7 @@ bindings to be included as a dependency with your application. This functionalit - [Amazon S3 Multi-Region Access Points](https://docs.aws.amazon.com/AmazonS3/latest/userguide/MultiRegionAccessPoints.html) - [Amazon S3 Object Integrity](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) - [Amazon CloudFront-KeyValueStore](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/kvs-with-functions-kvp.html) +- [Amazon S3 CRC64-NVME checksums](https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html) If the required AWS Common Runtime components are not installed, you will receive an error like: diff --git a/packages/crc64-nvme-crt/CHANGELOG.md b/packages/crc64-nvme-crt/CHANGELOG.md new file mode 100644 index 000000000000..e9fb6ecf5930 --- /dev/null +++ b/packages/crc64-nvme-crt/CHANGELOG.md @@ -0,0 +1,4 @@ +# Change Log + +All notable changes to this project will be documented in this file. +See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. \ No newline at end of file diff --git a/packages/crc64-nvme-crt/LICENSE b/packages/crc64-nvme-crt/LICENSE new file mode 100644 index 000000000000..7b6491ba7876 --- /dev/null +++ b/packages/crc64-nvme-crt/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/packages/crc64-nvme-crt/README.md b/packages/crc64-nvme-crt/README.md new file mode 100644 index 000000000000..3b410cc0b873 --- /dev/null +++ b/packages/crc64-nvme-crt/README.md @@ -0,0 +1,8 @@ +# @aws-sdk/crc64-nvme-crt + +[![NPM version](https://img.shields.io/npm/v/@aws-sdk/crc64-nvme-crt/latest.svg)](https://www.npmjs.com/package/@aws-sdk/crc64-nvme-crt) +[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/crc64-nvme-crt.svg)](https://www.npmjs.com/package/@aws-sdk/crc64-nvme-crt) + +This package contains native modules that only executable in Node.js runtime, used for computing CRC64-NVME checksums. + +See also https://github.com/aws/aws-sdk-js-v3/tree/main#functionality-requiring-aws-common-runtime-crt. diff --git a/packages/crc64-nvme-crt/api-extractor.json b/packages/crc64-nvme-crt/api-extractor.json new file mode 100644 index 000000000000..b03e22a16a06 --- /dev/null +++ b/packages/crc64-nvme-crt/api-extractor.json @@ -0,0 +1,4 @@ +{ + "extends": "../../api-extractor.packages.json", + "mainEntryPointFilePath": "./dist-types/index.d.ts" +} diff --git a/packages/crc64-nvme-crt/package.json b/packages/crc64-nvme-crt/package.json new file mode 100644 index 000000000000..e46e4b55caca --- /dev/null +++ b/packages/crc64-nvme-crt/package.json @@ -0,0 +1,51 @@ +{ + "name": "@aws-sdk/crc64-nvme-crt", + "version": "3.0.0", + "description": "An implementation of CRC64-NVME checksum based on AWS Common Runtime https://github.com/awslabs/aws-crt-nodejs", + "main": "./dist-cjs/index.js", + "module": "./dist-es/index.js", + "types": "./dist-types/index.d.ts", + "scripts": { + "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'", + "build:cjs": "node ../../scripts/compilation/inline crc64-nvme-crt", + "build:es": "tsc -p tsconfig.es.json", + "build:include:deps": "lerna run --scope $npm_package_name --include-dependencies build", + "build:types": "tsc -p tsconfig.types.json", + "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4", + "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo", + "extract:docs": "api-extractor run --local", + "test": "yarn g:vitest run", + "test:watch": "yarn g:vitest watch" + }, + "author": { + "name": "AWS SDK for JavaScript Team", + "url": "https://aws.amazon.com/javascript/" + }, + "license": "Apache-2.0", + "dependencies": { + "@aws-sdk/crt-loader": "*", + "@smithy/types": "^3.7.2", + "@smithy/util-utf8": "^3.0.0", + "tslib": "^2.6.2" + }, + "devDependencies": { + "@smithy/util-base64": "^3.0.0", + "@tsconfig/recommended": "1.0.1", + "concurrently": "7.0.0", + "downlevel-dts": "0.10.1", + "rimraf": "3.0.2", + "typescript": "~4.9.5" + }, + "engines": { + "node": ">=16.0.0" + }, + "files": [ + "dist-*/**" + ], + "homepage": "https://github.com/aws/aws-sdk-js-v3/tree/main/packages/crc64-nvme-crt", + "repository": { + "type": "git", + "url": "https://github.com/aws/aws-sdk-js-v3.git", + "directory": "packages/crc64-nvme-crt" + } +} diff --git a/packages/crc64-nvme-crt/src/CrtCrc64Nvme.spec.ts b/packages/crc64-nvme-crt/src/CrtCrc64Nvme.spec.ts new file mode 100644 index 000000000000..6c71ae9ca944 --- /dev/null +++ b/packages/crc64-nvme-crt/src/CrtCrc64Nvme.spec.ts @@ -0,0 +1,22 @@ +import { toBase64 } from "@smithy/util-base64"; +import { describe, expect, it } from "vitest"; + +import { CrtCrc64Nvme } from "./CrtCrc64Nvme"; + +describe(CrtCrc64Nvme.name, () => { + it("should throw an error if digest is called before update", async () => { + const crc64 = new CrtCrc64Nvme(); + await expect(crc64.digest()).rejects.toThrowError("No data provided to checksum"); + }); + + it.each([ + ["", "AAAAAAAAAAA="], + ["abc", "BeXKuz/B+us="], + ["Hello world", "OOJZ0D8xKts="], + ])(`crc64-nvme for "%s" is "%s"`, async (input, output) => { + const crc64 = new CrtCrc64Nvme(); + crc64.update(new TextEncoder().encode(input)); + const digest = await crc64.digest(); + expect(toBase64(digest)).toEqual(output); + }); +}); diff --git a/packages/crc64-nvme-crt/src/CrtCrc64Nvme.ts b/packages/crc64-nvme-crt/src/CrtCrc64Nvme.ts new file mode 100644 index 000000000000..3f8be18f148f --- /dev/null +++ b/packages/crc64-nvme-crt/src/CrtCrc64Nvme.ts @@ -0,0 +1,22 @@ +import { checksums } from "@aws-sdk/crt-loader"; +import { Checksum } from "@smithy/types"; +import { toUint8Array } from "@smithy/util-utf8"; + +export class CrtCrc64Nvme implements Checksum { + private previous: DataView | undefined; + + update(chunk: Uint8Array) { + this.previous = checksums.crc64nvme(chunk, this.previous); + } + + async digest() { + if (!this.previous) { + throw new Error("No data provided to checksum"); + } + return toUint8Array(this.previous); + } + + reset() { + this.previous = undefined; + } +} diff --git a/packages/crc64-nvme-crt/src/index.ts b/packages/crc64-nvme-crt/src/index.ts new file mode 100644 index 000000000000..e0be035dd474 --- /dev/null +++ b/packages/crc64-nvme-crt/src/index.ts @@ -0,0 +1,2 @@ +// ToDo: set implementation in middleware-flexible-checksums container. +export * from "./CrtCrc64Nvme"; diff --git a/packages/crc64-nvme-crt/tsconfig.cjs.json b/packages/crc64-nvme-crt/tsconfig.cjs.json new file mode 100644 index 000000000000..fd33d99033c0 --- /dev/null +++ b/packages/crc64-nvme-crt/tsconfig.cjs.json @@ -0,0 +1,12 @@ +{ + "compilerOptions": { + "baseUrl": ".", + "lib": ["es2016"], + "noUnusedLocals": true, + "outDir": "dist-cjs", + "rootDir": "src", + "stripInternal": true + }, + "extends": "../../tsconfig.cjs.json", + "include": ["src/"] +} diff --git a/packages/crc64-nvme-crt/tsconfig.es.json b/packages/crc64-nvme-crt/tsconfig.es.json new file mode 100644 index 000000000000..37d7418d4733 --- /dev/null +++ b/packages/crc64-nvme-crt/tsconfig.es.json @@ -0,0 +1,12 @@ +{ + "compilerOptions": { + "baseUrl": ".", + "lib": [], + "noUnusedLocals": true, + "outDir": "dist-es", + "rootDir": "src", + "stripInternal": true + }, + "extends": "../../tsconfig.es.json", + "include": ["src/"] +} diff --git a/packages/crc64-nvme-crt/tsconfig.types.json b/packages/crc64-nvme-crt/tsconfig.types.json new file mode 100644 index 000000000000..6cdf9f52ea06 --- /dev/null +++ b/packages/crc64-nvme-crt/tsconfig.types.json @@ -0,0 +1,9 @@ +{ + "compilerOptions": { + "baseUrl": ".", + "declarationDir": "dist-types", + "rootDir": "src" + }, + "extends": "../../tsconfig.types.json", + "include": ["src/"] +} diff --git a/packages/crc64-nvme-crt/vitest.config.ts b/packages/crc64-nvme-crt/vitest.config.ts new file mode 100644 index 000000000000..82a0517935eb --- /dev/null +++ b/packages/crc64-nvme-crt/vitest.config.ts @@ -0,0 +1,8 @@ +import { defineConfig } from "vitest/config"; + +export default defineConfig({ + test: { + include: ["**/*.spec.ts"], + environment: "node", + }, +}); diff --git a/yarn.lock b/yarn.lock index c224df79c522..10051375e470 100644 --- a/yarn.lock +++ b/yarn.lock @@ -23246,6 +23246,23 @@ __metadata: languageName: unknown linkType: soft +"@aws-sdk/crc64-nvme-crt@workspace:packages/crc64-nvme-crt": + version: 0.0.0-use.local + resolution: "@aws-sdk/crc64-nvme-crt@workspace:packages/crc64-nvme-crt" + dependencies: + "@aws-sdk/crt-loader": "npm:*" + "@smithy/types": "npm:^3.7.2" + "@smithy/util-base64": "npm:^3.0.0" + "@smithy/util-utf8": "npm:^3.0.0" + "@tsconfig/recommended": "npm:1.0.1" + concurrently: "npm:7.0.0" + downlevel-dts: "npm:0.10.1" + rimraf: "npm:3.0.2" + tslib: "npm:^2.6.2" + typescript: "npm:~4.9.5" + languageName: unknown + linkType: soft + "@aws-sdk/credential-provider-cognito-identity@npm:*, @aws-sdk/credential-provider-cognito-identity@workspace:packages/credential-provider-cognito-identity": version: 0.0.0-use.local resolution: "@aws-sdk/credential-provider-cognito-identity@workspace:packages/credential-provider-cognito-identity"