iosignal 0.0.1 → 1.0.0

package/index.js

@@ -0,0 +1,19 @@
+export { IOCongSocket } from './src/client/IOCongSocket.js'
+export { IOWS as IO } from './src/client/IOWS.js'
+export { pack, CongRx } from './src/client/CongPacket.js'
+export { Server } from './src/server/Server.js'
+export { serverOption } from './src/server/serverOption.js'
+export { FileLogger } from './src/server/FileLogger.js'
+export * from './src/common/constants.js'
+
+// boho auth
+export * 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'
+
+// api
+export * as api_reply from './src/api/api_reply.js'
+export * as api_sudo from './src/api/api_sudo.js'
+export { RedisAPI } from './src/api/RedisAPI.js'

package/indexWebBrowser.js

@@ -0,0 +1,13 @@
+import { IO } from './src/client/IOWebSocket.js'
+import { Boho, RAND, MBP, BohoMsg, Meta, MetaSize , sha256, Buffer } from 'boho'
+
+Boho.RAND = RAND;
+Boho.BohoMsg = BohoMsg;
+Boho.Meta = Meta;
+Boho.MetaSize = MetaSize;
+Boho.sha256 = sha256;
+IO.Boho = Boho;
+IO.MBP = MBP;
+IO.Buffer = Buffer;
+
+export default IO;

package/package.json

@@ -1,13 +1,55 @@
 {
   "name": "iosignal",
-  "version": "0.0.1",
+  "version": "1.0.0",
   "description": "iosignal",
   "type": "module",
-  "main": "index.js",
+  "main": "./dist/iosignal.cjs",
+  "exports": {
+    "import": "./index.js",
+    "require": "./dist/iosignal.cjs"
+  },
+  "browser": "./dist/iosignal.min.js",
+  "browser_esm": "./dist/iosignal.esm.js",
+  "esm": "./dist/iosignal.mjs",
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^17.1.0",
+    "@rollup/plugin-json": "^6.0.1",
+    "@rollup/plugin-node-resolve": "^11.2.1",
+    "@rollup/plugin-replace": "^4.0.0",
+    "@rollup/plugin-terser": "^0.4.4",
+    "mocha": "^9.2.2",
+    "redis": "^4.6.12",
+    "rollup": "^2.79.1"
+  },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "build": "rollup -c",
+    "start": "node ./test-browser/server.js"
+  },
+  "engines": {
+    "node": ">=15.2.0"
+  },
+  "author": {
+    "name": "Lee Dongeun",
+    "email": "sixgen@gmail.com"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "boho": "^0.8.2",
+    "commander": "^9.5.0",
+    "eventemitter3": "^5.0.1",
+    "meta-buffer-pack": "^1.3.1",
+    "ws": "^8.16.0"
+  },
+  "optionalDependencies": {
+    "bufferutil": "^4.0.8",
+    "utf-8-validate": "^6.0.3"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/remocons/iosignal.git"
   },
-  "keywords": [],
-  "author": "Lee Dongeun",
-  "license": "MIT"
+  "homepage": "https://iosignal.net",
+  "keywords": [
+    "io","pubsub","arduino","iot","auth","signal"
+  ]
 }

package/rollup.config.js

@@ -0,0 +1,69 @@
+import replace from '@rollup/plugin-replace'
+import resolve from '@rollup/plugin-node-resolve'
+import commonjs from '@rollup/plugin-commonjs'
+import terser from '@rollup/plugin-terser'
+import json from '@rollup/plugin-json'
+import pkg from './package.json'
+
+export default [
+  {
+    input: './indexWebBrowser.js',
+    output: [
+      {
+        file: pkg.browser,
+        format: 'iife', 
+        name: 'IO',
+        sourcemap: true,
+      }
+
+    ],
+    plugins: [
+      replace({
+        crypto: '',
+        delimiters: ['import { webcrypto } from \'', '\''],
+        preventAssignment: true
+      }),
+      resolve(), 
+      commonjs() 
+      ,terser() 
+    ]
+  }
+  ,{
+    input: './src/client/IOWebSocket.js',
+    output: [
+      {
+        file: pkg.browser_esm,
+        format: 'es', // 
+        sourcemap: true,
+      }
+    ],
+    plugins: [
+      replace({
+        crypto: '',
+        delimiters: ['import { webcrypto } from \'', '\''],
+        preventAssignment: true
+      }),
+      resolve(), 
+      commonjs() 
+      ,terser() 
+    ]
+  }
+
+  ,{
+    input: './index.js',
+    output: [
+      { file: pkg.main,
+        format: 'cjs'
+      }
+    ],
+    plugins: [
+      resolve({
+        preferBuiltins: true
+      }), 
+      json(),
+      commonjs()
+      ,terser() 
+    ]
+  }
+
+]

package/src/api/RedisAPI.js

@@ -0,0 +1,68 @@
+import { STATUS } from './api_constant.js'
+
+const MIN_LEVEL = 200;
+const COMMANDS = [
+  'GET',       'SET',
+  'HGETALL',   'HGET',
+  'HSET',      'SADD',
+  'SISMEMBER', 'SMEMBERS',
+  'EXISTS',    'SREM',
+  'DEL',       'KEYS',
+  'SAVE'
+]
+
+export class RedisAPI{
+  constructor( redisClient, _minLevel ){
+    if( !redisClient ){
+      throw new Error("RedisAPI constructor: no redisClient")
+    }
+    this.redisClient = redisClient
+    this.minLevel = _minLevel ? _minLevel : MIN_LEVEL
+    this.commands = COMMANDS
+  }
+
+
+  checkPermission(remote ,req){
+    console.log('checkPermission', remote.level , 'vs', this.minLevel  )
+    if( remote.level >= this.minLevel ){
+      return true
+    }else{
+      return false
+    }
+  }
+
+
+  async request(remote, req ){
+
+    let result;
+    let status = STATUS.OK; // *0~127: ok ,  128~*255 :error
+    try {
+      // console.log(req)
+      let cmd = req.topic
+      cmd = cmd.toUpperCase()
+      if( COMMANDS.includes(cmd)){
+        console.log('RedisAPI call:', cmd, req.args)
+
+        if( req.args.length > 0 ){
+          result = await this.redisClient[cmd]( ...req.args )
+        }else{
+          result = await this.redisClient[cmd]()
+        }
+
+        // console.log('RedisAPI: result:', result)
+
+      }else{
+        // result = 'RedisAPI: no such a cmd '+ cmd;
+        status = STATUS.ERROR;
+      }
+      remote.response( req.mid, status , result)
+    } catch (e) {
+      remote.response( req.mid, STATUS.ERROR ,e.message )
+    }
+
+  }
+
+}
+
+  
+  

package/src/api/api_constant.js

@@ -0,0 +1,7 @@
+
+export const STATUS = {
+  OK: 0,
+  //0~127: success
+  //128~255: fail
+  ERROR: 255
+}

package/src/api/api_reply.js

@@ -0,0 +1,34 @@
+
+
+import { STATUS } from './api_constant.js'
+
+const MIN_LEVEL = 0;
+
+export function checkPermission(remote){
+  if( remote.level >= MIN_LEVEL ){
+    return true
+  }else{
+    return false
+  }
+}
+
+export async function echo( remote , req)
+{
+  if( !req.args)
+    remote.response( req.mid, STATUS.ERROR , 'no message to echo' )
+  else
+    remote.response( req.mid, STATUS.OK , req.args )
+}
+
+export async function date( remote , req)
+{
+  let r = new Date().toUTCString()
+  remote.response( req.mid, STATUS.OK , r)
+}
+
+export async function unixtime( remote , req)
+{
+  let r = Math.floor( Date.now() /1000)
+  remote.response( req.mid, STATUS.OK , r)
+}
+

package/src/api/api_sudo.js

@@ -0,0 +1,96 @@
+import { STATUS } from './api_constant.js'
+
+const MIN_LEVEL = 255;
+
+export const commands = [
+  'cid','remotes','clients',
+  'channels','subscribers',
+  'remote', 'client', 'close',
+  'addauth' , 'getauth' ,'delauth',
+  'getauthidlist', 'getdevicelist',
+  'adddevice' ,'getdevice','deldevice' 
+]
+
+
+export function checkPermission(remote){
+  if( remote.level >= MIN_LEVEL ){
+    return true
+  }else{
+    return false 
+  }
+}
+
+export async function request( remote, req) {
+    // console.log(req )
+    let result;
+    let status = 0;
+    try {
+      let cmd = req.topic;
+      cmd = cmd.toLowerCase()
+      if (cmd == 'cid') {
+        result = remote.manager.metric.getCIdList()
+      } else if (cmd == 'remotes' || cmd == 'clients') {
+        result = remote.manager.metric.getRemotes()
+      } else if (cmd == 'channels') {
+        result = remote.manager.metric.getChannelList()
+      } else if (cmd == 'subscribers') {
+        let ch = req.$[0]
+        if (ch) result = remote.manager.metric.getSubscribers(ch)
+      } else if (cmd == 'remote' || cmd == 'client') {
+        let cid = req.$[0]
+        let mode = req.$[1]
+        if (cid) result = remote.manager.metric.getRemoteByCId(cid, mode)
+  
+      } else if (cmd == 'close') {
+        if (req.$[0]) result = remote.manager.closeRemoteByCId(req.$[0])
+  
+      } else if (cmd == 'addauth' || cmd == 'adddevice') {
+        // console.log('## api_sudo: addauth ', remote.manager.authManager , req.$.length)
+        if (remote.manager.authManager && req.$.length == 4) {
+          if (remote.manager.authManager.addAuth) {
+            let did = req.$[0]
+            let dkey = req.$[1]
+            let cid = req.$[2]
+            let level = req.$[3]
+            // console.log('###### did,dkey,cid,level: ', did,dkey,cid,level)
+            result = await remote.manager.authManager.addAuth(did, dkey, cid, level)
+          }
+  
+        }
+      } else if (cmd == 'delauth' || cmd == 'deldevice') {
+        if (remote.manager.authManager && req.$.length == 1) {
+          if (remote.manager.authManager.delAuth) {
+            let did = req.$[0]
+            result = await remote.manager.authManager.delAuth(did)
+          }
+        }
+      } else if (cmd == 'getauth' || cmd == 'getdevice') {
+        if (remote.manager.authManager && req.$.length == 1) {
+          if (remote.manager.authManager.getAuth) {
+            let did = req.$[0]
+            result = await remote.manager.authManager.getAuth(did)
+          }
+        }
+      } else if (cmd == 'getauthidlist' || cmd == 'getdevicelist') {
+        if (remote.manager.authManager ) {
+          if (remote.manager.authManager.getAuthIdList ) {
+            result = await remote.manager.authManager.getAuthIdList()
+          }
+        }
+      } else{
+        status = STATUS.ERROR;
+        result = "api sudo: no such a cmd: " + cmd
+      }
+  
+      // console.log('req_sudo: result', result)
+      remote.response(req.mid, status, result)
+  
+    } catch (e) {
+      // console.log('req_sudo err:',e.message)
+      remote.response(req.mid, STATUS.ERROR , e.message )
+    }
+  
+  }
+
+
+

package/src/auth/Auth_Env.js

@@ -0,0 +1,78 @@
+/**
+ * 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 { sha256 } 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)
+
+        // console.log('typeof level', level, typeof 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(sha256.hash(keyStr)).toString('base64')
+    this.AUTH.set(id, { key: Base64hashKey, cid: cid, level: level })
+  }
+
+}
+

package/src/auth/Auth_File.js

@@ -0,0 +1,75 @@
+/**
+ * Auth_File
+ */
+import { BohoAuth } from './BohoAuth.js';
+import { readFileSync } from 'fs'
+import { sha256 } from 'boho'
+import path from 'path'
+
+export class Auth_File extends BohoAuth{
+  constructor( _path ){
+    super()
+    this.AUTH = new Map();
+    let pathObj = path.parse(_path)
+    this.path = path.resolve(_path)
+    console.log('auth from file path:', this.path )
+    let ext = pathObj.ext;
+    if( ext.toLowerCase() == '.js' || ext.toLowerCase() == '.mjs'){
+      // Read auth data from file
+      console.log( "#JS path:", this.path ); 
+      this.loadAuthInfoFile_JS( this.path)
+    }else if( ext.toLowerCase() == '.json') {
+      console.log( "#JSON path:", this.path ); 
+      this.loadAuthInfoFile_JSON(this.path)
+    }else{
+      console.log('no authinfofile path.')
+    }
+  }
+
+
+  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 )
+      })
+      console.log('total AUTH INFO size: ', this.AUTH.size  )
+    }).catch(e=>{
+      console.log(e)
+    })
+
+
+  }
+
+   loadAuthInfoFile_JSON(path){ 
+    let file = readFileSync( path )
+    file = new TextDecoder().decode( file )
+    // console.log(file )
+    let list = JSON.parse( file )
+    list.forEach( item =>{
+      this.addAuth(...item )
+    })
+    console.log('total AUTH INFO size: ', this.AUTH.size  )
+
+  }
+
+  addAuth( id, keyStr , cid , level = 0){
+    let Base64hashKey = Buffer.from( sha256.hash(keyStr)).toString('base64')
+    this.AUTH.set( id, { key: Base64hashKey, cid: cid, level: level } )
+  }
+
+
+
+}
+

package/src/auth/Auth_Redis.js

@@ -0,0 +1,50 @@
+
+/**
+ * Auth_Redis
+ */
+import { BohoAuth } from './BohoAuth.js';
+import { sha256 } from 'boho'
+const DEVICE_PREFIX = "device:"
+
+export class Auth_Redis extends BohoAuth{
+  constructor( redisClient ){
+    super()
+    if( !redisClient ){
+      throw new Error("AuthRedis constructor: no redisClient")
+    }
+    this.redis = redisClient
+  }
+
+  // get device key from DB. (for Boho auth.)
+  async getAuth( id ){
+    let result = await this.redis.hGetAll(DEVICE_PREFIX + id)
+    // console.log('Auth_Redis: getAuth req id result',id, result)
+    if(result.key) return result
+  }
+
+
+  async getAuthIdList() {
+    let result = await this.redis.keys( DEVICE_PREFIX + '*')
+    result = result.map( v=> {
+      return v.split(':')[1]
+    })
+    if(result) return result
+  }
+
+// add device auth info
+  async addAuth( id, keyStr , cid = '', level = 0){
+    // console.log('addAuth', id, keyStr, cid, level)
+    let Base64hashKey = Buffer.from( sha256.hash( keyStr)).toString('base64')
+    return this.redis.hSet( DEVICE_PREFIX + id, {'key': Base64hashKey, 'cid': cid ,'level': level} )
+  }
+
+  async delAuth( id ){
+    return this.redis.del( DEVICE_PREFIX + id )
+  }
+
+  async save( id ){
+    return this.redis.save()
+  }
+
+}
+