autopass 1.0.0

package/.github/workflows/test-node.yml

@@ -0,0 +1,23 @@
+name: Build Status
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+jobs:
+  build:
+    strategy:
+      matrix:
+        node-version: [lts/*]
+        os: [ubuntu-latest, macos-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v3
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: npm install
+    - run: npm test

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,13 @@
+Copyright 2024 Holepunch Inc 
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,109 @@
+# autopass
+
+Distributed notes/password manager
+
+``` sh
+npm install autopass
+```
+
+## Usage
+
+First choose if you wanna pair or make a new instance.
+
+``` js
+import Autopass from 'autopass'
+import Corestore from 'corestore'
+
+const pass = new Autopass(new Corestore('./pass'))
+
+const inv = await pass.createInvite()
+console.log('share to add', inv)
+```
+
+Then invite another instance
+
+``` js
+const pair = Autopass.pair(new Corestore('./another-pass'), inv)
+
+const anotherPass = await pair.finished()
+await anotherPass.ready()
+```
+
+When paired you can simply start the instance again with the normal constructor.
+
+``` js
+await pass.add('a-note', 'hello this is a note')
+```
+
+Then on the other node you get it out with
+
+``` js
+const note = await pass.get('a-note')
+console.log({ note })
+```
+
+## API
+
+#### `pass = new Autopass(new Corestore(path))`
+
+Make a new pass instance.
+
+#### `pass.on('update', fn)`
+
+Triggered when it updates, ie something added/removed an entry
+
+#### `value = await pass.get(key)`
+
+Get an entry.
+
+#### `stream = pass.list()`
+
+Get all entries.
+
+#### `await pass.add(key, value)`
+
+Add new entry
+
+#### `await pass.remove(key)`
+
+Remove an entry.
+
+#### `await pass.removeWriter(writerKey)`
+
+Remove a writer explictly.
+
+#### `await pass.addWriter(writerKey)`
+
+Add a writer explictly.
+
+#### `pass.writerKey`
+
+Get the local writer key.
+
+#### `inv = await pass.createInvite()`
+
+Get invite to add a writer.
+
+#### `await pass.ready()`
+
+Wait for the pass to load fully
+
+#### `pair = Autopass.pair(new Corestore(path), invite)`
+
+Pair with another instance.
+
+#### `pass = await pair.finished()`
+
+Wait for the pair to finish.
+
+#### `await pair.close()`
+
+Force close the pair instance. Only need to call this if you dont wait for it to finish.get
+
+#### `await pass.close()`
+
+Fully close the pass instance.
+
+## Contributors
+
+Written with big contributions from [@supersu](https://github.com/supersuryaansh)

package/index.js

@@ -0,0 +1,293 @@
+// the js module powering the mobile and desktop app
+
+const Autobase = require('autobase')
+const BlindPairing = require('blind-pairing')
+const Hyperbee = require('hyperbee')
+const Hyperswarm = require('hyperswarm')
+const ReadyResource = require('ready-resource')
+const z32 = require('z32')
+const b4a = require('b4a')
+
+class AutopassPairer extends ReadyResource {
+  constructor (store, invite, opts) {
+    super()
+
+    this.store = store
+    this.invite = invite
+    this.swarm = null
+    this.pairing = null
+    this.candidate = null
+    this.bootstrap = opts.bootstrap || null
+    this.onresolve = null
+    this.onreject = null
+    this.pass = null
+
+    this.ready().catch(noop)
+  }
+
+  async _open () {
+    await this.store.ready()
+
+    this.swarm = new Hyperswarm({
+      keyPair: await this.store.createKeyPair('hyperswarm'),
+      bootstrap: this.bootstrap
+    })
+
+    this.swarm.on('connection', (connection, peerInfo) => {
+      this.store.replicate(connection)
+    })
+
+    this.pairing = new BlindPairing(this.swarm)
+
+    const core = Autobase.getLocalCore(this.store)
+    await core.ready()
+    const key = core.key
+    await core.close()
+
+    this.candidate = this.pairing.addCandidate({
+      invite: z32.decode(this.invite),
+      userData: key,
+      onadd: async (result) => {
+        if (this.pass === null) {
+          this.pass = new Autopass(this.store, {
+            swarm: this.swarm,
+            key: result.key,
+            encryptionKey: result.encryptionKey,
+            bootstrap: this.bootstrap
+          })
+        }
+        this.swarm = null
+        this.store = null
+        if (this.onresolve) this.onresolve(this.pass)
+        this.candidate.close().catch(noop)
+      }
+    })
+  }
+
+  async _close () {
+    if (this.candidate !== null) {
+      await this.candidate.close()
+    }
+
+    if (this.swarm !== null) {
+      await this.swarm.destroy()
+    }
+
+    if (this.store !== null) {
+      await this.store.close()
+    }
+
+    if (this.onreject) {
+      this.onreject(new Error('Pairing closed'))
+    } else if (this.base) {
+      await this.base.close()
+    }
+  }
+
+  finished () {
+    return new Promise((resolve, reject) => {
+      this.onresolve = resolve
+      this.onreject = reject
+    })
+  }
+}
+
+class Autopass extends ReadyResource {
+  constructor (corestore, opts = {}) {
+    super()
+
+    this.store = corestore
+    this.swarm = opts.swarm || null
+    this.base = null
+    this.bootstrap = opts.bootstrap || null
+    this.member = null
+    this.pairing = null
+    this.replicate = opts.replicate !== false
+    this.debug = !!opts.key
+
+    this._boot(opts)
+    this.ready().catch(noop)
+  }
+
+  // Initialize autobase
+  _boot (opts = {}) {
+    const { encryptionKey, key } = opts
+
+    this.base = new Autobase(this.store, key, {
+      encrypt: true,
+      encryptionKey,
+      valueEncoding: 'json',
+      open (store) {
+        return new Hyperbee(store.get('view'), {
+          extension: false,
+          keyEncoding: 'utf-8',
+          valueEncoding: 'json'
+        })
+      },
+      // New data blocks will be added using the apply function
+      async apply (nodes, view, base) {
+        for (const node of nodes) {
+          const op = node.value
+
+          // Add support for adding other peers as a writer to the base
+          if (op.type === 'addWriter') {
+            await base.addWriter(z32.decode(op.key))
+          } else if (op.type === 'removeWriter') {
+            await base.removeWriter(z32.decode(op.key))
+          } else if (op.type === 'addRecord') {
+            // This adds a new record
+            await view.put(op.key, op.value)
+          } else if (op.type === 'removeRecord') {
+            // Remove an existing record
+            await view.del(op.key)
+          }
+        }
+      }
+    })
+
+    this.base.on('update', () => this.emit('update'))
+  }
+
+  async _open () {
+    await this.base.ready()
+    if (this.replicate) await this._replicate()
+  }
+
+  // Close the base
+  async _close () {
+    if (this.swarm) {
+      await this.member.close()
+      await this.pairing.close()
+      await this.swarm.destroy()
+    }
+    await this.base.close()
+  }
+
+  // Need this key to become a writer
+  get writerKey () {
+    return this.base.local.key
+  }
+
+  // Return bootstrap key of the base
+  // This is what other peers should use to bootstrap the base from
+  get key () {
+    return this.base.key
+  }
+
+  // Find peers in Hyperswarm using this
+  get discoveryKey () {
+    return this.base.discoveryKey
+  }
+
+  // Encryption key for the base
+  get encryptionKey () {
+    return this.base.encryptionKey
+  }
+
+  static pair (store, invite, opts) {
+    return new AutopassPairer(store, invite, opts)
+  }
+
+  async createInvite (opts) {
+    if (this.opened === false) await this.ready()
+    const existing = await this.get('autopass/invite')
+    if (existing) return existing.invite
+    const { id, invite, publicKey, expires } = BlindPairing.createInvite(this.base.key)
+    const record = { id: z32.encode(id), invite: z32.encode(invite), publicKey: z32.encode(publicKey), expires }
+    await this.add('autopass/invite', record)
+    return record.invite
+  }
+
+  // Get data of all indexes in the base
+  list (opts) {
+    return this.base.view.createReadStream(opts)
+  }
+
+  // Get data stored in a specific key
+  async get (key) {
+    const node = await this.base.view.get(key)
+    if (node === null) return null
+    return node.value
+  }
+
+  // Add a peer as a writer
+  async addWriter (key) {
+    await this.base.append({
+      type: 'addWriter',
+      key: b4a.isBuffer(key) ? z32.encode(key) : key
+    })
+
+    return true
+  }
+
+  // To later add removeWriter
+  async removeWriter (key) {
+    await this.base.append({
+      type: 'removeWriter',
+      key: b4a.isBuffer(key) ? z32.encode(key) : key
+    })
+  }
+
+  // Check if the base is writable
+  get writable () {
+    return this.base.writable
+  }
+
+  // Start Replicating the base across peers
+  async _replicate () {
+    if (this.swarm === null) {
+      this.swarm = new Hyperswarm({
+        keyPair: await this.store.createKeyPair('hyperswarm'),
+        bootstrap: this.bootstrap
+      })
+
+      this.swarm.on('connection', (connection, peerInfo) => {
+        this.store.replicate(connection)
+      })
+    }
+    this.pairing = new BlindPairing(this.swarm)
+
+    this.member = this.pairing.addMember({
+      discoveryKey: this.base.discoveryKey,
+      onadd: async (candidate) => {
+        const id = z32.encode(candidate.inviteId)
+        const inv = await this.get('autopass/invite')
+
+        if (inv.id !== id) return
+
+        candidate.open(z32.decode(inv.publicKey))
+
+        await this.addWriter(candidate.userData)
+
+        candidate.confirm({
+          key: this.base.key,
+          encryptionKey: this.base.encryptionKey
+        })
+      }
+    })
+
+    this.swarm.join(this.base.discoveryKey)
+  }
+
+  // Append a key/value to the base
+  async add (key, value) {
+    await this.base.append({
+      type: 'addRecord',
+      key,
+      value
+    })
+  }
+
+  // Remove a key pair
+  async remove (key) {
+    await this.base.append({
+      type: 'removeRecord',
+      key,
+      value: null
+    })
+  }
+} // end class
+
+function noop () {}
+
+module.exports = Autopass

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "autopass",
+  "version": "1.0.0",
+  "main": "index.js",
+  "scripts": {
+    "test": "standard && brittle test.js"
+  },
+  "author": "Holepunch Inc",
+  "license": "Apache-2.0",
+  "description": "",
+  "devDependencies": {
+    "brittle": "^3.7.0",
+    "corestore": "^6.18.4",
+    "hyperdht": "^6.20.1",
+    "test-tmp": "^1.3.0"
+  },
+  "dependencies": {
+    "autobase": "^6.5.12",
+    "b4a": "^1.6.7",
+    "blind-pairing": "^2.3.1",
+    "hyperbee": "^2.20.7",
+    "hyperswarm": "^4.8.4",
+    "ready-resource": "^1.1.1"
+  }
+}

package/test.js

@@ -0,0 +1,54 @@
+const test = require('brittle')
+const Autopass = require('./')
+const Corestore = require('corestore')
+const testnet = require('hyperdht/testnet')
+const tmp = require('test-tmp')
+
+test('basic', async function (t) {
+  const a = await create(t, { replicate: false })
+
+  await a.add('hello', 'world')
+
+  t.ok(a.base.encryptionKey)
+  t.is(await a.get('hello'), 'world')
+
+  await a.close()
+})
+
+test('invites', async function (t) {
+  t.plan(2)
+
+  const tn = await testnet(10, t)
+
+  const a = await create(t, { bootstrap: tn.bootstrap })
+  t.teardown(() => a.close())
+
+  a.on('update', function () {
+    if (a.base.system.members === 2) t.pass('a has two members')
+  })
+
+  const inv = await a.createInvite()
+
+  const p = await pair(t, inv, { bootstrap: tn.bootstrap })
+
+  const b = await p.finished()
+  await b.ready()
+
+  t.teardown(() => b.close())
+  b.on('update', function () {
+    if (b.base.system.members === 2) t.pass('b has two members')
+  })
+})
+
+async function create (t, opts) {
+  const dir = await tmp(t)
+  const a = new Autopass(new Corestore(dir), opts)
+  await a.ready()
+  return a
+}
+
+async function pair (t, inv, opts) {
+  const dir = await tmp(t)
+  const a = Autopass.pair(new Corestore(dir), inv, opts)
+  return a
+}