@nivinjoseph/n-sec 5.0.5 → 6.0.2

package/src/api-security/claims-identity.ts

@@ -1,5 +1,5 @@
-import { Claim } from "./claim";
 import { given } from "@nivinjoseph/n-defensive";
+import { Claim } from "./claim.js";
 
 
 // public

package/src/api-security/json-web-token.ts

@@ -1,11 +1,11 @@
-import { Claim } from "./claim";
-import { InvalidOperationException } from "@nivinjoseph/n-exception";
 import { given } from "@nivinjoseph/n-defensive";
-import { InvalidTokenException } from "./invalid-token-exception";
-import { AlgType } from "./alg-type";
-import { Hmac } from "./../crypto/hmac";
-// import { DigitalSignature } from "./../crypto/digital-signature";
-import { ExpiredTokenException } from "./expired-token-exception";
+import { InvalidOperationException } from "@nivinjoseph/n-exception";
+import { Hmac } from "./../crypto/hmac.js";
+import { AlgType } from "./alg-type.js";
+import { Claim } from "./claim.js";
+import { InvalidTokenException } from "./invalid-token-exception.js";
+// import { DigitalSignature } from "./../crypto/digital-signature.js";
+import { ExpiredTokenException } from "./expired-token-exception.js";
 
 
 // public
@@ -18,7 +18,7 @@ export class JsonWebToken
     private readonly _expiry: number;
     private readonly _claims: Array<Claim>;
 
-    
+
     public get issuer(): string { return this._issuer; }
     public get algType(): AlgType { return this._algType; }
     public get key(): string { return this._key; }
@@ -26,8 +26,8 @@ export class JsonWebToken
     public get expiry(): number { return this._expiry; }
     public get isExpired(): boolean { return this._expiry <= Date.now(); }
     public get claims(): ReadonlyArray<Claim> { return this._claims; }
-    
-    
+
+
     private constructor(issuer: string, algType: AlgType, key: string, isFullKey: boolean, expiry: number,
         claims: Array<Claim>)
     {
@@ -38,7 +38,7 @@ export class JsonWebToken
         given(expiry, "expiry").ensureHasValue().ensureIsNumber();
         given(claims, "claims").ensureHasValue().ensureIsArray()
             .ensure(t => t.isNotEmpty, "cannot be empty");
-        
+
         this._issuer = issuer.trim();
         this._algType = algType;
         this._key = key.trim();
@@ -46,7 +46,7 @@ export class JsonWebToken
         this._expiry = expiry;
         this._claims = [...claims];
     }
-    
+
     public static fromClaims(issuer: string, algType: AlgType, key: string, expiry: number,
         claims: Array<Claim>): JsonWebToken
     {
@@ -132,33 +132,33 @@ export class JsonWebToken
         const obj = JSON.parse(json) as object;
         return obj;
     }
-    
+
     public generateToken(): string
     {
         if (!this._isfullKey)
-            throw new InvalidOperationException("generating token using an instance created from token");    
-        
+            throw new InvalidOperationException("generating token using an instance created from token");
+
         const header: Header = {
             iss: this._issuer,
             alg: this._algType,
             exp: this._expiry
         };
-        
+
         const body: any = {};
         this._claims.forEach(t => body[t.type] = t.value);
-        
+
         const headerAndBody = this._toHex(header) + "." + this._toHex(body);
-        
+
         // let signature = this._algType === AlgType.hmac
         //     ? await Hmac.create(this._key, headerAndBody)
         //     : await DigitalSignature.sign(this._key, headerAndBody);
-        
+
         const signature = Hmac.create(this._key, headerAndBody);
-        
+
         const token = headerAndBody + "." + signature;
         return token;
     }
-    
+
     private _toHex(obj: object): string
     {
         const json = JSON.stringify(obj);

package/src/bin.ts

@@ -2,7 +2,7 @@
 
 // import { given } from "@nivinjoseph/n-defensive";
 import { TypeHelper } from "@nivinjoseph/n-util";
-import { SymmetricEncryption } from "./crypto/symmetric-encryption";
+import { SymmetricEncryption } from "./crypto/symmetric-encryption.js";
 
 enum SupportedCommands
 {
@@ -17,6 +17,7 @@ async function executeCommand(command: SupportedCommands): Promise<void>
 
     switch (command)
     {
+        // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
         case SupportedCommands.generateSymmetricKey:
             {
                 const key = await SymmetricEncryption.generateKey();

package/src/crypto/hash.ts

@@ -1,23 +1,23 @@
 import { given } from "@nivinjoseph/n-defensive";
-import * as Crypto from "crypto";
+import { createHash } from "node:crypto";
 
 
 // public
 export class Hash
 {
     private constructor() { }
-    
+
 
     public static create(value: string): string
     {
         given(value, "value").ensureHasValue().ensureIsString();
         value = value.trim();
-        
-        const hash = Crypto.createHash("sha512");
+
+        const hash = createHash("sha512");
         hash.update(value, "utf8");
         return hash.digest("hex").toUpperCase();
     }
-    
+
     public static createUsingSalt(value: string, salt: string): string
     {
         given(value, "value").ensureHasValue().ensureIsString();
@@ -25,7 +25,7 @@ export class Hash
 
         value = value.trim();
         salt = salt.trim();
-        
+
         const reverse = (val: string): string =>
         {
             let rev = "";
@@ -33,14 +33,14 @@ export class Hash
                 rev = val[i] + rev;
             return rev;
         };
-        
+
         const valueReverse = reverse(value);
         const saltReverse = reverse(salt);
 
         // const saltedValue = "{1}{0}{2}{1}{3}{1}{2}".format(value, salt, valueReverse, saltReverse);
-        
+
         const saltedValue = `${salt}${value}${valueReverse}${salt}${saltReverse}${salt}${valueReverse}`;
-        
+
         return Hash.create(saltedValue);
     }
 }

package/src/crypto/hmac.ts

@@ -1,23 +1,23 @@
 import { given } from "@nivinjoseph/n-defensive";
-import * as Crypto from "crypto";
+import { createHmac } from "node:crypto";
 
 
 // public
 export class Hmac
 {
     private constructor() { }
-    
-    
+
+
     public static create(key: string, value: string): string
     {
         given(key, "key").ensureHasValue().ensureIsString();
         given(value, "value").ensureHasValue().ensureIsString();
-        
+
         key = key.trim();
         value = value.trim();
-        
-        const hmac = Crypto.createHmac("sha256", Buffer.from(key, "hex"));
-        
+
+        const hmac = createHmac("sha256", Buffer.from(key, "hex"));
+
         hmac.update(value, "utf8");
         return hmac.digest("hex").toUpperCase();
     }

package/src/crypto/symmetric-encryption.ts

@@ -1,6 +1,6 @@
-import * as Crypto from "crypto";
-import { CryptoException } from "./crypto-exception";
 import { given } from "@nivinjoseph/n-defensive";
+import { createCipheriv, createDecipheriv, randomBytes } from "node:crypto";
+import { CryptoException } from "./crypto-exception.js";
 
 
 // public
@@ -8,12 +8,12 @@ export class SymmetricEncryption
 {
     private constructor() { }
 
-    
+
     public static generateKey(): Promise<string>
     {
         return new Promise<string>((resolve, reject) =>
         {
-            Crypto.randomBytes(32, (err, buf) =>
+            randomBytes(32, (err, buf) =>
             {
                 if (err)
                 {
@@ -25,7 +25,7 @@ export class SymmetricEncryption
             });
         });
     }
-    
+
     public static encrypt(key: string, value: string): Promise<string>
     {
         return new Promise<string>((resolve, reject) =>
@@ -35,8 +35,8 @@ export class SymmetricEncryption
 
             key = key.trim();
             value = value.trim();
-            
-            Crypto.randomBytes(16, (err, buf) =>
+
+            randomBytes(16, (err, buf) =>
             {
                 if (err)
                 {
@@ -47,7 +47,7 @@ export class SymmetricEncryption
                 try 
                 {
                     const iv = buf;
-                    const cipher = Crypto.createCipheriv("AES-256-CBC", Buffer.from(key, "hex"), iv);
+                    const cipher = createCipheriv("AES-256-CBC", Buffer.from(key, "hex"), iv);
                     let encrypted = cipher.update(value, "utf8", "hex");
                     encrypted += cipher.final("hex");
                     const cipherText = `${encrypted}.${iv.toString("hex")}`;
@@ -60,7 +60,7 @@ export class SymmetricEncryption
             });
         });
     }
-    
+
     public static decrypt(key: string, value: string): string
     {
         given(key, "key").ensureHasValue().ensureIsString();
@@ -68,13 +68,13 @@ export class SymmetricEncryption
 
         key = key.trim();
         value = value.trim();
-        
+
         const splitted = value.split(".");
         if (splitted.length !== 2)
             throw new CryptoException("Invalid value.");
 
         const iv = Buffer.from(splitted[1], "hex");
-        const deCipher = Crypto.createDecipheriv("AES-256-CBC", Buffer.from(key, "hex"), iv);
+        const deCipher = createDecipheriv("AES-256-CBC", Buffer.from(key, "hex"), iv);
         let decrypted = deCipher.update(splitted[0], "hex", "utf8");
         decrypted += deCipher.final("utf8");
         return decrypted;

package/src/index.ts

@@ -1,26 +1,25 @@
 import "@nivinjoseph/n-ext";
 
-import { SymmetricEncryption } from "./crypto/symmetric-encryption";
-import { Hmac } from "./crypto/hmac";
-import { Hash } from "./crypto/hash";
-// import { DigitalSignature } from "./crypto/digital-signature";
-// import { AsymmetricEncryption } from "./crypto/asymmetric-encryption";
-import { CryptoException } from "./crypto/crypto-exception";
+import { Hash } from "./crypto/hash.js";
+import { Hmac } from "./crypto/hmac.js";
+import { SymmetricEncryption } from "./crypto/symmetric-encryption.js";
+// import { DigitalSignature } from "./crypto/digital-signature.js";
+// import { AsymmetricEncryption } from "./crypto/asymmetric-encryption.js";
+import { CryptoException } from "./crypto/crypto-exception.js";
 
-import { AlgType } from "./api-security/alg-type";
-import { Claim } from "./api-security/claim";
-import { ClaimsIdentity } from "./api-security/claims-identity";
-import { ExpiredTokenException } from "./api-security/expired-token-exception";
-import { InvalidTokenException } from "./api-security/invalid-token-exception";
-import { JsonWebToken } from "./api-security/json-web-token";
-import { SecurityToken } from "./api-security/security-token";
+import { AlgType } from "./api-security/alg-type.js";
+import { Claim } from "./api-security/claim.js";
+import { ClaimsIdentity } from "./api-security/claims-identity.js";
+import { ExpiredTokenException } from "./api-security/expired-token-exception.js";
+import { InvalidTokenException } from "./api-security/invalid-token-exception.js";
+import { JsonWebToken } from "./api-security/json-web-token.js";
+import { SecurityToken } from "./api-security/security-token.js";
 
 
 export
 {
-    SymmetricEncryption, Hmac, Hash,
+
+    AlgType, Claim, ClaimsIdentity,
     // DigitalSignature, AsymmetricEncryption,
-    CryptoException,
-    
-    AlgType, Claim, ClaimsIdentity, ExpiredTokenException, InvalidTokenException, JsonWebToken, SecurityToken
-};
+    CryptoException, ExpiredTokenException, Hash, Hmac, InvalidTokenException, JsonWebToken, SecurityToken, SymmetricEncryption
+};

package/test/asymmetric-encryption.test.ts

@@ -3,24 +3,24 @@
 // // import { CryptoException } from "./../src/crypto-exception";
 // import "@nivinjoseph/n-ext";
 
-// suite("AsymmetricEncryption", () =>
+// await describe("AsymmetricEncryption", () =>
 // {
-//     suite("generateKeyPair", () =>
+//     await describe("generateKeyPair", () =>
 //     { 
-//         test("should return string value that is not null, empty or whitespace", async () =>
+//         await test("should return string value that is not null, empty or whitespace", async () =>
 //         {
 //             let keyPair = await AsymmetricEncryption.generateKeyPair();
 //             Assert.ok(keyPair !== null && !keyPair.isEmptyOrWhiteSpace());
 //         });
         
-//         test("consecutive invocations must generate different values", async () =>
+//         await test("consecutive invocations must generate different values", async () =>
 //         {
 //             let keyPair1 = await AsymmetricEncryption.generateKeyPair();
 //             let keyPair2 = await AsymmetricEncryption.generateKeyPair();
 //             Assert.notStrictEqual(keyPair1, keyPair2);
 //         });
 
-//         // test("generate 3 KeyPairs", async () =>
+//         // await test("generate 3 KeyPairs", async () =>
 //         // {
 //         //     let keyPair1 = await AsymmetricEncryption.generateKeyPair();
 //         //     let keyPair2 = await AsymmetricEncryption.generateKeyPair();
@@ -34,9 +34,9 @@
 //         // });
 //     });
     
-//     suite("getPublicKey", () =>
+//     await describe("getPublicKey", () =>
 //     {
-//         test("should return a string value that is not null, empty, whitespace or same as the input when called with a valid keypair", async () =>
+//         await test("should return a string value that is not null, empty, whitespace or same as the input when called with a valid keypair", async () =>
 //         {
 //             let keyPair = await AsymmetricEncryption.generateKeyPair();
 //             let publicKey = await AsymmetricEncryption.getPublicKey(keyPair);
@@ -44,7 +44,7 @@
 //             Assert.notStrictEqual(keyPair, publicKey);
 //         });
         
-//         test("multiple invocations should return the same value for the same keypair", async () =>
+//         await test("multiple invocations should return the same value for the same keypair", async () =>
 //         {
 //             let keyPair = await AsymmetricEncryption.generateKeyPair();
 //             let publicKey1 = await AsymmetricEncryption.getPublicKey(keyPair);
@@ -52,7 +52,7 @@
 //             Assert.strictEqual(publicKey1, publicKey2);
 //         });
         
-//         test("should return different values for different keypairs", async () =>
+//         await test("should return different values for different keypairs", async () =>
 //         {
 //             let keyPair1 = await AsymmetricEncryption.generateKeyPair();
 //             let publicKey1 = await AsymmetricEncryption.getPublicKey(keyPair1);
@@ -63,7 +63,7 @@
 //             Assert.notStrictEqual(publicKey1, publicKey2);
 //         });
         
-//         // test("get 2 public keys with same key pair", async () =>
+//         // await test("get 2 public keys with same key pair", async () =>
 //         // {
 //         //     let keyPair = await AsymmetricEncryption.generateKeyPair();
 //         //     let publicKey1 = await AsymmetricEncryption.getPublicKey(keyPair);
@@ -75,7 +75,7 @@
 //         //     Assert.strictEqual(publicKey1, publicKey2);
 //         // });
         
-//         // test("throws CryptoException when key pair is null", async () =>
+//         // await test("throws CryptoException when key pair is null", async () =>
 //         // {
 //         //     try
 //         //     {
@@ -90,7 +90,7 @@
 //         //     Assert.ok(false);
 //         // });
         
-//         // test("throws CryptoException when key pair is undefined", async () =>
+//         // await test("throws CryptoException when key pair is undefined", async () =>
 //         // {
 //         //     try
 //         //     {
@@ -105,7 +105,7 @@
 //         //     Assert.ok(false);
 //         // });
         
-//         // test("throws CryptoException when key pair is empty String", async () =>
+//         // await test("throws CryptoException when key pair is empty String", async () =>
 //         // {
 //         //     try
 //         //     {
@@ -121,9 +121,9 @@
 //         // });
 //     });
     
-//     suite("encrypt", () =>
+//     await describe("encrypt", () =>
 //     {
-//         test("should return cipher text when called with a keypair and plain text value", async () =>
+//         await test("should return cipher text when called with a keypair and plain text value", async () =>
 //         {
 //             let keyPair = await AsymmetricEncryption.generateKeyPair();
 //             let value = "password";
@@ -133,7 +133,7 @@
 //             Assert.notStrictEqual(encrypted, keyPair);
 //         });
         
-//         test("should return cipher text when called with a public key and plain text value", async () =>
+//         await test("should return cipher text when called with a public key and plain text value", async () =>
 //         {
 //             let keyPair = await AsymmetricEncryption.generateKeyPair();
 //             let publicKey = await AsymmetricEncryption.getPublicKey(keyPair);
@@ -144,7 +144,7 @@
 //             Assert.notStrictEqual(encrypted, keyPair);
 //         });
         
-//         // test("encrypt a string with public Key", async () =>
+//         // await test("encrypt a string with public Key", async () =>
 //         // {
 //         //     let keyPair = await AsymmetricEncryption.generateKeyPair();
 //         //     let publicKey = await AsymmetricEncryption.getPublicKey(keyPair);
@@ -153,7 +153,7 @@
 //         //     Assert.notStrictEqual(encrypt, "password");
 //         // });
         
-//         // test("encrypt twice using the same key pair", async () =>
+//         // await test("encrypt twice using the same key pair", async () =>
 //         // {
 //         //     let keyPair = await AsymmetricEncryption.generateKeyPair();
 //         //     let encrypt1 = await AsymmetricEncryption.encrypt(keyPair, "password");
@@ -165,7 +165,7 @@
 //         //     Assert.strictEqual(encrypt2, encrypt1);
 //         // });
         
-//         // test("encrypt 2 strings using the same key pair", async () =>
+//         // await test("encrypt 2 strings using the same key pair", async () =>
 //         // {
 //         //     let keyPair = await AsymmetricEncryption.generateKeyPair();
 //         //     let encrypt1 = await AsymmetricEncryption.encrypt(keyPair, "hello world");
@@ -177,7 +177,7 @@
 //         //     Assert.notStrictEqual(encrypt2, encrypt1);
 //         // });
         
-//         // test("throws CryptoException when key pair is null", async () =>
+//         // await test("throws CryptoException when key pair is null", async () =>
 //         // {
 //         //     try
 //         //     {
@@ -192,7 +192,7 @@
 //         //     Assert.ok(false);
 //         // });
         
-//         // test("throws CryptoException when key pair is undefined", async () =>
+//         // await test("throws CryptoException when key pair is undefined", async () =>
 //         // {
 //         //     try
 //         //     {
@@ -207,7 +207,7 @@
 //         //     Assert.ok(false);
 //         // });
         
-//         // test("throws CryptoException when key pair is empty string", async () =>
+//         // await test("throws CryptoException when key pair is empty string", async () =>
 //         // {
 //         //     try
 //         //     {
@@ -222,7 +222,7 @@
 //         //     Assert.ok(false);
 //         // });
         
-//         // test("throws CryptoException when key pair is empty string", async () =>
+//         // await test("throws CryptoException when key pair is empty string", async () =>
 //         // {
 //         //     try
 //         //     {
@@ -238,7 +238,7 @@
 //         //     Assert.ok(false);
 //         // });
         
-//         // test("throws CryptoException when key pair and value are empty strings", async () =>
+//         // await test("throws CryptoException when key pair and value are empty strings", async () =>
 //         // {
 //         //     try
 //         //     {
@@ -253,7 +253,7 @@
 //         //     Assert.ok(false);
 //         // });
         
-//         // test("encrypt using public key and key pair", async () =>
+//         // await test("encrypt using public key and key pair", async () =>
 //         // {
 //         //     let keyPair = await AsymmetricEncryption.generateKeyPair();
 //         //     let encrypt1 = await AsymmetricEncryption.encrypt(keyPair, "hello world");
@@ -267,9 +267,9 @@
 //         // });
 //     });
     
-//     suite("decrypt", () =>
+//     await describe("decrypt", () =>
 //     {
-//         test("should return plain text when called with key pair and cipher text encrypted with key pair", async () =>
+//         await test("should return plain text when called with key pair and cipher text encrypted with key pair", async () =>
 //         {
 //             let keyPair = await AsymmetricEncryption.generateKeyPair();
 //             let value = "password";
@@ -278,7 +278,7 @@
 //             Assert.strictEqual(decrypted, value);
 //         });
         
-//         test("should return plain text when called with key pair and cipher text encrypted with public key of key pair", async () =>
+//         await test("should return plain text when called with key pair and cipher text encrypted with public key of key pair", async () =>
 //         {
 //             let keyPair = await AsymmetricEncryption.generateKeyPair();
 //             let publicKey = await AsymmetricEncryption.getPublicKey(keyPair);
@@ -290,7 +290,7 @@
         
         
         
-//         // test("decrypt using public key when encrypted by key pair", async () =>
+//         // await test("decrypt using public key when encrypted by key pair", async () =>
 //         // {
 //         //     let keyPair = await AsymmetricEncryption.generateKeyPair();
 //         //     let publicKey = await AsymmetricEncryption.getPublicKey(keyPair);
@@ -300,7 +300,7 @@
 //         //     Assert.strictEqual(decrypt, "password");
 //         // });
         
-//         // test("decrypt using key pair when encrypted by public key", async () =>
+//         // await test("decrypt using key pair when encrypted by public key", async () =>
 //         // {
 //         //     let keyPair = await AsymmetricEncryption.generateKeyPair();
 //         //     let publicKey = await AsymmetricEncryption.getPublicKey(keyPair);
@@ -310,7 +310,7 @@
 //         //     Assert.strictEqual(decrypt, "password");
 //         // });
         
-//         // test("decrypt using key pair when encrypted by key pair", async () =>
+//         // await test("decrypt using key pair when encrypted by key pair", async () =>
 //         // {
 //         //     let keyPair = await AsymmetricEncryption.generateKeyPair();
 //         //     let encrypt = await AsymmetricEncryption.encrypt(keyPair, "password");
@@ -318,7 +318,7 @@
 //         //     Assert.notStrictEqual(decrypt, "password");
 //         // });
         
-//         // test("decrypt using public key when encrypted by public key", async () =>
+//         // await test("decrypt using public key when encrypted by public key", async () =>
 //         // {
 //         //     let keyPair = await AsymmetricEncryption.generateKeyPair();
 //         //     let publicKey = await AsymmetricEncryption.getPublicKey(keyPair);
@@ -327,7 +327,7 @@
 //         //     Assert.notStrictEqual(decrypt, "password");
 //         // });
         
-//         // test("throws CryptoException when key is null", async () =>
+//         // await test("throws CryptoException when key is null", async () =>
 //         // {
 //         //     let keyPair = await AsymmetricEncryption.generateKeyPair();
 //         //     let encrypt = await AsymmetricEncryption.encrypt(keyPair, "password");
@@ -344,7 +344,7 @@
 //         //     Assert.ok(false);
 //         // });
         
-//         // test("throws CryptoException when key is undefined", async () =>
+//         // await test("throws CryptoException when key is undefined", async () =>
 //         // {
 //         //     let keyPair = await AsymmetricEncryption.generateKeyPair();
 //         //     let encrypt = await AsymmetricEncryption.encrypt(keyPair, "password");
@@ -361,7 +361,7 @@
 //         //     Assert.ok(false);
 //         // });
         
-//         // test("throws CryptoException when value is null", async () =>
+//         // await test("throws CryptoException when value is null", async () =>
 //         // {
 //         //     let keyPair = await AsymmetricEncryption.generateKeyPair();
 //         //     let publicKey = await AsymmetricEncryption.getPublicKey(keyPair);
@@ -378,7 +378,7 @@
 //         //     Assert.ok(false);
 //         // });
 
-//         // test("throws CryptoException when value is undefined", async () =>
+//         // await test("throws CryptoException when value is undefined", async () =>
 //         // {
 //         //     let keyPair = await AsymmetricEncryption.generateKeyPair();
 //         //     let publicKey = await AsymmetricEncryption.getPublicKey(keyPair);
@@ -395,7 +395,7 @@
 //         //     Assert.ok(false);
 //         // });
         
-//         // test("throws CryptoException when key and value is null", async () =>
+//         // await test("throws CryptoException when key and value is null", async () =>
 //         // {
 //         //     try
 //         //     {