iosignal 4.0.0 → 4.6.0

package/dist/types/client/IOCore.d.ts

@@ -159,7 +159,7 @@ export class IOCore extends EventEmitter<string | symbol, any> {
     /**
      * Disables auto-reconnect and closes the current connection.
      * The instance can be re-opened manually later. For complete cleanup, use destroy().
-     */
+    */
     stop(): void;
     /**
      * Permanently destroys the instance, cleaning up all resources.
@@ -167,8 +167,9 @@ export class IOCore extends EventEmitter<string | symbol, any> {
      */
     destroy(): void;
     /**
-     * The core keep-alive logic. It checks if auto-reconnect is enabled.
-     * The actual check for the socket's state is implemented in the child classes.
+     * The core keep-alive logic.
+     * The specific logic for checking the socket's state and reconnecting
+     * is implemented keepConnection() in the child classes (IOWS, IOCongSocket, etc.).
      */
     keepAlive(): void;
     /**
@@ -191,18 +192,18 @@ export class IOCore extends EventEmitter<string | symbol, any> {
     onClose(): void;
     /**
      * Manually logs in with provided ID and key.
-     * @param {string} id - The user ID.
+     * @param {string} id - The user ID. or 'id.key'
      * @param {string} key - The user key.
-     * @returns {boolean}
+     * @returns {this}
      */
-    login(id: string, key: string): boolean;
+    login(id: string, key: string): this;
     /**
      * Sets up authentication for auto-login.
-     * @param {string} id - The user ID.
+     * @param {string} id - The user ID. or 'id.Key'
      * @param {string} key - The user key.
-     * @returns {boolean}
+     * @returns {this}
      */
-    auth(id: string, key: string): boolean;
+    auth(id: string, key: string): this;
     /**
      * Handles incoming data from the WebSocket.
      * @param {Buffer} buffer - The incoming data buffer.
@@ -261,10 +262,12 @@ export class IOCore extends EventEmitter<string | symbol, any> {
      */
     testPromise(buffer: Buffer): void;
     /**
-     * Publishes a signal.
+     * alias of signal()
+     * Sends a signal with a tag and arguments.
+     * @param {string} tag - The signal tag.
      * @param {...any} args - Arguments for the signal.
      */
-    publish(...args: any[]): void;
+    publish(tag: string, ...args: any[]): void;
     /**
      * Sends a signal with a tag and arguments.
      * @param {string} tag - The signal tag.
@@ -408,7 +411,7 @@ export type IOMsg = import("../common/constants.js").IOMsg;
 export type PAYLOAD_TYPE = import("../common/constants.js").PAYLOAD_TYPE;
 export type SIZE_LIMIT = import("../common/constants.js").SIZE_LIMIT;
 export type ENC_MODE = import("../common/constants.js").ENC_MODE;
-export type STATES = import("../common/constants.js").STATES;
+export type STATE = import("../common/constants.js").STATE;
 export type quotaTable = any;
 export type Boho = import("boho").Boho;
 export type Buffer = import("boho").Buffer;

package/dist/types/client/browser/IOWebSocket.d.ts

@@ -48,6 +48,10 @@ export default class IO extends IOCore {
      * Pings the server when the browser tab becomes visible.
      */
     browserVisiblePing(): void;
+    /**
+     * Keeps the connection alive by re-connecting if closed.
+     */
+    keepConnection(): void;
     /**
      * Creates a new WebSocket connection.
      * @param {string} url - The WebSocket URL to connect to.

package/dist/types/common/constants.d.ts

@@ -1,47 +1,34 @@
-export type STATES = {
-    OPENING: number;
+export type STATE = {
+    CONNECTING: number;
     OPEN: number;
-    CLOSING: number;
-    CLOSED: number;
     SERVER_READY: number;
-    AUTH_FAIL: number;
-    AUTH_READY: number;
+    AUTH_ACK: number;
+    CLOSING: number;
     READY: number;
+    AUTH_FAIL: number;
+    AUTH_CLEAR: number;
+    CLOSED: number;
+    STOP: number;
     REDIRECTING: number;
 };
-export namespace STATES {
-    let OPENING: number;
+export namespace STATE {
+    let CONNECTING: number;
     let OPEN: number;
-    let CLOSING: number;
-    let CLOSED: number;
     let SERVER_READY: number;
+    let AUTH_REQ: number;
+    let AUTH_NONCE: number;
+    let AUTH_HMAC: number;
+    let AUTH_ACK: number;
     let AUTH_FAIL: number;
-    let AUTH_READY: number;
+    let AUTH_CLEAR: number;
+    let CID_REQ: number;
+    let CID_RES: number;
     let READY: number;
+    let CLOSING: number;
+    let CLOSED: number;
+    let STOP: number;
     let REDIRECTING: number;
 }
-export type CLIENT_STATE = {
-    INIT: number;
-    SENT_SERVER_READY: number;
-    RECV_AUTH_REQ: number;
-    SENT_SERVER_NONCE: number;
-    RECV_AUTH_HMAC: number;
-    AUTH_FAIL: number;
-    AUTH_READY: number;
-    CID_READY: number;
-};
-export namespace CLIENT_STATE {
-    export let INIT: number;
-    export let SENT_SERVER_READY: number;
-    export let RECV_AUTH_REQ: number;
-    export let SENT_SERVER_NONCE: number;
-    export let RECV_AUTH_HMAC: number;
-    let AUTH_FAIL_1: number;
-    export { AUTH_FAIL_1 as AUTH_FAIL };
-    let AUTH_READY_1: number;
-    export { AUTH_READY_1 as AUTH_READY };
-    export let CID_READY: number;
-}
 export type ENC_MODE = {
     NO: number;
     YES: number;
@@ -56,6 +43,7 @@ export type SIZE_LIMIT = {
     TAG_LEN1: number;
     TAG_LEN2: number;
     CONNECTION_CHECKER_PERIOD: number;
+    CLIENT_PING_PERIOD: number;
     PROMISE_TIMEOUT: number;
     DID: number;
     CID: number;
@@ -64,6 +52,7 @@ export namespace SIZE_LIMIT {
     let TAG_LEN1: number;
     let TAG_LEN2: number;
     let CONNECTION_CHECKER_PERIOD: number;
+    let CLIENT_PING_PERIOD: number;
     let PROMISE_TIMEOUT: number;
     let DID: number;
     let CID: number;
@@ -89,7 +78,7 @@ export type IOMsg = {
     CID_REQ: number;
     CID_RES: number;
     QUOTA_LEVEL: number;
-    SERVER_CLEAR_AUTH: number;
+    AUTH_CLEAR: number;
     SERVER_REDIRECT: number;
     LOOP: number;
     ECHO: number;
@@ -120,10 +109,13 @@ export type IOMsg = {
 export namespace IOMsg {
     let SERVER_READY_1: number;
     export { SERVER_READY_1 as SERVER_READY };
-    export let CID_REQ: number;
-    export let CID_RES: number;
+    let CID_REQ_1: number;
+    export { CID_REQ_1 as CID_REQ };
+    let CID_RES_1: number;
+    export { CID_RES_1 as CID_RES };
     export let QUOTA_LEVEL: number;
-    export let SERVER_CLEAR_AUTH: number;
+    let AUTH_CLEAR_1: number;
+    export { AUTH_CLEAR_1 as AUTH_CLEAR };
     export let SERVER_REDIRECT: number;
     export let LOOP: number;
     export let ECHO: number;

package/index.js

@@ -8,6 +8,7 @@ export { serverOption } from './src/server/serverOption.js'
 export { FileLogger } from './src/server/FileLogger.js'
 export { getSignalPack, parsePayload, getPayloadFromSignalPack } from './src/common/payload.js'
 export * from './src/common/constants.js'
+export * from './src/common/util.js'
 
 // MBP
 export { default as MBP } from 'meta-buffer-pack'
@@ -15,9 +16,9 @@ export { default as MBP } from 'meta-buffer-pack'
 // boho auth
 export { default as Boho} from 'boho'
 export { BohoAuth } from './src/auth/BohoAuth.js'
-export { Auth_File } from './src/auth/Auth_File.js'
-export { Auth_Env } from './src/auth/Auth_Env.js'
-export { Auth_Redis } from './src/auth/Auth_Redis.js'
+export { FileKeyProvider } from './src/auth/key_providers/FileKeyProvider.js'
+export { RedisKeyProvider } from './src/auth/key_providers/RedisKeyProvider.js'
+export { StringKeyProvider } from './src/auth/key_providers/StringKeyProvider.js'
 
 // api
 export * as api_reply from './src/api/api_reply.js'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iosignal",
-  "version": "4.0.0",
+  "version": "4.6.0",
   "description": "iosignal",
   "type": "module",
   "exports": {

package/src/auth/BohoAuth.js

@@ -2,12 +2,17 @@ import MBP from 'meta-buffer-pack'
 import Boho from 'boho'
 import { quotaTable } from '../common/quotaTable.js'
 import { serverOption } from '../server/serverOption.js'
-import { IOMsg, CLIENT_STATE } from '../common/constants.js'
+import { IOMsg, STATE } from '../common/constants.js'
 import { FileLogger } from '../server/FileLogger.js'
 
 const decoder = new TextDecoder()
 export class BohoAuth {
-  constructor() {
+  constructor(keyProvider) {
+    if (!keyProvider) {
+      throw new Error('BohoAuth must be initialized with a keyProvider.');
+    }
+    this.keyProvider = keyProvider;
+
     this.authLogger;
     if (serverOption.fileLogger.auth.use) {
       this.authLogger = new FileLogger(serverOption.fileLogger.auth.path)
@@ -21,11 +26,11 @@ export class BohoAuth {
       this.authLogger.log(peerInfo)
     }
     // console.log('##### AUTH_FAIL reason: ', reason)
-    peer.setState(CLIENT_STATE.AUTH_FAIL)
+    peer.setState(STATE.AUTH_FAIL)
+    peer.send(Buffer.from([Boho.BohoMsg.AUTH_FAIL]))
     // add some delay time.
-    setTimeout(e => {
-      peer.send(Buffer.from([Boho.BohoMsg.AUTH_FAIL]))
-    }, serverOption.auth.delay_auth_fail)
+    // setTimeout(e => {
+    // }, serverOption.auth.delay_auth_fail)
   }
 
   async verify_auth_hmac(auth_hmac, peer) {
@@ -46,7 +51,7 @@ export class BohoAuth {
       }
       
       //2. get key of id from DB
-      let authInfo = await this.getAuth(id)
+      let authInfo = await this.keyProvider.getAuth(id)
 
       if (!authInfo) {
         this.send_auth_fail(peer, 'NO ID:' + id);
@@ -97,9 +102,13 @@ export class BohoAuth {
           console.log('## trying RELOGIN with SAME ID. ignored.')
           return
         }
-        console.log('### clear_auth and close old connection:', old.cid)
-        old.send(Buffer.from([IOMsg.SERVER_CLEAR_AUTH]))
-        old.close()
+        console.log('### DUPLICATE_LOGIN detected.', old.cid)
+        let sigPack = MBP.pack(
+          MBP.MB('#MsgType', '8', IOMsg.AUTH_CLEAR),
+          MBP.MB('#reason', 'duplicate login.')
+        )
+        old.send( sigPack)
+        // old.close()  client will close and stop.
         peer.close()  // auto relogin
         return
       }
@@ -146,7 +155,7 @@ export class BohoAuth {
       // console.log("LOGIN: ", `id: ${ peer.did}(${peer.cid})` )
       //10. send ack.
       peer.send(auth_ack)
-      peer.setState(CLIENT_STATE.AUTH_READY)
+      peer.setState(STATE.AUTH_ACK)
       if (this.authLogger) {
         let peerInfo = `OK #${peer.ssid} cid: ${peer.cid} did:${peer.did}`
         if (peer.isAdmin) peerInfo = "#ADMIN# " + peerInfo
@@ -159,6 +168,34 @@ export class BohoAuth {
 
   }
 
+  async getAuth(id) {
+    return this.keyProvider.getAuth(id);
+  }
+
+  async getAuthIdList() {
+    if (typeof this.keyProvider.getAuthIdList === 'function') {
+      return this.keyProvider.getAuthIdList();
+    }
+  }
+
+  async addAuth(id, keyStr, cid, level = 0) {
+    if (typeof this.keyProvider.addAuth === 'function') {
+      return this.keyProvider.addAuth(id, keyStr, cid, level);
+    }
+  }
+
+  async delAuth(id) {
+    if (typeof this.keyProvider.delAuth === 'function') {
+      return this.keyProvider.delAuth(id);
+    }
+  }
+
+  async save() {
+    if (typeof this.keyProvider.save === 'function') {
+      return this.keyProvider.save();
+    }
+  }
+
 
 }
 

package/src/auth/{Auth_File.js → key_providers/FileKeyProvider.js}

@@ -1,11 +1,9 @@
-import { BohoAuth } from './BohoAuth.js';
 import { readFileSync } from 'fs'
 import Boho from 'boho'
 import path from 'path'
 
-export class Auth_File extends BohoAuth {
+export class FileKeyProvider {
   constructor(_path) {
-    super()
     this.AUTH = new Map();
     let pathObj = path.parse(_path)
     this.path = path.resolve(_path)
@@ -23,20 +21,9 @@ export class Auth_File extends BohoAuth {
     }
   }
 
-
-  async getAuth(id) {
-    return this.AUTH.get(id)
-  }
-
-  async getAuthIdList() {
-    return Array.from(this.AUTH.keys())
-  }
-
   //loaded when server start.
   loadAuthInfoFile_JS(path) {
-
     import(path).then((file) => {
-
       console.log(file.authInfo);
       file.authInfo.forEach(item => {
         this.addAuth(...item)
@@ -45,8 +32,6 @@ export class Auth_File extends BohoAuth {
     }).catch(e => {
       console.log(e)
     })
-
-
   }
 
   loadAuthInfoFile_JSON(path) {
@@ -57,15 +42,18 @@ export class Auth_File extends BohoAuth {
       this.addAuth(...item)
     })
     console.log('total AUTH INFO size: ', this.AUTH.size)
+  }
+
+  async getAuth(id) {
+    return this.AUTH.get(id)
+  }
 
+  async getAuthIdList() {
+    return Array.from(this.AUTH.keys())
   }
 
   addAuth(id, keyStr, cid, level = 0) {
     let Base64hashKey = Buffer.from(Boho.sha256.hash(keyStr)).toString('base64')
     this.AUTH.set(id, { key: Base64hashKey, cid: cid, level: level })
   }
-
-
-
 }
-

package/src/auth/{Auth_Redis.js → key_providers/RedisKeyProvider.js}

@@ -1,12 +1,10 @@
-import { BohoAuth } from './BohoAuth.js';
 import Boho from 'boho'
 const DEVICE_PREFIX = "device:"
 
-export class Auth_Redis extends BohoAuth {
+export class RedisKeyProvider {
   constructor(redisClient) {
-    super()
     if (!redisClient) {
-      throw new Error("AuthRedis constructor: no redisClient")
+      throw new Error("RedisKeyProvider constructor: no redisClient")
     }
     this.redis = redisClient
   }
@@ -15,7 +13,8 @@ export class Auth_Redis extends BohoAuth {
   async getAuth(id) {
     try {
       let result = await this.redis.hGetAll(DEVICE_PREFIX + id)
-      if (result.key) return result
+      if (result && result.key) return result
+      else return null;
     } catch (error) {
       console.log('getAuth', error)
     }
@@ -44,6 +43,4 @@ export class Auth_Redis extends BohoAuth {
   async save(id) {
     return this.redis.save()
   }
-
 }
-

package/src/auth/key_providers/StringKeyProvider.js

@@ -0,0 +1,54 @@
+/**
+ * StringKeyProvider.js
+ * 
+ * authInfo <String>
+ *  id: max 8chars
+ *  key: ~44 base64 chars recomended
+ *  cid: 
+ *  level: range: 0~255
+ *  separator: ',' for multiple devices.
+ * 
+ * example => authInfo = 'id1.key1.cid1.255,id2.key2.cid2.200'
+ */
+
+import Boho from 'boho'
+
+export class StringKeyProvider {
+  constructor(authInfo) {
+
+    if (!authInfo) {
+      throw TypeError("StringKeyProvider constructor() missing authInfo.")
+    }
+
+    let id_keys = authInfo.split(',')
+
+    this.AUTH = new Map();
+
+    if (id_keys.length >= 1) {
+      id_keys.forEach(v => {
+        let [ did, key, cid, level ]  = v.split('.')
+        level = parseInt(level)
+        if (did && key && cid && typeof level == 'number') {
+          this.addAuth(did, key, cid, level)
+        } else {
+          throw TypeError("StringKeyProvider invalid authInfo.")
+        }
+      })
+    } else {
+      throw TypeError("StringKeyProvider invalid authInfo.")
+    }
+
+  }
+
+  async getAuth(id) {
+    return this.AUTH.get(id)
+  }
+  async getAuthIdList() {
+    return Array.from(this.AUTH.keys())
+  }
+
+  addAuth(id, keyStr, cid, level = 0) {
+    let Base64hashKey = Buffer.from(Boho.sha256.hash(keyStr)).toString('base64')
+    this.AUTH.set(id, { key: Base64hashKey, cid: cid, level: level })
+  }
+}

package/src/client/IOCongSocket.js

@@ -1,5 +1,5 @@
 import { IOCore } from "./IOCore.js"
-import { STATES } from "../common/constants.js";
+import { SIZE_LIMIT } from "../common/constants.js";
 import { pack, CongRx } from './CongPacket.js'
 import net from 'net'
 
@@ -30,10 +30,10 @@ export class IOCongSocket extends IOCore {
 
 
 
-  keepAlive() {
+  keepConnection() {
     if (!this.autoReconnect) return;
     // Reconnect only if the socket is fully destroyed and the state is closed.
-    if ((!this.socket || this.socket.destroyed) && this.state === STATES.CLOSED) {
+    if ((!this.socket || this.socket.destroyed)) {
       this.open();
     }
   }
@@ -46,7 +46,7 @@ export class IOCongSocket extends IOCore {
       urlObj = new URL('cong://' + url)
     }
     this.socket = net.createConnection(urlObj.port, urlObj.hostname)
-    this.stateChange('opening')
+    this.stateChange('connecting','connecting')
 
     this.socket.on('connect', () => {
       this.congRx = new CongRx();