iosignal 0.0.1 → 1.0.0

package/src/client/IOWS.js

@@ -0,0 +1,81 @@
+import { IOCore } from "./IOCore.js";
+import { WebSocket } from "ws";
+
+//  Node.js 'ws' websocket
+export class IOWS extends IOCore{
+  constructor(url  ) {
+    super(url);
+    if(url) this.open();
+  }
+
+  
+
+  close() {
+    if(this.socket ){
+      this.socket.onclose = null
+      this.socket.onmessage = null
+      this.socket.onerror = null
+      this.socket.close();
+      this.socket = null;
+    }
+    this.emit('close')
+  }
+
+
+
+  stop() {
+    this.close()
+    clearInterval(this.connectionCheckerIntervalID);
+    this.connectionCheckerIntervalID = null
+  }
+  
+  keepAlive() {
+    if ( !this.socket || this.socket?.readyState === 3 ) { //closed
+      this.open();
+    }
+  }
+
+
+  createConnection(url){
+    // node WebSocket
+    this.socket = new WebSocket ( url );
+    this.stateChange('opening')
+
+    this.socket.onopen = () => {
+      this.socket.on('message', this.onWebSocketMessage.bind(this) );
+      this.emit('open' );
+    };
+
+    this.socket.onerror = (e)=>{ 
+      this.emit('error', e)
+    }
+
+    this.socket.onclose = ()=>{ 
+      this.emit('close' );
+    }
+  }
+
+  onWebSocketMessage( data  ) {
+    this.rxCounter++;
+    this.lastTxRxTime = Date.now();
+    this.rxBytes += data.byteLength
+    this.emit('socket_data', data  );
+  }
+
+  socket_send(data) {  
+    if( this.socket?.readyState === 1 ){ //open
+      // console.log('websocket send', data)
+      this.socket.send( data )
+      this.txCounter++;
+      this.txBytes += data.byteLength
+      this.lastTxRxTime = Date.now();
+    }else{
+      console.log('')
+    }
+  }
+ 
+}
+
+
+
+

package/src/client/IOWebSocket.js

@@ -0,0 +1,96 @@
+import { IOCore } from "./IOCore.js";
+import { Buffer } from 'meta-buffer-pack'
+export { Boho, RAND, BohoMsg, Meta, MetaSize , sha256, MBP, Buffer } from 'boho'
+export * from '../common/constants.js'
+
+// Browser WebSocket
+export class IO extends IOCore{
+  constructor(url  ) {
+    super(url);
+    document.addEventListener('visibilitychange', this.browserVisiblePing.bind(this));
+    if(url) this.open();
+  }
+
+  browserVisiblePing(){
+    if (document.visibilityState === 'visible') {
+      console.log('[Remote connection check] visibilityState is visible.')
+      this.ping()
+    }
+  }
+
+  
+  close() {
+    if(this.socket ){
+      this.socket.onclose = null
+      this.socket.onmessage = null
+      this.socket.onerror = null
+      this.socket.close();
+      this.socket = null;
+    }
+    this.emit('close')
+  }
+
+
+  stop(){
+    this.close()
+    clearInterval(this.connectionCheckerIntervalID);
+    this.connectionCheckerIntervalID = null
+  } 
+  
+  
+  keepAlive() {
+    if ( !this.socket || this.socket?.readyState === 3 ) { //closed
+      this.open();
+    }
+  }
+
+  createConnection(url){
+    // Web Browser WebSocket
+    this.socket = new WebSocket (url );
+    this.stateChange('opening')
+
+    this.socket.binaryType = "arraybuffer"
+    this.socket.onopen = () => {
+      this.socket.onmessage = this.onWebSocketMessage.bind(this) ;
+      this.emit('open' );
+    };
+
+    this.socket.onerror = (e)=>{ 
+      this.emit('error', e)
+    }
+
+    this.socket.onclose = ()=>{ 
+      this.emit('close' );
+    }
+  }
+
+  onWebSocketMessage( event ) {
+    this.rxCounter++;
+    this.lastTxRxTime = Date.now();
+    let buffer;
+
+    // if( event.data instanceof ArrayBuffer ){
+    //   //binary frame
+    // }else{
+    //   //text frame
+    // }
+    buffer = Buffer.from( event.data )
+    this.rxBytes += buffer.byteLength
+
+    this.emit('socket_data', buffer  );
+  }
+
+  socket_send(data) {  
+    if( this.socket?.readyState === 1 ){ //open
+      // console.log('websocket send', data)
+      this.socket.send( data )
+      this.txCounter++;
+      this.txBytes += data.byteLength
+      this.lastTxRxTime = Date.now();
+    }else{
+      console.log('.')
+    }
+  }
+ 
+}
+

package/src/common/constants.js

@@ -0,0 +1,159 @@
+
+// IOclient state
+export const STATES = {
+  OPENING: 0,
+  OPEN: 1,
+  CLOSING: 2,
+  CLOSED: 3,
+  SERVER_READY: 4,
+  AUTH_FAIL: 5,
+  AUTH_READY: 6,
+  READY: 7,
+  REDIRECTING: 8
+}
+for (let c in STATES) { STATES[STATES[c]] = c }
+
+// server side client state
+export const CLIENT_STATE = {
+  INIT: 0,
+  SENT_SERVER_READY: 1,
+  RECV_AUTH_REQ: 2,
+  SENT_SERVER_NONCE: 3,
+  RECV_AUTH_HMAC: 4,
+  AUTH_FAIL: 5,
+  AUTH_READY: 6,
+  CID_READY: 7
+}
+for (let c in CLIENT_STATE) { CLIENT_STATE[CLIENT_STATE[c]] = c }
+
+export let ENC_MODE = {
+  NO: 0,
+  YES: 1,
+  AUTO: 2
+}
+
+for (let c in ENC_MODE) { ENC_MODE[ENC_MODE[c]] = c }
+
+
+export const SIZE_LIMIT = {
+  TAG_LEN1: 255,
+  TAG_LEN2: 65535,
+  CONNECTION_CHECKER_PERIOD: 3000,
+  PROMISE_TIMEOUT: 5000,
+  DID: 8,
+  CID: 12
+}
+
+export let PAYLOAD_TYPE = {
+  EMPTY: 0, 
+  TEXT: 1,
+  BINARY: 2, 
+  OBJECT: 3, // one stringify able object. no buffer.
+  MJSON: 4, // multiple stringify able obejct.  JSON string. with top levle array , no buffer
+  MBA: 5  // "meta_buffer_arguments" arbitary types.  buffer included.
+}
+for (let c in PAYLOAD_TYPE) { PAYLOAD_TYPE[PAYLOAD_TYPE[c]] = c }
+// console.log( PAYLOAD_TYPE )
+
+// MJSON: multiple arguments 
+// accepet only string, number, root depth js primittive object, 
+// unpack and will send to receiver handler with multiple params.
+
+// MBA: buffer pack of multiple arguments.  check "meta-buffer-pack" module. 
+// MBA: when armuents includes raw Buffer( TypedArray )
+
+// IO message pack one byte header. 
+export let IOMsg = {
+
+  /* 
+  * 0~127dec.  reserved. for text stream.
+  * 0~31: control code
+  * 32~126: ascii charactor
+  * 127: DEL
+  */
+  
+  // ADMIN_REQ: 0xA0,
+
+  // DO NOT USE: 0xB0~ 0xBF
+  // Boho module using this numbers.
+  // AUTH_REQ : 0xB0,  
+  // AUTH_NONCE: 0xB1,
+  // AUTH_HMAC: 0xB2,
+  // AUTH_ACK: 0xB3,
+  // AUTH_FAIL: 0xB4,
+  // AUTH_EXT: 0xB5,
+  // ENC_PACK : 0xB6,  
+  // ENC_E2E : 0xB7,  
+  // ENC_488 : 0xB8
+  // reserved ~0xBF
+
+  // C. IO status contorl.
+  SERVER_READY: 0xC0,
+  CID_REQ: 0xC1, 
+  CID_RES: 0xC2,  
+  QUOTA_LEVEL: 0xC3,
+  SERVER_CLEAR_AUTH: 0xC4, 
+  SERVER_REDIRECT: 0xC5,
+
+  // ..
+  LOOP: 0xCB,
+  ECHO: 0xCC,
+  PING: 0xCD,  
+  PONG: 0xCE,
+  CLOSE: 0xCF,
+  // ~CF
+
+
+  // D. IO data signaling
+  SIGNAL: 0xD0,  
+  SIGNAL_REQ: 0xD1, 
+  SIGNAL_E2E: 0xD2, 
+  SUBSCRIBE: 0xD3,
+  SUBSCRIBE_REQ: 0xD4, 
+  UNSUBSCRIBE: 0xD5, 
+  SERVER_SIGNAL: 0xD6, 
+
+  // ..
+  IAM: 0xD9,
+  IAM_RES: 0xDA,
+  
+  //.. 
+  SET: 0xDB,   //
+  RESPONSE_CODE: 0xDC,   
+  RESPONSE_MBP: 0xDD,   
+
+  REQUEST: 0xDE, //client public
+  RESPONSE: 0xDF,
+  // ~DF
+
+
+  // F. Framing Flow control related framing protocol.(CongPacket)
+  FLOW_MODE: 0xF0,
+  WAIT: 0xF1,
+  RESUME: 0xF2,
+  //..
+  TIME_OUT: 0xFD,
+  OVER_SIZE: 0xFE,
+  OVER_FLOW: 0xFF
+
+}
+
+for (let c in IOMsg) { IOMsg[IOMsg[c]] = c }
+
+// console.log( IOMsg );
+
+
+export const API_TYPE = {
+  'REQUEST_RESPONSE': 'requet_response',
+  'ONE_WAY': 'one_way'
+}
+
+
+
+// api response status code
+export const STATUS = {
+  OK: 0,
+  //0~127: success
+  //128~255: fail
+  ERROR: 255
+}

package/src/common/quotaTable.js

@@ -0,0 +1,61 @@
+// table index related with:
+// - AUTH database level
+// - serverOption.defaultQuotaIndex
+
+// quota example
+// index range: 0~255.
+export let quotaTable = {
+  // CongSocket
+  0: { // default. anonymouse:
+    signalSize: 1500,
+    publishCounter: 10,
+    trafficRate: 10000
+  },
+  1: { // auth_ultralight:  eg. Arduino Uno.
+    signalSize: 255,
+    publishCounter: 10,
+    trafficRate: 100000
+  },
+  2: { // auth_light:  eg. authorized ESP.
+    signalSize: 65535,
+    publishCounter: 10,
+    trafficRate: 1048576
+  },
+
+  // WebSocket (browser and node app)
+  3: { // authorized basic.
+    signalSize: 1048576,  
+    publishCounter: 10,
+    trafficRate: 1048576 * 20
+  },
+
+  // WebSocket (browser and node app)
+  10: { //  anonymouse
+    signalSize: 1500,  
+    publishCounter: 5,
+    trafficRate: 1048576 * 20
+  },
+
+  11: { // authorized basic.
+    signalSize: 65535,  
+    publishCounter: 10,
+    trafficRate: 1048576 * 20
+  },
+  
+  12: { // authorized power.
+    signalSize: 1048576,  
+    publishCounter: 100,
+    trafficRate: 1048576 * 20
+  },
+  
+  // you can add your custom quota level.
+
+  // super admin or root user.
+  // to monitor, metric, sudo command, db acess
+  255: { 
+    signalSize: 1048576 * 20,
+    publishCounter: 10000,
+    trafficRate: 1048576 * 100
+  }
+}
+

package/src/common/util.js

@@ -0,0 +1,61 @@
+import { networkInterfaces } from 'os';
+
+export function isPrivateIP(ip){
+  if(ip.indexOf("0.0.0.0") === 0) return  true 
+  if(ip.indexOf("127.0.0.1") === 0) return  true 
+  if(ip.indexOf("192.168.") === 0) return  true 
+  if(ip.indexOf("10.") === 0) return  true 
+  if(ip.indexOf("172.") === 0){
+    if(ip.indexOf("172.16.") === 0) return  true 
+    if(ip.indexOf("172.17.") === 0) return  true 
+    if(ip.indexOf("172.18.") === 0) return  true 
+    if(ip.indexOf("172.19.") === 0) return  true 
+    if(ip.indexOf("172.20.") === 0) return  true 
+    if(ip.indexOf("172.21.") === 0) return  true 
+    if(ip.indexOf("172.22.") === 0) return  true 
+    if(ip.indexOf("172.23.") === 0) return  true 
+    if(ip.indexOf("172.24.") === 0) return  true 
+    if(ip.indexOf("172.25.") === 0) return  true 
+    if(ip.indexOf("172.26.") === 0) return  true 
+    if(ip.indexOf("172.27.") === 0) return  true 
+    if(ip.indexOf("172.28.") === 0) return  true 
+    if(ip.indexOf("172.29.") === 0) return  true 
+    if(ip.indexOf("172.30.") === 0) return  true 
+    if(ip.indexOf("172.31.") === 0) return  true 
+  }
+
+  return false
+}
+
+export function numberWithCommas (x) {
+  return x.toString().replace(/\B(?=(\d{3})+(?!\d))/g, ',')
+}
+
+export function getIPv4HexString(ipStr){
+  let ipv4 = ipStr.split('.')
+  return Buffer.from(ipv4).toString('hex')
+}
+
+export function getLocalAddress(){
+  const nets = networkInterfaces();
+  // console.log(nets)
+  const results = Object.create(null); // Or just '{}', an empty object
+  let localAddress =''
+  for (const name of Object.keys(nets)) {
+      for (const net of nets[name]) {
+          // Skip over non-IPv4 and internal (i.e. 127.0.0.1) addresses
+          // 'IPv4' is in Node <= 17, from 18 it's a number 4 or 6
+          const familyV4Value = typeof net.family === 'string' ? 'IPv4' : 4
+          if (net.family === familyV4Value && !net.internal) {
+              if (!results[name]) {
+                  results[name] = [];
+              }
+              results[name].push(net.address);
+              localAddress = net.address
+          }
+      }
+  }
+  
+  // console.log('localAddress:', localAddress)
+  return localAddress
+}

package/src/server/FileLogger.js

@@ -0,0 +1,30 @@
+import fs from 'fs'
+
+const formatter = new Intl.DateTimeFormat('ko-KR', {
+  // hour12: true,
+  // hour: 'numeric',
+  // minute: '2-digit',
+  // second: '2-digit'
+  year: 'numeric', month: 'numeric', day: 'numeric',
+  hour: 'numeric', minute: 'numeric', 
+  hour12: false,
+  timeZone: 'Asia/Seoul'
+});
+
+
+export class FileLogger{
+  constructor(path ){
+    this.file = fs.openSync(path ,'a+')
+    console.log('new logFile', path, this.file )
+  }
+  
+  log(msg){
+    let format =formatter.format(new Date()) + " "+ msg +'\n';
+    fs.write( this.file, format , (err) => {
+      if (err) throw err;
+    })
+
+  }
+
+
+}