ts-configurable - npm Package Compare versions

Comparing version 0.3.1 to 1.0.0

CHANGELOG.md

 # CHANGELOG
 
+## 1.0.0
+
+- Breaking changes: values are base64 encoded before being encrypted and base64 decoded after being decrypted. This way, when providing multiple keys, a correct decryption can be determined by checking whether the plaintext only contains charactesr from the base64 characterset.
+- Export the `decrypt` method from the package so the consumer can test the correct functionality of encryption and decryption.
+
 ## 0.3.1
@@ -4,0 +9,0 @@

index.d.ts

 export { IConstructorOptions, IEnvOptions, IDecoratorOptions } from './lib/interfaces';
 export { Configurable } from './lib/configurable';
 export { BaseConfig } from './lib/base-config';
-export { encrypt } from './lib/encryption-utils';
+export { encrypt, decrypt } from './lib/encryption-utils';

index.js

@@ -9,2 +9,3 @@ "use strict";
 exports.encrypt = encryption_utils_1.encrypt;
+exports.decrypt = encryption_utils_1.decrypt;
 //# sourceMappingURL=index.js.map

lib/encryption-utils.d.ts

@@ -12,6 +12,6 @@ /// <reference types="node" />
  * Decrypt the given ciphertext
- * @param key decryption key
+ * @param keyOrSecret decryption secret (string) or derived key (Buffer)
  * @param ciphertext ciphertext to decrypt
  */
-export declare function decrypt(key: Buffer, ciphertext: string): string;
+export declare function decrypt(keyOrSecret: Buffer | string, ciphertext: string): string;
 export declare function attemptDecryption(keys: Buffer[], ciphertext: any): any;

lib/encryption-utils.js

@@ -104,5 +104,5 @@ "use strict";
     const iv = crypto_1.randomBytes(ivBytelength);
-    // Encrypt plaintext
+    // Encrypt base64-encoded plaintext
     const cipher = crypto_1.createCipheriv(cipherAlgorithm, key, iv);
-    let encrypted = cipher.update(plaintext);
+    let encrypted = cipher.update(Buffer.from(plaintext).toString('base64'));
     encrypted = Buffer.concat([encrypted, cipher.final()]);
@@ -115,6 +115,7 @@ // Return the serialized cipher (its string representation)
  * Decrypt the given ciphertext
- * @param key decryption key
+ * @param keyOrSecret decryption secret (string) or derived key (Buffer)
  * @param ciphertext ciphertext to decrypt
  */
-function decrypt(key, ciphertext) {
+function decrypt(keyOrSecret, ciphertext) {
+    const key = typeof keyOrSecret === 'string' ? keyFromSecret(keyOrSecret) : keyOrSecret;
     const { iv, encrypted } = deserializeCipher(ciphertext);
@@ -125,3 +126,3 @@ // Decrypt value
     decrypted = Buffer.concat([decrypted, decipher.final()]);
-    const plaintext = decrypted.toString();
+    const plaintext = Buffer.from(decrypted.toString(), 'base64').toString();
     return plaintext;
@@ -128,0 +129,0 @@ }

package.json

 {
   "name": "ts-configurable",
-  "version": "0.3.1",
+  "version": "1.0.0",
   "license": "MIT",
@@ -5,0 +5,0 @@ "author": "Benjamin Assadsolimani (derbenoo)",

README.md

@@ -308,3 +308,3 @@ # TS-Configurable
 console.log(`CIPHER: ${cipher}`);
-// output: CIPHER: $ENC$.f60399294c2152fe8bbffc1cd9e8d22a.e44f27a1290864635acc3fd32b09f66a086de3743a26479c85edb3724f9ca8ad
+// output: CIPHER: $ENC$.6aaa302f81c67ce6fe2da026ba7a2d0b.91b5db5ffea63e0d2c89c350760ca54152e6d4b5526ef06f8d6952407120891c
 ```
@@ -311,0 +311,0 @@

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

68809

increased by1.81%

Lines of code

493

increased by0.41%

Number of low quality alerts

1

decreased by-50%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes