@techbulls/encrypted-s3-store 1.0.0

package/.prettierignore

@@ -0,0 +1,3 @@
+dist
+node_modules
+pnpm-lock.yaml

package/.prettierrc

@@ -0,0 +1,7 @@
+{
+  "semi": true,
+  "singleQuote": true,
+  "tabWidth": 2,
+  "trailingComma": "es5",
+  "printWidth": 100
+}

package/LICENSE.md

@@ -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.

package/README.md

@@ -0,0 +1,353 @@
+# encrypted-s3-store
+
+A TypeScript library that provides transparent end-to-end encryption for AWS S3 objects using AES-256-GCM encryption with scrypt key derivation.
+
+## Features
+
+- **AES-256-GCM Encryption** - Military-grade encryption for all stored objects
+- **Configurable Modes** - Choose between `encrypt` (with encryption) or `passthrough` (without encryption)
+- **Scrypt Key Derivation** - Secure memory-hard key derivation using Node.js built-in crypto
+- **Transparent Encryption/Decryption** - Automatic handling during upload and download
+- **Full AWS SDK Compatibility** - Wraps the official AWS S3 client
+- **TypeScript Support** - Complete type definitions with strict mode
+- **Zero External Dependencies** - Uses only Node.js built-in crypto modules for encryption
+
+## Installation
+
+```bash
+npm install @techbulls/encrypted-s3-store
+```
+
+or
+
+```bash
+pnpm install @techbulls/encrypted-s3-store
+```
+
+or
+
+```bash
+yarn add @techbulls/encrypted-s3-store
+```
+
+## Quick Start
+
+```typescript
+import { S3ObjectStore, S3Client } from '@techbulls/encrypted-s3-store';
+
+// Create an AWS S3 client
+const s3Client = new S3Client({ region: 'us-east-1' });
+
+// Create the encrypted store wrapper
+const store = new S3ObjectStore(s3Client, 'your-secret-encryption-key');
+
+// Upload encrypted data
+await store.upload({
+  Bucket: 'my-secure-bucket',
+  Key: 'secret-file.txt',
+  Body: 'This content will be encrypted automatically',
+  ContentType: 'text/plain',
+});
+
+// Download and decrypt data
+const result = await store.download({
+  Bucket: 'my-secure-bucket',
+  Key: 'secret-file.txt',
+});
+
+// result.Body is a readable stream with decrypted content
+```
+
+## Configuration
+
+### Constructor Parameters
+
+The `S3ObjectStore` constructor accepts the following parameters:
+
+| Parameter | Type       | Required | Description                                                    |
+| --------- | ---------- | -------- | -------------------------------------------------------------- |
+| `client`  | `S3Client` | Yes      | An initialized AWS S3Client instance                           |
+| `key`     | `string`   | Yes\*    | Encryption key for AES-256-GCM                                 |
+| `mode`    | `ModeType` | No       | Operation mode (`'encrypt'` or `'passthrough'`). Default: `'encrypt'` |
+
+\*Required when using `encrypt` mode. Can also be provided via `ENCRYPTION_KEY` environment variable.
+
+### Modes
+
+- **`encrypt`** (default): Data is encrypted before upload and decrypted on download using AES-256-GCM.
+- **`passthrough`**: Data is uploaded and downloaded without any encryption. Useful for non-sensitive data or when using S3's built-in encryption.
+
+### Environment Variables
+
+The library supports the following environment variables:
+
+| Variable         | Description                                       |
+| ---------------- | ------------------------------------------------- |
+| `ENCRYPTION_KEY` | Fallback encryption key if not provided in config |
+
+## API Reference
+
+### `upload(input)`
+
+Encrypts and uploads data to S3.
+
+```typescript
+await store.upload({
+  Bucket: 'my-bucket',
+  Key: 'path/to/file.txt',
+  Body: 'content to encrypt', // string, Buffer, or Uint8Array
+  ContentType: 'text/plain',
+});
+
+// Or with per-operation mode override
+await store.upload({
+  Bucket: 'my-bucket',
+  Key: 'file.txt',
+  Body: 'content',
+  mode: 'passthrough', // Skip encryption for this upload
+});
+```
+
+**Parameters:**
+
+- `input` - `IUpload` object (extends `PutObjectCommandInput`)
+  - `Bucket` (required) - S3 bucket name
+  - `Key` (required) - S3 object key
+  - `Body` (required) - Content to encrypt and upload (string, Buffer, or Uint8Array)
+  - `mode` (optional) - Per-operation mode override (`'encrypt'` or `'passthrough'`)
+  - All other `PutObjectCommandInput` options are supported
+
+**Returns:** `PutObjectCommandOutput` from AWS SDK
+
+### `download(input)`
+
+Downloads and decrypts data from S3.
+
+```typescript
+const result = await store.download({
+  Bucket: 'my-bucket',
+  Key: 'path/to/file.txt',
+});
+
+// Or with per-operation mode override
+const result = await store.download({
+  Bucket: 'my-bucket',
+  Key: 'file.txt',
+  mode: 'passthrough', // Skip decryption for this download
+});
+
+// result.Body is a Readable stream with decrypted content
+```
+
+**Parameters:**
+
+- `input` - `IDownload` object (extends `GetObjectCommandInput`)
+  - `Bucket` (required) - S3 bucket name
+  - `Key` (required) - S3 object key
+  - `mode` (optional) - Per-operation mode override (`'encrypt'` or `'passthrough'`)
+  - All other `GetObjectCommandInput` options are supported
+
+**Returns:**
+
+- `Body` - Decrypted readable stream
+- `ContentType` - Original content type
+- `ContentLength` - Content length
+- `Metadata` - S3 object metadata
+
+## Examples
+
+### Basic Usage
+
+```typescript
+import { S3ObjectStore, S3Client } from '@techbulls/encrypted-s3-store';
+
+const s3Client = new S3Client({ region: 'us-west-2' });
+const store = new S3ObjectStore(s3Client, process.env.ENCRYPTION_KEY!);
+
+// Upload a JSON object
+const data = { userId: 123, sensitiveInfo: 'secret' };
+await store.upload({
+  Bucket: 'my-bucket',
+  Key: 'users/123/data.json',
+  Body: JSON.stringify(data),
+  ContentType: 'application/json',
+});
+```
+
+### Reading Downloaded Content
+
+```typescript
+import { Readable } from 'stream';
+
+const result = await store.download({
+  Bucket: 'my-bucket',
+  Key: 'users/123/data.json',
+});
+
+// Convert stream to string
+const chunks: Buffer[] = [];
+for await (const chunk of result.Body as Readable) {
+  chunks.push(Buffer.from(chunk));
+}
+const content = Buffer.concat(chunks).toString('utf-8');
+const data = JSON.parse(content);
+```
+
+### Using with Buffer
+
+```typescript
+// Upload binary data
+const imageBuffer = fs.readFileSync('photo.jpg');
+await store.upload({
+  Bucket: 'my-bucket',
+  Key: 'images/photo.jpg',
+  Body: imageBuffer,
+  ContentType: 'image/jpeg',
+});
+```
+
+### Passthrough Mode (No Encryption)
+
+```typescript
+// Use passthrough mode for non-sensitive data
+const s3Client = new S3Client({ region: 'us-west-2' });
+const store = new S3ObjectStore(s3Client, 'unused-key', 'passthrough');
+
+// Data is uploaded without encryption
+await store.upload({
+  Bucket: 'my-public-bucket',
+  Key: 'public/readme.txt',
+  Body: 'This content is not encrypted',
+  ContentType: 'text/plain',
+});
+```
+
+### Per-Operation Mode Override
+
+```typescript
+const store = new S3ObjectStore(s3Client, 'my-secret-key'); // Default: encrypt
+
+// This upload will skip encryption
+await store.upload({
+  Bucket: 'my-bucket',
+  Key: 'public-file.txt',
+  Body: 'Not sensitive',
+  mode: 'passthrough',
+});
+
+// This upload will use encryption (default)
+await store.upload({
+  Bucket: 'my-bucket',
+  Key: 'secret-file.txt',
+  Body: 'Sensitive data',
+});
+
+// Download without decryption
+const result = await store.download({
+  Bucket: 'my-bucket',
+  Key: 'unencrypted-file.txt',
+  mode: 'passthrough',
+});
+```
+
+### Environment-based Configuration
+
+```typescript
+// Set environment variable:
+// ENCRYPTION_KEY=your-secret-key
+
+const s3Client = new S3Client({ region: 'us-east-1' });
+const store = new S3ObjectStore(s3Client);
+// encryptionKey will be read from ENCRYPTION_KEY env var
+```
+
+## Security
+
+### Encryption Details
+
+- **Algorithm:** AES-256-GCM (Advanced Encryption Standard, 256-bit key, Galois/Counter Mode)
+- **IV:** Random 12-byte initialization vector per upload
+- **Authentication:** GCM authentication tag for integrity verification
+
+### Key Derivation
+
+Uses scrypt with the following parameters:
+
+- **N (cost):** 16384 (2^14)
+- **r (blockSize):** 8
+- **p (parallelization):** 1
+- **Output:** 32 bytes (256-bit key)
+
+### Metadata Storage
+
+Encryption metadata is stored in S3 object metadata:
+
+- `x-amz-iv` - Base64-encoded initialization vector
+- `x-amz-salt` - Base64-encoded salt for key derivation
+- `x-amz-auth-tag` - Base64-encoded authentication tag
+- `x-amz-encryption` - Encryption algorithm identifier
+
+## Error Handling
+
+The library throws descriptive errors for common issues:
+
+```typescript
+try {
+  await store.upload({ Bucket: 'my-bucket', Key: 'test.txt', Body: 'content' });
+} catch (error) {
+  // Handle errors:
+  // - "Encryption key not provided."
+  // - "Body is required for upload"
+  // - "No body returned from S3"
+}
+```
+
+## TypeScript
+
+The library is written in TypeScript and exports all types:
+
+```typescript
+import { S3ObjectStore } from '@techbulls/encrypted-s3-store';
+import type { ModeType, IUpload, IDownload } from '@techbulls/encrypted-s3-store';
+import type { PutObjectCommandInput, GetObjectCommandInput } from '@techbulls/encrypted-s3-store';
+```
+
+## Using the Underlying S3 Client
+
+The `S3ObjectStore` wraps an S3 client, which you can access for standard S3 operations:
+
+```typescript
+import { S3Client, ListObjectsV2Command, DeleteObjectCommand } from '@techbulls/encrypted-s3-store';
+
+const s3Client = new S3Client({ region: 'us-east-1' });
+const store = new S3ObjectStore(s3Client, 'my-key');
+
+// List objects (use the underlying client directly)
+const listResult = await store.client.send(
+  new ListObjectsV2Command({
+    Bucket: 'my-bucket',
+    Prefix: 'users/',
+  })
+);
+
+// Delete object
+await store.client.send(
+  new DeleteObjectCommand({
+    Bucket: 'my-bucket',
+    Key: 'old-file.txt',
+  })
+);
+```
+
+## Requirements
+
+- Node.js 18+
+- AWS credentials with S3 access
+
+## Author
+
+**Aditya Chaphekar** - [aditya.chaphekar@techbulls.com](mailto:aditya.chaphekar@techbulls.com)
+
+## License
+
+Licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) for details.