Merge pull request #66 from datapartyjs/secure-config

sevenbitbyte · web-flow · commit df56b7294471 · 2023-04-07T18:36:39.000-07:00
Secure config
diff --git a/examples/secure-config.js b/examples/secure-config.js
@@ -0,0 +1,135 @@
+
+const Dataparty = require('../src/index')
+
+const prompt = require('prompt')
+
+let secureConfig = null
+
+async function main(){
+    const memoryConfig = new Dataparty.Config.MemoryConfig({foo: 'bar'})
+
+
+    const jsonConfig = new Dataparty.Config.JsonFileConfig({
+        basePath: '/tmp'
+    })
+
+
+    secureConfig = new Dataparty.Config.SecureConfig({
+        config: jsonConfig
+    })
+
+    
+    secureConfig.on('locked', ()=>{ console.log('locked') })
+
+    secureConfig.on('unlocked', async ()=>{ 
+        console.log('unlocked')
+
+        await secureConfig.write('timestamp', Date.now())
+    })
+
+    secureConfig.on('timeout', ()=>{ console.log('timeout') })
+
+    secureConfig.on('ready', async ()=>{ 
+        console.log('ready')
+
+        console.log('config', await secureConfig.readAll())
+    })
+
+    let blocked = false
+
+    secureConfig.on('blocked', async (reason)=>{
+
+        if(await secureConfig.isInitialized() && secureConfig.isLocked()){
+
+            if(blocked){
+                console.log('blocked true')
+                await secureConfig.waitForUnlocked()
+                return
+            }
+
+            blocked = true
+            console.log('blocked -',reason)
+
+
+            const {password} = await prompt.get({
+                properties: {
+                    password: {
+                        message: 'Enter password',
+                        hidden: true
+                }
+            }})
+
+            await secureConfig.unlock(password)
+
+            blocked = false
+        }
+        
+    
+    })
+
+    secureConfig.on('setup-required', async ()=>{
+        
+        console.log('setup-required')
+
+        let password = ''
+
+        while(1){
+            let passes = await prompt.get({
+                properties: {
+                    password1: {
+                        message: 'Set password',
+                        hidden: true
+                    },
+                    password2: {
+                        message: 'Confim password',
+                        hidden: true
+                    }
+                }
+            })
+
+            if(passes.password1 == passes.password2){
+
+                password = passes.password1
+                break
+            }
+
+            console.log("passwords don't match")
+        }
+
+        await secureConfig.setPassword(password, {
+            foo: 'bar'
+        })
+
+        console.log('password set')
+
+
+        await secureConfig.unlock(password)
+
+    })
+
+    console.log('starting')
+
+    await secureConfig.start()
+
+    console.log('wait for startup')
+
+    await secureConfig.waitForUnlocked('startup')
+
+    console.log('wait over')
+
+    console.log('main config', await secureConfig.readAll())
+
+    let timer = setTimeout(async ()=>{
+
+
+        console.log('timer config', await secureConfig.readAll())
+
+    }, 30000)
+
+}
+
+main().catch((err)=>{
+    console.error('crashed', err)  
+}).then(()=>{
+    console.log('done')
+})
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@dataparty/api",
   "private": false,
-  "version": "1.2.21",
+  "version": "1.2.22",
   "main": "dist/dataparty.js",
   "frontend": "dist/dataparty-browser.js",
   "backend": "dist/dataparty.js",
@@ -59,7 +59,7 @@
   },
   "dependencies": {
     "@dataparty/bouncer-db": "1.0.1",
-    "@dataparty/crypto": "1.0.3",
+    "@dataparty/crypto": "^1.1.1",
     "@dataparty/tasker": "^0.0.2",
     "@diva.exchange/i2p-sam": "^4.1.8",
     "@markwylde/liferaft": "^1.3.4",
@@ -73,7 +73,6 @@
     "colors": "1.3.1",
     "cors": "^2.8.5",
     "debug": "^3.1.0",
-    "deep-set": "^1.0.1",
     "dom-storage": "^2.1.0",
     "eventemitter3": "^4.0.7",
     "express": "^4.17.1",
@@ -97,7 +96,6 @@
     "origin-router": "^1.6.4",
     "parse-url": "^5.0.1",
     "promisfy": "^1.2.0",
-    "prompt": "^1.0.0",
     "roslib": "^1.3.0",
     "sanitize-filename": "^1.6.3",
     "simple-peer": "9.7.2",
@@ -130,6 +128,7 @@
     "parcel": "^2.3.1",
     "path-browserify": "^1.0.1",
     "process": "^0.11.10",
+    "prompt": "^1.3.0",
     "punycode": "^1.4.1",
     "querystring-es3": "^0.2.1",
     "stream-browserify": "^3.0.0",
diff --git a/src/config/iconfig.js b/src/config/iconfig.js
@@ -1,17 +1,17 @@
-
+const EventEmitter = require('eventemitter3')
 
 /**
  * @interface module:Config.IConfig
  * @link module.Config
  */
-class IConfig {
-    constructor(){}
+class IConfig extends EventEmitter {
+    constructor(){super()}
     async start(){ throw 'not implemented' }
     async clear(){ throw 'not implemented' }
-    readAll(){ throw 'not implemented' }
-    read(key){ throw 'not implemented' }
+    async readAll(){ throw 'not implemented' }
+    async read(key){ throw 'not implemented' }
     async write(key, data){ throw 'not implemented' }
-    exists(key){ throw 'not implemented' }
+    async exists(key){ throw 'not implemented' }
     async save(){ throw 'not implemented' }
 }
 
diff --git a/src/config/index.js b/src/config/index.js
@@ -7,4 +7,6 @@
 exports.NconfConfig = require('./nconf')
 exports.MemoryConfig = require('./memory')
 exports.JsonFileConfig = require('./json-file')
-exports.LocalStorageConfig = require('./local-storage')
+exports.LocalStorageConfig = require('./local-storage')
+
+exports.SecureConfig = require('./secure-config')
diff --git a/src/config/json-file.js b/src/config/json-file.js
@@ -52,16 +52,16 @@ class JsonFileConfig extends IConfig {
     logger('started')
   }
 
-  clear () {
+  async clear () {
     this.content = {}
   }
 
-  readAll(){
+  async readAll(){
 
     return Object.assign({}, this.content)
   }
 
-  read(key){
+  async read(key){
     logger('reading path: ' + key)
     return reach( this.content, key)
   }
@@ -73,8 +73,8 @@ class JsonFileConfig extends IConfig {
   }
 
 
-  exists(key){
-    return (read(key) !== undefined)
+  async exists(key){
+    return (await read(key)) !== undefined
   }
 
   async save(){
diff --git a/src/config/local-storage.js b/src/config/local-storage.js
@@ -23,15 +23,15 @@ class LocalStorageConfig extends IConfig {
     this.defaults.logicalSeparator = '.'
   }
 
-  start () {
-    return Promise.resolve(this)
+  async start () {
+    return this
   }
 
-  clear () {
+  async clear () {
     localStorage.setItem(this.basePath, JSON.stringify({}))
   }
 
-  readAll(){
+  async readAll(){
     try{
       return Object.assign(
         {},
@@ -44,14 +44,14 @@ class LocalStorageConfig extends IConfig {
     }
   }
 
-  read(key){
+  async read(key){
     logger('reading path: ' + key)
-    return reach( this.readAll(), key)
+    return reach( await this.readAll(), key)
   }
 
   async write(key, value){
 
-    let data = this.readAll()
+    let data = await this.readAll()
 
     deepSet(data, key, value)
 
@@ -61,8 +61,8 @@ class LocalStorageConfig extends IConfig {
   }
 
 
-  exists(key){
-    return (read(key) !== undefined)
+  async exists(key){
+    return (await read(key)) !== undefined
   }
 
   async save(){
diff --git a/src/config/memory.js b/src/config/memory.js
@@ -21,28 +21,28 @@ class MemoryConfig extends IConfig {
     this.content = Object.assign({}, defaults)
   }
 
-  start () {
+  async start () {
     //read and merge defaults
     return this
   }
 
-  clear () {
+  async clear () {
     this.content = {}
   }
 
-  readAll(){
+  async readAll(){
 
     return Object.assign({}, this.content)
   }
 
-  read(key){
+  async read(key){
     logger('reading path: ' + key)
-    return reach( this.readAll(), key)
+    return reach( await this.readAll(), key)
   }
 
   async write(key, value){
 
-    let data = this.readAll()
+    let data = await this.readAll()
 
     deepSet(data, key, value)
 
@@ -52,8 +52,8 @@ class MemoryConfig extends IConfig {
   }
 
 
-  exists(key){
-    return (read(key) !== undefined)
+  async exists(key){
+    return (await read(key)) !== undefined
   }
 
   async save(){
diff --git a/src/config/nconf.js b/src/config/nconf.js
@@ -31,7 +31,7 @@ class NconfConfig extends IConfig {
     this.started=false
   }
 
-  start () {
+  async start () {
     if(this.started){ return Promise.resolve(this) }
 
     this.touchDir('')
@@ -66,7 +66,7 @@ class NconfConfig extends IConfig {
     return Promise.resolve(this)
   }
 
-  clear () {
+  async clear () {
     logger('clear')
     return Promise((resolve,reject)=>{
       logger('clearing')
@@ -80,12 +80,12 @@ class NconfConfig extends IConfig {
     })
   }
 
-  readAll(){
+  async readAll(){
     logger('read all')
     return nconf.get();
   }
 
-  read(key){
+  async read(key){
     logger('reading key: ' + key)
     let val = nconf.get(key)
 
@@ -104,8 +104,8 @@ class NconfConfig extends IConfig {
   }
 
 
-  exists(key){
-    return (read(key) !== undefined)
+  async exists(key){
+    return (await read(key)) !== undefined
   }
 
   async save(){
diff --git a/src/config/secure-config.js b/src/config/secure-config.js
diff --git a/src/index-browser.js b/src/index-browser.js

Original file line number	Diff line number	Diff line change
`@@ -52,16 +52,16 @@ class JsonFileConfig extends IConfig {`
`52`	`52`	`logger('started')`
`53`	`53`	`}`
`54`	`54`
`55`		`- clear () {`
	`55`	`+ async clear () {`
`56`	`56`	`this.content = {}`
`57`	`57`	`}`
`58`	`58`
`59`		`- readAll(){`
	`59`	`+ async readAll(){`
`60`	`60`
`61`	`61`	`return Object.assign({}, this.content)`
`62`	`62`	`}`
`63`	`63`
`64`		`- read(key){`
	`64`	`+ async read(key){`
`65`	`65`	`logger('reading path: ' + key)`
`66`	`66`	`return reach( this.content, key)`
`67`	`67`	`}`
`@@ -73,8 +73,8 @@ class JsonFileConfig extends IConfig {`
`73`	`73`	`}`
`74`	`74`
`75`	`75`
`76`		`- exists(key){`
`77`		`- return (read(key) !== undefined)`
	`76`	`+ async exists(key){`
	`77`	`+ return (await read(key)) !== undefined`
`78`	`78`	`}`
`79`	`79`
`80`	`80`	`async save(){`
Original file line number	Diff line number	Diff line change
`@@ -23,15 +23,15 @@ class LocalStorageConfig extends IConfig {`
`23`	`23`	`this.defaults.logicalSeparator = '.'`
`24`	`24`	`}`
`25`	`25`
`26`		`- start () {`
`27`		`- return Promise.resolve(this)`
	`26`	`+ async start () {`
	`27`	`+ return this`
`28`	`28`	`}`
`29`	`29`
`30`		`- clear () {`
	`30`	`+ async clear () {`
`31`	`31`	`localStorage.setItem(this.basePath, JSON.stringify({}))`
`32`	`32`	`}`
`33`	`33`
`34`		`- readAll(){`
	`34`	`+ async readAll(){`
`35`	`35`	`try{`
`36`	`36`	`return Object.assign(`
`37`	`37`	`{},`
`@@ -44,14 +44,14 @@ class LocalStorageConfig extends IConfig {`
`44`	`44`	`}`
`45`	`45`	`}`
`46`	`46`
`47`		`- read(key){`
	`47`	`+ async read(key){`
`48`	`48`	`logger('reading path: ' + key)`
`49`		`- return reach( this.readAll(), key)`
	`49`	`+ return reach( await this.readAll(), key)`
`50`	`50`	`}`
`51`	`51`
`52`	`52`	`async write(key, value){`
`53`	`53`
`54`		`- let data = this.readAll()`
	`54`	`+ let data = await this.readAll()`
`55`	`55`
`56`	`56`	`deepSet(data, key, value)`
`57`	`57`
`@@ -61,8 +61,8 @@ class LocalStorageConfig extends IConfig {`
`61`	`61`	`}`
`62`	`62`
`63`	`63`
`64`		`- exists(key){`
`65`		`- return (read(key) !== undefined)`
	`64`	`+ async exists(key){`
	`65`	`+ return (await read(key)) !== undefined`
`66`	`66`	`}`
`67`	`67`
`68`	`68`	`async save(){`
Original file line number	Diff line number	Diff line change
`@@ -21,28 +21,28 @@ class MemoryConfig extends IConfig {`
`21`	`21`	`this.content = Object.assign({}, defaults)`
`22`	`22`	`}`
`23`	`23`
`24`		`- start () {`
	`24`	`+ async start () {`
`25`	`25`	`//read and merge defaults`
`26`	`26`	`return this`
`27`	`27`	`}`
`28`	`28`
`29`		`- clear () {`
	`29`	`+ async clear () {`
`30`	`30`	`this.content = {}`
`31`	`31`	`}`
`32`	`32`
`33`		`- readAll(){`
	`33`	`+ async readAll(){`
`34`	`34`
`35`	`35`	`return Object.assign({}, this.content)`
`36`	`36`	`}`
`37`	`37`
`38`		`- read(key){`
	`38`	`+ async read(key){`
`39`	`39`	`logger('reading path: ' + key)`
`40`		`- return reach( this.readAll(), key)`
	`40`	`+ return reach( await this.readAll(), key)`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`async write(key, value){`
`44`	`44`
`45`		`- let data = this.readAll()`
	`45`	`+ let data = await this.readAll()`
`46`	`46`
`47`	`47`	`deepSet(data, key, value)`
`48`	`48`
`@@ -52,8 +52,8 @@ class MemoryConfig extends IConfig {`
`52`	`52`	`}`
`53`	`53`
`54`	`54`
`55`		`- exists(key){`
`56`		`- return (read(key) !== undefined)`
	`55`	`+ async exists(key){`
	`56`	`+ return (await read(key)) !== undefined`
`57`	`57`	`}`
`58`	`58`
`59`	`59`	`async save(){`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ class NconfConfig extends IConfig {`
`31`	`31`	`this.started=false`
`32`	`32`	`}`
`33`	`33`
`34`		`- start () {`
	`34`	`+ async start () {`
`35`	`35`	`if(this.started){ return Promise.resolve(this) }`
`36`	`36`
`37`	`37`	`this.touchDir('')`
`@@ -66,7 +66,7 @@ class NconfConfig extends IConfig {`
`66`	`66`	`return Promise.resolve(this)`
`67`	`67`	`}`
`68`	`68`
`69`		`- clear () {`
	`69`	`+ async clear () {`
`70`	`70`	`logger('clear')`
`71`	`71`	`return Promise((resolve,reject)=>{`
`72`	`72`	`logger('clearing')`
`@@ -80,12 +80,12 @@ class NconfConfig extends IConfig {`
`80`	`80`	`})`
`81`	`81`	`}`
`82`	`82`
`83`		`- readAll(){`
	`83`	`+ async readAll(){`
`84`	`84`	`logger('read all')`
`85`	`85`	`return nconf.get();`
`86`	`86`	`}`
`87`	`87`
`88`		`- read(key){`
	`88`	`+ async read(key){`
`89`	`89`	`logger('reading key: ' + key)`
`90`	`90`	`let val = nconf.get(key)`
`91`	`91`
`@@ -104,8 +104,8 @@ class NconfConfig extends IConfig {`
`104`	`104`	`}`
`105`	`105`
`106`	`106`
`107`		`- exists(key){`
`108`		`- return (read(key) !== undefined)`
	`107`	`+ async exists(key){`
	`108`	`+ return (await read(key)) !== undefined`
`109`	`109`	`}`
`110`	`110`
`111`	`111`	`async save(){`