iosignal 1.6.1 → 1.7.0

package/src/server/{ServerRemoteCore.js → RemoteCore.js}

@@ -11,7 +11,7 @@ const NB = MBP.NB
 const MB = MBP.MB
 
 
-export class ServerRemoteCore {
+export class RemoteCore {
   constructor(socket, manager) {
 
     this.socket = socket;
@@ -25,12 +25,12 @@ export class ServerRemoteCore {
     this.channels = new Set();  //  subscribed tags
     this.retain_signal = new Map();
 
-    this.ssid = ServerRemoteCore.ssid++;  // ordered index number
+    this.ssid = RemoteCore.ssid++;  // ordered index number
     this.manager = manager;
 
     this.cid; // Communication Id
     this.did; // Device Id
-    this.uid;
+    this.uid; // User Id
     this.nick = ""
 
 
@@ -49,8 +49,6 @@ export class ServerRemoteCore {
 
   static ssid = 1;
 
-
-
   setState(state) {
     this.state = state
     if (serverOption.debug.showAuthInfo) {
@@ -59,16 +57,12 @@ export class ServerRemoteCore {
     }
   }
 
-  getState(){
+  getState() { // <Number>
     return this.state
   }
 
-  getStateName(){ 
-    //state <number>
-    //value of constant STATES.NAME < number >
-    //type of constant STATES.NAME name < string uppercase >
-    //stateName,eventName <string lowercase>
-    return ( CLIENT_STATE[ this.state ]).toLowerCase()
+  getStateName() { // <String>
+    return (CLIENT_STATE[this.state]).toLowerCase()
   }
 
 
@@ -77,11 +71,11 @@ export class ServerRemoteCore {
     if (isBinary) {
       let msgTypeName = IOMsg[message[0]]
       if (!msgTypeName) msgTypeName = BohoMsg[message[0]]
-        msgTypeName =' [' + msgTypeName + ']';
+      msgTypeName = ' [' + msgTypeName + ']';
       if (message.byteLength > 40) {
         console.log(from + msgTypeName + ' LEN:', message.length);
       } else {
-        console.log(from + msgTypeName , message);
+        console.log(from + msgTypeName, message);
       }
 
     } else {
@@ -102,21 +96,20 @@ export class ServerRemoteCore {
 
     // todo:
     // traffic rate :  
-
     return true;
   }
 
-  // 
   onTimeDelayMessage(message, isBinary = true) {
     setTimeout(() => {
       this.onSocketMessage(message, isBinary)
     }
       , serverOption.debug.delay)
   }
+
   // CongSocket or WebSocket
   onSocketMessage(message, isBinary = true) {
 
-    this.receiveMonitor() // rx data and ping pong : timeout check
+    this.receiveMonitor() // rx-data, ping/pong and timeout check
     if (!this.rxQuotaChecker(message)) return
 
     if (serverOption.showMessage === 'message') this.showMessageLog(message, isBinary)
@@ -127,9 +120,7 @@ export class ServerRemoteCore {
       msgType = message[0]
 
       if (msgType === BohoMsg.ENC_488) {
-        // let from = this.boho.isAuthorized ? this.cid : "anonymous"
-        // console.log(`>> [E488] from: ${from} LEN ${message.byteLength}`)
-        // console.log( "ENC buffer", message)
+
         try {
           decoded = this.boho.decrypt_488(message)
         } catch (err) {
@@ -139,17 +130,16 @@ export class ServerRemoteCore {
 
         if (decoded) {
           msgType = decoded[0]
-          message = decoded   // signal message
-          // console.log('[D]', IOMsg[ msgType] )
+          message = decoded
         } else {
           return
         }
 
-      } else if (msgType === BohoMsg.ENC_E2E) { // End to End Signal
+      } else if (msgType === BohoMsg.ENC_E2E) { // symetric E2EE Signal
         try {
           decoded = this.boho.decrypt_488(message)
         } catch (err) {
-          console.log('-- E2E DEC_FAIL', err)
+          // console.log('-- E2E DEC_FAIL', err)
           return
         }
         // console.log('e2e unpack:', decoded )
@@ -157,7 +147,6 @@ export class ServerRemoteCore {
           msgType = decoded[0]
           message.set(decoded, MetaSize.ENC_488) // set decoded signal_e2e headaer.
           message = message.subarray(MetaSize.ENC_488) // reset offset.
-          // console.log('[D]', IOMsg[ msgType] )
         } else {
           return
         }
@@ -168,19 +157,18 @@ export class ServerRemoteCore {
 
       switch (msgType) {
         case IOMsg.PING:
-          // console.log('-- ping from:' , this.cid )
           this.pong();
           break;
 
         case IOMsg.PONG:
-          // console.log('<-pong')
           break;
 
         case IOMsg.CID_REQ:
           if (this.state < CLIENT_STATE.SENT_SERVER_READY) {
-            // console.log('protocol error. cid_req before server_ready')
+            // Protocol violation: CID_REQ was sent before receiving the SERVER_READY signal.
             this.close()
           }
+
           if (!this.cid) {
             this.cid = '?' + webcrypto.getRandomValues(Buffer.alloc(3)).toString('base64url')
             this.manager.cid2remote.set(this.cid, this)
@@ -206,10 +194,10 @@ export class ServerRemoteCore {
           this.send(message, isBinary)
           break;
 
-        case IOMsg.IAM: // iam
-          if(message.byteLength > 1){
+        case IOMsg.IAM:
+          if (message.byteLength > 1) {
             let iamInfo = message.subarray(1)
-            this.nick = decoder.decode(iamInfo)  
+            this.nick = decoder.decode(iamInfo)
             console.log('iam nick reset', this.nick)
           }
           this.iamResponse()
@@ -222,7 +210,7 @@ export class ServerRemoteCore {
             if (message.byteLength >= tagLen + 2) {
               let tag = message.subarray(2, 2 + tagLen)
               tag = decoder.decode(tag)
-              this.manager.sender(tag, this, message )
+              this.manager.sender(tag, this, message)
             }
           }
           break;
@@ -238,7 +226,6 @@ export class ServerRemoteCore {
             if (message.byteLength == tagLen + 2) {
               let tag = message.subarray(2, 2 + tagLen)
               tag = decoder.decode(tag)
-              // console.log('unsub:  tag', tag)
               let tagList = tag.split(',')
               this.manager.unsubscribe(tagList, this)
             }
@@ -253,14 +240,12 @@ export class ServerRemoteCore {
               let tag = message.subarray(2, 2 + tagLen)
               tag = decoder.decode(tag)
               let tagList = tag.split(',')
-              // console.log('-- SUBSCRIBE req splittagList', tagList)
               this.manager.subscribe(tagList, this)
             }
           }
           break;
 
         case IOMsg.SUBSCRIBE_REQ:  // 2bytes tagLen
-          // console.log('#####recv sub_req ', message, message.byteLength )
           if (message.byteLength >= 6) {
             let msgID = message.readUInt16BE(1)
             let tagLen = message.readUInt16BE(3)
@@ -269,12 +254,10 @@ export class ServerRemoteCore {
               tag = decoder.decode(tag)
               let tagList = tag.split(',')
               // console.log('>> SUBSCRIBE_REQ from:', this.cid, tagList)
-              let size = this.manager.subscribe(tagList, this)
-
-              // this.response(msgID, 0, { size: size })
+              this.manager.subscribe(tagList, this)
               this.response(msgID, 0)
             } else {
-              this.response(msgID, 255 )
+              this.response(msgID, 255)
             }
           }
           break;
@@ -282,15 +265,13 @@ export class ServerRemoteCore {
 
         case IOMsg.REQUEST: //api request
           try {
-            let req = MBP.unpack( message )
-            // console.log('request unpack req', req)
-            if(req){
-              // console.log('request target:', req.target, 'topic:', req.topic)
-              if( !req.target || !req.topic ) return
-              if(this.manager.server.apiNames.has(req.target)){
-                this.manager.server.emit( req.target, this , req  )
-              }else{
-              console.log('UnKnown API req: ', req.target)
+            let req = MBP.unpack(message)
+            if (req) {
+              if (!req.target || !req.topic) return
+              if (this.manager.server.apiNames.has(req.target)) {
+                this.manager.server.emit(req.target, this, req)
+              } else {
+                // console.log('UnKnown API req: ', req.target)
               }
             }
           } catch (e) {
@@ -331,17 +312,17 @@ export class ServerRemoteCore {
           this.setState(CLIENT_STATE.RECV_AUTH_HMAC)
           //async
           this.manager.authManager.verify_auth_hmac(message, this)
-          .then(authInfo=>{
-            if(authInfo){
-              this.manager.deligateSignal(remote, '@$name', authInfo.name)
-              // console.log('device login success authInfo', authInfo)
-              // this.manager.sender('@$name', authInfo.name )
-            }
+            .then(authInfo => {
+              if (authInfo) {
+                this.manager.deligateSignal(remote, '@$name', authInfo.name)
+                // console.log('device login success authInfo', authInfo)
+                // this.manager.sender('@$name', authInfo.name )
+              }
 
-          })
-          .catch(e=>{
+            })
+            .catch(e => {
 
-          })
+            })
 
           return;
 
@@ -366,25 +347,25 @@ export class ServerRemoteCore {
 
 
   response(msgId, statusCode, body) {
-// console.log('response body', body)
-    if( body ){
+    // console.log('response body', body)
+    if (body) {
 
-      this.send_enc_mode( MBP.pack(
+      this.send_enc_mode(MBP.pack(
         MB('#type', '8', IOMsg.RESPONSE_MBP),
-        MB('status','8', statusCode),
-        MB('mid','16', msgId),
-        MB('body',body)
+        MB('status', '8', statusCode),
+        MB('mid', '16', msgId),
+        MB('body', body)
       ))
 
-    }else{
-      this.send_enc_mode( MBP.pack(
-        MB('#type','8', IOMsg.RESPONSE_MBP),
-        MB('status','8', statusCode),
-        MB('mid','16', msgId)
+    } else {
+      this.send_enc_mode(MBP.pack(
+        MB('#type', '8', IOMsg.RESPONSE_MBP),
+        MB('status', '8', statusCode),
+        MB('mid', '16', msgId)
       ))
 
     }
-    
+
   }
 
 
@@ -398,29 +379,24 @@ export class ServerRemoteCore {
     // console.log('svr useEnc',  useEncryption, data )
 
     if (useEncryption && data[0] == IOMsg.SIGNAL_E2E) {
-      // E2E는,
-      // 서버는 수신자와 암호통신하는경우, 헤더부분만 암호화 하고, 데이타 부분은 그대로 전달해야한다.
+      // When the server delivers end-to-end encrypted messages, 
+      // it should only encrypt the header part and pass the data part as is.
       let tagLen = data[1];
 
       // let tagInfo = decoder.decode( data.subarray( 2, 2 + tagLen) )
       // console.log('server bypass E2E signal taginfo:', tagInfo )
 
       let encHeader = this.boho.encrypt_488(data.subarray(0, 3 + tagLen))
-      // console.log('size check:', encHeader.byteLength == (tagLen + 3 + 21 ) )
       encHeader[0] = BohoMsg.ENC_E2E
-      // encHeader 크기가 21(enc_488)크기 만큼 커짐. tagLen+3 + 21 
       let newEncBuffer = Buffer.concat([encHeader, data.subarray(3 + tagLen)])
-
-      // console.log('ENC_E2E', newEncBuffer)
       this.send(newEncBuffer)
 
     } else if (useEncryption) {
       let encPack = this.boho.encrypt_488(data)
       if (encPack) {
-        // console.log('send *S* LEN:', encPack.byteLength)
         this.send(encPack)
       } else {
-        console.log('encryption FAIL: NO DATA TRANSIT')
+        // console.log('encryption FAIL: NO DATA TRANSIT')
       }
     } else {
       // console.log('send -N-')
@@ -435,7 +411,6 @@ export class ServerRemoteCore {
   iamResponse(info = "") {
 
     if (info == "") {
-      //send general info
       let channels = []
       for (let tag of this.channels.keys()) {
         channels.push(tag)
@@ -459,9 +434,6 @@ export class ServerRemoteCore {
     this.send_enc_mode(pack)
   }
 
-  // storeSet(topic, ...args){
-    // this.manager.set( this, topic, ...args )
-  // }
 
 }
 

package/src/server/Server.js

@@ -7,7 +7,7 @@ import { STATUS } from '../api/api_constant.js'
 
 export class Server extends EventEmitter {
 
-  constructor(options, authManager ) {
+  constructor(options, authManager) {
     super();
     this.apiNames = new Set()
     this.wss = {};
@@ -42,32 +42,31 @@ export class Server extends EventEmitter {
     if (options.httpServer) {
       serverOption.httpServer = options.httpServer
     }
-    
+
     if (options.congPort) {
       serverOption.congPort = parseInt(options.congPort)
     }
-    
+
     this.manager = new Manager(this, authManager)
 
-    if (serverOption.port || serverOption.httpServer ) this.startWSServer(serverOption)
-    if( serverOption.congPort) this.startCongServer(serverOption.congPort)
-    
-    // console.log('serverOption:', serverOption)
+    if (serverOption.port || serverOption.httpServer) this.startWSServer(serverOption)
+    if (serverOption.congPort) this.startCongServer(serverOption.congPort)
+
   }
 
 
   startWSServer(serverOption) {
 
-    if(serverOption.port ){
+    if (serverOption.port) {
       console.log('opening WebSocket Server port:', serverOption.port)
       this.wss = new WebSocketServer({ port: serverOption.port })
-    }else if( serverOption.httpServer ){
-      console.log('opening WebSocket Server external httpServer:' )
+    } else if (serverOption.httpServer) {
+      console.log('opening WebSocket Server external httpServer:')
       this.wss = new WebSocketServer({ server: serverOption.httpServer })
-    }else{
+    } else {
       throw new TypeError(
         'One and only one of the "port", "httpServer"' +
-          'must be specified'
+        'must be specified'
       );
     }
 
@@ -76,7 +75,7 @@ export class Server extends EventEmitter {
 
     this.wss.on('error', (err) => {
       console.error('### ws server error:', err.message)
-      if(err.code == 'EADDRINUSE'){
+      if (err.code == 'EADDRINUSE') {
         process.exit()
       }
     })
@@ -93,7 +92,7 @@ export class Server extends EventEmitter {
 
   }
 
-  startCongServer( congPort ) {
+  startCongServer(congPort) {
     console.log('opening CongSocket Server:', congPort)
 
     this.congServer = net.createServer((socket) => {
@@ -101,10 +100,10 @@ export class Server extends EventEmitter {
     })
       .on('error', (err) => {
         console.log('### cong server error:', err.message)
-        if(err.code == 'EADDRINUSE'){
+        if (err.code == 'EADDRINUSE') {
           process.exit()
         }
-      }).listen( congPort, () => {
+      }).listen(congPort, () => {
         // console.log('congsocket server bound' );
       });
   }
@@ -112,17 +111,16 @@ export class Server extends EventEmitter {
 
 
   api(target, api) {
-   
+
     this.apiNames.add(target)
 
-    // common checkPermission
     if (!api.checkPermission || typeof api.checkPermission != 'function') {
       throw new Error('wrong api interface. no checkPermission function.')
     }
 
 
-    if(typeof api.request == 'function' && Array.isArray( api.commands )){
-      console.log(`API TYPE1. A Class with one request function. target: ${target} list: ${api.commands}` )
+    if (typeof api.request == 'function' && Array.isArray(api.commands)) {
+      console.log(`API TYPE1. A Class with one request function. target: ${target} list: ${api.commands}`)
 
       this.on(target, (remote, req) => {
         if (api.checkPermission(remote, req)) {
@@ -132,11 +130,11 @@ export class Server extends EventEmitter {
         }
       })
 
-    }else{
+    } else {
       let apiList = []
       Object.keys(api).forEach(v => {
         if (typeof api[v] === 'function') apiList.push(v)
-        console.log('api list',typeof api[v] ,v )
+        console.log('api list', typeof api[v], v)
       })
 
       console.log(`API TYPE2. Multiple function list.  target: ${target} list:${apiList}`)
@@ -146,9 +144,8 @@ export class Server extends EventEmitter {
         if (!api.checkPermission(remote, req)) {
           r = "NO_PERMISSION."
         } else {
-          // if (apiList.includes(req.topic)) {
-          if ( api[req.topic] ) {
-        console.log(`API TYPE2. request target: ${target}  has topic:${req.topic}`)
+          if (api[req.topic]) {
+            console.log(`API TYPE2. request target: ${target}  has topic:${req.topic}`)
             api[req.topic](remote, req)
             return
           } else {

package/src/server/serverOption.js

@@ -10,21 +10,21 @@ export let serverOption = {
   showMetric: 0,
   showChannel: 0,
   monitorPeriod: 5000,
-  fileLogger:{
-    connection: { 
-      use: false, 
+  fileLogger: {
+    connection: {
+      use: false,
       path: 'connection.log'
     },
     auth: {
-      use: false, 
+      use: false,
       path: 'auth.log'
     },
-    attack:{
+    attack: {
       use: false,
-      path:'attack.log'
+      path: 'attack.log'
     }
   },
-  useQuota:{
+  useQuota: {
     signalSize: false,
     publishCounter: false,
     trafficRate: false,
@@ -33,19 +33,19 @@ export let serverOption = {
   defaultQuotaIndex: 3,
   adminLevel: 255,
 
-  debug:{
+  debug: {
     slow: false,
     delay: 500,
     showAuthInfo: false
   },
 
-  retain:{
+  retain: {
     isAvailable: true,
     limitSize: 100000,
     limitCounter: 1000
   },
 
-  auth:{
+  auth: {
     delay_auth_fail: 1000,
   },
 

package/test-browser/index.html

@@ -1,23 +1,25 @@
 <!DOCTYPE html>
 <html lang="en">
+
 <head>
   <meta charset="UTF-8">
   <meta http-equiv="X-UA-Compatible" content="IE=edge">
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   <title>Document</title>
   <style>
-    #messageView{
+    #messageView {
       border: 1px solid red;
       padding: 2em;
     }
   </style>
 </head>
+
 <body>
   <h2>Simple pub sub example.</h2>
   <p>you should start server first.</p>
   <p>this index.html load two types of modules. </p>
   <h5>1. IIFE: iosignal.min.js</h5>
-  <p>use global name:  IO </p>
+  <p>use global name: IO </p>
   <p>IO has props: Boho, MBP, Buffer,, </p>
   <h5>2. ESM: iosignal.esm.js</h5>
   <p> check the console.</p>
@@ -27,55 +29,55 @@
   <script>
     console.log('IIFE:')
     console.log('IO', IO)
-    console.log('MBP', IO.MBP )
+    console.log('MBP', IO.MBP)
     console.log('Buffer', IO.Buffer)
-    console.log('Boho', IO.Boho )
-    console.log('sha256.hash("hi")',  IO.Boho.sha256.hash('hi'))
+    console.log('Boho', IO.Boho)
+    console.log('sha256.hash("hi")', IO.Boho.sha256.hash('hi'))
 
-    var ESM_IO ;
-    // IO.binaryType = "blob"
+    var ESM_IO;
+    IO.binaryType = "blob"
     var io1 = new IO('ws://localhost:7777')
     var io2 = new IO('ws://localhost:7777')
     var io3 = new IO('ws://localhost:7777')
 
-    io1.on('error', errorHandler )
-    io2.on('error', errorHandler )
-    io3.on('error', errorHandler )
+    io1.on('error', errorHandler)
+    io2.on('error', errorHandler)
+    io3.on('error', errorHandler)
 
     let channelName = 'io'
     // classic style subsribing
-    io1.on('ready',e=>{
+    io1.on('ready', e => {
       io1.subscribe(channelName)
-      io1.on(channelName, (...args)=>{
+      io1.on(channelName, (...args) => {
         // console.log('io1 received', args )
-        let msg = '[io1] ' + JSON.stringify( args )
+        let msg = '[io1] ' + JSON.stringify(args)
         addMessage(msg)
       })
     })
 
     // modern style subscribing
-    io2.listen(channelName, (...args)=>{
+    io2.listen(channelName, (...args) => {
       // console.log('io2 receive', args )
-      let msg = '[io2] ' + JSON.stringify( args )
-        addMessage(msg)
+      let msg = '[io2] ' + JSON.stringify(args)
+      addMessage(msg)
     })
 
-    setInterval(e=>{
+    setInterval(e => {
       io3.signal(channelName, 'single string')   // single string payload
-      io3.signal(channelName, Date.now(), 'a', 2 , {key: 3} ) //multiple payload 
-      io3.signal(channelName ) // pure signal without payload.
-    },3000)
+      io3.signal(channelName, Date.now(), 'a', 2, { key: 3 }) //multiple payload 
+      io3.signal(channelName) // pure signal without payload.
+    }, 3000)
+
+    function addMessage(msg) {
 
-    function addMessage(msg){
-    
       let p = document.createElement('p')
       p.textContent = msg
       let v = document.querySelector('#messageView')
-      if(v.childElementCount > 20) v.innerHTML = ""
-      v.prepend( p )
+      if (v.childElementCount > 20) v.innerHTML = ""
+      v.prepend(p)
     }
 
-    function errorHandler(e){
+    function errorHandler(e) {
       console.log(e.target)
       addMessage('ws.error')
     }
@@ -91,4 +93,5 @@
     console.log('sha256.hash("hi")',  sha256.hash('hi'))
   </script> -->
 </body>
+
 </html>

package/test-browser/server.js

@@ -6,6 +6,6 @@ const options = {
   showMessage: 'message'
 }
 
-const server = new Server( options )
+const server = new Server(options)
 
 

package/test-client-nodejs/client.cjs

@@ -3,15 +3,15 @@ const { IO } = require('iosignal')
 
 const io = new IO('ws://localhost:7777')
 
-io.on('ready', ()=>{
+io.on('ready', () => {
   console.log('ready cid:', io.cid)
-  io.signal('#screen','playToggle')
+  io.signal('#screen', 'playToggle')
 });
 
-io.listen('#notify', (...args)=>{
-  console.log( args )
+io.listen('#notify', (...args) => {
+  console.log(args)
 })
 
-io.on('error',err=>{
-    console.log('err', err)
+io.on('error', err => {
+  console.log('err', err)
 })