cas-typescript-sdk 1.0.22 → 1.0.23

package/src-ts/key_exchange/x25519.ts

@@ -1,11 +1,23 @@
 import { x25519DiffieHellman, x25519GenerateSecretAndPublicKey, X25519SecretPublicKeyResult } from "../../index"
 
 export class X25519Wrapper {
+    /**
+     * Generates and secret and public key to be used to create a shared secret with Diffie Hellman.
+     * User should share their public key with the other user and take the other user's public key and they can generate a Shared Secret.
+     * @returns X25519SecretPublicKeyResult
+     */
     public generateSecretAndPublicKey(): X25519SecretPublicKeyResult {
         return x25519GenerateSecretAndPublicKey();
     }
 
-    public generateSharedSecret(secretKey: Array<number>, publicKey: Array<number>) {
+    /**
+     * User takes their secret key and the other user's public key to generate a shared secret.
+     * Can be used to derive an AES key over insecure channel.
+     * @param secretKey 
+     * @param publicKey 
+     * @returns Array<number>
+     */
+    public generateSharedSecret(secretKey: Array<number>, publicKey: Array<number>): Array<number> {
         return x25519DiffieHellman(secretKey, publicKey);
     }
 }

package/src-ts/password-hashers/argon2-wrapper.ts

@@ -3,6 +3,12 @@ import { IPasswordHasherBase } from "./password-hasher-base";
 
 export class Argon2Wrapper implements IPasswordHasherBase {
 
+  /**
+   * Verifies a password with Argon2 on the threadpool.
+   * @param hashedPassword 
+   * @param passwordToCheck 
+   * @returns boolean
+   */
   verifyThreadPool(hashedPassword: string, passwordToCheck: string): boolean {
     if (!hashedPassword) {
       throw new Error("You must provide a password to verify with Argon2");
@@ -13,6 +19,11 @@ export class Argon2Wrapper implements IPasswordHasherBase {
     return argon2VerifyThreadpool(hashedPassword, passwordToCheck);
   }
 
+  /**
+   * Hashes a password with Argon2 on the threadpool.
+   * @param password 
+   * @returns string
+   */
   public hashPasswordThreadPool(password: string): string {
     if (!password) {
       throw new Error("You must provide a password to hash with Argon2");
@@ -20,6 +31,11 @@ export class Argon2Wrapper implements IPasswordHasherBase {
     return argon2HashThreadPool(password);
   }
 
+  /**
+   * Hashes a password with Argon2
+   * @param password 
+   * @returns string
+   */
   public hashPassword(password: string): string {
     if (!password) {
       throw new Error("You must provide a password to hash with Argon2");
@@ -27,6 +43,12 @@ export class Argon2Wrapper implements IPasswordHasherBase {
     return argon2Hash(password);
   }
 
+  /**
+   * Verifies that a password is the same as the hashed password with Argon2.
+   * @param hashedPassword 
+   * @param passwordToVerify 
+   * @returns boolean
+   */
   public verify(hashedPassword: string, passwordToVerify: string): boolean {
     if (!hashedPassword || !passwordToVerify) {
       throw new Error(

package/src-ts/password-hashers/bcrypt-wrapper.ts

@@ -3,6 +3,12 @@ import { bcryptHash, bcryptHashThreadpool, bcryptVerify, bcryptVerifyThreadpool
 
 export class BCryptWrapper implements IPasswordHasherBase {
 
+  /**
+   * Verifies a password with BCrypt on the threadpool.
+   * @param hashedPassword 
+   * @param passwordToCheck 
+   * @returns boolean
+   */
   verifyThreadPool(hashedPassword: string, passwordToCheck: string): boolean {
     if (!hashedPassword || !passwordToCheck) {
       throw new Error(
@@ -12,6 +18,11 @@ export class BCryptWrapper implements IPasswordHasherBase {
     return bcryptVerifyThreadpool(hashedPassword, passwordToCheck);
   }
 
+  /**
+   * Hashes a password with BCrypt on the threadpool.
+   * @param password 
+   * @returns string
+   */
   public hashPasswordThreadPool(password: string): string {
     if (!password) {
       throw new Error("You must provide a password to hash with Argon2");
@@ -19,6 +30,11 @@ export class BCryptWrapper implements IPasswordHasherBase {
     return bcryptHashThreadpool(password);
   }
 
+  /**
+   * Hashes a password with BCrypt
+   * @param password 
+   * @returns string
+   */
   public hashPassword(password: string): string {
     if (!password) {
       throw new Error("You must provide a password to hash with Argon2");
@@ -26,6 +42,12 @@ export class BCryptWrapper implements IPasswordHasherBase {
     return bcryptHash(password);
   }
 
+  /**
+   * Verifies that a password is the same as the hashed password with BCrypt.
+   * @param hashedPassword 
+   * @param passwordToVerify 
+   * @returns boolean
+   */
   public verify(
     hashedPassword: string,
     passwordToVerify: string,

package/src-ts/password-hashers/password-hasher-factory.ts

@@ -4,6 +4,11 @@ import { PasswordHasherType } from "./password-hasher-type";
 import { ScryptWrapper } from "./scrypt-wrapper";
 
 export class PasswordHasherFactory {
+  /**
+   * Returns the appropriate hasher type based upon the type passed in.
+   * @param type 
+   * @returns 
+   */
   static getHasher(type: PasswordHasherType): any {
     // Argon2 by default
     let hasher = new Argon2Wrapper();

package/src-ts/password-hashers/scrypt-wrapper.ts

@@ -3,6 +3,12 @@ import { IPasswordHasherBase } from "./password-hasher-base";
 
 export class ScryptWrapper implements IPasswordHasherBase {
 
+  /**
+   * Verifies a password with SCrypt on the threadpool.
+   * @param hashedPassword 
+   * @param passwordToCheck 
+   * @returns boolean
+   */
   verifyThreadPool(hashedPassword: string, passwordToCheck: string): boolean {
     if (!hashedPassword || !passwordToCheck) {
       throw new Error(
@@ -12,6 +18,11 @@ export class ScryptWrapper implements IPasswordHasherBase {
     return scryptVerifyThreadpool(hashedPassword, passwordToCheck);
   }
 
+  /**
+   * Hashes a password with SCrypt on the threadpool.
+   * @param password 
+   * @returns string
+   */
   hashPasswordThreadPool(password: string): string {
     if (!password) {
       throw new Error("You must provide a password to hash with Scrypt");
@@ -19,6 +30,11 @@ export class ScryptWrapper implements IPasswordHasherBase {
     return scryptHashThreadpool(password);
   }
 
+  /**
+   * Hashes a password with SCrypt
+   * @param password 
+   * @returns string
+   */
   public hashPassword(password: string): string {
     if (!password) {
       throw new Error("You must provide a password to hash with Scrypt");
@@ -26,6 +42,12 @@ export class ScryptWrapper implements IPasswordHasherBase {
     return scryptHash(password);
   }
 
+  /**
+   * Verifies that a password is the same as the hashed password with SCrypt.
+   * @param hashedPassword 
+   * @param passwordToVerify 
+   * @returns boolean
+   */
   public verify(hashedPassword: string, passwordToVerify: string): boolean {
     if (!hashedPassword || !passwordToVerify) {
       throw new Error(

package/src-ts/sponges/ascon-wrapper.ts

@@ -6,14 +6,29 @@ import {
 } from "../../index";
 
 export class AsconWrapper {
+  /**
+   * Generates an Ascon 128 key
+   * @returns Array<number>
+   */
   ascon128Key(): Array<number> {
     return ascon128KeyGenerate();
   }
 
+  /**
+   * Generates and Ascon 128 nonce.
+   * @returns Array<number>
+   */
   ascon128Nonce(): Array<number> {
     return ascon128NonceGenerate();
   }
 
+  /**
+   * Encrypts with Ascon 128 using the key and nonce generated from ascon128Key() and ascon128Nonce() respectively.
+   * @param key 
+   * @param nonce 
+   * @param plaintext 
+   * @returns 
+   */
   ascon128Encrypt(
     key: Array<number>,
     nonce: Array<number>,
@@ -31,6 +46,13 @@ export class AsconWrapper {
     return ascon128Encrypt(key, nonce, plaintext);
   }
 
+   /**
+   * Decrypts with Ascon 128 using the key and nonce generated from ascon128Key() and ascon128Nonce() respectively.
+   * @param key 
+   * @param nonce 
+   * @param ciphertext 
+   * @returns Array<number>
+   */
   ascon128Decrypt(
     key: Array<number>,
     nonce: Array<number>,

package/src-ts/symmetric/aes-wrapper.ts

@@ -11,18 +11,7 @@ import {
   aesNonce,
 } from "../../index";
 
-/**
- * @description A wrapper class that contains methods to construct keys, nonces, and methods to encrypt and decrypt with AES-128-GCM and AES-256-GCM
- * 
- * @example
- * ```ts
- * const nonce = aesWrapper.generateAESNonce();
-const key = aesWrapper.aes128Key();
-const textEncoder = new TextEncoder();
-const array = Array.from(textEncoder.encode("Hello World"));
-const encrypted = aesWrapper.aes128Encrypt(key, nonce, array);
- * ```
- */
+
 export class AESWrapper {
 
     /**
@@ -41,30 +30,72 @@ export class AESWrapper {
         return aes256Key();
     }
 
+    /**
+     * Generates an 96 bit AES nonce
+     * @returns Array<number>
+     */
     public generateAESNonce(): Array<number> {
         return aesNonce();
     }
 
+    /**
+     * Encrypts with AES 128.
+     * @param aesKey 
+     * @param nonce 
+     * @param plaintext 
+     * @returns Array<number>
+     */
     public aes128Encrypt(aesKey: Array<number>, nonce: Array<number>, plaintext: Array<number>): Array<number> {
         return aes128Encrypt(aesKey, nonce, plaintext);
     }
 
+    /**
+     * Decrypts with AES 128
+     * @param aesKey 
+     * @param nonce 
+     * @param ciphertext 
+     * @returns Array<number>
+     */
     public aes128Decrypt(aesKey: Array<number>, nonce: Array<number>, ciphertext: Array<number>): Array<number> {
         return aes128Decrypt(aesKey, nonce, ciphertext);
     }
 
+    /**
+     * Encrypts with AES-256
+     * @param aesKey 
+     * @param nonce 
+     * @param plaintext 
+     * @returns 
+     */
     public aes256Encrypt(aesKey: Array<number>, nonce: Array<number>, plaintext: Array<number>): Array<number> {
         return aes256Encrypt(aesKey, nonce, plaintext);
     }
 
+    /**
+     * Decrypts with AES 256
+     * @param aesKey 
+     * @param nonce 
+     * @param ciphertext 
+     * @returns 
+     */
     public aes256Decrypt(aesKey: Array<number>, nonce: Array<number>, ciphertext: Array<number>): Array<number> {
         return aes256Decrypt(aesKey, nonce, ciphertext);
     }
 
+    /**
+     * Derives an AES-256 key from a X25519 Diffie Hellman shared secret.
+     * @param shared_secret 
+     * @returns 
+     */
     public aes256KeyNonceX25519DiffieHellman(shared_secret: Array<number>): AesKeyFromX25519SharedSecret {
          return aes256KeyFromX25519SharedSecret(shared_secret);
     }
 
+    /**
+     * Derives an AES-128 key from a X25519 Diffie Hellman shared secret.
+     * @param shared_secret 
+     * @returns 
+     */
     public aes128KeyNonceX25519DiffieHellman(shared_secret: Array<number>): AesKeyFromX25519SharedSecret {
         return aes128KeyFromX25519SharedSecret(shared_secret);
    }

package/lib/helpers/nonce-generator.d.ts

@@ -1,3 +0,0 @@
-export declare class NonceGenerator {
-    generateNonce(): string;
-}

package/lib/helpers/nonce-generator.js

@@ -1,34 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.NonceGenerator = void 0;
-const crypto = __importStar(require("crypto"));
-class NonceGenerator {
-    generateNonce() {
-        const nonceBytes = crypto.randomBytes(12);
-        return nonceBytes.toString('hex').substring(0, 12);
-    }
-}
-exports.NonceGenerator = NonceGenerator;

package/src-ts/helpers/nonce-generator.ts

@@ -1,9 +0,0 @@
-import * as crypto from "crypto";
-
-export class NonceGenerator {
-
-    public generateNonce(): string {
-        const nonceBytes = crypto.randomBytes(12);
-        return nonceBytes.toString('hex').substring(0, 12);
-    }
-}