@oino-ts/hashid 0.0.18 → 0.1.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oino-ts/hashid",
-  "version": "0.0.18",
+  "version": "0.1.1",
   "description": "OINO TS package for hashid's.",
   "author": "Matias Kiviniemi (pragmatta)",
   "license": "MPL-2.0",
@@ -18,10 +18,11 @@
   "types": "./dist/types/index.d.ts",
   "dependencies": {
     "@types/node": "^20.12.7",
-    "@oino-ts/types": "^0.0.18",
+    "@oino-ts/common": "0.1.1",
     "base-x": "5.0.0"
   },
   "devDependencies": {
+    "@oino-ts/types": "0.1.1"
   },
   "files": [
     "src/*.ts",

package/src/OINOHashid.ts

@@ -4,7 +4,7 @@
  * file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
 
-import { createCipheriv, createDecipheriv, createHmac, randomFillSync } from 'node:crypto';
+import { BinaryLike, createCipheriv, createDecipheriv, createHmac, randomFillSync } from 'node:crypto';
 import basex from 'base-x'
 
 const HASHID_MIN_LENGTH:number = 12
@@ -63,27 +63,27 @@ export class OINOHashid {
         // if seed was given use it for pseudorandom chars, otherwise generate them
         let random_chars:string = ""
         if (this._staticIds) {
-            const hmac_seed = createHmac('sha1', this._key)
+            const hmac_seed = createHmac('sha1', this._key as BinaryLike)
             hmac_seed.update(this._domainId + " " + cellSeed)
-            random_chars = hashidEncoder.encode(hmac_seed.digest()) // hmac_seed.digest('base64url')
+            random_chars = hashidEncoder.encode(hmac_seed.digest() as Uint8Array) // hmac_seed.digest('base64url')
             
         } else {
-            randomFillSync(this._iv, 0, 16)
-            random_chars = hashidEncoder.encode(this._iv) // this._iv.toString('base64url')
+            randomFillSync(this._iv as Uint8Array, 0, 16)
+            random_chars = hashidEncoder.encode(this._iv as Uint8Array) // this._iv.toString('base64url')
         }
-        const hmac = createHmac('sha1', this._key)
+        const hmac = createHmac('sha1', this._key as Uint8Array)
         let iv_seed:string = random_chars.substring(0, this._minLength)
         hmac.update(this._domainId + " " + iv_seed)
         const iv_data:Buffer = hmac.digest()
-        iv_data.copy(this._iv, 0, 0, 16) 
+        iv_data.copy(this._iv as Uint8Array, 0, 0, 16) 
 
         let plaintext = id.toString()
         if (plaintext.length < this._minLength) {
             plaintext += " " + random_chars.substring(random_chars.length - (this._minLength - plaintext.length - 1))
         }
 
-        const cipher = createCipheriv('aes-128-gcm', this._key, this._iv)
-        const cryptotext = hashidEncoder.encode(cipher.update(plaintext, 'utf8')) + hashidEncoder.encode(cipher.final())
+        const cipher = createCipheriv('aes-128-gcm', this._key as Uint8Array, this._iv as Uint8Array)
+        const cryptotext = hashidEncoder.encode(cipher.update(plaintext, 'utf8') as Uint8Array) + hashidEncoder.encode(cipher.final() as Uint8Array)
         return iv_seed + cryptotext
     }
 
@@ -95,16 +95,16 @@ export class OINOHashid {
      */
     decode(hashid:string):string {
         // reproduce nonce from seed
-        const hmac = createHmac('sha1', this._key)
+        const hmac = createHmac('sha1', this._key as Uint8Array)
         const iv_seed = hashid.substring(0, this._minLength)
         hmac.update(this._domainId + " " + iv_seed)
         const hash:Buffer = hmac.digest()
-        hash.copy(this._iv, 0, 0, 16)
+        hash.copy(this._iv as Uint8Array, 0, 0, 16)
 
         const cryptotext:string = hashid.substring(this._minLength)
         const cryptobytes:Buffer = Buffer.from(hashidEncoder.decode(cryptotext))
-        const decipher = createDecipheriv('aes-128-gcm', this._key, this._iv)
-        const plaintext = decipher.update(cryptobytes, undefined, 'utf8') //, cryptotext, 'base64url', 'utf8') 
+        const decipher = createDecipheriv('aes-128-gcm', this._key as Uint8Array, this._iv as Uint8Array)
+        const plaintext = decipher.update(cryptobytes as Uint8Array, undefined, 'utf8') //, cryptotext, 'base64url', 'utf8') 
         
         return plaintext.split(" ")[0]
     }

package/dist/types/OINOHashid.d.ts

@@ -1,40 +0,0 @@
-/**
- * Hashid implementation for OINO API:s for the purpose of making it infeasible to scan
- * through numeric autoinc keys. It's not a solution to keeping the id secret in insecure
- * channels, just making it hard enough to not iterate through the entire key space. Half
- * of the the hashid length is nonce and half cryptotext, i.e. 16 char hashid 8 chars of
- * base64 encoded nonce ~ 6 bytes or 48 bits of entropy.
- *
- */
-export declare class OINOHashid {
-    private _key;
-    private _iv;
-    private _domainId;
-    private _minLength;
-    private _staticIds;
-    /**
-     * Hashid constructor
-     *
-     * @param key AES128 key (32 char hex-string)
-     * @param domainId a sufficiently unique domain ID in which row-Id's are unique
-     * @param minLength minimum length of nonce and crypto
-     * @param staticIds whether hash values should remain static per row or random values
-     *
-     */
-    constructor(key: string, domainId: string, minLength?: number, staticIds?: boolean);
-    /**
-     * Encode given id value as a hashid either using random data or given seed value for nonce.
-     *
-     * @param id numeric value
-     * @param cellSeed a sufficiently unique seed for the current cell to keep hashids unique but persistent (e.g. fieldname + primarykey values)
-     *
-     */
-    encode(id: string, cellSeed?: string): string;
-    /**
-     * Decode given hashid.
-     *
-     * @param hashid value
-     *
-     */
-    decode(hashid: string): string;
-}

package/dist/types/index.d.ts

@@ -1 +0,0 @@
-export { OINOHashid } from "./OINOHashid.js";