feat: keychain #631

vasco-santos · 2020-05-07T09:00:52Z

This PR is part of the PeerStore improvements EPIC and tackles part of the milestone 4 - KeyChain.

Points to note:

The entire libp2p-keychain history has been added
Additional commits were made to move keychain under ./src/keychain and its tests under ./test/keychain.
Some of the unneeded files were removed (like LICENSE) since libp2p already has a version of that file
libp2p-keychain is now created on Libp2p.create and follows the same approach as js-ipfs did https://github.com/ipfs/js-ipfs/blob/master/packages/ipfs/src/core/components/init.js#L178-L257 (This will not be needed anymore in ipfs, you can also see this temporary commit with the new usage: ipfs/js-ipfs@1a342c5)

Note on Merging:

Right now the plan (obtained from libp2p-keychain PR) is to:

squash the merge to minimize the commit pollution
update the readme to point to the original repo
append the Co-Author list to the squashed commit to maintain author credit
- This co author list was generated from the libp2p-keychain package.json which is auto generated from the commit history there.

Co-authored-by: Alan Shaw <alan.shaw@protocol.ai>
Co-authored-by: Alberto Elias <hi@albertoelias.me>
Co-authored-by: Alex Potsides <alex@achingbrain.net>
Co-authored-by: David Dias <daviddias.p@gmail.com>
Co-authored-by: Hugo Dias <mail@hugodias.me>
Co-authored-by: Jacob Heun <jacobheun@gmail.com>
Co-authored-by: Maciej Krüger <mkg20001@gmail.com>
Co-authored-by: Masahiro Saito <camelmasa@gmail.com>
Co-authored-by: Richard Schneider <makaretu@gmail.com>
Co-authored-by: Vasco Santos <vasco.santos@moxy.studio>
Co-authored-by: Vasco Santos <vasco.santos@ua.pt>
Co-authored-by: Victor Bjelkholm <victorbjelkholm@gmail.com>

This replaces #525 because the other PR was super outdated and complex to rebase at this point.

Fixes #2

Add syntax highlighting to README

Fixes #12

This commit updates all CI scripts to the latest version

Updating CI files

Persist the key info in the store

test: key name comparision

* test: openssl interop is now the responsibility of libp2p-crypto * feat: use libp2p-crypto, not node-forge, for key management * fix: use libp2p-crypto.pbkdf, not node-forge * fix: do not ship CMS This removes all depencies on node-forge * test: update dependencies * test: remove dead code

BREAKING CHANGE: all API methods with peer-info parameters or return values were changed. You can check the API.md document, in order to check the new values to use

Co-Authored-By: Jacob Heun <jacobheun@gmail.com>

Bumps [datastore-level](https://github.com/ipfs/js-datastore-level) from 0.14.1 to 1.0.0. - [Release notes](https://github.com/ipfs/js-datastore-level/releases) - [Changelog](https://github.com/ipfs/js-datastore-level/blob/master/CHANGELOG.md) - [Commits](ipfs/js-datastore-level@v0.14.1...v1.0.0) Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-Authored-By: Jacob Heun <jacobheun@gmail.com>

Bumps [datastore-fs](https://github.com/ipfs/js-datastore-fs) from 0.9.1 to 1.0.0. - [Release notes](https://github.com/ipfs/js-datastore-fs/releases) - [Changelog](https://github.com/ipfs/js-datastore-fs/blob/master/CHANGELOG.md) - [Commits](ipfs/js-datastore-fs@v0.9.1...v1.0.0) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>

jacobheun

Just a general note in addition to the other comments, I think this PR would be a bit easier to review and would maintain an easier historical squash reference if it was split into 2 PRs.

PR1: Just include libp2p-keychain in libp2p. This would let us run tests and just use keychain via require('libp2p/src/keychain'). This also ensure the squash commit has the "as is" keychain implementation from existing contributors.
PR2: Integrate directly into libp2p. This just makes it easier to see if any keychain code needs to be touched during integration

jacobheun · 2020-05-08T14:20:08Z

doc/API.md

+// ...
+const listenMa = libp2p.transportManager.getAddrs()
+// [ <Multiaddr 047f00000106f9ba - /ip4/127.0.0.1/tcp/63930> ]
+


This whole added block already exists, this is adding duplicate data.

Removing this should also fix the formatting below as it isn't properly closing the code blocks

jacobheun · 2020-05-08T14:22:41Z

doc/API.md

+
+```js
+const keyInfo = await libp2p.keychain.createKey('keyTest', 'rsa', 4096)
+const enc = await libp2p.keychain.cms.encrypt('keyTest', Buffer.from('data'))


This is an encrypt example, but this section is decrypt

jacobheun · 2020-05-08T14:33:43Z

src/index.js

    this.datastore = this._options.datastore
+    this.keychain = this._options.keychain


_options.keychain is an object, not a KeyChain, this will break

jacobheun · 2020-05-08T14:37:42Z

src/index.js

@@ -168,6 +172,9 @@ class Libp2p extends EventEmitter {
    this.peerRouting = peerRouting(this)
    this.contentRouting = contentRouting(this)

+    // Keychain
+    this.keychain = this._options._keychain || new NoKeychain()


Why NoKeychain? It's just throwing errors whenever you try to use it. Just leave it undefined and let type errors happen.

jacobheun · 2020-05-08T14:41:03Z

src/index.js

+      await keychain.importPeer('self', peerId)
+    }
+
+    options._keychain = keychain


Having keychain and _keychain on options is confusing. Why not move the keychain creation in to the libp2p constructor? We can create libp2p then do the keychain await stuff before returning the libp2p instance.

vasco-santos · 2020-05-13T11:26:43Z

Closed in favour of #633 and #634

daviddias and others added 30 commits December 6, 2017 08:24

Initial commit

4c8d147

chore: setup repo

49e6c47

feat: move bits from https://github.com/richardschneider/ipfs-encryption

1a96ae8

docs: install and links

658a4d7

fix: linting

409a999

fix: more linting

7c44c91

test: needs more time to generate RSA key

98ba68a

test: temporarily disable webworker tests #3

569f963

test: disable webworker

358c8c2

chore: ci coverage

99780ab

Fixes #2

chore: publish coverage report

cfdd2f4

Add syntax highlighting to README

643bcd4

Merge pull request #4 from libp2p/mkg20001-patch-1

506e1d7

Add syntax highlighting to README

fix: return info on removed key #10

f49e753

fix: error message

8305d20

docs(keychain): add API documentation

3b8d05a

fix: maps an IPFS hash name to its forge equivalent

f71d3a6

Fixes #12

fix: lint errors

ff4f656

fix: lint errors

06917f7

test: importing openssl keys

2dd069b

refactor: keep the key info in the store

1b2664a

Updating CI files

ee9dbeb

This commit updates all CI scripts to the latest version

Merge pull request #15 from libp2p/automatic-ci-script-update

b4518e0

Updating CI files

docs: correct hash name

9129d20

Merge pull request #13 from libp2p/ds-keyinfo

97bf98f

Persist the key info in the store

test: key name comparision

e78b248

test(openssl): verify key id

3b7c691

Merge pull request #17 from libp2p/filenames

605d290

test: key name comparision

chore: update deps

5343b0f

vasco-santos and others added 16 commits April 24, 2020 14:58

chore: remove peer-info usage

0f6e878

BREAKING CHANGE: all API methods with peer-info parameters or return values were changed. You can check the API.md document, in order to check the new values to use

chore: apply suggestions from code review

984d933

Co-Authored-By: Jacob Heun <jacobheun@gmail.com>

chore: rename peer-store properties

8723388

chore: use kad-dht with renamed peer-store properties

7627f96

chore: refactor connection manager and registrar

a55a4dc

chore: apply suggestions from code review

e87b42b

Co-Authored-By: Jacob Heun <jacobheun@gmail.com>

feat: address manager

7e76d0f

chore: update api docs

4e4a998

chore: rename address functions and apply suggestions from code review

21b39eb

Co-Authored-By: Jacob Heun <jacobheun@gmail.com>

chore(deps-dev): bump datastore-level from 0.14.1 to 1.0.0

e72a5b0

chore: move to libp2p

d9fd726

Merge branch 'master' of ../js-libp2p-keychain into feat/keychain

0b260e9

chore: merge 0.28x updates

9d54730

Merge branch '0.28.x' into feat/keychain

b1a2b8a

vasco-santos force-pushed the feat/keychain branch 4 times, most recently from 1df9134 to b1a2b8a Compare May 7, 2020 15:45

vasco-santos added 2 commits May 7, 2020 17:45

chore: merge 0.28x updates

c0bbda2

feat: keychain in libp2p

c9d776a

vasco-santos force-pushed the feat/keychain branch from f240930 to c9d776a Compare May 7, 2020 19:59

vasco-santos requested a review from jacobheun May 7, 2020 20:07

jacobheun reviewed May 8, 2020

View reviewed changes

This was referenced May 11, 2020

chore: move keychain #633

Merged

chore: integrate libp2p-keychain into js-libp2p (#633) #634

Merged

vasco-santos closed this May 13, 2020

achingbrain deleted the feat/keychain branch May 18, 2023 13:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: keychain #631

feat: keychain #631

vasco-santos commented May 7, 2020 •

edited

Loading

jacobheun left a comment

jacobheun May 8, 2020

jacobheun May 8, 2020

jacobheun May 8, 2020

jacobheun May 8, 2020

jacobheun May 8, 2020

jacobheun May 8, 2020

vasco-santos commented May 13, 2020

		this.datastore = this._options.datastore
		this.keychain = this._options.keychain

feat: keychain #631

feat: keychain #631

Conversation

vasco-santos commented May 7, 2020 • edited Loading

Note on Merging:

jacobheun left a comment

Choose a reason for hiding this comment

jacobheun May 8, 2020

Choose a reason for hiding this comment

jacobheun May 8, 2020

Choose a reason for hiding this comment

jacobheun May 8, 2020

Choose a reason for hiding this comment

jacobheun May 8, 2020

Choose a reason for hiding this comment

jacobheun May 8, 2020

Choose a reason for hiding this comment

jacobheun May 8, 2020

Choose a reason for hiding this comment

vasco-santos commented May 13, 2020

vasco-santos commented May 7, 2020 •

edited

Loading