Replace Buffer with Uint8Array (sindresorhus#189)

Co-authored-by: Sindre Sorhus <sindresorhus@gmail.com>

package.json

@@ -53,7 +53,8 @@
 		"dot-prop": "^7.2.0",
 		"env-paths": "^3.0.0",
 		"json-schema-typed": "^8.0.1",
-		"semver": "^7.3.8"
+		"semver": "^7.3.8",
+		"uint8array-extras": "^0.2.0"
 	},
 	"devDependencies": {
 		"@sindresorhus/tsconfig": "^3.0.1",

readme.md

@@ -224,7 +224,7 @@ The only use-case I can think of is having the config located in the app directo
 
 #### encryptionKey
 
-Type: `string | Buffer | TypedArray | DataView`\
+Type: `string | Uint8Array | TypedArray | DataView`\
 Default: `undefined`
 
 Note that this is **not intended for security purposes**, since the encryption key would be easily found inside a plain-text Node.js app.

source/index.ts

@@ -1,7 +1,6 @@
 /* eslint-disable @typescript-eslint/naming-convention, @typescript-eslint/no-unsafe-return, @typescript-eslint/no-redundant-type-constituents */
 import {isDeepStrictEqual} from 'node:util';
 import process from 'node:process';
-import {Buffer} from 'node:buffer';
 import fs from 'node:fs';
 import path from 'node:path';
 import crypto from 'node:crypto';
@@ -15,6 +14,12 @@ import ajvFormatsModule from 'ajv-formats';
 import debounceFn from 'debounce-fn';
 import semver from 'semver';
 import {type JSONSchema} from 'json-schema-typed';
+import {
+	concatUint8Arrays,
+	isUint8Array,
+	stringToUint8Array,
+	uint8ArrayToString,
+} from 'uint8array-extras';
 import {
 	type Deserialize,
 	type Migrations,
@@ -57,7 +62,7 @@ export default class Conf<T extends Record<string, any> = Record<string, unknown
 	readonly path: string;
 	readonly events: EventEmitter;
 	readonly #validator?: AjvValidateFunction;
-	readonly #encryptionKey?: string | Buffer | NodeJS.TypedArray | DataView;
+	readonly #encryptionKey?: string | Uint8Array | NodeJS.TypedArray | DataView;
 	readonly #options: Readonly<Partial<Options<T>>>;
 	readonly #defaultValues: Partial<T> = {};
 
@@ -353,17 +358,19 @@ export default class Conf<T extends Record<string, any> = Record<string, unknown
 		}
 	}
 
-	private _encryptData(data: string | Buffer): string {
+	private _encryptData(data: string | Uint8Array): string {
 		if (!this.#encryptionKey) {
-			return data.toString();
+			return typeof data === 'string' ? data : uint8ArrayToString(data);
 		}
 
 		// Check if an initialization vector has been used to encrypt the data.
 		try {
 			const initializationVector = data.slice(0, 16);
 			const password = crypto.pbkdf2Sync(this.#encryptionKey, initializationVector.toString(), 10_000, 32, 'sha512');
 			const decipher = crypto.createDecipheriv(encryptionAlgorithm, password, initializationVector);
-			return Buffer.concat([decipher.update(Buffer.from(data.slice(17))), decipher.final()]).toString('utf8');
+			const slice = data.slice(17);
+			const dataUpdate = isUint8Array(slice) ? slice : stringToUint8Array(slice);
+			return uint8ArrayToString(concatUint8Arrays([decipher.update(dataUpdate), decipher.final()]));
 		} catch {}
 
 		return data.toString();
@@ -425,13 +432,13 @@ export default class Conf<T extends Record<string, any> = Record<string, unknown
 	}
 
 	private _write(value: T): void {
-		let data: string | Buffer = this._serialize(value);
+		let data: string | Uint8Array = this._serialize(value);
 
 		if (this.#encryptionKey) {
 			const initializationVector = crypto.randomBytes(16);
 			const password = crypto.pbkdf2Sync(this.#encryptionKey, initializationVector.toString(), 10_000, 32, 'sha512');
 			const cipher = crypto.createCipheriv(encryptionAlgorithm, password, initializationVector);
-			data = Buffer.concat([initializationVector, Buffer.from(':'), cipher.update(Buffer.from(data)), cipher.final()]);
+			data = concatUint8Arrays([initializationVector, stringToUint8Array(':'), cipher.update(stringToUint8Array(data)), cipher.final()]);
 		}
 
 		// Temporary workaround for Conf being packaged in a Ubuntu Snap app.

source/types.ts

@@ -1,4 +1,3 @@
-import {type Buffer} from 'node:buffer';
 import {type EventEmitter} from 'node:events';
 import {type JSONSchema as TypedJSONSchema} from 'json-schema-typed';
 // eslint-disable unicorn/import-index
@@ -132,7 +131,7 @@ export type Options<T extends Record<string, any>> = {
 
 	When specified, the store will be encrypted using the [`aes-256-cbc`](https://en.wikipedia.org/wiki/Block_cipher_mode_of_operation) encryption algorithm.
 	*/
-	encryptionKey?: string | Buffer | NodeJS.TypedArray | DataView;
+	encryptionKey?: string | Uint8Array | NodeJS.TypedArray | DataView;
 
 	/**
 	Extension of the config file.

test/index.test-d.ts

@@ -1,5 +1,5 @@
 /* eslint-disable no-new, @typescript-eslint/naming-convention */
-import {Buffer} from 'node:buffer';
+import {stringToUint8Array} from 'uint8array-extras';
 import {expectType, expectAssignable, expectError} from 'tsd';
 import Conf from '../source/index.js';
 
@@ -23,7 +23,7 @@ new Conf<UnicornFoo>({configName: ''});
 new Conf<UnicornFoo>({projectName: 'foo'});
 new Conf<UnicornFoo>({cwd: ''});
 new Conf<UnicornFoo>({encryptionKey: ''});
-new Conf<UnicornFoo>({encryptionKey: Buffer.from('')});
+new Conf<UnicornFoo>({encryptionKey: stringToUint8Array('')});
 new Conf<UnicornFoo>({encryptionKey: new Uint8Array([1])});
 new Conf<UnicornFoo>({encryptionKey: new DataView(new ArrayBuffer(2))});
 new Conf<UnicornFoo>({fileExtension: '.foo'});