Merge pull request #36 from Cryptographic-API-Services/#29-implement-hmac

#29 implement hmac

Author: WingZer0o

README.md

@@ -12,7 +12,7 @@ The official NPM page can be found [here](https://www.npmjs.com/package/cas-type
 
 
 ## Consuming Library Documentation
-This Node.js NPM module is dependent on our Rust layer [here](./src) that contains methods to run industry-standard cryptographic operations sequentially, on threads, and the thread pool.
+This Node.js NPM module is dependent on our Rust layer [cas-lib](https://github.com/Cryptographic-API-Services/cas-lib). that contains methods to run industry-standard cryptographic operations sequentially, on threads, and the thread pool.
 
 We utilize some smart people's existing work and we believe their documentation should be reviewed when possible.
 - [Spin Research](https://github.com/SpinResearch)

index.d.ts

@@ -47,6 +47,10 @@ export function ascon128KeyGenerate(): Array<number>
 export function ascon128NonceGenerate(): Array<number>
 export function ascon128Encrypt(key: Array<number>, nonce: Array<number>, plaintext: Array<number>): Array<number>
 export function ascon128Decrypt(key: Array<number>, nonce: Array<number>, ciphertext: Array<number>): Array<number>
+export function hmacSign(key: Array<number>, message: Array<number>): Array<number>
+export function hmacSignThreadpool(key: Array<number>, message: Array<number>): Array<number>
+export function hmacVerify(key: Array<number>, message: Array<number>, signature: Array<number>): boolean
+export function hmacVerifyThreadpool(key: Array<number>, message: Array<number>, signature: Array<number>): boolean
 export type CASx25519SecretPublicKeyResult = CaSx25519SecretPublicKeyResult
 export class CaSx25519SecretPublicKeyResult {
   publicKey: Array<number>

index.node

@@ -1,7 +1,7 @@
 
 {
   "name": "cas-typescript-sdk",
-  "version": "1.0.25",
+  "version": "1.0.26",
   "description": "",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

package.json

@@ -5,4 +5,5 @@ export * from "./symmetric/index";
 export * from "./asymmetric/index";
 export * from "./hybrid/index";
 export * from "./digital-signature";
-export * from "./sponges/index";
+export * from "./sponges/index";
+export * from "./message/index";

src-ts/index.ts

@@ -0,0 +1,49 @@
+import { hmacSign, hmacSignThreadpool, hmacVerify, hmacVerifyThreadpool } from "../../index";
+
+export class HmacWrapper {
+    public hmacSignBytes(key: Array<number>, message: Array<number>): Array<number> {
+        if (key?.length === 0) {
+            throw new Error("Must provide an allocated key");
+        }
+        if (message?.length === 0) {
+            throw new Error("Must provide an allocated message");
+        }
+        return hmacSign(key, message);
+    }
+    
+    public hmacVerifyBytes(key: Array<number>, message: Array<number>, signature: Array<number>): boolean {
+        if (key?.length === 0) {
+            throw new Error("Must provide an allocated key");
+        }
+        if (message?.length === 0) {
+            throw new Error("Must provide an allocated message");
+        }
+        if(signature?.length===0) {
+            throw new Error("Must provide an allocated signature");
+        }
+        return hmacVerify(key, message, signature);
+    }
+
+    public hmacSignBytesThreadpool(key: Array<number>, message: Array<number>): Array<number> {
+        if (key?.length === 0) {
+            throw new Error("Must provide an allocated key");
+        }
+        if (message?.length === 0) {
+            throw new Error("Must provide an allocated message");
+        }
+        return hmacSignThreadpool(key, message);
+    }
+    
+    public hmacVerifyBytesThreadpool(key: Array<number>, message: Array<number>, signature: Array<number>): boolean {
+        if (key?.length === 0) {
+            throw new Error("Must provide an allocated key");
+        }
+        if (message?.length === 0) {
+            throw new Error("Must provide an allocated message");
+        }
+        if(signature?.length===0) {
+            throw new Error("Must provide an allocated signature");
+        }
+        return hmacVerifyThreadpool(key, message, signature);
+    }
+}

src-ts/message/hmac.ts

@@ -0,0 +1,3 @@
+import { HmacWrapper } from "./hmac";
+
+export { HmacWrapper };

src-ts/message/index.ts

@@ -32,4 +32,8 @@ mod digital_signature {
 
 mod sponges {
     pub mod ascon_aead;
+}
+
+mod message {
+    pub mod hmac;
 }

src/lib.rs

@@ -0,0 +1,40 @@
+use cas_lib::message::{cas_hmac::CASHMAC, hmac::HMAC};
+use napi_derive::napi;
+
+#[napi]
+pub fn hmac_sign(key: Vec<u8>, message: Vec<u8>) -> Vec<u8> {
+    return <HMAC as CASHMAC>::sign(key, message);
+}
+
+#[napi]
+pub fn hmac_sign_threadpool(key: Vec<u8>, message: Vec<u8>) -> Vec<u8> {
+    return <HMAC as CASHMAC>::sign_threadpool(key, message);
+}
+
+#[napi]
+pub fn hmac_verify(key: Vec<u8>, message: Vec<u8>, signature: Vec<u8>) -> bool {
+    return <HMAC as CASHMAC>::verify(key, message, signature);
+}
+
+#[napi]
+pub fn hmac_verify_threadpool(key: Vec<u8>, message: Vec<u8>, signature: Vec<u8>) -> bool {
+    return <HMAC as CASHMAC>::verify_threadpool(key, message, signature);
+}
+
+#[test]
+fn hmac_sign_and_verify_test() {
+    let mut key = b"ThisIsMyKeyForHmac".to_vec();
+    let mut message = b"ThisIsMyMessageToSign".to_vec();
+    let signature = hmac_sign(key.clone(), message.clone());
+    let result = hmac_verify(key, message, signature);
+    assert_eq!(true, result);
+}
+
+#[test]
+fn hmac_sign_and_verify_threadpool_test() {
+    let mut key = b"ThisIsMyKeyForHmac7789".to_vec();
+    let mut message = b"ThisIsMyMessageToSign1230".to_vec();
+    let signature = hmac_sign_threadpool(key.clone(), message.clone());
+    let result = hmac_verify_threadpool(key, message, signature);
+    assert_eq!(true, result);
+}

src/message/hmac.rs

@@ -0,0 +1,32 @@
+import { assert } from "chai";
+import { HmacWrapper } from "../src-ts/message/index";
+
+describe("HMAC Tests", () => {
+  it("Sign and Verify", () => {
+    const wrapper = new HmacWrapper();
+    const key: string = "This is my array to hash";
+    const encoder = new TextEncoder();
+    const keyBytes: Array<number> = Array.from(encoder.encode(key));
+    const message: string = "This is my message";
+    const messageBytes = Array.from(encoder.encode(message));
+    const signature = wrapper.hmacSignBytes(keyBytes, messageBytes);
+    const result = wrapper.hmacVerifyBytes(keyBytes, messageBytes, signature);
+    assert.equal(true, result);
+  });
+
+  it("Sign and Verify Threadpool", () => {
+    const wrapper = new HmacWrapper();
+    const key: string = "This is my array to hash";
+    const encoder = new TextEncoder();
+    const keyBytes: Array<number> = Array.from(encoder.encode(key));
+    const message: string = "This is my message";
+    const messageBytes = Array.from(encoder.encode(message));
+    const signature = wrapper.hmacSignBytesThreadpool(keyBytes, messageBytes);
+    const result = wrapper.hmacVerifyBytesThreadpool(
+      keyBytes,
+      messageBytes,
+      signature,
+    );
+    assert.equal(true, result);
+  });
+});