iosignal 1.6.0 → 1.7.0

package/src/auth/BohoAuth.js

@@ -1,92 +1,88 @@
-/**
- * BohoAuth
- */
-
 import { MBP } from 'meta-buffer-pack'
-import { BohoMsg , Meta } from 'boho'
+import { BohoMsg, Meta } from 'boho'
 import { quotaTable } from '../common/quotaTable.js'
 import { serverOption } from '../server/serverOption.js'
-import { IOMsg ,CLIENT_STATE } from '../common/constants.js'
+import { IOMsg, CLIENT_STATE } from '../common/constants.js'
 import { FileLogger } from '../server/FileLogger.js'
 
 const decoder = new TextDecoder()
-export class BohoAuth{
-  constructor(){ 
+export class BohoAuth {
+  constructor() {
     this.authLogger;
-    if( serverOption.fileLogger.auth.use ){
-      this.authLogger = new FileLogger( serverOption.fileLogger.auth.path)
+    if (serverOption.fileLogger.auth.use) {
+      this.authLogger = new FileLogger(serverOption.fileLogger.auth.path)
       console.log('Auth: begin file logger.[auth]')
     }
   }
 
-  send_auth_fail( peer , reason){
-    if( this.authLogger ){
+  send_auth_fail(peer, reason) {
+    if (this.authLogger) {
       let peerInfo = `FAIL #${peer.ssid} reason:${reason} `
-      this.authLogger.log( peerInfo )
-    } 
+      this.authLogger.log(peerInfo)
+    }
 
-    console.log('## AUTH_FAIL reason:', reason )
+    console.log('## AUTH_FAIL reason:', reason)
     // peer.send( Buffer.from( [BohoMsg.AUTH_FAIL] ))
-    peer.setState( CLIENT_STATE.AUTH_FAIL )
-    setTimeout(e=>{
-      peer.send( Buffer.from( [BohoMsg.AUTH_FAIL] ))
-    }, serverOption.auth.delay_auth_fail )
+    peer.setState(CLIENT_STATE.AUTH_FAIL)
+    setTimeout(e => {
+      peer.send(Buffer.from([BohoMsg.AUTH_FAIL]))
+    }, serverOption.auth.delay_auth_fail)
   }
 
-  async verify_auth_hmac( auth_hmac , peer ){
+  async verify_auth_hmac(auth_hmac, peer) {
     try {
       //1. unpack 
-      let infoPack = MBP.unpack( auth_hmac , Meta.AUTH_HMAC )
-      if(!infoPack){
-        this.send_auth_fail( peer ,'unpack auth_pack fail');
+      let infoPack = MBP.unpack(auth_hmac, Meta.AUTH_HMAC)
+      if (!infoPack) {
+        this.send_auth_fail(peer, 'unpack auth_pack fail');
         return
       }
 
       let id = ""
-      if( infoPack.id8.includes(0)){
-        id = decoder.decode( infoPack.id8.subarray( 0, infoPack.id8.indexOf(0) ) );
-      }else{
-        id = decoder.decode( infoPack.id8 );
+      if (infoPack.id8.includes(0)) {
+        id = decoder.decode(infoPack.id8.subarray(0, infoPack.id8.indexOf(0)));
+      } else {
+        id = decoder.decode(infoPack.id8);
       }
 
       //2. get key of id from DB
-      let authInfo = await this.getAuth( id )
+      let authInfo = await this.getAuth(id)
 
       // console.log('##### authInfo',authInfo )
-      if(serverOption.debug.showAuthInfo ){
+      if (serverOption.debug.showAuthInfo) {
       }
-      
-      if( !authInfo ){
-        this.send_auth_fail( peer , 'NO ID:'+ id);
+
+      if (!authInfo) {
+        this.send_auth_fail(peer, 'NO ID:' + id);
         return
       }
 
       // console.log('db authInfo.key: ', authInfo.key)
-      peer.boho.copy_id8( infoPack.id8 )
+      peer.boho.copy_id8(infoPack.id8)
       // type of key
-      let authKey ;
+      let authKey;
       const SHA256_HASH_BASE64_LEN = 44
-      if( authInfo.key.length == SHA256_HASH_BASE64_LEN){
+      if (authInfo.key.length == SHA256_HASH_BASE64_LEN) {
         // hashed key
-        authKey =  Buffer.from( authInfo.key, 'base64')
-        peer.boho.copy_key( authKey )
-      }else{
+        authKey = Buffer.from(authInfo.key, 'base64')
+        peer.boho.copy_key(authKey)
+      } else {
         // plain key
-        peer.boho.set_key( authInfo.key )
+        peer.boho.set_key(authInfo.key)
       }
-      
+
       //3. check hmac
       // console.log('-- found: authKey of id: ', id, authKey.toString('hex'))
-      let auth_ack = peer.boho.check_auth_hmac( infoPack )
+      let auth_ack = peer.boho.check_auth_hmac(infoPack)
 
       // console.log('auth_ack',  auth_ack )
-      if( !auth_ack ){
-        this.send_auth_fail( peer, 'hmac dismatched' );
+      if (!auth_ack) {
+        this.send_auth_fail(peer, 'hmac dismatched');
         return
       }
 
       //4. get info
-        // console.log('#### auth success' )
+      // console.log('#### auth success' )
 
       //5. check duplicate login.
       // current policy. Deny duplicate login
@@ -95,74 +91,74 @@ export class BohoAuth{
       // 1. send clear_auth signal to the old connection. 
       // 2. close old connection.
       // 3. close new connection. retry from begining.
-      if( peer.manager.cid2remote.has( authInfo.cid  ) ){
-        let old = peer.manager.cid2remote.get(authInfo.cid )
-        if( old == peer ){
+      if (peer.manager.cid2remote.has(authInfo.cid)) {
+        let old = peer.manager.cid2remote.get(authInfo.cid)
+        if (old == peer) {
           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('### clear_auth and close old connection:', old.cid)
+        old.send(Buffer.from([IOMsg.SERVER_CLEAR_AUTH]))
+        old.close()
         peer.close()  // auto relogin
         return
       }
 
 
       //6. delete current (temp rand)cid if exist.
-      if( peer.cid ){
-        peer.manager.cid2remote.delete( peer.cid ) 
+      if (peer.cid) {
+        peer.manager.cid2remote.delete(peer.cid)
       }
 
       //7. setting info.
       peer.did = id
       peer.cid = authInfo.cid
-      peer.nick =  authInfo.cid // temporary: nick as cid
+      peer.nick = authInfo.cid // temporary: nick as cid
 
       //8. setting quota level. 
       let quotaLevel = serverOption.defaultQuotaIndex;
-      if(authInfo.level) quotaLevel = authInfo.level; 
-      quotaLevel = parseInt( quotaLevel )
-      let newQuota = quotaTable[ quotaLevel ];
-      if(!newQuota){
+      if (authInfo.level) quotaLevel = authInfo.level;
+      quotaLevel = parseInt(quotaLevel)
+      let newQuota = quotaTable[quotaLevel];
+      if (!newQuota) {
         let err = 'no index quotaTable for auth.level: ' + quotaLevel
         console.log('##AUTH:DATA ERROR##', err)
-        this.send_auth_fail( peer, err );
+        this.send_auth_fail(peer, err);
         return
-      }else{
+      } else {
         peer.level = quotaLevel;
         peer.quota = newQuota;
       }
 
-      if( peer.level === serverOption.adminLevel){
-        console.log('## LOGIN ADMIN CID:',  peer.cid )
+      if (peer.level === serverOption.adminLevel) {
+        console.log('## LOGIN ADMIN CID:', peer.cid)
         peer.isAdmin = true;
       }
       // console.log('auth: peer.quota', peer.quota )
       // send quota.level
-      peer.send( Buffer.from( [IOMsg.QUOTA_LEVEL, quotaLevel] ))
+      peer.send(Buffer.from([IOMsg.QUOTA_LEVEL, quotaLevel]))
 
       //9. set cid2remote
-      peer.manager.cid2remote.set( peer.cid , peer )
+      peer.manager.cid2remote.set(peer.cid, peer)
       // console.log( 'done: cid2remote:', peer.manager.cid2remote.keys()  )
       // console.log("LOGIN: ", `id: ${ peer.did}(${peer.cid})` )
       //10. send ack.
-      peer.send( auth_ack )
-      peer.setState( CLIENT_STATE.AUTH_READY )
-      if( this.authLogger ){
-        let peerInfo = `OK #${peer.ssid} cid: ${peer.cid} did:${ peer.did }`
-        if( peer.isAdmin ) peerInfo = "#ADMIN# "+ peerInfo
-        this.authLogger.log( peerInfo )
-      } 
+      peer.send(auth_ack)
+      peer.setState(CLIENT_STATE.AUTH_READY)
+      if (this.authLogger) {
+        let peerInfo = `OK #${peer.ssid} cid: ${peer.cid} did:${peer.did}`
+        if (peer.isAdmin) peerInfo = "#ADMIN# " + peerInfo
+        this.authLogger.log(peerInfo)
+      }
       return authInfo
     } catch (error) {
-      this.send_auth_fail( peer , 'caught: unknown error' + error );
+      this.send_auth_fail(peer, 'caught: unknown error' + error);
     }
 
   }
 
 
 
-  
+
 }
 

package/src/client/CongPacket.js

@@ -27,8 +27,8 @@ export function pack(payload) {
 
   } else if (payload.byteLength < 2 ** 24) {  // 3bytes len
     let len4Buffer = Buffer.alloc(4)
-    len4Buffer.writeUint32LE( payload.byteLength ) 
-    let cropLen3 = len4Buffer.subarray(0,3)
+    len4Buffer.writeUint32LE(payload.byteLength)
+    let cropLen3 = len4Buffer.subarray(0, 3)
     return MBP.pack(
       MBP.MB('#type', '8', CongType.TYPE_LEN3),
       MBP.MB('#payloadLen3', cropLen3),
@@ -45,12 +45,9 @@ export function pack(payload) {
 
 }
 
-// let totalCong = 0;
-
 export class CongRx extends Transform {
   constructor(options) {
     super(options)
-    // console.log('new congRx. totalCong:', ++totalCong )
     this.buffer = Buffer.alloc(0)
     this.frames = []
     this.rxi = 0;
@@ -63,7 +60,6 @@ export class CongRx extends Transform {
     this.addData(chunk)
     if (this.frames.length > 0) {
       this.frames.forEach(frame => {
-        // console.log('emit frame:', frame)
         this.push(frame)
       })
       this.frames = []
@@ -73,12 +69,11 @@ export class CongRx extends Transform {
 
 
   addData(chunk) {
-    // console.log('congpack chunk:', chunk )
     let c = chunk.byteLength;
     let i = 0;
-    while( c-- ){
+    while (c--) {
       this.rxi++
-      if( chunk[ i++ ] == 0 ){
+      if (chunk[i++] == 0) {
         this.rxi_zero++
       }
     }
@@ -88,7 +83,6 @@ export class CongRx extends Transform {
     } else {
       this.buffer = chunk
     }
-    // console.log('buffer before parse', this.buffer )
     this.parse()
   }
 
@@ -97,32 +91,29 @@ export class CongRx extends Transform {
     let head = this.buffer[0]
     let headerLen;
     let payloadSize;
-    // find header
-    // console.log('>> parser head, buffer:', head , this.buffer )
 
     if (head == CongType.TYPE_LEN1) {
-       headerLen = 2;
+      headerLen = 2;
       if (this.buffer.byteLength < headerLen) return;
-       payloadSize = this.buffer.readUint8(1)
+      payloadSize = this.buffer.readUint8(1)
 
     } else if (head == CongType.TYPE_LEN2) {
-       headerLen = 3;
+      headerLen = 3;
       if (this.buffer.byteLength < headerLen) return;
-       payloadSize = this.buffer.readUint16LE(1)
+      payloadSize = this.buffer.readUint16LE(1)
 
     } else if (head == CongType.TYPE_LEN3) {
-       headerLen = 4;
+      headerLen = 4;
       if (this.buffer.byteLength < headerLen) return;
-       payloadSize = this.buffer.readUint16LE(1) + this.buffer.readUint8(3) * 65536
+      payloadSize = this.buffer.readUint16LE(1) + this.buffer.readUint8(3) * 65536
 
     } else if (head == CongType.TYPE_LEN4) {
-       headerLen = 5;
+      headerLen = 5;
       if (this.buffer.byteLength < headerLen) return;
-       payloadSize = this.buffer.readUint32LE(1)
+      payloadSize = this.buffer.readUint32LE(1)
 
     } else {
-      // console.log('CongPacket: UNKNOWN_HEAD drop', this.buffer)
-      this.emit('wrong',this.buffer)
+      this.emit('wrong', this.buffer)
       this.buffer = Buffer.alloc(0)
     }
 
@@ -135,8 +126,8 @@ export class CongRx extends Transform {
       this.frames.push(this.buffer.subarray(headerLen, headerLen + payloadSize))
       this.buffer = this.buffer.subarray(headerLen + payloadSize)
       this.parse()
-    } else { 
-      //not ready
+    } else {
+      // not ready
       // console.log('+')
       return
     }

package/src/client/IOCongSocket.js

@@ -1,12 +1,12 @@
 import { IOCore } from "./IOCore.js"
 import { pack, CongRx } from './CongPacket.js'
-import net from'net'
+import net from 'net'
 
 
-export class IOCongSocket extends IOCore{
-  constructor( url  ) {
-    super( url );
-    if(url) this.open();
+export class IOCongSocket extends IOCore {
+  constructor(url) {
+    super(url);
+    if (url) this.open();
   }
 
   close() {
@@ -19,68 +19,61 @@ export class IOCongSocket extends IOCore{
     clearInterval(this.connectionCheckerIntervalID);
     this.connectionCheckerIntervalID = null
   }
-  
+
   keepAlive() {
     let state = this.socket?.readyState;
-    if ( !this.socket || !(state === 'open' || state === 'opening')  ) {
+    if (!this.socket || !(state === 'open' || state === 'opening')) {
       this.open();
-    } 
+    }
   }
 
 
-  createConnection(url){
+  createConnection(url) {
     // TCP Socket
-    let urlObj = new URL( url )
-    // console.log(urlObj)
-    if( urlObj.protocol != "cong:"){ 
-      urlObj = new URL( 'cong://'+ url )
+    let urlObj = new URL(url)
+    if (urlObj.protocol != "cong:") {
+      urlObj = new URL('cong://' + url)
     }
-    // console.log('congSocket url:', urlObj )
-    this.socket = net.createConnection( urlObj.port,  urlObj.hostname )
+    this.socket = net.createConnection(urlObj.port, urlObj.hostname)
     this.stateChange('opening')
 
-    this.socket.on('connect' , ()=>{
-      // console.log('cong connected' )
+    this.socket.on('connect', () => {
       this.congRx = new CongRx();
-      this.socket.pipe( this.congRx )
+      this.socket.pipe(this.congRx)
       this.congRx.on("data", this.onTCPSocketMessage.bind(this));
-      this.emit('open') 
+      this.emit('open')
     })
 
-    this.socket.on('error', e=>{ 
+    this.socket.on('error', e => {
       this.emit('error', e)
     })
 
-    this.socket.on('close', ()=>{ 
+    this.socket.on('close', () => {
       this.emit('close');
     })
 
   }
 
-  onTCPSocketMessage( data ) {
+  onTCPSocketMessage(data) {
     this.rxCounter++;
     this.rxBytes += data.byteLength
     this.lastTxRxTime = Date.now();
-    // console.log('>> congRx data.len:', data.byteLength )
-    // console.log('>> cong.rxi, rxi_zero:', this.congRx.rxi, this.congRx.rxi_zero )
-    this.emit('socket_data', data  );
-    
+    this.emit('socket_data', data);
+
   }
 
-  socket_send(data) {  
-    if( this.socket?.readyState === 'open'){
-      // console.log('tcp send raw payload:', data)
+  socket_send(data) {
+    if (this.socket?.readyState === 'open') {
       let packData = pack(data);
-      // console.log('tcp send cong packed:', packData)
-      this.socket.write( packData )
+      this.socket.write(packData)
       this.txCounter++;
       this.txBytes += packData.byteLength;
       this.lastTxRxTime = Date.now();
-    }else{
+    } else {
       console.log('.')
     }
   }
- 
+
 }
 
 

package/src/client/IOCore.js

@@ -120,7 +120,6 @@ export class IOCore extends EventEmitter {
     }
     this.useAuth = true
     let auth_pack = this.boho.auth_req()
-    // console.log('auth_req_pack', auth_pack )
     this.send(auth_pack)
   }
 
@@ -144,27 +143,21 @@ export class IOCore extends EventEmitter {
   }
 
   onData(buffer) {
-    // console.log('remote rcv socket_message', buffer )
-    //check first byte (remote message type)
     let msgType = buffer[0];
     let decoded;
 
     if (msgType === BohoMsg.ENC_488) {
       decoded = this.boho.decrypt_488(buffer)
       if (decoded) {
-        //  console.log( decoded )
         msgType = decoded[0]
         buffer = decoded
-        // console.log('DECODED MsgType:', IOMsg[ msgType ] )
       } else {
         // console.log('DEC_FAIL', buffer.byteLength)
       }
     } else if (msgType === BohoMsg.ENC_E2E) {
-      // console.log('rcv ENC_E2E' )
 
       try {
         decoded = this.boho.decrypt_488(buffer)
-        //헤더를 읽고 헤더크기만큼만 해석한다.
         if (decoded) {
           // console.log( 'ENC_E2E decoded ', decoded )
           msgType = decoded[0]
@@ -217,9 +210,9 @@ export class IOCore extends EventEmitter {
 
       case IOMsg.CID_RES:
         let cidStr = decoder.decode(buffer.subarray(1))
-        // console.log( '>> CID_RES: ' ,cidStr )
         this.cid = cidStr;
-        // change state before subscribe.
+
+        // **IMPORTANT** change state before subscribe.
         this.stateChange('ready', 'cid_ready')
         this.subscribe_memory_channels()
         break;
@@ -271,7 +264,6 @@ export class IOCore extends EventEmitter {
         try {
           let str = decoder.decode(buffer.subarray(1))
           let ss = JSON.parse(str)
-          // console.log('SERVER_SIGNAL', JSON.stringify(ss))
 
           if (ss.event && ss.data) {
             this.serverSet = ss.data;
@@ -287,7 +279,6 @@ export class IOCore extends EventEmitter {
         try {
           let setPack = MBP.unpack(buffer)
           if (setPack) {
-            // console.log('[SET] topic: ', setPack.topic)
             this.emit(setPack.topic, ...setPack.args)
           }
         } catch (error) {
@@ -312,12 +303,12 @@ export class IOCore extends EventEmitter {
           */
           switch (payloadType) {
 
-            case PAYLOAD_TYPE.EMPTY:  // 0
+            case PAYLOAD_TYPE.EMPTY:
               if (tag.indexOf('@') === 0) this.emit('@', null, tag)
               else this.emit(tag, null, tag)
               break;
 
-            case PAYLOAD_TYPE.TEXT: // 1
+            case PAYLOAD_TYPE.TEXT:
               // !! Must remove null char before decode in JS.
               // string payload contains null char for the c/cpp devices.
               let payloadStringWithoutNull = payloadBuffer.subarray(0, payloadBuffer.byteLength - 1)
@@ -326,7 +317,7 @@ export class IOCore extends EventEmitter {
               if (tag !== '@') this.emit(tag, oneString, tag)
               break;
 
-            case PAYLOAD_TYPE.BINARY: // 2
+            case PAYLOAD_TYPE.BINARY:
               if (tag.indexOf('@') === 0) this.emit('@', payloadBuffer, tag)
               if (tag !== '@') this.emit(tag, payloadBuffer, tag)
               break;
@@ -512,35 +503,26 @@ export class IOCore extends EventEmitter {
   setMsgPromise(mid) {
     return new Promise((resolve, reject) => {
       this.promiseMap.set(mid, [resolve, reject])
-      // console.log('set promise.  mid, size', mid, this.promiseMap.size)
       setTimeout(e => {
         if (this.promiseMap.has(mid)) {
           reject('timeout');
           this.promiseMap.delete(mid)
-          // console.log('promise timeout. mid, size:', mid, this.promiseMap.size)
         }
       }, this.promiseTimeOut);
     })
   }
 
   testPromise(buffer) {
-    // console.log('mbp buffer : ', buffer , buffer.byteLength)
-    // let mbp = ( buffer.byteLength > 4  ) ?  buffer.subarray(4) : ""
 
     let res = MBP.unpack(buffer)
     if (!res) return
-    // console.log( res )
-
-    // console.log(`RESPONSE_MBP  MID: ${mid} status: ${status} ,mbp: ${ buffer.subarray(4)} `)
 
     if (this.promiseMap.has(res.mid)) {
-      // console.log('res promise msg', mid)
       let [resolve, reject] = this.promiseMap.get(res.mid)
       this.promiseMap.delete(res.mid)
 
       if (res.status < 128) {
         res.ok = true;
-        // console.log( 'unpack meta:', meta)
         resolve(res)
       } else {
         res.ok = false;
@@ -611,7 +593,6 @@ export class IOCore extends EventEmitter {
 
 
   req(target, topic, ...args) {
-    // console.log('common_req args', args)
     if (!target || !topic)
       return Promise.reject(new Error('request need target and topic)'))
     let sigPack;
@@ -631,7 +612,6 @@ export class IOCore extends EventEmitter {
         MBP.MB('topic', topic)
       )
     }
-    // console.log('<< adminPack', this.mid, sigPack)
     this.send_enc_mode(sigPack)
     return this.setMsgPromise(this.mid)
   }
@@ -659,7 +639,6 @@ export class IOCore extends EventEmitter {
   subscribe_promise(tag) {
     if (typeof tag !== 'string') throw TypeError('tag should be string.')
     if (this.state !== STATES.READY) {
-      // console.log('not ready state:', this.state )
       return Promise.reject('subscribe_promise:: connection is not ready')
     }
 
@@ -678,7 +657,6 @@ export class IOCore extends EventEmitter {
   subscribe_memory_channels() { //local cache . auto_resubscribe
     if (this.channels.size == 0) return
     let chList = Array.from(this.channels).join(',')
-    // console.log('<< subscibe memory channels by cid', chList , this.cid )
 
     this.subscribe_promise(chList)
       .then((res) => {
@@ -690,11 +668,9 @@ export class IOCore extends EventEmitter {
   }
 
   unsubscribe(tag = "") {
-    // console.log('unsub', tag)
     if (typeof tag !== 'string') throw TypeError('tag should be string.')
 
-    if (tag == "") {
-      // console.log('unsub all')
+    if (tag == "") { // blank tag means unsubscribe all
       this.channels.clear();
     } else {
       let tagList = tag.split(',')
@@ -721,7 +697,6 @@ export class IOCore extends EventEmitter {
     if (tag.indexOf('@') !== 0) {
       this.channels.add(tag)
     }
-    // console.log('channels:', this.channels )
     this.on(tag, handler)
     // do not subscribe now.
     // will subscribe when receive CID_RES signal from server.
@@ -751,7 +726,6 @@ export class IOCore extends EventEmitter {
     this.linkMap.set(to, linkSet)
     this.on(tag, handler)
     this.subscribe(tag)
-    // console.log('link [to] linkMap:', to, this.linkMap )
 
   }
 
@@ -775,7 +749,6 @@ export class IOCore extends EventEmitter {
       }
     }
 
-    // console.log('unlink linkMap result:', this.linkMap )
   }
 
   unlinkAll(to) {
@@ -791,7 +764,6 @@ export class IOCore extends EventEmitter {
     }
     this.linkMap.delete(to)
 
-    // console.log('unlinkAll linkMap result:', this.linkMap )
   }
 
 
@@ -838,7 +810,6 @@ export class IOCore extends EventEmitter {
     if (emitEventAndMessage) this.emit(eventName, emitEventAndMessage)
 
     if (this.stateName !== eventName) {
-      // console.log(`state: ${this.stateName} => ${eventName}` )
       this.stateName = eventName
       this.emit('change', eventName)
     }