Compare commits

...

31 Commits

Author SHA1 Message Date
Pavel Murygin
85dac48621 bump dependencies 2021-04-09 17:10:55 +03:00
Vasco Santos
f3fc3449c1 chore: release version v0.14.6 2021-04-06 14:09:48 +02:00
Vasco Santos
927a6cf078 chore: update contributors 2021-04-06 14:09:48 +02:00
Vasco Santos
73fe2c553f chore: add no types to release script 2021-04-06 14:04:43 +02:00
Alex Potsides
719ddfe8e2
chore: update deps (#143) 2021-04-06 13:59:19 +02:00
Vasco Santos
037ed87dac chore: release version v0.14.4 2021-03-29 12:57:18 +02:00
Vasco Santos
af47794289 chore: update contributors 2021-03-29 12:57:18 +02:00
Alex Potsides
eeb53305c8
fix: remove toString side effect that breaks deep equals (#142)
Makes the cached string cid property non-enumerable so deep equals
still works even after a peer id has been stringifed.

Fixes #141
2021-03-29 12:53:11 +02:00
Vasco Santos
5468ee0877 chore: release version v0.14.3 2021-01-26 09:22:15 +01:00
Vasco Santos
f895151451 chore: update contributors 2021-01-26 09:22:15 +01:00
Vasco Santos
e7d0eaa796
chore: update deps (#137) 2021-01-26 09:10:46 +01:00
acolytec3
41ab96c47d
docs: correct case for RSA keyType (#136)
* docs: correct case for RSA keyType

correct case of rsa keytype in docs/examples to match keyType exported from libp2p-crypto

Co-authored-by: Vasco Santos <vasco.santos@ua.pt>
2021-01-06 15:13:25 +01:00
a1300
4178e53db8
docs: add documentation for isPeerId(id) (#134) (#135) 2020-12-01 17:33:15 +01:00
Vasco Santos
10ead07dd9 chore: release version v0.14.2 2020-09-23 19:11:12 +02:00
Vasco Santos
d940099131 chore: update contributors 2020-09-23 19:11:12 +02:00
Vasco Santos
b2ee34295b
feat: has inline public key method (#132) 2020-09-23 19:07:28 +02:00
Vasco Santos
ecc1e5be6d chore: release version v0.14.1 2020-09-03 18:49:02 +02:00
Vasco Santos
153bc8ea38 chore: update contributors 2020-09-03 18:49:01 +02:00
Vasco Santos
d40d588776
fix: ts constructor types (#130) 2020-08-26 11:46:38 +02:00
Adam Uhlíř
224b30cb65
fix: privKey possible undefined (#129) 2020-08-17 16:35:13 +02:00
Vojtech Simetka
6d571ae196
fix: typo in readme (#128) 2020-08-12 13:40:13 +02:00
Jacob Heun
ff4bd96467
chore: release version v0.14.0 2020-08-07 17:41:53 +02:00
Jacob Heun
427b46c86e
chore: update contributors 2020-08-07 17:41:52 +02:00
Alex Potsides
d16ce9c2ac
fix: replace node buffers with uint8arrays (#127)
* fix: replace node buffers with uint8arrays

Replaces all uses of node Buffers with Uint8Arrays

BREAKING CHANGES:

- Where node Buffers were returned, now Uint8Arrays are

* chore: remove gh dep
2020-08-07 17:36:22 +02:00
Vasco Santos
cd99cb2c7d chore: release version v0.13.13 2020-06-23 18:58:05 +02:00
Vasco Santos
c295329300 chore: update contributors 2020-06-23 18:58:04 +02:00
Alex Potsides
bb32b12395
chore: update deps (#126)
Allows for deduping multihashes module
2020-06-23 18:43:30 +02:00
dependabot-preview[bot]
6fd5ca2a12
chore(deps-dev): bump aegir from 21.10.2 to 22.0.0 (#124)
Bumps [aegir](https://github.com/ipfs/aegir) from 21.10.2 to 22.0.0.
- [Release notes](https://github.com/ipfs/aegir/releases)
- [Changelog](https://github.com/ipfs/aegir/blob/master/CHANGELOG.md)
- [Commits](https://github.com/ipfs/aegir/compare/v21.10.2...v22.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>
2020-05-28 18:10:20 +02:00
Vasco Santos
020b963711 chore: release version v0.13.12 2020-04-22 16:35:07 +02:00
Vasco Santos
e3da29a440 chore: update contributors 2020-04-22 16:35:07 +02:00
Jacob Heun
8cd9dfb137
feat(cli): add support for specifying type and size (#122) 2020-04-22 16:32:38 +02:00
8 changed files with 251 additions and 88 deletions

7
.aegir.js Normal file
View File

@ -0,0 +1,7 @@
'use strict'
module.exports = {
bundlesize: {
maxSize: '140kB'
}
}

View File

@ -1,3 +1,82 @@
## [0.14.6](https://github.com/libp2p/js-peer-id/compare/v0.14.4...v0.14.6) (2021-04-06)
## [0.14.4](https://github.com/libp2p/js-peer-id/compare/v0.14.3...v0.14.4) (2021-03-29)
### Bug Fixes
* remove toString side effect that breaks deep equals ([#142](https://github.com/libp2p/js-peer-id/issues/142)) ([eeb5330](https://github.com/libp2p/js-peer-id/commit/eeb53305c8767a6a2b3f610fe9e45a589b4fa972)), closes [#141](https://github.com/libp2p/js-peer-id/issues/141)
## [0.14.3](https://github.com/libp2p/js-peer-id/compare/v0.14.2...v0.14.3) (2021-01-26)
<a name="0.14.2"></a>
## [0.14.2](https://github.com/libp2p/js-peer-id/compare/v0.14.1...v0.14.2) (2020-09-23)
### Features
* has inline public key method ([#132](https://github.com/libp2p/js-peer-id/issues/132)) ([b2ee342](https://github.com/libp2p/js-peer-id/commit/b2ee342))
<a name="0.14.1"></a>
## [0.14.1](https://github.com/libp2p/js-peer-id/compare/v0.13.13...v0.14.1) (2020-09-03)
### Bug Fixes
* privKey possible undefined ([#129](https://github.com/libp2p/js-peer-id/issues/129)) ([224b30c](https://github.com/libp2p/js-peer-id/commit/224b30c))
* replace node buffers with uint8arrays ([#127](https://github.com/libp2p/js-peer-id/issues/127)) ([d16ce9c](https://github.com/libp2p/js-peer-id/commit/d16ce9c))
* ts constructor types ([#130](https://github.com/libp2p/js-peer-id/issues/130)) ([d40d588](https://github.com/libp2p/js-peer-id/commit/d40d588))
* typo in readme ([#128](https://github.com/libp2p/js-peer-id/issues/128)) ([6d571ae](https://github.com/libp2p/js-peer-id/commit/6d571ae))
### BREAKING CHANGES
* - Where node Buffers were returned, now Uint8Arrays are
* chore: remove gh dep
<a name="0.14.0"></a>
# [0.14.0](https://github.com/libp2p/js-peer-id/compare/v0.13.13...v0.14.0) (2020-08-07)
### Bug Fixes
* replace node buffers with uint8arrays ([#127](https://github.com/libp2p/js-peer-id/issues/127)) ([d16ce9c](https://github.com/libp2p/js-peer-id/commit/d16ce9c))
### BREAKING CHANGES
* - Where node Buffers were returned, now Uint8Arrays are
* chore: remove gh dep
<a name="0.13.13"></a>
## [0.13.13](https://github.com/libp2p/js-peer-id/compare/v0.13.12...v0.13.13) (2020-06-23)
<a name="0.13.12"></a>
## [0.13.12](https://github.com/libp2p/js-peer-id/compare/v0.13.11...v0.13.12) (2020-04-22)
### Features
* **cli:** add support for specifying type and size ([#122](https://github.com/libp2p/js-peer-id/issues/122)) ([8cd9dfb](https://github.com/libp2p/js-peer-id/commit/8cd9dfb))
<a name="0.13.11"></a> <a name="0.13.11"></a>
## [0.13.11](https://github.com/libp2p/js-peer-id/compare/v0.13.10...v0.13.11) (2020-03-26) ## [0.13.11](https://github.com/libp2p/js-peer-id/compare/v0.13.10...v0.13.11) (2020-03-26)

View File

@ -28,6 +28,7 @@
- [Node.js](#nodejs) - [Node.js](#nodejs)
- [Browser: Browserify, Webpack, other bundlers](#browser-browserify-webpack-other-bundlers) - [Browser: Browserify, Webpack, other bundlers](#browser-browserify-webpack-other-bundlers)
- [Browser: `<script>` Tag](#browser-script-tag) - [Browser: `<script>` Tag](#browser-script-tag)
- [CLI](#cli)
- [API](#api) - [API](#api)
- [Create](#create) - [Create](#create)
- [`new PeerId(id[, privKey, pubKey])`](#new-peeridid-privkey-pubkey) - [`new PeerId(id[, privKey, pubKey])`](#new-peeridid-privkey-pubkey)
@ -52,6 +53,8 @@
- [`toPrint()`](#toprint) - [`toPrint()`](#toprint)
- [`equals(id)`](#equalsid) - [`equals(id)`](#equalsid)
- [`isEqual(id)`](#isequalid) - [`isEqual(id)`](#isequalid)
- [Others](#others)
- [`isPeerId(id)`](#ispeeridid)
- [License](#license) - [License](#license)
# Description # Description
@ -67,7 +70,7 @@ The public key is a base64 encoded string of a protobuf containing an RSA DER bu
```JavaScript ```JavaScript
const PeerId = require('peer-id') const PeerId = require('peer-id')
const id = await PeerId.create({ bits: 1024, keyType: 'rsa' }) const id = await PeerId.create({ bits: 1024, keyType: 'RSA' })
console.log(JSON.stringify(id.toJSON(), null, 2)) console.log(JSON.stringify(id.toJSON(), null, 2))
``` ```
@ -117,6 +120,14 @@ the global namespace.
<script src="https://unpkg.com/peer-id/dist/index.js"></script> <script src="https://unpkg.com/peer-id/dist/index.js"></script>
``` ```
# CLI
After installing `peer-id`, `npm install peer-id`, you can leverage the cli to generate keys exported as JSON. You can specify the type for the key and size, as detailed in [`create([opts])`](#createopts). The defaults are shown here.
```sh
> peer-id --type rsa --bits 2048
```
# API # API
```js ```js
@ -137,7 +148,8 @@ The key format is detailed in [libp2p-crypto](https://github.com/libp2p/js-libp2
Generates a new Peer ID, complete with public/private keypair. Generates a new Peer ID, complete with public/private keypair.
- `opts: Object`: Default: `{bits: 2048, keyType: 'rsa'}` - `opts.bits: number` - The size of the key. Default: `2048`
- `opts.keyType: string` - The key type, one of: `['RSA', 'Ed25519', 'secp256k1']`. Default: `RSA`
Returns `Promise<PeerId>`. Returns `Promise<PeerId>`.
@ -147,7 +159,7 @@ Returns `Promise<PeerId>`.
Creates a Peer ID from hex string representing the key's multihash. Creates a Peer ID from hex string representing the key's multihash.
Returns `PeerId. Returns `PeerId`.
### `createFromBytes(buf)` ### `createFromBytes(buf)`
@ -275,6 +287,14 @@ Returns `true` if the given PeerId is equal to the current instance.
- `id` can be a PeerId or a Buffer containing the id - `id` can be a PeerId or a Buffer containing the id
## Others
### `isPeerId(id)`
Returns `true` if the given id is an instance of PeerId
- `id` should be an instance of PeerId
# License # License
MIT MIT

View File

@ -1,6 +1,6 @@
{ {
"name": "peer-id", "name": "peer-id",
"version": "0.13.11", "version": "0.14.6",
"description": "IPFS Peer Id implementation in Node.js", "description": "IPFS Peer Id implementation in Node.js",
"leadMaintainer": "Vasco Santos <santos.vasco10@gmail.com>", "leadMaintainer": "Vasco Santos <santos.vasco10@gmail.com>",
"main": "src/index.js", "main": "src/index.js",
@ -8,16 +8,16 @@
"bin": "src/bin.js", "bin": "src/bin.js",
"scripts": { "scripts": {
"lint": "aegir lint", "lint": "aegir lint",
"build": "aegir build", "build": "aegir build --no-types",
"test": "aegir test", "test": "aegir test",
"test:node": "aegir test -t node", "test:node": "aegir test -t node",
"test:browser": "aegir test -t browser -t webworker", "test:browser": "aegir test -t browser -t webworker",
"test:types": "npx tsc", "test:types": "npx tsc",
"release": "aegir release", "release": "aegir release --no-types",
"release-minor": "aegir release --type minor", "release-minor": "aegir release --type minor",
"release-major": "aegir release --type major", "release-major": "aegir release --type major",
"coverage": "aegir coverage", "coverage": "aegir coverage",
"size": "bundlesize -f dist/index.min.js -s 140kB" "size": "aegir build -b"
}, },
"files": [ "files": [
"src", "src",
@ -36,21 +36,19 @@
}, },
"homepage": "https://github.com/libp2p/js-peer-id", "homepage": "https://github.com/libp2p/js-peer-id",
"devDependencies": { "devDependencies": {
"@types/chai": "^4.2.7", "@types/chai": "^4.2.14",
"@types/dirty-chai": "^2.0.2", "@types/dirty-chai": "^2.0.2",
"@types/mocha": "^7.0.2", "@types/mocha": "^8.2.0",
"aegir": "^21.2.0", "aegir": "^32.2.0"
"bundlesize": "~0.18.0",
"chai": "^4.2.0",
"dirty-chai": "^2.0.1"
}, },
"dependencies": { "dependencies": {
"buffer": "^5.5.0", "cids": "^1.1.6",
"cids": "^0.8.0",
"class-is": "^1.1.0", "class-is": "^1.1.0",
"libp2p-crypto": "~0.17.3", "libp2p-crypto": "fluencelabs/js-libp2p-crypto",
"multihashes": "~0.4.15", "minimist": "^1.2.5",
"protons": "^1.0.2" "multihashes": "^4.0.2",
"protons": "^2.0.0",
"uint8arrays": "^2.1.4"
}, },
"repository": { "repository": {
"type": "git", "type": "git",
@ -64,10 +62,12 @@
"Jacob Heun <jacobheun@gmail.com>", "Jacob Heun <jacobheun@gmail.com>",
"Pedro Teixeira <i@pgte.me>", "Pedro Teixeira <i@pgte.me>",
"Stephen Whitmore <stephen.whitmore@gmail.com>", "Stephen Whitmore <stephen.whitmore@gmail.com>",
"Maciej Krüger <mkg20001@gmail.com>", "Alex Potsides <alex@achingbrain.net>",
"Hugo Dias <hugomrdias@gmail.com>", "Hugo Dias <hugomrdias@gmail.com>",
"Maciej Krüger <mkg20001@gmail.com>",
"Nate Foss <npfoss@gmail.com>", "Nate Foss <npfoss@gmail.com>",
"Robert Kiel <robert.kiel@validitylabs.org>", "Robert Kiel <robert.kiel@validitylabs.org>",
"Adam Uhlíř <adam@uhlir.dev>",
"ᴠɪᴄᴛᴏʀ ʙᴊᴇʟᴋʜᴏʟᴍ <victorbjelkholm@gmail.com>", "ᴠɪᴄᴛᴏʀ ʙᴊᴇʟᴋʜᴏʟᴍ <victorbjelkholm@gmail.com>",
"Arve Knudsen <arve.knudsen@gmail.com>", "Arve Knudsen <arve.knudsen@gmail.com>",
"Carson Farmer <carson.farmer@gmail.com>", "Carson Farmer <carson.farmer@gmail.com>",
@ -79,7 +79,8 @@
"Richard Littauer <richard.littauer@gmail.com>", "Richard Littauer <richard.littauer@gmail.com>",
"Richard Schneider <makaretu@gmail.com>", "Richard Schneider <makaretu@gmail.com>",
"Topper Bowers <topper@quorumcontrol.com>", "Topper Bowers <topper@quorumcontrol.com>",
"Vojtech Simetka <vojtech@simetka.cz>",
"Yahya <ya7yaz@gmail.com>", "Yahya <ya7yaz@gmail.com>",
"Alex Potsides <alex@achingbrain.net>" "a1300 <matthias-knopp@gmx.net>"
] ]
} }

View File

@ -3,9 +3,13 @@
'use strict' 'use strict'
const PeerId = require('./index.js') const PeerId = require('./index.js')
const argv = require('minimist')(process.argv.slice(2))
async function main () { async function main () {
const id = await PeerId.create() const id = await PeerId.create({
keyType: argv.type,
bits: argv.bits
})
console.log(JSON.stringify(id.toJSON(), null, 2)) // eslint-disable-line no-console console.log(JSON.stringify(id.toJSON(), null, 2)) // eslint-disable-line no-console
} }

45
src/index.d.ts vendored
View File

@ -1,4 +1,4 @@
import crypto, { PrivateKey, PublicKey, KeyType } from "libp2p-crypto"; import { PrivateKey, PublicKey, KeyType } from "libp2p-crypto";
import CID from 'cids' import CID from 'cids'
declare namespace PeerId { declare namespace PeerId {
@ -31,7 +31,7 @@ declare namespace PeerId {
/** /**
* Private key. * Private key.
*/ */
privKey: string; privKey?: string;
}; };
/** /**
@ -51,36 +51,36 @@ declare namespace PeerId {
* @param str The input hex string. * @param str The input hex string.
*/ */
function createFromHexString(str: string): PeerId; function createFromHexString(str: string): PeerId;
/** /**
* Create PeerId from raw bytes. * Create PeerId from raw bytes.
* @param buf The raw bytes. * @param buf The raw bytes.
*/ */
function createFromBytes(buf: Buffer): PeerId; function createFromBytes(buf: Uint8Array): PeerId;
/** /**
* Create PeerId from base58-encoded string. * Create PeerId from base58-encoded string.
* @param str The base58-encoded string. * @param str The base58-encoded string.
*/ */
function createFromB58String(str: string): PeerId; function createFromB58String(str: string): PeerId;
/** /**
* Create PeerId from CID. * Create PeerId from CID.
* @param cid The CID. * @param cid The CID.
*/ */
function createFromCID(cid: CID | Buffer | string | object): PeerId; function createFromCID(cid: CID | Uint8Array | string | object): PeerId;
/** /**
* Create PeerId from public key. * Create PeerId from public key.
* @param key Public key, as Buffer or base64-encoded string. * @param key Public key, as Uint8Array or base64-encoded string.
*/ */
function createFromPubKey(key: Buffer | string): Promise<PeerId>; function createFromPubKey(key: Uint8Array | string): Promise<PeerId>;
/** /**
* Create PeerId from private key. * Create PeerId from private key.
* @param key Private key, as Buffer or base64-encoded string. * @param key Private key, as Uint8Array or base64-encoded string.
*/ */
function createFromPrivKey(key: Buffer | string): Promise<PeerId>; function createFromPrivKey(key: Uint8Array | string): Promise<PeerId>;
/** /**
* Create PeerId from PeerId JSON formatted object. * Create PeerId from PeerId JSON formatted object.
@ -91,21 +91,21 @@ declare namespace PeerId {
/** /**
* Create PeerId from Protobuf bytes. * Create PeerId from Protobuf bytes.
* @param buf Protobuf bytes, as Buffer or hex-encoded string. * @param buf Protobuf bytes, as Uint8Array or hex-encoded string.
*/ */
function createFromProtobuf(buf: Buffer | string): Promise<PeerId>; function createFromProtobuf(buf: Uint8Array | string): Promise<PeerId>;
} }
/** /**
* PeerId is an object representation of a peer identifier. * PeerId is an object representation of a peer identifier.
*/ */
declare class PeerId { declare class PeerId {
constructor(id: Buffer | string, privKey?: PrivateKey, pubKey?: PublicKey); constructor(id: Uint8Array, privKey?: PrivateKey, pubKey?: PublicKey);
/** /**
* Raw id. * Raw id.
*/ */
readonly id: Buffer; readonly id: Uint8Array;
/** /**
* Private key. * Private key.
@ -120,18 +120,18 @@ declare class PeerId {
/** /**
* Return the protobuf version of the public key, matching go ipfs formatting. * Return the protobuf version of the public key, matching go ipfs formatting.
*/ */
marshalPubKey(): Buffer; marshalPubKey(): Uint8Array;
/** /**
* Return the protobuf version of the private key, matching go ipfs formatting. * Return the protobuf version of the private key, matching go ipfs formatting.
*/ */
marshalPrivKey(): Buffer; marshalPrivKey(): Uint8Array;
/** /**
* Return the protobuf version of the peer-id. * Return the protobuf version of the peer-id.
* @param excludePriv Whether to exclude the private key information from the output. * @param excludePriv Whether to exclude the private key information from the output.
*/ */
marshal(excludePriv?: boolean): Buffer; marshal(excludePriv?: boolean): Uint8Array;
/** /**
* String representation. * String representation.
@ -153,7 +153,7 @@ declare class PeerId {
/** /**
* Return raw id bytes. * Return raw id bytes.
*/ */
toBytes(): Buffer; toBytes(): Uint8Array;
/** /**
* Encode to base58 string. * Encode to base58 string.
@ -170,19 +170,24 @@ declare class PeerId {
* Checks the equality of `this` peer against a given PeerId. * Checks the equality of `this` peer against a given PeerId.
* @param id The other PeerId. * @param id The other PeerId.
*/ */
equals(id: PeerId | Buffer): boolean; equals(id: PeerId | Uint8Array): boolean;
/** /**
* Checks the equality of `this` peer against a given PeerId. * Checks the equality of `this` peer against a given PeerId.
* @deprecated Use {.equals} * @deprecated Use {.equals}
* @param id The other PeerId. * @param id The other PeerId.
*/ */
isEqual(id: PeerId | Buffer): boolean; isEqual(id: PeerId | Uint8Array): boolean;
/** /**
* Check if this PeerId instance is valid (privKey -> pubKey -> Id) * Check if this PeerId instance is valid (privKey -> pubKey -> Id)
*/ */
isValid(): boolean; isValid(): boolean;
/**
* Check if the PeerId has an inline public key.
*/
hasInlinePublicKey(): boolean;
} }
export = PeerId; export = PeerId;

View File

@ -4,20 +4,22 @@
'use strict' 'use strict'
const { Buffer } = require('buffer')
const mh = require('multihashes') const mh = require('multihashes')
const CID = require('cids') const CID = require('cids')
const cryptoKeys = require('libp2p-crypto/src/keys') const cryptoKeys = require('libp2p-crypto/src/keys')
const withIs = require('class-is') const withIs = require('class-is')
const { PeerIdProto } = require('./proto') const { PeerIdProto } = require('./proto')
const uint8ArrayEquals = require('uint8arrays/equals')
const uint8ArrayFromString = require('uint8arrays/from-string')
const uint8ArrayToString = require('uint8arrays/to-string')
class PeerId { class PeerId {
constructor (id, privKey, pubKey) { constructor (id, privKey, pubKey) {
if (!Buffer.isBuffer(id)) { if (!(id instanceof Uint8Array)) {
throw new Error('invalid id provided') throw new Error('invalid id provided')
} }
if (privKey && pubKey && !privKey.public.bytes.equals(pubKey.bytes)) { if (privKey && pubKey && !uint8ArrayEquals(privKey.public.bytes, pubKey.bytes)) {
throw new Error('inconsistent arguments') throw new Error('inconsistent arguments')
} }
@ -135,21 +137,26 @@ class PeerId {
toString () { toString () {
if (!this._idCIDString) { if (!this._idCIDString) {
const cid = new CID(1, 'libp2p-key', this.id, 'base32') const cid = new CID(1, 'libp2p-key', this.id, 'base32')
this._idCIDString = cid.toBaseEncodedString('base32')
Object.defineProperty(this, '_idCIDString', {
value: cid.toBaseEncodedString('base32'),
enumerable: false
})
} }
return this._idCIDString return this._idCIDString
} }
/** /**
* Checks the equality of `this` peer against a given PeerId. * Checks the equality of `this` peer against a given PeerId.
* @param {Buffer|PeerId} id *
* @param {Uint8Array|PeerId} id
* @returns {boolean} * @returns {boolean}
*/ */
equals (id) { equals (id) {
if (Buffer.isBuffer(id)) { if (id instanceof Uint8Array) {
return this.id.equals(id) return uint8ArrayEquals(this.id, id)
} else if (id.id) { } else if (id.id) {
return this.id.equals(id.id) return uint8ArrayEquals(this.id, id.id)
} else { } else {
throw new Error('not valid Id') throw new Error('not valid Id')
} }
@ -157,8 +164,9 @@ class PeerId {
/** /**
* Checks the equality of `this` peer against a given PeerId. * Checks the equality of `this` peer against a given PeerId.
*
* @deprecated Use `.equals` * @deprecated Use `.equals`
* @param {Buffer|PeerId} id * @param {Uint8Array|PeerId} id
* @returns {boolean} * @returns {boolean}
*/ */
isEqual (id) { isEqual (id) {
@ -173,8 +181,26 @@ class PeerId {
return Boolean(this.privKey && return Boolean(this.privKey &&
this.privKey.public && this.privKey.public &&
this.privKey.public.bytes && this.privKey.public.bytes &&
Buffer.isBuffer(this.pubKey.bytes) && this.pubKey.bytes instanceof Uint8Array &&
this.privKey.public.bytes.equals(this.pubKey.bytes)) uint8ArrayEquals(this.privKey.public.bytes, this.pubKey.bytes))
}
/**
* Check if the PeerId has an inline public key.
*
* @returns {boolean}
*/
hasInlinePublicKey () {
try {
const decoded = mh.decode(this.id)
if (decoded.name === 'identity') {
return true
}
} catch (_) {
// Ignore, there is no valid public key
}
return false
} }
} }
@ -231,16 +257,16 @@ exports.createFromCID = (cid) => {
return new PeerIdWithIs(cid.multihash) return new PeerIdWithIs(cid.multihash)
} }
// Public Key input will be a buffer // Public Key input will be a Uint8Array
exports.createFromPubKey = async (key) => { exports.createFromPubKey = async (key) => {
let buf = key let buf = key
if (typeof buf === 'string') { if (typeof buf === 'string') {
buf = Buffer.from(key, 'base64') buf = uint8ArrayFromString(key, 'base64pad')
} }
if (!Buffer.isBuffer(buf)) { if (!(buf instanceof Uint8Array)) {
throw new Error('Supplied key is neither a base64 string nor a buffer') throw new Error('Supplied key is neither a base64 string nor a Uint8Array')
} }
const pubKey = await cryptoKeys.unmarshalPublicKey(buf) const pubKey = await cryptoKeys.unmarshalPublicKey(buf)
@ -249,24 +275,22 @@ exports.createFromPubKey = async (key) => {
// Private key input will be a string // Private key input will be a string
exports.createFromPrivKey = async (key) => { exports.createFromPrivKey = async (key) => {
let buf = key if (typeof key === 'string') {
key = uint8ArrayFromString(key, 'base64pad')
if (typeof buf === 'string') {
buf = Buffer.from(key, 'base64')
} }
if (!Buffer.isBuffer(buf)) { if (!(key instanceof Uint8Array)) {
throw new Error('Supplied key is neither a base64 string nor a buffer') throw new Error('Supplied key is neither a base64 string nor a Uint8Array')
} }
const privKey = await cryptoKeys.unmarshalPrivateKey(buf) const privKey = await cryptoKeys.unmarshalPrivateKey(key)
return computePeerId(privKey, privKey.public) return computePeerId(privKey, privKey.public)
} }
exports.createFromJSON = async (obj) => { exports.createFromJSON = async (obj) => {
const id = mh.fromB58String(obj.id) const id = mh.fromB58String(obj.id)
const rawPrivKey = obj.privKey && Buffer.from(obj.privKey, 'base64') const rawPrivKey = obj.privKey && uint8ArrayFromString(obj.privKey, 'base64pad')
const rawPubKey = obj.pubKey && Buffer.from(obj.pubKey, 'base64') const rawPubKey = obj.pubKey && uint8ArrayFromString(obj.pubKey, 'base64pad')
const pub = rawPubKey && await cryptoKeys.unmarshalPublicKey(rawPubKey) const pub = rawPubKey && await cryptoKeys.unmarshalPublicKey(rawPubKey)
if (!rawPrivKey) { if (!rawPrivKey) {
@ -282,11 +306,11 @@ exports.createFromJSON = async (obj) => {
pubDigest = await computeDigest(pub) pubDigest = await computeDigest(pub)
} }
if (pub && !privDigest.equals(pubDigest)) { if (pub && !uint8ArrayEquals(privDigest, pubDigest)) {
throw new Error('Public and private key do not match') throw new Error('Public and private key do not match')
} }
if (id && !privDigest.equals(id)) { if (id && !uint8ArrayEquals(privDigest, id)) {
throw new Error('Id and private key do not match') throw new Error('Id and private key do not match')
} }
@ -295,7 +319,7 @@ exports.createFromJSON = async (obj) => {
exports.createFromProtobuf = async (buf) => { exports.createFromProtobuf = async (buf) => {
if (typeof buf === 'string') { if (typeof buf === 'string') {
buf = Buffer.from(buf, 'hex') buf = uint8ArrayFromString(buf, 'base16')
} }
let { id, privKey, pubKey } = PeerIdProto.decode(buf) let { id, privKey, pubKey } = PeerIdProto.decode(buf)
@ -316,7 +340,7 @@ exports.createFromProtobuf = async (buf) => {
if (privKey) { if (privKey) {
if (pubKey) { if (pubKey) {
if (!privDigest.equals(pubDigest)) { if (!uint8ArrayEquals(privDigest, pubDigest)) {
throw new Error('Public and private key do not match') throw new Error('Public and private key do not match')
} }
} }
@ -344,6 +368,6 @@ exports.isPeerId = (peerId) => {
function toB64Opt (val) { function toB64Opt (val) {
if (val) { if (val) {
return val.toString('base64') return uint8ArrayToString(val, 'base64pad')
} }
} }

View File

@ -2,14 +2,12 @@
/* eslint-env mocha */ /* eslint-env mocha */
'use strict' 'use strict'
const { Buffer } = require('buffer') const { expect } = require('aegir/utils/chai')
const chai = require('chai')
const dirtyChai = require('dirty-chai')
chai.use(dirtyChai)
const expect = chai.expect
const crypto = require('libp2p-crypto') const crypto = require('libp2p-crypto')
const mh = require('multihashes') const mh = require('multihashes')
const CID = require('cids') const CID = require('cids')
const uint8ArrayFromString = require('uint8arrays/from-string')
const uint8ArrayToString = require('uint8arrays/to-string')
const PeerId = require('../src') const PeerId = require('../src')
@ -56,14 +54,15 @@ describe('PeerId', () => {
const id = await PeerId.create(testOpts) const id = await PeerId.create(testOpts)
expect(PeerId.isPeerId(id)).to.equal(true) expect(PeerId.isPeerId(id)).to.equal(true)
expect(PeerId.isPeerId('aaa')).to.equal(false) expect(PeerId.isPeerId('aaa')).to.equal(false)
expect(PeerId.isPeerId(Buffer.from('batatas'))).to.equal(false) expect(PeerId.isPeerId(uint8ArrayFromString('batatas'))).to.equal(false)
}) })
it('throws on changing the id', async () => { it('throws on changing the id', async () => {
const id = await PeerId.create(testOpts) const id = await PeerId.create(testOpts)
expect(id.toB58String().length).to.equal(46) expect(id.toB58String().length).to.equal(46)
expect(() => { expect(() => {
id.id = Buffer.from('hello') // @ts-ignore
id.id = uint8ArrayFromString('hello')
}).to.throw(/immutable/) }).to.throw(/immutable/)
}) })
@ -72,7 +71,7 @@ describe('PeerId', () => {
expect(testIdBytes).to.deep.equal(id.toBytes()) expect(testIdBytes).to.deep.equal(id.toBytes())
}) })
it('recreate from a Buffer', () => { it('recreate from a Uint8Array', () => {
const id = PeerId.createFromBytes(testIdBytes) const id = PeerId.createFromBytes(testIdBytes)
expect(testId.id).to.equal(id.toHexString()) expect(testId.id).to.equal(id.toHexString())
expect(testIdBytes).to.deep.equal(id.toBytes()) expect(testIdBytes).to.deep.equal(id.toBytes())
@ -113,8 +112,8 @@ describe('PeerId', () => {
expect(testIdBytes).to.deep.equal(id.toBytes()) expect(testIdBytes).to.deep.equal(id.toBytes())
}) })
it('recreate from CID Buffer', () => { it('recreate from CID Uint8Array', () => {
const id = PeerId.createFromCID(testIdCID.buffer) const id = PeerId.createFromCID(testIdCID.bytes)
expect(testIdCIDString).to.equal(id.toString()) expect(testIdCIDString).to.equal(id.toString())
expect(testIdBytes).to.deep.equal(id.toBytes()) expect(testIdBytes).to.deep.equal(id.toBytes())
}) })
@ -159,7 +158,7 @@ describe('PeerId', () => {
it('recreate from a Private Key', async () => { it('recreate from a Private Key', async () => {
const id = await PeerId.createFromPrivKey(testId.privKey) const id = await PeerId.createFromPrivKey(testId.privKey)
expect(testIdB58String).to.equal(id.toB58String()) expect(testIdB58String).to.equal(id.toB58String())
const encoded = Buffer.from(testId.privKey, 'base64') const encoded = uint8ArrayFromString(testId.privKey, 'base64pad')
const id2 = await PeerId.createFromPrivKey(encoded) const id2 = await PeerId.createFromPrivKey(encoded)
expect(testIdB58String).to.equal(id2.toB58String()) expect(testIdB58String).to.equal(id2.toB58String())
expect(id.marshalPubKey()).to.deep.equal(id2.marshalPubKey()) expect(id.marshalPubKey()).to.deep.equal(id2.marshalPubKey())
@ -168,11 +167,11 @@ describe('PeerId', () => {
it('recreate from Protobuf', async () => { it('recreate from Protobuf', async () => {
const id = await PeerId.createFromProtobuf(testId.marshaled) const id = await PeerId.createFromProtobuf(testId.marshaled)
expect(testIdB58String).to.equal(id.toB58String()) expect(testIdB58String).to.equal(id.toB58String())
const encoded = Buffer.from(testId.privKey, 'base64') const encoded = uint8ArrayFromString(testId.privKey, 'base64pad')
const id2 = await PeerId.createFromPrivKey(encoded) const id2 = await PeerId.createFromPrivKey(encoded)
expect(testIdB58String).to.equal(id2.toB58String()) expect(testIdB58String).to.equal(id2.toB58String())
expect(id.marshalPubKey()).to.deep.equal(id2.marshalPubKey()) expect(id.marshalPubKey()).to.deep.equal(id2.marshalPubKey())
expect(id.marshal().toString('hex')).to.deep.equal(testId.marshaled) expect(uint8ArrayToString(id.marshal(), 'base16')).to.deep.equal(testId.marshaled)
}) })
it('can be created from a Secp256k1 public key', async () => { it('can be created from a Secp256k1 public key', async () => {
@ -217,7 +216,7 @@ describe('PeerId', () => {
it('toBytes', () => { it('toBytes', () => {
const id = PeerId.createFromHexString(testIdHex) const id = PeerId.createFromHexString(testIdHex)
expect(id.toBytes().toString('hex')).to.equal(testIdBytes.toString('hex')) expect(uint8ArrayToString(id.toBytes(), 'base16')).to.equal(uint8ArrayToString(testIdBytes, 'base16'))
}) })
it('isEqual', async () => { it('isEqual', async () => {
@ -244,6 +243,18 @@ describe('PeerId', () => {
expect(ids[0].equals(ids[1].id)).to.equal(false) expect(ids[0].equals(ids[1].id)).to.equal(false)
}) })
describe('hasInlinePublicKey', () => {
it('returns true if uses a key type with inline public key', async () => {
const peerId = await PeerId.create({ keyType: 'secp256k1' })
expect(peerId.hasInlinePublicKey()).to.equal(true)
})
it('returns false if uses a key type with no inline public key', async () => {
const peerId = await PeerId.create({ keyType: 'RSA' })
expect(peerId.hasInlinePublicKey()).to.equal(false)
})
})
describe('fromJSON', () => { describe('fromJSON', () => {
it('full node', async () => { it('full node', async () => {
const id = await PeerId.create(testOpts) const id = await PeerId.create(testOpts)
@ -287,22 +298,34 @@ describe('PeerId', () => {
it('set privKey (invalid)', async () => { it('set privKey (invalid)', async () => {
const peerId = await PeerId.create(testOpts) const peerId = await PeerId.create(testOpts)
// @ts-ignore // @ts-ignore
peerId.privKey = Buffer.from('bufff') peerId.privKey = uint8ArrayFromString('bufff')
expect(peerId.isValid()).to.equal(false) expect(peerId.isValid()).to.equal(false)
}) })
it('set pubKey (invalid)', async () => { it('set pubKey (invalid)', async () => {
const peerId = await PeerId.create(testOpts) const peerId = await PeerId.create(testOpts)
// @ts-ignore // @ts-ignore
peerId.pubKey = Buffer.from('bufff') peerId.pubKey = uint8ArrayFromString('bufff')
expect(peerId.isValid()).to.equal(false) expect(peerId.isValid()).to.equal(false)
}) })
it('keys are equal after one is stringified', async () => {
const peerId = await PeerId.create(testOpts)
const peerId1 = PeerId.createFromB58String(peerId.toB58String())
const peerId2 = PeerId.createFromB58String(peerId.toB58String())
expect(peerId1).to.deep.equal(peerId2)
peerId1.toString()
expect(peerId1).to.deep.equal(peerId2)
})
describe('returns error via cb instead of crashing', () => { describe('returns error via cb instead of crashing', () => {
const garbage = [ const garbage = [
Buffer.from('00010203040506070809', 'hex'), uint8ArrayFromString('00010203040506070809', 'base16'),
{}, null, false, undefined, true, 1, 0, {}, null, false, undefined, true, 1, 0,
Buffer.from(''), 'aGVsbG93b3JsZA==', 'helloworld', '' uint8ArrayFromString(''), 'aGVsbG93b3JsZA==', 'helloworld', ''
] ]
const fncs = ['createFromPubKey', 'createFromPrivKey', 'createFromJSON', 'createFromProtobuf'] const fncs = ['createFromPubKey', 'createFromPrivKey', 'createFromJSON', 'createFromProtobuf']