iosignal 4.0.0 → 4.5.0

package/src/server/RemoteCore.js

@@ -1,7 +1,7 @@
 import MBP from 'meta-buffer-pack'
 import Boho from 'boho'
 import { serverOption } from './serverOption.js';
-import { IOMsg, ENC_MODE, CLIENT_STATE } from '../common/constants.js'
+import { IOMsg, ENC_MODE, STATE } from '../common/constants.js'
 import { quotaTable } from '../common/quotaTable.js'
 
 const decoder = new TextDecoder()
@@ -40,7 +40,7 @@ export class RemoteCore {
 
     this.state;
     this.stateLog = [];
-    this.setState(CLIENT_STATE.INIT)
+    this.setState(STATE.OPEN)
 
   }
 
@@ -49,7 +49,7 @@ export class RemoteCore {
   setState(state) {
     this.state = state
     if (serverOption.debug.showAuthInfo) {
-      // let s = state + ":" + CLIENT_STATE[ state] 
+      state = state + ":" + STATE[ state] 
       this.stateLog.push( state  )
       console.log(this.stateLog.join('>'))
     }
@@ -60,24 +60,30 @@ export class RemoteCore {
   }
 
   getStateName() { // <String>
-    return (CLIENT_STATE[this.state]).toLowerCase()
+    return (STATE[this.state]).toLowerCase()
   }
 
 
   showMessageLog(message, isBinary) {
-    let from = this.boho.isAuthorized ? `[FROM]did: ${this.did} cid:${this.cid}` : `[FROM]cid:${this.cid}`
+    let h = '->S '
+    let from = this.boho.isAuthorized ? ` did: ${this.did} cid: ${this.cid}` : ` cid: ${this.cid}`
+    let prnLimit = 20
     if (isBinary) {
       let msgTypeName = IOMsg[message[0]]
       if (!msgTypeName) msgTypeName = Boho.BohoMsg[message[0]]
-      msgTypeName = ' [' + msgTypeName + ']';
-      if (message.byteLength > 40) {
-        console.log(from + msgTypeName + ' LEN:', message.length);
+
+      msgTypeName = '[' + msgTypeName + ']';
+      let size = message.byteLength;
+      if (size < prnLimit) {
+        console.log( h + msgTypeName + from +` [${size}]`, message);
       } else {
-        console.log(from + msgTypeName, message);
+        let elseLen = size - prnLimit
+        let some = message.subarray(0,prnLimit)
+        console.log( h + msgTypeName + from +` [${size}]` , some , ' ... else: ', elseLen);
       }
 
     } else {
-      console.log(from + ' [TEXT] %s', message);
+      console.log( h + ' [TEXT] %s' + from, message);
     }
   }
 
@@ -162,7 +168,7 @@ export class RemoteCore {
           break;
 
         case IOMsg.CID_REQ:
-          if (this.state < CLIENT_STATE.SENT_SERVER_READY) {
+          if (this.state < STATE.SERVER_READY) {
             // Protocol violation: CID_REQ was sent before receiving the SERVER_READY signal.
             console.log('CID_REQ before SERVER_READY')
             this.close()
@@ -179,7 +185,7 @@ export class RemoteCore {
             MB('#cid', this.cid)
           ))
 
-          this.setState(CLIENT_STATE.CID_READY)
+          this.setState(STATE.CID_RES)
           break;
 
         case IOMsg.ECHO:
@@ -285,24 +291,24 @@ export class RemoteCore {
         // Auth
         case Boho.BohoMsg.AUTH_REQ:
           if (!this.manager.authManager) return
-          if (this.state < CLIENT_STATE.SENT_SERVER_READY) {
+          if (this.state < STATE.SERVER_READY) {
             console.log('protocol error. auth_req before server_ready')
             this.close();
           }
-          this.setState(CLIENT_STATE.RECV_AUTH_REQ)
+          this.setState(STATE.AUTH_REQ)
           let auth_nonce_pack = this.boho.auth_nonce()
           // console.log('## auth_nonce_pack', auth_nonce_pack )
           this.send(auth_nonce_pack)
-          this.setState(CLIENT_STATE.SENT_SERVER_NONCE)
+          this.setState(STATE.AUTH_NONCE)
           break;
 
         case Boho.BohoMsg.AUTH_HMAC:
           if (!this.manager.authManager) return
-          if (this.state < CLIENT_STATE.SENT_SERVER_NONCE) {
+          if (this.state < STATE.AUTH_NONCE) {
             console.log('protocol error. auth_hmac before server_nonce')
             this.close();
           }
-          this.setState(CLIENT_STATE.RECV_AUTH_HMAC)
+          this.setState(STATE.AUTH_HMAC)
           //async
           this.manager.authManager.verify_auth_hmac(message, this)
             .then(authInfo => {

package/src/server/Server.js

@@ -81,7 +81,7 @@ export class Server extends EventEmitter {
 
     this.wss.once('listening', () => {
       this.port = this.wss.address().port;
-      console.log('wss server bound port:',  this.port );
+      // console.log('wss server bound port:',  this.port );
       this.listeningServerCount++;
       if (this.listeningServerCount === this.serverCountToListen) {
         this.emit('ready');
@@ -97,7 +97,7 @@ export class Server extends EventEmitter {
     })
 
     this.wss.on('close', () => {
-      console.log('### WS server is closed.')
+      // console.log('### WS server is closed.')
     })
 
     this.wss.on('connection', (ws, req) => {
@@ -118,10 +118,10 @@ export class Server extends EventEmitter {
           process.exit()
         }
       }).on('close', () => {
-        console.log('### congsocket server is closed.')
+        // console.log('### congsocket server is closed.')
       }).listen(this.congPort, () => {
         this.congPort = this.congServer.address().port;
-        console.log('congsocket server bound port:', this.congPort );
+        // console.log('congsocket server bound port:', this.congPort );
         this.listeningServerCount++;
         if (this.listeningServerCount === this.serverCountToListen) {
           this.emit('ready');
@@ -156,7 +156,7 @@ export class Server extends EventEmitter {
             return
           }
           if( api.commands.includes( req.topic )){
-            console.log('server api req', req )
+            // console.log('server api req', req )
             await api.request(remote, req)
           }else{
             remote.response(req.mid, STATUS.ERROR, "UNKNOWN_COMMAND");
@@ -186,7 +186,7 @@ export class Server extends EventEmitter {
       })
     }
     this.apiNames.add(target)
-    console.log(`[API registed: ${target} ] accept commands: ${api.commands}`)
+    // console.log(`[API registed: ${target} ] accept commands: ${api.commands}`)
     return this
   }
 
@@ -226,7 +226,7 @@ export class Server extends EventEmitter {
 
     if (this.congServer) {
       this.congServer.close((err) => {
-        if (err) console.error('congServer close error', err)
+        // if (err) console.error('congServer close error', err)
         // console.log('cong server closed.')
         onClosed()
       })

package/README.en.md

@@ -1,56 +0,0 @@
-[ English | [한국어](./README.md) ]
-
-# IOSignal
-
-IOSignal enables real-time communication across web browsers, Node.js, and Arduino. It features built-in secure authentication, encrypted communication, and a pre-configured signaling protocol, allowing server deployment without complex programming.
-
-
-## Features
-
-### Built-in Message Trasport Protocol
-- pub/sub multicast by channel name.
-- uni-cast: one to one messaging by CID.
-- `CID` is a Communication Id
-- CID subscribing: subscribe one peer using CID.
-- HomeChannel: group by IP address.
-
-### Built-in Security
-- Authentication
-- Encryption
-- E2EE
-- thanks to the `Boho` [ [github](https://github.com/remocons/boho) ]
-
-## Connection
- - Web browser use WebSocket.
- - Node.js use WebSocket or CongSocket.
- - Arduino use CongSocket.
-
-## IOSignal Server Architecture
-![IOSignal](./docs/iosignal_architecture.png)
-
-## IOSignal repositories.
-
-- Javascript: `iosignal` [ [github](https://github.com/remocons/iosignal) | [npm](https://www.npmjs.com/package/iosignal) ]
-    - Node.js server ( WebSocket, CongSocket)
-    - Node.js client ( WebSocket, CongSocket)
-    - Web Browser client( WebSocket)
-
-- CLI program
-    - `iosignal-cli` [ [github](https://github.com/remocons/iosignal-cli) | [npm](https://www.npmjs.com/package/iosignal-cli) ]
-    - install: `npm i -g iosignal-cli` or `sudo npm i -g iosignal-cli`
-    - support mac, linux and windows.
-    - server and client
-
-- Arduino iosignal library and examples:
-    - use Arduino Library Manager: `iosignal`
-    - or `iosignal-arduino` [ [github](https://github.com/remocons/iosignal-arduino) ]
-    - web app : http://test.iosignal.net
-
-- Arduino remocon library and examples:
-    - use Arduino Library Manager: `remocon`
-    - or `remocon-arduino` [ [github](https://github.com/remocons/remocon-arduino) ]
-    - web app : https://remocon.kr
-    
-## License
-
-This code is released under the MIT License.

package/auth_file_sample.js

@@ -1,23 +0,0 @@
-
-/*
-  Authentication data sample.
-
-  device props: ["did", "key", "cid", level ]
-
-    did: ( device id ) authentication id.  maximum 8 chars.
-    key: ( device key ) authentication key. no size limit.
-    cid: ( communication id ) signal target id.  maximum 12 chars. 
-    level:( quota level) <Number>   ref. /server/quotaTable.js
-
-*/
-export const authInfo = [
-  ["did","passowrd","cid",0],
-  ["device1","device1_key","device1_cid",0],
-  ["device2","device2_key","device2_cid",0],
-  ["uno","uno-key","uno",1],
-  ["go","go-key","go",2],
-  ["bro","bro-key","bro",3],
-  ["admin","admin-key","admin",255],
-]
-
-

package/auth_file_sample.json

@@ -1,13 +0,0 @@
-[
-  ["sampleid","samplekey","sample_cid",0],
-  ["id_max8","no_key_size_limit","communication_id",0],
-  ["device1","device1_key","device1_cid",0],
-  ["device2","device2_key","device2_cid",0],
-  ["uno","uno","uno",1],
-  ["go","go","go",2],
-  ["bro","bro","bro",3],
-  ["admin","admin","admin",255],
-  ["adminb","adminb","adminb",255]
-]
-
-

package/src/auth/Auth_Env.js

@@ -1,76 +0,0 @@
-/**
- * Auth_Env.js
- * 
- * You can use environment variable BOHO_AUTH.
- * 
- *  BOHO_AUTH=id1.key1.level,id2:key2.level 
- * 
- *  or constructor parameter.
- * 
- * 
- * [ authInfo ]
- *  id: <String> max 8chars
- *  key: <String>
- *  level: <Numbrer> range: 0~255
- *  separator: ','
- * 
- * example => process.env.BOHO_AUTH=id1.key1.255,id2.key2.200
- */
-
-import { BohoAuth } from './BohoAuth.js';
-import Boho from 'boho'
-
-export class Auth_Env extends BohoAuth {
-  constructor(authInfo) {
-    super()
-    let id_keys;
-    if (authInfo) {
-      id_keys = authInfo.split(',')
-    } else if (process.env.BOHO_AUTH) {
-      authInfo = process.env.BOHO_AUTH
-      id_keys = process.env.BOHO_AUTH.split(',')
-    } else {
-      console.log("Auth_Env: None of process.env.BOHO_AUTH or authInfo")
-      process.exit()
-    }
-
-    this.AUTH = new Map();
-
-    if (id_keys.length >= 1) {
-      id_keys.forEach(v => {
-
-        let did = v.split('.')[0]
-        let key = v.split('.')[1]
-        let level = v.split('.')[2]
-        level = parseInt(level)
-
-        if (did && key && typeof level == 'number') {
-          let cid = did;
-          this.addAuth(did, key, cid, level)
-        } else {
-          console.log("Wrong process.env.BOHO_AUTH authentication value.", id, key, level)
-          process.exit();
-        }
-      })
-
-    } else {
-      console.log("Wrong process.env.BOHO_AUTH authentication value.")
-      process.exit();
-    }
-
-  }
-
-  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 })
-  }
-
-}
-