Compare commits

..

9 Commits

Author SHA1 Message Date
9922f85693 chore: release version v0.12.5 2019-09-25 16:12:25 +02:00
843d35e1da chore: update contributors 2019-09-25 16:12:25 +02:00
ceeff130fa feat: inline public key handling for the 0.12.x line (#102) 2019-09-25 16:03:01 +02:00
8f4027b136 chore: release version v0.12.4 2019-07-23 14:38:20 +02:00
90835484fe chore: update contributors 2019-07-23 14:38:20 +02:00
8bcd9a880e chore: revert async dep change (#97)
* chore: revert async dep change

* chore: update async to 2.6.3
2019-07-23 13:32:46 +01:00
0bce8f7a87 chore: release version v0.12.3 2019-07-11 18:17:27 +01:00
8f15adbce5 chore: update contributors 2019-07-11 18:17:27 +01:00
fd072213b7 feat(peerid): support creating from secp256k1; harmonize algo with Go 2019-07-11 18:11:05 +01:00
10 changed files with 416 additions and 835 deletions

View File

@ -1,105 +1,25 @@
<a name="0.13.8"></a> <a name="0.12.5"></a>
## [0.13.8](https://github.com/libp2p/js-peer-id/compare/v0.13.6...v0.13.8) (2020-02-18) ## [0.12.5](https://github.com/libp2p/js-peer-id/compare/v0.12.4...v0.12.5) (2019-09-25)
### Bug Fixes
* remove use of assert module ([#117](https://github.com/libp2p/js-peer-id/issues/117)) ([f44645e](https://github.com/libp2p/js-peer-id/commit/f44645e))
### Features ### Features
* adds typescript types + type tests ([#110](https://github.com/libp2p/js-peer-id/issues/110)) ([a5070ae](https://github.com/libp2p/js-peer-id/commit/a5070ae)) * inline public key handling for the 0.12.x line ([#102](https://github.com/libp2p/js-peer-id/issues/102)) ([ceeff13](https://github.com/libp2p/js-peer-id/commit/ceeff13))
<a name="0.13.7"></a> <a name="0.12.4"></a>
## [0.13.7](https://github.com/libp2p/js-peer-id/compare/v0.13.6...v0.13.7) (2020-01-27) ## [0.12.4](https://github.com/libp2p/js-peer-id/compare/v0.12.3...v0.12.4) (2019-07-23)
<a name="0.12.3"></a>
## [0.12.3](https://github.com/libp2p/js-peer-id/compare/v0.12.2...v0.12.3) (2019-07-11)
### Features ### Features
* adds typescript types + type tests ([#110](https://github.com/libp2p/js-peer-id/issues/110)) ([a5070ae](https://github.com/libp2p/js-peer-id/commit/a5070ae)) * **peerid:** support creating from secp256k1; harmonize algo with Go ([fd07221](https://github.com/libp2p/js-peer-id/commit/fd07221))
<a name="0.13.6"></a>
## [0.13.6](https://github.com/libp2p/js-peer-id/compare/v0.13.5...v0.13.6) (2019-12-18)
### Bug Fixes
* catch errors thrown by multihash decode ([#109](https://github.com/libp2p/js-peer-id/issues/109)) ([65e0b74](https://github.com/libp2p/js-peer-id/commit/65e0b74))
<a name="0.13.5"></a>
## [0.13.5](https://github.com/libp2p/js-peer-id/compare/v0.13.4...v0.13.5) (2019-11-12)
### Features
* deprecate isEqual in favor of equals ([#107](https://github.com/libp2p/js-peer-id/issues/107)) ([bbf0416](https://github.com/libp2p/js-peer-id/commit/bbf0416))
<a name="0.13.4"></a>
## [0.13.4](https://github.com/libp2p/js-peer-id/compare/v0.13.3...v0.13.4) (2019-11-04)
### Bug Fixes
* bang in bin.js ([#106](https://github.com/libp2p/js-peer-id/issues/106)) ([11d4ec1](https://github.com/libp2p/js-peer-id/commit/11d4ec1))
### Features
* support Peer ID represented as CID ([#105](https://github.com/libp2p/js-peer-id/issues/105)) ([544ca7d](https://github.com/libp2p/js-peer-id/commit/544ca7d))
<a name="0.13.3"></a>
## [0.13.3](https://github.com/libp2p/js-peer-id/compare/v0.13.2...v0.13.3) (2019-09-25)
### Features
* allow nested PeerIds to support pubKey function when using identity encoding ([#101](https://github.com/libp2p/js-peer-id/issues/101)) ([f39fb24](https://github.com/libp2p/js-peer-id/commit/f39fb24))
<a name="0.13.2"></a>
## [0.13.2](https://github.com/libp2p/js-peer-id/compare/v0.13.1...v0.13.2) (2019-07-12)
### Features
* add compact protobuf format ([#76](https://github.com/libp2p/js-peer-id/issues/76)) ([7686418](https://github.com/libp2p/js-peer-id/commit/7686418))
<a name="0.13.1"></a>
## [0.13.1](https://github.com/libp2p/js-peer-id/compare/v0.13.0...v0.13.1) (2019-07-11)
### Features
* **peerid:** support creating from secp256k1; harmonize algo with Go ([#95](https://github.com/libp2p/js-peer-id/issues/95)) ([17440a3](https://github.com/libp2p/js-peer-id/commit/17440a3))
<a name="0.13.0"></a>
# [0.13.0](https://github.com/libp2p/js-peer-id/compare/v0.12.2...v0.13.0) (2019-07-11)
### Features
* async await ([#87](https://github.com/libp2p/js-peer-id/issues/87)) ([c3463c7](https://github.com/libp2p/js-peer-id/commit/c3463c7))
### BREAKING CHANGES
* API refactored to use async/await

View File

@ -13,13 +13,10 @@
## Lead Maintainer ## Lead Maintainer
[Vasco Santos](https://github.com/vasco-santos) [Pedro Teixeira](https://github.com/pgte)
## Table of Contents ## Table of Contents
- [peer-id](#peer-id)
- [Lead Maintainer](#lead-maintainer)
- [Table of Contents](#table-of-contents)
- [Description](#description) - [Description](#description)
- [Example](#example) - [Example](#example)
- [Installation](#installation) - [Installation](#installation)
@ -31,27 +28,20 @@
- [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)
- [`create([opts])`](#createopts) - [`create([opts], callback)`](#createopts-callback)
- [Import](#import) - [Import](#import)
- [`createFromHexString(str)`](#createfromhexstringstr) - [`createFromHexString(str)`](#createfromhexstringstr)
- [`createFromBytes(buf)`](#createfrombytesbuf) - [`createFromBytes(buf)`](#createfrombytesbuf)
- [`createFromCID(cid)`](#createfromcidcid)
- [`createFromB58String(str)`](#createfromb58stringstr) - [`createFromB58String(str)`](#createfromb58stringstr)
- [`createFromPubKey(pubKey)`](#createfrompubkeypubkey) - [`createFromPubKey(pubKey)`](#createfrompubkeypubkey)
- [`createFromPrivKey(privKey)`](#createfromprivkeyprivkey) - [`createFromPrivKey(privKey)`](#createfromprivkeyprivkey)
- [`createFromJSON(obj)`](#createfromjsonobj) - [`createFromJSON(obj)`](#createfromjsonobj)
- [`createFromProtobuf(buf)`](#createfromprotobufbuf)
- [Export](#export) - [Export](#export)
- [`toHexString()`](#tohexstring) - [`toHexString()`](#tohexstring)
- [`toBytes()`](#tobytes) - [`toBytes()`](#tobytes)
- [`toString()`](#tostring)
- [`toB58String()`](#tob58string) - [`toB58String()`](#tob58string)
- [`toJSON()`](#tojson) - [`toJSON()`](#tojson)
- [`marshal(excludePrivateKey)`](#marshalexcludeprivatekey)
- [`marshalPubKey()`](#marshalpubkey)
- [`toPrint()`](#toprint) - [`toPrint()`](#toprint)
- [`equals(id)`](#equalsid)
- [`isEqual(id)`](#isequalid)
- [License](#license) - [License](#license)
# Description # Description
@ -67,10 +57,11 @@ 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' }) PeerId.create({ bits: 1024, keyType: 'rsa' }, (err, id) => {
console.log(JSON.stringify(id.toJSON(), null, 2)) if (err) { throw err }
console.log(JSON.stringify(id.toJSON(), null, 2))
})
``` ```
```bash ```bash
{ {
"id": "Qma9T5YraSnpRDZqRR4krcSJabThc8nwZuJV3LercPHufi", "id": "Qma9T5YraSnpRDZqRR4krcSJabThc8nwZuJV3LercPHufi",
@ -127,19 +118,20 @@ const PeerId = require('peer-id')
### `new PeerId(id[, privKey, pubKey])` ### `new PeerId(id[, privKey, pubKey])`
- `id: Buffer` - The multihash of the public key as `Buffer` - `id: Buffer` - The multihash of the publick key as `Buffer`
- `privKey: RsaPrivateKey` - The private key - `privKey: RsaPrivateKey` - The private key
- `pubKey: RsaPublicKey` - The public key - `pubKey: RsaPublicKey` - The public key
The key format is detailed in [libp2p-crypto](https://github.com/libp2p/js-libp2p-crypto). The key format is detailed in [libp2p-crypto](https://github.com/libp2p/js-libp2p-crypto).
### `create([opts])` ### `create([opts], callback)`
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: Object`: Default: `{bits: 2048, keyType: 'rsa'}`
- `callback: Function`
Returns `Promise<PeerId>`. Calls back `callback` with `err, id`.
## Import ## Import
@ -147,56 +139,32 @@ 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.
### `createFromBytes(buf)` ### `createFromBytes(buf)`
Creates a Peer ID from a buffer representing the key's multihash. Creates a Peer ID from a buffer representing the key's multihash.
Returns `PeerId`.
### `createFromCID(cid)`
- `cid: CID|String|Buffer` - The multihash encoded as [CID](https://github.com/ipld/js-cid) (object, `String` or `Buffer`)
Creates a Peer ID from a CID representation of the key's multihash ([RFC 0001](https://github.com/libp2p/specs/blob/master/RFC/0001-text-peerid-cid.md)).
Returns `PeerId`.
### `createFromB58String(str)` ### `createFromB58String(str)`
Creates a Peer ID from a Base58 string representing the key's multihash. Creates a Peer ID from a Base58 string representing the key's multihash.
Returns `PeerId`.
### `createFromPubKey(pubKey)` ### `createFromPubKey(pubKey)`
- `publicKey: Buffer` - `publicKey: Buffer`
Creates a Peer ID from a buffer containing a public key. Creates a Peer ID from a buffer containing a public key.
Returns `Promise<PeerId>`.
### `createFromPrivKey(privKey)` ### `createFromPrivKey(privKey)`
- `privKey: Buffer` - `privKey: Buffer`
Creates a Peer ID from a buffer containing a private key. Creates a Peer ID from a buffer containing a private key.
Returns `Promise<PeerId>`.
### `createFromJSON(obj)` ### `createFromJSON(obj)`
- `obj.id: String` - The multihash encoded in `base58` - `obj.id: String` - The multihash encoded in `base58`
- `obj.pubKey: String` - The public key in protobuf format, encoded in `base64` - `obj.pubKey: String` - The public key in protobuf format, encoded in `base64`
- `obj.privKey: String` - The private key in protobuf format, encoded in `base64` - `obj.privKey: String` - The private key in protobuf format, encoded in `base64`
Returns `Promise<PeerId>`.
### `createFromProtobuf(buf)`
`buf` is a protocol-buffers encoded PeerId (see `marshal()`)
## Export ## Export
### `toHexString()` ### `toHexString()`
@ -215,18 +183,9 @@ Returns the Peer ID's `id` as a buffer.
<Buffer 12 20 d6 24 39 98 f2 fc 56 34 3a d7 ed 03 42 ab 78 86 a4 eb 18 d7 36 f1 b6 7d 44 b3 7f cc 81 e0 f3 9f> <Buffer 12 20 d6 24 39 98 f2 fc 56 34 3a d7 ed 03 42 ab 78 86 a4 eb 18 d7 36 f1 b6 7d 44 b3 7f cc 81 e0 f3 9f>
``` ```
### `toString()`
Returns the Peer ID's `id` as a self-describing CIDv1 in Base32 ([RFC 0001](https://github.com/libp2p/specs/blob/master/RFC/0001-text-peerid-cid.md))
```
bafzbeigweq4zr4x4ky2dvv7nanbkw6egutvrrvzw6g3h2rftp7gidyhtt4
```
### `toB58String()` ### `toB58String()`
Returns the Peer ID's `id` as a base58 string (multihash/CIDv0). Returns the Peer ID's `id` as a base58 string.
``` ```
QmckZzdVd72h9QUFuJJpQqhsZqGLwjhh81qSvZ9BhB2FQi QmckZzdVd72h9QUFuJJpQqhsZqGLwjhh81qSvZ9BhB2FQi
@ -240,38 +199,13 @@ Returns an `obj` of the form
- `obj.pubKey: String` - The public key in protobuf format, encoded in 'base64' - `obj.pubKey: String` - The public key in protobuf format, encoded in 'base64'
- `obj.privKey: String` - The private key in protobuf format, encoded in 'base 64' - `obj.privKey: String` - The private key in protobuf format, encoded in 'base 64'
### `marshal(excludePrivateKey)`
Returns a protocol-buffers encoded version of the id, public key and, if `excludePrivateKey` is not set, the private key.
### `marshalPubKey()`
Returns a protobuf of just the public key, compatible with `libp2p-crypto` (unlike `marshal` above).
For example:
```js
const crypto = require('libp2p-crypto')
PeerId.create({ bits: 256, keyType: 'ed25519' }).then( pid => {
let pk = crypto.keys.unmarshalPublicKey(pid.marshalPubKey())
// your code here
}
```
### `toPrint()` ### `toPrint()`
Returns the Peer ID as a printable string without the `Qm` prefix. Returns the Peer ID as a printable string without the `Qm` prefix.
Example: `<peer.ID xxxxxx>` Example: `<peer.ID xxxxxx>`
### `equals(id)`
Returns `true` if the given PeerId is equal to the current instance.
- `id` can be a PeerId or a Buffer containing the id
### `isEqual(id)` ### `isEqual(id)`
**Deprecation Notice**: Use [`equals`](#equalsid), `isEqual` will be removed in 0.14.0.
- `id` can be a PeerId or a Buffer containing the id - `id` can be a PeerId or a Buffer containing the id

View File

@ -1,10 +1,9 @@
{ {
"name": "peer-id", "name": "peer-id",
"version": "0.13.8", "version": "0.12.5",
"description": "IPFS Peer Id implementation in Node.js", "description": "IPFS Peer Id implementation in Node.js",
"leadMaintainer": "Vasco Santos <santos.vasco10@gmail.com>", "leadMaintainer": "Pedro Teixeira <i@pgte.me>",
"main": "src/index.js", "main": "src/index.js",
"types": "src/index.d.ts",
"bin": "src/bin.js", "bin": "src/bin.js",
"scripts": { "scripts": {
"lint": "aegir lint", "lint": "aegir lint",
@ -12,7 +11,6 @@
"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",
"release": "aegir release", "release": "aegir release",
"release-minor": "aegir release --type minor", "release-minor": "aegir release --type minor",
"release-major": "aegir release --type major", "release-major": "aegir release --type major",
@ -36,48 +34,38 @@
}, },
"homepage": "https://github.com/libp2p/js-peer-id", "homepage": "https://github.com/libp2p/js-peer-id",
"devDependencies": { "devDependencies": {
"@types/chai": "^4.2.7",
"@types/dirty-chai": "^2.0.2",
"@types/mocha": "^5.2.7",
"aegir": "^20.0.0", "aegir": "^20.0.0",
"bundlesize": "~0.18.0", "bundlesize": "~0.17.1",
"chai": "^4.2.0", "chai": "^4.2.0",
"dirty-chai": "^2.0.1" "dirty-chai": "^2.0.1"
}, },
"dependencies": { "dependencies": {
"cids": "^0.7.3", "libp2p-crypto": "~0.16.1",
"async": "^2.6.3",
"class-is": "^1.1.0", "class-is": "^1.1.0",
"libp2p-crypto": "~0.17.2", "multihashes": "~0.4.15"
"multihashes": "~0.4.15",
"protons": "^1.0.1"
}, },
"repository": { "repository": {
"type": "git", "type": "git",
"url": "https://github.com/libp2p/js-peer-id.git" "url": "https://github.com/libp2p/js-peer-id.git"
}, },
"contributors": [ "contributors": [
"Alex Potsides <alex@achingbrain.net>",
"Arve Knudsen <arve.knudsen@gmail.com>", "Arve Knudsen <arve.knudsen@gmail.com>",
"Carson Farmer <carson.farmer@gmail.com>",
"Christian Paul <info@jaller.de>",
"David Dias <daviddias.p@gmail.com>", "David Dias <daviddias.p@gmail.com>",
"David Dias <mail@daviddias.me>", "David Dias <mail@daviddias.me>",
"Friedel Ziegelmayer <dignifiedquire@gmail.com>", "Friedel Ziegelmayer <dignifiedquire@gmail.com>",
"Henrique Dias <hacdias@gmail.com>",
"Hugo Dias <hugomrdias@gmail.com>", "Hugo Dias <hugomrdias@gmail.com>",
"Jacob Heun <jacobheun@gmail.com>", "Jacob Heun <jacobheun@gmail.com>",
"Maciej Krüger <mkg20001@gmail.com>", "Maciej Krüger <mkg20001@gmail.com>",
"Marcin Rataj <lidel@lidel.org>",
"Michael Garvin <gar+gh@danger.computer>", "Michael Garvin <gar+gh@danger.computer>",
"Nate Foss <npfoss@gmail.com>",
"Pedro Teixeira <i@pgte.me>", "Pedro Teixeira <i@pgte.me>",
"Prashanth Chandra <coolshanth94@gmail.com>", "Prashanth Chandra <coolshanth94@gmail.com>",
"Richard Littauer <richard.littauer@gmail.com>", "Richard Littauer <richard.littauer@gmail.com>",
"Richard Schneider <makaretu@gmail.com>", "Richard Schneider <makaretu@gmail.com>",
"Stephen Whitmore <stephen.whitmore@gmail.com>", "Stephen Whitmore <stephen.whitmore@gmail.com>",
"Topper Bowers <topper@quorumcontrol.com>", "Topper Bowers <topper@toppingdesign.com>",
"Vasco Santos <vasco.santos@moxy.studio>",
"Vasco Santos <vasco.santos@ua.pt>", "Vasco Santos <vasco.santos@ua.pt>",
"Vasco Santos <vasco.santos@moxy.studio>",
"Yahya <ya7yaz@gmail.com>", "Yahya <ya7yaz@gmail.com>",
"greenkeeperio-bot <support@greenkeeper.io>", "greenkeeperio-bot <support@greenkeeper.io>",
"nginnever <ginneversource@gmail.com>", "nginnever <ginneversource@gmail.com>",

View File

@ -1,12 +1,14 @@
#!/usr/bin/env node #!/usr/local/bin/node
'use strict' 'use strict'
const PeerId = require('./index.js') const PeerId = require('./index.js')
async function main () { PeerId.create((err, id) => {
const id = await PeerId.create() if (err) {
console.log(JSON.stringify(id.toJSON(), null, 2)) // eslint-disable-line no-console throw err
} }
main() // eslint-disable-next-line
console.log(JSON.stringify(id.toJSON(), null, 2))
})

188
src/index.d.ts vendored
View File

@ -1,188 +0,0 @@
import crypto, { PrivateKey, PublicKey, KeyType } from "libp2p-crypto";
import CID from 'cids'
declare namespace PeerId {
/**
* Options for PeerId creation.
*/
type CreateOptions = {
/**
* The number of bits to use.
*/
bits?: number;
/**
* The type of key to use.
*/
keyType?: KeyType;
};
/**
* PeerId JSON format.
*/
type JSONPeerId = {
/**
* String representation of PeerId.
*/
id: string;
/**
* Public key.
*/
pubKey?: string;
/**
* Private key.
*/
privKey: string;
};
/**
* Checks if a value is an instance of PeerId.
* @param id The value to check.
*/
function isPeerId(id: any): boolean
/**
* Create a new PeerId.
* @param opts Options.
*/
function create(opts?: PeerId.CreateOptions): Promise<PeerId>;
/**
* Create PeerId from hex string.
* @param str The input hex string.
*/
function createFromHexString(str: string): PeerId;
/**
* Create PeerId from raw bytes.
* @param buf The raw bytes.
*/
function createFromBytes(buf: Buffer): PeerId;
/**
* Create PeerId from base58-encoded string.
* @param str The base58-encoded string.
*/
function createFromB58String(str: string): PeerId;
/**
* Create PeerId from CID.
* @param cid The CID.
*/
function createFromCID(cid: CID | Buffer | string | object): PeerId;
/**
* Create PeerId from public key.
* @param key Public key, as Buffer or base64-encoded string.
*/
function createFromPubKey(key: Buffer | string): Promise<PeerId>;
/**
* Create PeerId from private key.
* @param key Private key, as Buffer or base64-encoded string.
*/
function createFromPrivKey(key: Buffer | string): Promise<PeerId>;
/**
* Create PeerId from PeerId JSON formatted object.
* @see {@link PeerId#toJSON}
* @param json PeerId in JSON format.
*/
function createFromJSON(json: JSONPeerId): Promise<PeerId>;
/**
* Create PeerId from Protobuf bytes.
* @param buf Protobuf bytes, as Buffer or hex-encoded string.
*/
function createFromProtobuf(buf: Buffer | string): Promise<PeerId>;
}
/**
* PeerId is an object representation of a peer identifier.
*/
declare class PeerId {
constructor(id: Buffer | string, privKey?: PrivateKey, pubKey?: PublicKey);
/**
* Raw id.
*/
id: Buffer;
/**
* Private key.
*/
privKey: PrivateKey;
/**
* Public key.
*/
pubKey: PublicKey;
/**
* Return the protobuf version of the public key, matching go ipfs formatting.
*/
marshalPubKey(): Buffer;
/**
* Return the protobuf version of the private key, matching go ipfs formatting.
*/
marshalPrivKey(): Buffer;
/**
* Return the protobuf version of the peer-id.
* @param excludePriv Whether to exclude the private key information from the output.
*/
marshal(excludePriv?: boolean): Buffer;
/**
* String representation.
*/
toPrint(): string;
/**
* Return the jsonified version of the key.
* Matches the formatting of go-ipfs for its config file.
* @see {@link PeerId.createFromJSON}
*/
toJSON(): PeerId.JSONPeerId;
/**
* Encode to hex.
*/
toHexString(): string;
/**
* Return raw id bytes.
*/
toBytes(): Buffer;
/**
* Encode to base58 string.
*/
toB58String(): string;
/**
* Return self-describing string representation.
* Uses default format from RFC 0001: https://github.com/libp2p/specs/pull/209
*/
toString(): string;
/**
* Checks the equality of `this` peer against a given PeerId.
* @param id The other PeerId.
*/
equals(id: PeerId | Buffer): boolean;
/**
* Checks the equality of `this` peer against a given PeerId.
* @deprecated Use {.equals}
* @param id The other PeerId.
*/
isEqual(id: PeerId | Buffer): boolean;
/**
* Check if this PeerId instance is valid (privKey -> pubKey -> Id)
*/
isValid(): boolean;
}
export = PeerId;

View File

@ -5,19 +5,17 @@
'use strict' 'use strict'
const mh = require('multihashes') const mh = require('multihashes')
const CID = require('cids')
const cryptoKeys = require('libp2p-crypto/src/keys') const cryptoKeys = require('libp2p-crypto/src/keys')
const assert = require('assert')
const waterfall = require('async/waterfall')
const withIs = require('class-is') const withIs = require('class-is')
const { PeerIdProto } = require('./proto')
class PeerId { class PeerId {
constructor (id, privKey, pubKey) { constructor (id, privKey, pubKey) {
if (!Buffer.isBuffer(id)) { assert(Buffer.isBuffer(id), 'invalid id provided')
throw new Error('invalid id provided')
}
if (privKey && pubKey && !privKey.public.bytes.equals(pubKey.bytes)) { if (privKey && pubKey) {
throw new Error('inconsistent arguments') assert(privKey.public.bytes.equals(pubKey.bytes), 'inconsistent arguments')
} }
this._id = id this._id = id
@ -51,17 +49,12 @@ class PeerId {
return this._privKey.public return this._privKey.public
} }
try { const decoded = mh.decode(this.id)
const decoded = mh.decode(this.id)
if (decoded.name === 'identity') { if (decoded.name === 'identity') {
this._pubKey = cryptoKeys.unmarshalPublicKey(decoded.digest) this._pubKey = cryptoKeys.unmarshalPublicKey(decoded.digest)
} return this._pubKey
} catch (_) {
// Ignore, there is no valid public key
} }
return this._pubKey
} }
set pubKey (pubKey) { set pubKey (pubKey) {
@ -82,15 +75,6 @@ class PeerId {
} }
} }
// Return the protobuf version of the peer-id
marshal (excludePriv) {
return PeerIdProto.encode({
id: this.toBytes(),
pubKey: this.marshalPubKey(),
privKey: excludePriv ? null : this.marshalPrivKey()
})
}
toPrint () { toPrint () {
let pid = this.toB58String() let pid = this.toB58String()
// All sha256 nodes start with Qm // All sha256 nodes start with Qm
@ -129,22 +113,7 @@ class PeerId {
return this._idB58String return this._idB58String
} }
// return self-describing String representation isEqual (id) {
// in default format from RFC 0001: https://github.com/libp2p/specs/pull/209
toString () {
if (!this._idCIDString) {
const cid = new CID(1, 'libp2p-key', this.id, 'base32')
this._idCIDString = cid.toBaseEncodedString('base32')
}
return this._idCIDString
}
/**
* Checks the equality of `this` peer against a given PeerId.
* @param {Buffer|PeerId} id
* @returns {boolean}
*/
equals (id) {
if (Buffer.isBuffer(id)) { if (Buffer.isBuffer(id)) {
return this.id.equals(id) return this.id.equals(id)
} else if (id.id) { } else if (id.id) {
@ -154,188 +123,188 @@ class PeerId {
} }
} }
/**
* Checks the equality of `this` peer against a given PeerId.
* @deprecated Use `.equals`
* @param {Buffer|PeerId} id
* @returns {boolean}
*/
isEqual (id) {
return this.equals(id)
}
/* /*
* Check if this PeerId instance is valid (privKey -> pubKey -> Id) * Check if this PeerId instance is valid (privKey -> pubKey -> Id)
*/ */
isValid () { isValid (callback) {
// TODO: needs better checking // TODO Needs better checking
return Boolean(this.privKey && if (this.privKey &&
this.privKey.public && this.privKey.public &&
this.privKey.public.bytes && this.privKey.public.bytes &&
Buffer.isBuffer(this.pubKey.bytes) && Buffer.isBuffer(this.pubKey.bytes) &&
this.privKey.public.bytes.equals(this.pubKey.bytes)) this.privKey.public.bytes.equals(this.pubKey.bytes)) {
callback()
} else {
callback(new Error('Keys not match'))
}
} }
} }
const PeerIdWithIs = withIs(PeerId, { const PeerIdWithIs = withIs(PeerId, { className: 'PeerId', symbolName: '@libp2p/js-peer-id/PeerId' })
className: 'PeerId',
symbolName: '@libp2p/js-peer-id/PeerId'
})
exports = module.exports = PeerIdWithIs exports = module.exports = PeerIdWithIs
const computeDigest = (pubKey) => { const computeDigest = (pubKey, cb) => {
if (pubKey.bytes.length <= 42) { if (pubKey.bytes.length <= 42) {
return mh.encode(pubKey.bytes, 'identity') const digest = mh.encode(pubKey.bytes, 'identity')
cb(null, digest)
} else { } else {
return pubKey.hash() pubKey.hash((err, digest) => {
cb(err, digest)
})
} }
} }
const computePeerId = async (privKey, pubKey) => { const computePeerId = (privKey, pubKey, cb) => {
const digest = await computeDigest(pubKey) computeDigest(pubKey, (err, digest) => {
return new PeerIdWithIs(digest, privKey, pubKey) if (err != null) {
cb(err)
} else {
cb(null, new PeerIdWithIs(digest, privKey, pubKey))
}
})
} }
// generation // generation
exports.create = async (opts) => { exports.create = function (opts, callback) {
if (typeof opts === 'function') {
callback = opts
opts = {}
}
opts = opts || {} opts = opts || {}
opts.bits = opts.bits || 2048 opts.bits = opts.bits || 2048
opts.keyType = opts.keyType || 'RSA' opts.keyType = opts.keyType || 'RSA'
const key = await cryptoKeys.generateKeyPair(opts.keyType, opts.bits) cryptoKeys.generateKeyPair(opts.keyType, opts.bits, (err, privKey) => {
return computePeerId(key, key.public) if (err != null) {
callback(err)
} else {
computePeerId(privKey, privKey.public, callback)
}
})
} }
exports.createFromHexString = (str) => { exports.createFromHexString = function (str) {
return new PeerIdWithIs(mh.fromHexString(str)) return new PeerIdWithIs(mh.fromHexString(str))
} }
exports.createFromBytes = (buf) => { exports.createFromBytes = function (buf) {
return new PeerIdWithIs(buf) return new PeerIdWithIs(buf)
} }
exports.createFromB58String = (str) => { exports.createFromB58String = function (str) {
return exports.createFromCID(str) // B58String is CIDv0 return new PeerIdWithIs(mh.fromB58String(str))
}
const validMulticodec = (cid) => {
// supported: 'libp2p-key' (CIDv1) and 'dag-pb' (CIDv0 converted to CIDv1)
return cid.codec === 'libp2p-key' || cid.codec === 'dag-pb'
}
exports.createFromCID = (cid) => {
cid = CID.isCID(cid) ? cid : new CID(cid)
if (!validMulticodec(cid)) throw new Error('Supplied PeerID CID has invalid multicodec: ' + cid.codec)
return new PeerIdWithIs(cid.multihash)
} }
// Public Key input will be a buffer // Public Key input will be a buffer
exports.createFromPubKey = async (key) => { exports.createFromPubKey = function (key, callback) {
let buf = key if (typeof callback !== 'function') {
throw new Error('callback is required')
if (typeof buf === 'string') {
buf = Buffer.from(key, 'base64')
} }
if (!Buffer.isBuffer(buf)) { let pubKey
throw new Error('Supplied key is neither a base64 string nor a buffer')
try {
let buf = key
if (typeof buf === 'string') {
buf = Buffer.from(key, 'base64')
}
if (!Buffer.isBuffer(buf)) throw new Error('Supplied key is neither a base64 string nor a buffer')
pubKey = cryptoKeys.unmarshalPublicKey(buf)
} catch (err) {
return callback(err)
} }
const pubKey = await cryptoKeys.unmarshalPublicKey(buf) computePeerId(null, pubKey, callback)
return computePeerId(null, pubKey)
} }
// Private key input will be a string // Private key input will be a string
exports.createFromPrivKey = async (key) => { exports.createFromPrivKey = function (key, callback) {
if (typeof callback !== 'function') {
throw new Error('callback is required')
}
let buf = key let buf = key
if (typeof buf === 'string') { try {
buf = Buffer.from(key, 'base64') if (typeof buf === 'string') {
buf = Buffer.from(key, 'base64')
}
if (!Buffer.isBuffer(buf)) throw new Error('Supplied key is neither a base64 string nor a buffer')
} catch (err) {
return callback(err)
} }
if (!Buffer.isBuffer(buf)) { cryptoKeys.unmarshalPrivateKey(buf, (err, privKey) => {
throw new Error('Supplied key is neither a base64 string nor a buffer') if (err != null) {
} callback(err)
} else {
const privKey = await cryptoKeys.unmarshalPrivateKey(buf) computePeerId(privKey, privKey.public, callback)
return computePeerId(privKey, privKey.public) }
})
} }
exports.createFromJSON = async (obj) => { exports.createFromJSON = function (obj, callback) {
const id = mh.fromB58String(obj.id) if (typeof callback !== 'function') {
const rawPrivKey = obj.privKey && Buffer.from(obj.privKey, 'base64') throw new Error('callback is required')
const rawPubKey = obj.pubKey && Buffer.from(obj.pubKey, 'base64') }
const pub = rawPubKey && await cryptoKeys.unmarshalPublicKey(rawPubKey)
let id
let rawPrivKey
let rawPubKey
let pub
try {
id = mh.fromB58String(obj.id)
rawPrivKey = obj.privKey && Buffer.from(obj.privKey, 'base64')
rawPubKey = obj.pubKey && Buffer.from(obj.pubKey, 'base64')
pub = rawPubKey && cryptoKeys.unmarshalPublicKey(rawPubKey)
} catch (err) {
return callback(err)
}
if (!rawPrivKey) { if (!rawPrivKey) {
return new PeerIdWithIs(id, null, pub) callback(null, new PeerIdWithIs(id, null, pub))
return
} }
const privKey = await cryptoKeys.unmarshalPrivateKey(rawPrivKey) waterfall([
const privDigest = await computeDigest(privKey.public) (cb) => cryptoKeys.unmarshalPrivateKey(rawPrivKey, cb),
(priv, cb) => {
let pubDigest computeDigest(priv.public, (err, digest) => {
cb(err, digest, priv)
if (pub) { })
pubDigest = await computeDigest(pub) },
} (privDigest, priv, cb) => {
if (pub) {
if (pub && !privDigest.equals(pubDigest)) { computeDigest(pub, (err, pubDigest) => {
throw new Error('Public and private key do not match') cb(err, privDigest, priv, pubDigest)
} })
} else {
if (id && !privDigest.equals(id)) { cb(null, privDigest, priv)
throw new Error('Id and private key do not match')
}
return new PeerIdWithIs(id, privKey, pub)
}
exports.createFromProtobuf = async (buf) => {
if (typeof buf === 'string') {
buf = Buffer.from(buf, 'hex')
}
let { id, privKey, pubKey } = PeerIdProto.decode(buf)
privKey = privKey ? await cryptoKeys.unmarshalPrivateKey(privKey) : false
pubKey = pubKey ? await cryptoKeys.unmarshalPublicKey(pubKey) : false
let pubDigest
let privDigest
if (privKey) {
privDigest = await computeDigest(privKey.public)
}
if (pubKey) {
pubDigest = await computeDigest(pubKey)
}
if (privKey) {
if (pubKey) {
if (!privDigest.equals(pubDigest)) {
throw new Error('Public and private key do not match')
} }
} }
return new PeerIdWithIs(privDigest, privKey, privKey.public) ], (err, privDigest, priv, pubDigest) => {
} if (err) {
return callback(err)
}
// TODO: val id and pubDigest if (pub && !privDigest.equals(pubDigest)) {
return callback(new Error('Public and private key do not match'))
}
if (pubKey) { if (id && !privDigest.equals(id)) {
return new PeerIdWithIs(pubDigest, null, pubKey) return callback(new Error('Id and private key do not match'))
} }
if (id) { callback(null, new PeerIdWithIs(id, priv, pub))
return new PeerIdWithIs(id) })
}
throw new Error('Protobuf did not contain any usable key material')
} }
exports.isPeerId = (peerId) => { exports.isPeerId = function (peerId) {
return Boolean(typeof peerId === 'object' && return Boolean(typeof peerId === 'object' &&
peerId._id && peerId._id &&
peerId._idB58String) peerId._idB58String)

View File

@ -1,12 +0,0 @@
'use strict'
const protons = require('protons')
module.exports = protons(`
message PeerIdProto {
required bytes id = 1;
bytes pubKey = 2;
bytes privKey = 3;
}
`)

View File

@ -3,6 +3,5 @@
module.exports = { module.exports = {
id: '122019318b6e5e0cf93a2314bf01269a2cc23cd3dcd452d742cdb9379d8646f6e4a9', id: '122019318b6e5e0cf93a2314bf01269a2cc23cd3dcd452d742cdb9379d8646f6e4a9',
privKey: 'CAASpgkwggSiAgEAAoIBAQC2SKo/HMFZeBml1AF3XijzrxrfQXdJzjePBZAbdxqKR1Mc6juRHXij6HXYPjlAk01BhF1S3Ll4Lwi0cAHhggf457sMg55UWyeGKeUv0ucgvCpBwlR5cQ020i0MgzjPWOLWq1rtvSbNcAi2ZEVn6+Q2EcHo3wUvWRtLeKz+DZSZfw2PEDC+DGPJPl7f8g7zl56YymmmzH9liZLNrzg/qidokUv5u1pdGrcpLuPNeTODk0cqKB+OUbuKj9GShYECCEjaybJDl9276oalL9ghBtSeEv20kugatTvYy590wFlJkkvyl+nPxIH0EEYMKK9XRWlu9XYnoSfboiwcv8M3SlsjAgMBAAECggEAZtju/bcKvKFPz0mkHiaJcpycy9STKphorpCT83srBVQi59CdFU6Mj+aL/xt0kCPMVigJw8P3/YCEJ9J+rS8BsoWE+xWUEsJvtXoT7vzPHaAtM3ci1HZd302Mz1+GgS8Epdx+7F5p80XAFLDUnELzOzKftvWGZmWfSeDnslwVONkL/1VAzwKy7Ce6hk4SxRE7l2NE2OklSHOzCGU1f78ZzVYKSnS5Ag9YrGjOAmTOXDbKNKN/qIorAQ1bovzGoCwx3iGIatQKFOxyVCyO1PsJYT7JO+kZbhBWRRE+L7l+ppPER9bdLFxs1t5CrKc078h+wuUr05S1P1JjXk68pk3+kQKBgQDeK8AR11373Mzib6uzpjGzgNRMzdYNuExWjxyxAzz53NAR7zrPHvXvfIqjDScLJ4NcRO2TddhXAfZoOPVH5k4PJHKLBPKuXZpWlookCAyENY7+Pd55S8r+a+MusrMagYNljb5WbVTgN8cgdpim9lbbIFlpN6SZaVjLQL3J8TWH6wKBgQDSChzItkqWX11CNstJ9zJyUE20I7LrpyBJNgG1gtvz3ZMUQCn3PxxHtQzN9n1P0mSSYs+jBKPuoSyYLt1wwe10/lpgL4rkKWU3/m1Myt0tveJ9WcqHh6tzcAbb/fXpUFT/o4SWDimWkPkuCb+8j//2yiXk0a/T2f36zKMuZvujqQKBgC6B7BAQDG2H2B/ijofp12ejJU36nL98gAZyqOfpLJ+FeMz4TlBDQ+phIMhnHXA5UkdDapQ+zA3SrFk+6yGk9Vw4Hf46B+82SvOrSbmnMa+PYqKYIvUzR4gg34rL/7AhwnbEyD5hXq4dHwMNsIDq+l2elPjwm/U9V0gdAl2+r50HAoGALtsKqMvhv8HucAMBPrLikhXP/8um8mMKFMrzfqZ+otxfHzlhI0L08Bo3jQrb0Z7ByNY6M8epOmbCKADsbWcVre/AAY0ZkuSZK/CaOXNX/AhMKmKJh8qAOPRY02LIJRBCpfS4czEdnfUhYV/TYiFNnKRj57PPYZdTzUsxa/yVTmECgYBr7slQEjb5Onn5mZnGDh+72BxLNdgwBkhO0OCdpdISqk0F0Pxby22DFOKXZEpiyI9XYP1C8wPiJsShGm2yEwBPWXnrrZNWczaVuCbXHrZkWQogBDG3HGXNdU4MAWCyiYlyinIBpPpoAJZSzpGLmWbMWh28+RJS6AQX6KHrK1o2uw==', privKey: 'CAASpgkwggSiAgEAAoIBAQC2SKo/HMFZeBml1AF3XijzrxrfQXdJzjePBZAbdxqKR1Mc6juRHXij6HXYPjlAk01BhF1S3Ll4Lwi0cAHhggf457sMg55UWyeGKeUv0ucgvCpBwlR5cQ020i0MgzjPWOLWq1rtvSbNcAi2ZEVn6+Q2EcHo3wUvWRtLeKz+DZSZfw2PEDC+DGPJPl7f8g7zl56YymmmzH9liZLNrzg/qidokUv5u1pdGrcpLuPNeTODk0cqKB+OUbuKj9GShYECCEjaybJDl9276oalL9ghBtSeEv20kugatTvYy590wFlJkkvyl+nPxIH0EEYMKK9XRWlu9XYnoSfboiwcv8M3SlsjAgMBAAECggEAZtju/bcKvKFPz0mkHiaJcpycy9STKphorpCT83srBVQi59CdFU6Mj+aL/xt0kCPMVigJw8P3/YCEJ9J+rS8BsoWE+xWUEsJvtXoT7vzPHaAtM3ci1HZd302Mz1+GgS8Epdx+7F5p80XAFLDUnELzOzKftvWGZmWfSeDnslwVONkL/1VAzwKy7Ce6hk4SxRE7l2NE2OklSHOzCGU1f78ZzVYKSnS5Ag9YrGjOAmTOXDbKNKN/qIorAQ1bovzGoCwx3iGIatQKFOxyVCyO1PsJYT7JO+kZbhBWRRE+L7l+ppPER9bdLFxs1t5CrKc078h+wuUr05S1P1JjXk68pk3+kQKBgQDeK8AR11373Mzib6uzpjGzgNRMzdYNuExWjxyxAzz53NAR7zrPHvXvfIqjDScLJ4NcRO2TddhXAfZoOPVH5k4PJHKLBPKuXZpWlookCAyENY7+Pd55S8r+a+MusrMagYNljb5WbVTgN8cgdpim9lbbIFlpN6SZaVjLQL3J8TWH6wKBgQDSChzItkqWX11CNstJ9zJyUE20I7LrpyBJNgG1gtvz3ZMUQCn3PxxHtQzN9n1P0mSSYs+jBKPuoSyYLt1wwe10/lpgL4rkKWU3/m1Myt0tveJ9WcqHh6tzcAbb/fXpUFT/o4SWDimWkPkuCb+8j//2yiXk0a/T2f36zKMuZvujqQKBgC6B7BAQDG2H2B/ijofp12ejJU36nL98gAZyqOfpLJ+FeMz4TlBDQ+phIMhnHXA5UkdDapQ+zA3SrFk+6yGk9Vw4Hf46B+82SvOrSbmnMa+PYqKYIvUzR4gg34rL/7AhwnbEyD5hXq4dHwMNsIDq+l2elPjwm/U9V0gdAl2+r50HAoGALtsKqMvhv8HucAMBPrLikhXP/8um8mMKFMrzfqZ+otxfHzlhI0L08Bo3jQrb0Z7ByNY6M8epOmbCKADsbWcVre/AAY0ZkuSZK/CaOXNX/AhMKmKJh8qAOPRY02LIJRBCpfS4czEdnfUhYV/TYiFNnKRj57PPYZdTzUsxa/yVTmECgYBr7slQEjb5Onn5mZnGDh+72BxLNdgwBkhO0OCdpdISqk0F0Pxby22DFOKXZEpiyI9XYP1C8wPiJsShGm2yEwBPWXnrrZNWczaVuCbXHrZkWQogBDG3HGXNdU4MAWCyiYlyinIBpPpoAJZSzpGLmWbMWh28+RJS6AQX6KHrK1o2uw==',
pubKey: 'CAASpgIwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC2SKo/HMFZeBml1AF3XijzrxrfQXdJzjePBZAbdxqKR1Mc6juRHXij6HXYPjlAk01BhF1S3Ll4Lwi0cAHhggf457sMg55UWyeGKeUv0ucgvCpBwlR5cQ020i0MgzjPWOLWq1rtvSbNcAi2ZEVn6+Q2EcHo3wUvWRtLeKz+DZSZfw2PEDC+DGPJPl7f8g7zl56YymmmzH9liZLNrzg/qidokUv5u1pdGrcpLuPNeTODk0cqKB+OUbuKj9GShYECCEjaybJDl9276oalL9ghBtSeEv20kugatTvYy590wFlJkkvyl+nPxIH0EEYMKK9XRWlu9XYnoSfboiwcv8M3SlsjAgMBAAE=', pubKey: 'CAASpgIwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC2SKo/HMFZeBml1AF3XijzrxrfQXdJzjePBZAbdxqKR1Mc6juRHXij6HXYPjlAk01BhF1S3Ll4Lwi0cAHhggf457sMg55UWyeGKeUv0ucgvCpBwlR5cQ020i0MgzjPWOLWq1rtvSbNcAi2ZEVn6+Q2EcHo3wUvWRtLeKz+DZSZfw2PEDC+DGPJPl7f8g7zl56YymmmzH9liZLNrzg/qidokUv5u1pdGrcpLuPNeTODk0cqKB+OUbuKj9GShYECCEjaybJDl9276oalL9ghBtSeEv20kugatTvYy590wFlJkkvyl+nPxIH0EEYMKK9XRWlu9XYnoSfboiwcv8M3SlsjAgMBAAE='
marshaled: '0a22122019318b6e5e0cf93a2314bf01269a2cc23cd3dcd452d742cdb9379d8646f6e4a912ab02080012a60230820122300d06092a864886f70d01010105000382010f003082010a0282010100b648aa3f1cc1597819a5d401775e28f3af1adf417749ce378f05901b771a8a47531cea3b911d78a3e875d83e3940934d41845d52dcb9782f08b47001e18207f8e7bb0c839e545b278629e52fd2e720bc2a41c25479710d36d22d0c8338cf58e2d6ab5aedbd26cd7008b6644567ebe43611c1e8df052f591b4b78acfe0d94997f0d8f1030be0c63c93e5edff20ef3979e98ca69a6cc7f658992cdaf383faa2768914bf9bb5a5d1ab7292ee3cd79338393472a281f8e51bb8a8fd1928581020848dac9b24397ddbbea86a52fd82106d49e12fdb492e81ab53bd8cb9f74c05949924bf297e9cfc481f410460c28af5745696ef57627a127dba22c1cbfc3374a5b2302030100011aab09080012a609308204a20201000282010100b648aa3f1cc1597819a5d401775e28f3af1adf417749ce378f05901b771a8a47531cea3b911d78a3e875d83e3940934d41845d52dcb9782f08b47001e18207f8e7bb0c839e545b278629e52fd2e720bc2a41c25479710d36d22d0c8338cf58e2d6ab5aedbd26cd7008b6644567ebe43611c1e8df052f591b4b78acfe0d94997f0d8f1030be0c63c93e5edff20ef3979e98ca69a6cc7f658992cdaf383faa2768914bf9bb5a5d1ab7292ee3cd79338393472a281f8e51bb8a8fd1928581020848dac9b24397ddbbea86a52fd82106d49e12fdb492e81ab53bd8cb9f74c05949924bf297e9cfc481f410460c28af5745696ef57627a127dba22c1cbfc3374a5b2302030100010282010066d8eefdb70abca14fcf49a41e2689729c9ccbd4932a9868ae9093f37b2b055422e7d09d154e8c8fe68bff1b749023cc562809c3c3f7fd808427d27ead2f01b28584fb159412c26fb57a13eefccf1da02d337722d4765ddf4d8ccf5f86812f04a5dc7eec5e69f345c014b0d49c42f33b329fb6f58666659f49e0e7b25c1538d90bff5540cf02b2ec27ba864e12c5113b976344d8e9254873b30865357fbf19cd560a4a74b9020f58ac68ce0264ce5c36ca34a37fa88a2b010d5ba2fcc6a02c31de21886ad40a14ec72542c8ed4fb09613ec93be9196e105645113e2fb97ea693c447d6dd2c5c6cd6de42aca734efc87ec2e52bd394b53f52635e4ebca64dfe9102818100de2bc011d75dfbdccce26fabb3a631b380d44ccdd60db84c568f1cb1033cf9dcd011ef3acf1ef5ef7c8aa30d270b27835c44ed9375d85701f66838f547e64e0f24728b04f2ae5d9a56968a24080c84358efe3dde794bcafe6be32eb2b31a8183658dbe566d54e037c7207698a6f656db20596937a4996958cb40bdc9f13587eb02818100d20a1cc8b64a965f5d4236cb49f73272504db423b2eba720493601b582dbf3dd93144029f73f1c47b50ccdf67d4fd2649262cfa304a3eea12c982edd70c1ed74fe5a602f8ae4296537fe6d4ccadd2dbde27d59ca8787ab737006dbfdf5e95054ffa384960e299690f92e09bfbc8ffff6ca25e4d1afd3d9fdfacca32e66fba3a90281802e81ec10100c6d87d81fe28e87e9d767a3254dfa9cbf7c800672a8e7e92c9f8578ccf84e504343ea6120c8671d70395247436a943ecc0dd2ac593eeb21a4f55c381dfe3a07ef364af3ab49b9a731af8f62a29822f533478820df8acbffb021c276c4c83e615eae1d1f030db080eafa5d9e94f8f09bf53d57481d025dbeaf9d070281802edb0aa8cbe1bfc1ee7003013eb2e29215cfffcba6f2630a14caf37ea67ea2dc5f1f39612342f4f01a378d0adbd19ec1c8d63a33c7a93a66c22800ec6d6715adefc0018d1992e4992bf09a397357fc084c2a628987ca8038f458d362c8251042a5f4b873311d9df521615fd362214d9ca463e7b3cf619753cd4b316bfc954e610281806beec9501236f93a79f99999c60e1fbbd81c4b35d83006484ed0e09da5d212aa4d05d0fc5bcb6d8314e297644a62c88f5760fd42f303e226c4a11a6db213004f5979ebad9356733695b826d71eb664590a200431b71c65cd754e0c0160b28989728a7201a4fa68009652ce918b9966cc5a1dbcf91252e80417e8a1eb2b5a36bb'
} }

View File

@ -8,7 +8,8 @@ chai.use(dirtyChai)
const expect = chai.expect 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 parallel = require('async/parallel')
const waterfall = require('async/waterfall')
const PeerId = require('../src') const PeerId = require('../src')
@ -18,8 +19,6 @@ const testId = require('./fixtures/sample-id')
const testIdHex = testId.id const testIdHex = testId.id
const testIdBytes = mh.fromHexString(testId.id) const testIdBytes = mh.fromHexString(testId.id)
const testIdB58String = mh.toB58String(testIdBytes) const testIdB58String = mh.toB58String(testIdBytes)
const testIdCID = new CID(1, 'libp2p-key', testIdBytes)
const testIdCIDString = testIdCID.toBaseEncodedString('base32')
const goId = require('./fixtures/go-private-key') const goId = require('./fixtures/go-private-key')
@ -34,184 +33,168 @@ describe('PeerId', () => {
expect(PeerId).to.throw(Error) expect(PeerId).to.throw(Error)
}) })
it('create a new id', async () => { it('create a new id', (done) => {
const id = await PeerId.create(testOpts) PeerId.create(testOpts, (err, id) => {
expect(id.toB58String().length).to.equal(46) expect(err).to.not.exist()
expect(id.toB58String().length).to.equal(46)
done()
})
}) })
it('can be created for a Secp256k1 key', async () => { it('can be created for a Secp256k1 key', (done) => {
const id = await PeerId.create({ keyType: 'secp256k1', bits: 256 }) PeerId.create({ keyType: 'secp256k1', bits: 256 }, (err, id) => {
const expB58 = mh.toB58String(mh.encode(id.pubKey.bytes, 'identity')) const expB58 = mh.toB58String(mh.encode(id.pubKey.bytes, 'identity'))
expect(id.toB58String()).to.equal(expB58) expect(err).to.not.exist()
expect(id.toB58String()).to.equal(expB58)
done()
})
}) })
it('can get the public key from a Secp256k1 key', async () => { it('can get the public key from a Secp256k1 key', (done) => {
const original = await PeerId.create({ keyType: 'secp256k1', bits: 256 }) PeerId.create({ keyType: 'secp256k1', bits: 256 }, (err, original) => {
const newId = PeerId.createFromB58String(original.toB58String()) expect(err).to.not.exist()
expect(original.pubKey.bytes).to.eql(newId.pubKey.bytes)
const newId = PeerId.createFromB58String(original.toB58String())
expect(original.pubKey.bytes).to.eql(newId.pubKey.bytes)
done()
})
}) })
it('isPeerId', async () => { it('isPeerId', (done) => {
const id = await PeerId.create(testOpts) PeerId.create(testOpts, (err, id) => {
expect(PeerId.isPeerId(id)).to.equal(true) expect(err).to.not.exist()
expect(PeerId.isPeerId('aaa')).to.equal(false) expect(PeerId.isPeerId(id)).to.equal(true)
expect(PeerId.isPeerId(Buffer.from('batatas'))).to.equal(false) expect(PeerId.isPeerId('aaa')).to.equal(false)
expect(PeerId.isPeerId(Buffer.from('batatas'))).to.equal(false)
done()
})
}) })
it('throws on changing the id', async () => { it('throws on changing the id', function (done) {
const id = await PeerId.create(testOpts) this.timeout(10000)
expect(id.toB58String().length).to.equal(46) PeerId.create(testOpts, (err, id) => {
expect(() => { expect(err).to.not.exist()
id.id = Buffer.from('hello') expect(id.toB58String().length).to.equal(46)
}).to.throw(/immutable/) expect(() => {
id.id = Buffer.from('hello')
}).to.throw(/immutable/)
done()
})
}) })
it('recreate from Hex string', () => { it('recreate an Id from Hex string', () => {
const id = PeerId.createFromHexString(testIdHex) const id = PeerId.createFromHexString(testIdHex)
expect(testIdBytes).to.deep.equal(id.toBytes()) expect(testIdBytes).to.deep.equal(id.id)
}) })
it('recreate from a Buffer', () => { it('Recreate an Id from a Buffer', () => {
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())
}) })
it('recreate from a B58 String', () => { it('Recreate a B58 String', () => {
const id = PeerId.createFromB58String(testIdB58String) const id = PeerId.createFromB58String(testIdB58String)
expect(testIdB58String).to.equal(id.toB58String()) expect(testIdB58String).to.equal(id.toB58String())
expect(testIdBytes).to.deep.equal(id.toBytes())
}) })
it('recreate from CID object', () => { it('Recreate from a Public Key', (done) => {
const id = PeerId.createFromCID(testIdCID) PeerId.createFromPubKey(testId.pubKey, (err, id) => {
expect(testIdCIDString).to.equal(id.toString()) expect(err).to.not.exist()
expect(testIdBytes).to.deep.equal(id.toBytes()) expect(testIdB58String).to.equal(id.toB58String())
done()
})
}) })
it('recreate from Base58 String (CIDv0))', () => { it('can be created from a Secp256k1 public key', (done) => {
const id = PeerId.createFromCID(testIdB58String) waterfall([
expect(testIdCIDString).to.equal(id.toString()) (cb) => {
expect(testIdBytes).to.deep.equal(id.toBytes()) crypto.keys.generateKeyPair('secp256k1', 256, cb)
},
(privKey, cb) => {
PeerId.createFromPubKey(privKey.public.bytes, cb)
}
], (err, id) => {
expect(err).to.not.exist()
const expB58 = mh.toB58String(mh.encode(id.pubKey.bytes, 'identity'))
expect(id.toB58String()).to.equal(expB58)
done()
})
}) })
it('recreate from CIDv1 Base32 (libp2p-key multicodec)', () => { it('Recreate from a Private Key', (done) => {
const cid = new CID(1, 'libp2p-key', testIdBytes) PeerId.createFromPrivKey(testId.privKey, (err, id) => {
const cidString = cid.toBaseEncodedString('base32') expect(err).to.not.exist()
const id = PeerId.createFromCID(cidString) expect(testIdB58String).to.equal(id.toB58String())
expect(cidString).to.equal(id.toString())
expect(testIdBytes).to.deep.equal(id.toBytes()) const encoded = Buffer.from(testId.privKey, 'base64')
PeerId.createFromPrivKey(encoded, (err, id2) => {
expect(err).to.not.exist()
expect(testIdB58String).to.equal(id2.toB58String())
expect(id.marshalPubKey()).to.deep.equal(id2.marshalPubKey())
done()
})
})
}) })
it('recreate from CIDv1 Base32 (dag-pb multicodec)', () => { it('can be created from a Secp256k1 private key', (done) => {
const cid = new CID(1, 'dag-pb', testIdBytes) waterfall([
const cidString = cid.toBaseEncodedString('base32') (cb) => {
const id = PeerId.createFromCID(cidString) crypto.keys.generateKeyPair('secp256k1', 256, cb)
// toString should return CID with multicodec set to libp2p-key },
expect(new CID(id.toString()).codec).to.equal('libp2p-key') (privKey, cb) => {
expect(testIdBytes).to.deep.equal(id.toBytes()) PeerId.createFromPrivKey(privKey.bytes, cb)
}
], (err, id) => {
expect(err).to.not.exist()
const expB58 = mh.toB58String(mh.encode(id.pubKey.bytes, 'identity'))
expect(id.toB58String()).to.equal(expB58)
done()
})
}) })
it('recreate from CID Buffer', () => { it('Compare generated ID with one created from PubKey', (done) => {
const id = PeerId.createFromCID(testIdCID.buffer) PeerId.create(testOpts, (err, id1) => {
expect(testIdCIDString).to.equal(id.toString()) expect(err).to.not.exist()
expect(testIdBytes).to.deep.equal(id.toBytes())
PeerId.createFromPubKey(id1.marshalPubKey(), (err, id2) => {
expect(err).to.not.exist()
expect(id1.id).to.be.eql(id2.id)
done()
})
})
}) })
it('throws on invalid CID multicodec', () => { it('Works with default options', function (done) {
// only libp2p and dag-pb are supported
const invalidCID = new CID(1, 'raw', testIdBytes).toBaseEncodedString('base32')
expect(() => {
PeerId.createFromCID(invalidCID)
}).to.throw(/Supplied PeerID CID has invalid multicodec: raw/)
})
it('throws on invalid CID value', () => {
// using function code that does not represent valid hash function
// https://github.com/multiformats/js-multihash/blob/b85999d5768bf06f1b0f16b926ef2cb6d9c14265/src/constants.js#L345
const invalidCID = 'QmaozNR7DZHQK1ZcU9p7QdrshMvXqWK6gpu5rmrkPdT3L'
expect(() => {
PeerId.createFromCID(invalidCID)
}).to.throw(/multihash unknown function code: 0x50/)
})
it('throws on invalid CID object', () => {
const invalidCID = {}
expect(() => {
PeerId.createFromCID(invalidCID)
}).to.throw(/Invalid version, must be a number equal to 1 or 0/)
})
it('throws on invalid CID object', () => {
const invalidCID = {}
expect(() => {
PeerId.createFromCID(invalidCID)
}).to.throw(/Invalid version, must be a number equal to 1 or 0/)
})
it('recreate from a Public Key', async () => {
const id = await PeerId.createFromPubKey(testId.pubKey)
expect(testIdB58String).to.equal(id.toB58String())
expect(testIdBytes).to.deep.equal(id.toBytes())
})
it('recreate from a Private Key', async () => {
const id = await PeerId.createFromPrivKey(testId.privKey)
expect(testIdB58String).to.equal(id.toB58String())
const encoded = Buffer.from(testId.privKey, 'base64')
const id2 = await PeerId.createFromPrivKey(encoded)
expect(testIdB58String).to.equal(id2.toB58String())
expect(id.marshalPubKey()).to.deep.equal(id2.marshalPubKey())
})
it('recreate from Protobuf', async () => {
const id = await PeerId.createFromProtobuf(testId.marshaled)
expect(testIdB58String).to.equal(id.toB58String())
const encoded = Buffer.from(testId.privKey, 'base64')
const id2 = await PeerId.createFromPrivKey(encoded)
expect(testIdB58String).to.equal(id2.toB58String())
expect(id.marshalPubKey()).to.deep.equal(id2.marshalPubKey())
expect(id.marshal().toString('hex')).to.deep.equal(testId.marshaled)
})
it('can be created from a Secp256k1 public key', async () => {
const privKey = await crypto.keys.generateKeyPair('secp256k1', 256)
const id = await PeerId.createFromPubKey(privKey.public.bytes)
const expB58 = mh.toB58String(mh.encode(id.pubKey.bytes, 'identity'))
expect(id.toB58String()).to.equal(expB58)
})
it('can be created from a Secp256k1 private key', async () => {
const privKey = await crypto.keys.generateKeyPair('secp256k1', 256)
const id = await PeerId.createFromPrivKey(privKey.bytes)
const expB58 = mh.toB58String(mh.encode(id.pubKey.bytes, 'identity'))
expect(id.toB58String()).to.equal(expB58)
})
it('Compare generated ID with one created from PubKey', async () => {
const id1 = await PeerId.create(testOpts)
const id2 = await PeerId.createFromPubKey(id1.marshalPubKey())
expect(id1.id).to.be.eql(id2.id)
})
it('Works with default options', async function () {
this.timeout(10000) this.timeout(10000)
const id = await PeerId.create() PeerId.create((err, id) => {
expect(id.toB58String().length).to.equal(46) expect(err).to.not.exist()
expect(id.toB58String().length).to.equal(46)
done()
})
}) })
it('Non-default # of bits', async function () { it('Non-default # of bits', function (done) {
this.timeout(1000 * 60) this.timeout(1000 * 60)
const shortId = await PeerId.create(testOpts) PeerId.create(testOpts, (err, shortId) => {
const longId = await PeerId.create({ bits: 1024 }) expect(err).to.not.exist()
expect(shortId.privKey.bytes.length).is.below(longId.privKey.bytes.length) PeerId.create({ bits: 1024 }, (err, longId) => {
expect(err).to.not.exist()
expect(shortId.privKey.bytes.length).is.below(longId.privKey.bytes.length)
done()
})
})
}) })
it('Pretty printing', async () => { it('Pretty printing', (done) => {
const id1 = await PeerId.create(testOpts) PeerId.create(testOpts, (err, id1) => {
const id2 = await PeerId.createFromPrivKey((id1.toJSON()).privKey) expect(err).to.not.exist()
expect(id1.toPrint()).to.be.eql(id2.toPrint()) PeerId.createFromPrivKey(id1.toJSON().privKey, (err, id2) => {
expect(id1.toPrint()).to.equal('<peer.ID ' + id1.toB58String().substr(2, 6) + '>') expect(err).to.not.exist()
expect(id1.toPrint()).to.be.eql(id2.toPrint())
expect(id1.toPrint()).to.equal('<peer.ID ' + id1.toB58String().substr(2, 6) + '>')
done()
})
})
}) })
it('toBytes', () => { it('toBytes', () => {
@ -219,104 +202,120 @@ describe('PeerId', () => {
expect(id.toBytes().toString('hex')).to.equal(testIdBytes.toString('hex')) expect(id.toBytes().toString('hex')).to.equal(testIdBytes.toString('hex'))
}) })
it('isEqual', async () => { it('isEqual', (done) => {
const ids = await Promise.all([ parallel([
PeerId.create(testOpts), (cb) => PeerId.create(testOpts, cb),
PeerId.create(testOpts) (cb) => PeerId.create(testOpts, cb)
]) ], (err, ids) => {
expect(err).to.not.exist()
expect(ids[0].isEqual(ids[0])).to.equal(true) expect(ids[0].isEqual(ids[0])).to.equal(true)
expect(ids[0].isEqual(ids[1])).to.equal(false) expect(ids[0].isEqual(ids[1])).to.equal(false)
expect(ids[0].isEqual(ids[0].id)).to.equal(true) expect(ids[0].isEqual(ids[0].id)).to.equal(true)
expect(ids[0].isEqual(ids[1].id)).to.equal(false) expect(ids[0].isEqual(ids[1].id)).to.equal(false)
}) done()
})
it('equals', async () => {
const ids = await Promise.all([
PeerId.create(testOpts),
PeerId.create(testOpts)
])
expect(ids[0].equals(ids[0])).to.equal(true)
expect(ids[0].equals(ids[1])).to.equal(false)
expect(ids[0].equals(ids[0].id)).to.equal(true)
expect(ids[0].equals(ids[1].id)).to.equal(false)
}) })
describe('fromJSON', () => { describe('fromJSON', () => {
it('full node', async () => { it('full node', (done) => {
const id = await PeerId.create(testOpts) PeerId.create(testOpts, (err, id) => {
const other = await PeerId.createFromJSON(id.toJSON()) expect(err).to.not.exist()
expect(id.toB58String()).to.equal(other.toB58String())
expect(id.privKey.bytes).to.eql(other.privKey.bytes) PeerId.createFromJSON(id.toJSON(), (err, other) => {
expect(id.pubKey.bytes).to.eql(other.pubKey.bytes) expect(err).to.not.exist()
expect(id.toB58String()).to.equal(other.toB58String())
expect(id.privKey.bytes).to.eql(other.privKey.bytes)
expect(id.pubKey.bytes).to.eql(other.pubKey.bytes)
done()
})
})
}) })
it('only id', async () => { it('only id', (done) => {
const key = await crypto.keys.generateKeyPair('RSA', 1024) crypto.keys.generateKeyPair('RSA', 1024, (err, key) => {
const digest = await key.public.hash() expect(err).to.not.exist()
const id = PeerId.createFromBytes(digest) key.public.hash((err, digest) => {
expect(id.privKey).to.not.exist() expect(err).to.not.exist()
expect(id.pubKey).to.not.exist()
const other = await PeerId.createFromJSON(id.toJSON()) const id = PeerId.createFromBytes(digest)
expect(id.toB58String()).to.equal(other.toB58String()) expect(id.privKey).to.not.exist()
expect(id.pubKey).to.not.exist()
PeerId.createFromJSON(id.toJSON(), (err, other) => {
expect(err).to.not.exist()
expect(id.toB58String()).to.equal(other.toB58String())
done()
})
})
})
}) })
it('go interop', async () => { it('go interop', (done) => {
const id = await PeerId.createFromJSON(goId) PeerId.createFromJSON(goId, (err, id) => {
const digest = await id.privKey.public.hash() expect(err).to.not.exist()
expect(mh.toB58String(digest)).to.eql(goId.id) id.privKey.public.hash((err, digest) => {
expect(err).to.not.exist()
expect(mh.toB58String(digest)).to.eql(goId.id)
done()
})
})
}) })
}) })
it('set privKey (valid)', async () => { it('set privKey (valid)', (done) => {
const peerId = await PeerId.create(testOpts) PeerId.create(testOpts, (err, peerId) => {
// @ts-ignore expect(err).to.not.exist()
peerId.privKey = peerId._privKey peerId.privKey = peerId._privKey
expect(peerId.isValid()).to.equal(true) peerId.isValid(done)
})
}) })
it('set pubKey (valid)', async () => { it('set pubKey (valid)', (done) => {
const peerId = await PeerId.create(testOpts) PeerId.create(testOpts, (err, peerId) => {
// @ts-ignore expect(err).to.not.exist()
peerId.pubKey = peerId._pubKey peerId.pubKey = peerId._pubKey
expect(peerId.isValid()).to.equal(true) peerId.isValid(done)
})
}) })
it('set privKey (invalid)', async () => { it('set privKey (invalid)', (done) => {
const peerId = await PeerId.create(testOpts) PeerId.create(testOpts, (err, peerId) => {
// @ts-ignore expect(err).to.not.exist()
peerId.privKey = Buffer.from('bufff') peerId.privKey = Buffer.from('bufff')
expect(peerId.isValid()).to.equal(false) peerId.isValid((err) => {
expect(err).to.exist()
done()
})
})
}) })
it('set pubKey (invalid)', async () => { it('set pubKey (invalid)', (done) => {
const peerId = await PeerId.create(testOpts) PeerId.create(testOpts, (err, peerId) => {
// @ts-ignore expect(err).to.not.exist()
peerId.pubKey = Buffer.from('bufff') peerId.pubKey = Buffer.from('buffff')
expect(peerId.isValid()).to.equal(false) peerId.isValid((err) => {
expect(err).to.exist()
done()
})
})
}) })
describe('returns error via cb instead of crashing', () => { describe('returns error via cb instead of crashing', () => {
const garbage = [ const garbage = [Buffer.from('00010203040506070809', 'hex'), {}, null, false, undefined, true, 1, 0, Buffer.from(''), 'aGVsbG93b3JsZA==', 'helloworld', '']
Buffer.from('00010203040506070809', 'hex'),
{}, null, false, undefined, true, 1, 0,
Buffer.from(''), 'aGVsbG93b3JsZA==', 'helloworld', ''
]
const fncs = ['createFromPubKey', 'createFromPrivKey', 'createFromJSON', 'createFromProtobuf'] const fncs = ['createFromPubKey', 'createFromPrivKey', 'createFromJSON']
for (const gb of garbage) { garbage.forEach(garbage => {
for (const fn of fncs) { fncs.forEach(fnc => {
it(`${fn} (${util.inspect(gb)})`, async () => { it(fnc + '(' + util.inspect(garbage) + ')', cb => {
try { PeerId[fnc](garbage, (err, res) => {
await PeerId[fn](gb)
} catch (err) {
expect(err).to.exist() expect(err).to.exist()
} expect(res).to.not.exist()
cb()
})
}) })
} })
} })
}) })
describe('throws on inconsistent data', () => { describe('throws on inconsistent data', () => {
@ -324,30 +323,37 @@ describe('PeerId', () => {
let k2 let k2
let k3 let k3
before(async () => { before((done) => {
const keys = await Promise.all([ parallel([
crypto.keys.generateKeyPair('RSA', 512), (cb) => crypto.keys.generateKeyPair('RSA', 512, cb),
crypto.keys.generateKeyPair('RSA', 512), (cb) => crypto.keys.generateKeyPair('RSA', 512, cb),
crypto.keys.generateKeyPair('RSA', 512) (cb) => crypto.keys.generateKeyPair('RSA', 512, cb)
]) ], (err, keys) => {
expect(err).to.not.exist()
k1 = keys[0] k1 = keys[0]
k2 = keys[1] k2 = keys[1]
k3 = keys[2] k3 = keys[2]
done()
})
}) })
it('missmatch private - public key', async () => { it('missmatch private - public key', (done) => {
const digest = await k1.public.hash() k1.public.hash((err, digest) => {
expect(() => { expect(err).to.not.exist()
new PeerId(digest, k1, k2.public) // eslint-disable-line no-new expect(() => new PeerId(digest, k1, k2.public))
}).to.throw(/inconsistent arguments/) .to.throw(/inconsistent arguments/)
done()
})
}) })
it('missmatch id - private - public key', async () => { it('missmatch id - private - public key', (done) => {
const digest = await k1.public.hash() k1.public.hash((err, digest) => {
expect(() => { expect(err).to.not.exist()
new PeerId(digest, k1, k3.public) // eslint-disable-line no-new expect(() => new PeerId(digest, k1, k3.public))
}).to.throw(/inconsistent arguments/) .to.throw(/inconsistent arguments/)
done()
})
}) })
it('invalid id', () => { it('invalid id', () => {

View File

@ -1,37 +0,0 @@
{
"compilerOptions": {
"module": "commonjs",
"lib": [
"es6"
],
"target": "ES5",
"noImplicitAny": false,
"noImplicitThis": true,
"strictFunctionTypes": true,
"strictNullChecks": true,
"esModuleInterop": true,
"resolveJsonModule": true,
"allowJs": true,
"checkJs": true,
"baseUrl": ".",
"paths": {
"peer-id": [
"./src",
"../src",
]
},
"types": [
"node",
"mocha",
"chai"
],
"noEmit": true,
"forceConsistentCasingInFileNames": true
},
"files": [
"./src/index.d.ts",
],
"include": [
"./test/**/*.spec.js"
]
}