add read only invites

Author: supersuryaansh

README.md

@@ -83,7 +83,7 @@ Add a writer explictly.
 
 Get the local writer key.
 
-#### `inv = await pass.createInvite()`
+#### `inv = await pass.createInvite({ readOnly })`
 
 Get invite to add a writer.
 

index.js

@@ -70,14 +70,27 @@ class AutopassPairer extends ReadyResource {
 
           await this.pass.deleteInvite()
         }
+        const readOnly = JSON.parse(result.data.toString()).readOnly
         this.swarm = null
         this.store = null
-        if (this.onresolve) this._whenWritable()
+        if (this.onresolve && readOnly) {
+          this._whenReadable()
+        } else if (this.onresolve) {
+          this._whenWritable()
+        }
         this.candidate.close().catch(noop)
       }
     })
   }
 
+  _whenReadable() {
+    const check = () => {
+      this.pass.base.off('update', check)
+      this.onresolve(this.pass)
+    }
+    this.pass.base.on('update', check)
+  }
+
   _whenWritable() {
     if (this.pass.base.writable) return
     const check = () => {
@@ -238,14 +251,20 @@ class Autopass extends ReadyResource {
 
   async createInvite(opts) {
     if (this.opened === false) await this.ready()
+    const readOnly = opts?.readOnly ? true : false
     const existing = await this.base.view.findOne('@autopass/invite', {})
     if (existing) {
       if (this.member) await this.member.flushed()
       return z32.encode(existing.invite)
     }
-    const { id, invite, publicKey, expires } = BlindPairing.createInvite(this.base.key)
+    const { id, invite, publicKey, expires, additional } = BlindPairing.createInvite(
+      this.base.key,
+      {
+        data: Buffer.from(JSON.stringify({ readOnly }))
+      }
+    )
 
-    const record = { id, invite, publicKey, expires }
+    const record = { id, invite, publicKey, expires, readOnly, additional }
     await this.base.append(encode('@autopass/add-invite', record))
     if (this.member) await this.member.flushed()
     return z32.encode(record.invite)
@@ -313,11 +332,15 @@ class Autopass extends ReadyResource {
         if (inv === null || !b4a.equals(inv.id, id)) {
           return
         }
+        const readOnly = inv.readOnly
         candidate.open(inv.publicKey)
-        await this.addWriter(candidate.userData)
+        if (!readOnly) {
+          await this.addWriter(candidate.userData)
+        }
         candidate.confirm({
           key: this.base.key,
-          encryptionKey: this.base.encryptionKey
+          encryptionKey: this.base.encryptionKey,
+          additional: inv.additional
         })
         await this.deleteInvite()
       }

schema.js

@@ -62,6 +62,14 @@ template.register({
   ]
 })
 
+template.register({
+  name: 'additional-invite-data',
+  fields: [
+    { name: 'data', type: 'buffer', required: true },
+    { name: 'signature', type: 'buffer', required: true }
+  ]
+})
+
 template.register({
   name: 'invite',
   compact: false,
@@ -85,6 +93,16 @@ template.register({
       name: 'expires',
       type: 'int',
       required: true
+    },
+    {
+      name: 'readOnly',
+      type: 'bool',
+      required: true
+    },
+    {
+      name: 'additional',
+      type: '@autopass/additional-invite-data',
+      required: false
     }
   ]
 })

spec/db/db.json

@@ -7,6 +7,8 @@
       "namespace": "autopass",
       "id": 0,
       "type": 1,
+      "version": 0,
+      "versionField": null,
       "indexes": [],
       "schema": "@autopass/records",
       "derived": false,
@@ -18,6 +20,8 @@
       "namespace": "autopass",
       "id": 1,
       "type": 1,
+      "version": 0,
+      "versionField": null,
       "indexes": [],
       "schema": "@autopass/invite",
       "derived": false,
@@ -29,6 +33,8 @@
       "namespace": "autopass",
       "id": 2,
       "type": 1,
+      "version": 0,
+      "versionField": null,
       "indexes": [],
       "schema": "@autopass/mirrors",
       "derived": false,
@@ -40,6 +46,8 @@
       "namespace": "autopass",
       "id": 3,
       "type": 1,
+      "version": 0,
+      "versionField": null,
       "indexes": [],
       "schema": "@autopass/writer",
       "derived": false,
@@ -51,6 +59,8 @@
       "namespace": "autopass",
       "id": 4,
       "type": 1,
+      "version": 0,
+      "versionField": null,
       "indexes": [],
       "schema": "@autopass/delete",
       "derived": false,
@@ -62,6 +72,8 @@
       "namespace": "autopass",
       "id": 5,
       "type": 1,
+      "version": 0,
+      "versionField": null,
       "indexes": [],
       "schema": "@autopass/del-invite",
       "derived": false,
@@ -73,6 +85,8 @@
       "namespace": "autopass",
       "id": 6,
       "type": 1,
+      "version": 0,
+      "versionField": null,
       "indexes": [],
       "schema": "@autopass/del-mirror",
       "derived": false,