Compare commits

..

No commits in common. "master" and "v0.13.11" have entirely different histories.

8 changed files with 88 additions and 251 deletions

View File

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

View File

@ -1,82 +1,3 @@
## [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,7 +28,6 @@
- [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)
@ -53,8 +52,6 @@
- [`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
@ -70,7 +67,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))
``` ```
@ -120,14 +117,6 @@ 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
@ -148,8 +137,7 @@ 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.bits: number` - The size of the key. Default: `2048` - `opts: Object`: Default: `{bits: 2048, keyType: 'rsa'}`
- `opts.keyType: string` - The key type, one of: `['RSA', 'Ed25519', 'secp256k1']`. Default: `RSA`
Returns `Promise<PeerId>`. Returns `Promise<PeerId>`.
@ -159,7 +147,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)`
@ -287,14 +275,6 @@ 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.14.6", "version": "0.13.11",
"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 --no-types", "build": "aegir build",
"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 --no-types", "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",
"coverage": "aegir coverage", "coverage": "aegir coverage",
"size": "aegir build -b" "size": "bundlesize -f dist/index.min.js -s 140kB"
}, },
"files": [ "files": [
"src", "src",
@ -36,19 +36,21 @@
}, },
"homepage": "https://github.com/libp2p/js-peer-id", "homepage": "https://github.com/libp2p/js-peer-id",
"devDependencies": { "devDependencies": {
"@types/chai": "^4.2.14", "@types/chai": "^4.2.7",
"@types/dirty-chai": "^2.0.2", "@types/dirty-chai": "^2.0.2",
"@types/mocha": "^8.2.0", "@types/mocha": "^7.0.2",
"aegir": "^32.2.0" "aegir": "^21.2.0",
"bundlesize": "~0.18.0",
"chai": "^4.2.0",
"dirty-chai": "^2.0.1"
}, },
"dependencies": { "dependencies": {
"cids": "^1.1.6", "buffer": "^5.5.0",
"cids": "^0.8.0",
"class-is": "^1.1.0", "class-is": "^1.1.0",
"libp2p-crypto": "fluencelabs/js-libp2p-crypto", "libp2p-crypto": "~0.17.3",
"minimist": "^1.2.5", "multihashes": "~0.4.15",
"multihashes": "^4.0.2", "protons": "^1.0.2"
"protons": "^2.0.0",
"uint8arrays": "^2.1.4"
}, },
"repository": { "repository": {
"type": "git", "type": "git",
@ -62,12 +64,10 @@
"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>",
"Alex Potsides <alex@achingbrain.net>",
"Hugo Dias <hugomrdias@gmail.com>",
"Maciej Krüger <mkg20001@gmail.com>", "Maciej Krüger <mkg20001@gmail.com>",
"Hugo Dias <hugomrdias@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,8 +79,7 @@
"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>",
"a1300 <matthias-knopp@gmx.net>" "Alex Potsides <alex@achingbrain.net>"
] ]
} }

View File

@ -3,13 +3,9 @@
'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 { PrivateKey, PublicKey, KeyType } from "libp2p-crypto"; import crypto, { 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: Uint8Array): PeerId; function createFromBytes(buf: Buffer): 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 | Uint8Array | string | object): PeerId; function createFromCID(cid: CID | Buffer | string | object): PeerId;
/** /**
* Create PeerId from public key. * Create PeerId from public key.
* @param key Public key, as Uint8Array or base64-encoded string. * @param key Public key, as Buffer or base64-encoded string.
*/ */
function createFromPubKey(key: Uint8Array | string): Promise<PeerId>; function createFromPubKey(key: Buffer | string): Promise<PeerId>;
/** /**
* Create PeerId from private key. * Create PeerId from private key.
* @param key Private key, as Uint8Array or base64-encoded string. * @param key Private key, as Buffer or base64-encoded string.
*/ */
function createFromPrivKey(key: Uint8Array | string): Promise<PeerId>; function createFromPrivKey(key: Buffer | 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 Uint8Array or hex-encoded string. * @param buf Protobuf bytes, as Buffer or hex-encoded string.
*/ */
function createFromProtobuf(buf: Uint8Array | string): Promise<PeerId>; function createFromProtobuf(buf: Buffer | 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: Uint8Array, privKey?: PrivateKey, pubKey?: PublicKey); constructor(id: Buffer | string, privKey?: PrivateKey, pubKey?: PublicKey);
/** /**
* Raw id. * Raw id.
*/ */
readonly id: Uint8Array; readonly id: Buffer;
/** /**
* 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(): Uint8Array; marshalPubKey(): Buffer;
/** /**
* 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(): Uint8Array; marshalPrivKey(): Buffer;
/** /**
* 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): Uint8Array; marshal(excludePriv?: boolean): Buffer;
/** /**
* String representation. * String representation.
@ -153,7 +153,7 @@ declare class PeerId {
/** /**
* Return raw id bytes. * Return raw id bytes.
*/ */
toBytes(): Uint8Array; toBytes(): Buffer;
/** /**
* Encode to base58 string. * Encode to base58 string.
@ -170,24 +170,19 @@ 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 | Uint8Array): boolean; equals(id: PeerId | Buffer): 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 | Uint8Array): boolean; isEqual(id: PeerId | Buffer): 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,22 +4,20 @@
'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 (!(id instanceof Uint8Array)) { if (!Buffer.isBuffer(id)) {
throw new Error('invalid id provided') throw new Error('invalid id provided')
} }
if (privKey && pubKey && !uint8ArrayEquals(privKey.public.bytes, pubKey.bytes)) { if (privKey && pubKey && !privKey.public.bytes.equals(pubKey.bytes)) {
throw new Error('inconsistent arguments') throw new Error('inconsistent arguments')
} }
@ -137,26 +135,21 @@ 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 (id instanceof Uint8Array) { if (Buffer.isBuffer(id)) {
return uint8ArrayEquals(this.id, id) return this.id.equals(id)
} else if (id.id) { } else if (id.id) {
return uint8ArrayEquals(this.id, id.id) return this.id.equals(id.id)
} else { } else {
throw new Error('not valid Id') throw new Error('not valid Id')
} }
@ -164,9 +157,8 @@ 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 {Uint8Array|PeerId} id * @param {Buffer|PeerId} id
* @returns {boolean} * @returns {boolean}
*/ */
isEqual (id) { isEqual (id) {
@ -181,26 +173,8 @@ class PeerId {
return Boolean(this.privKey && return Boolean(this.privKey &&
this.privKey.public && this.privKey.public &&
this.privKey.public.bytes && this.privKey.public.bytes &&
this.pubKey.bytes instanceof Uint8Array && Buffer.isBuffer(this.pubKey.bytes) &&
uint8ArrayEquals(this.privKey.public.bytes, this.pubKey.bytes)) this.privKey.public.bytes.equals(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
} }
} }
@ -257,16 +231,16 @@ exports.createFromCID = (cid) => {
return new PeerIdWithIs(cid.multihash) return new PeerIdWithIs(cid.multihash)
} }
// Public Key input will be a Uint8Array // Public Key input will be a buffer
exports.createFromPubKey = async (key) => { exports.createFromPubKey = async (key) => {
let buf = key let buf = key
if (typeof buf === 'string') { if (typeof buf === 'string') {
buf = uint8ArrayFromString(key, 'base64pad') buf = Buffer.from(key, 'base64')
} }
if (!(buf instanceof Uint8Array)) { if (!Buffer.isBuffer(buf)) {
throw new Error('Supplied key is neither a base64 string nor a Uint8Array') throw new Error('Supplied key is neither a base64 string nor a buffer')
} }
const pubKey = await cryptoKeys.unmarshalPublicKey(buf) const pubKey = await cryptoKeys.unmarshalPublicKey(buf)
@ -275,22 +249,24 @@ 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) => {
if (typeof key === 'string') { let buf = key
key = uint8ArrayFromString(key, 'base64pad')
if (typeof buf === 'string') {
buf = Buffer.from(key, 'base64')
} }
if (!(key instanceof Uint8Array)) { if (!Buffer.isBuffer(buf)) {
throw new Error('Supplied key is neither a base64 string nor a Uint8Array') throw new Error('Supplied key is neither a base64 string nor a buffer')
} }
const privKey = await cryptoKeys.unmarshalPrivateKey(key) const privKey = await cryptoKeys.unmarshalPrivateKey(buf)
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 && uint8ArrayFromString(obj.privKey, 'base64pad') const rawPrivKey = obj.privKey && Buffer.from(obj.privKey, 'base64')
const rawPubKey = obj.pubKey && uint8ArrayFromString(obj.pubKey, 'base64pad') const rawPubKey = obj.pubKey && Buffer.from(obj.pubKey, 'base64')
const pub = rawPubKey && await cryptoKeys.unmarshalPublicKey(rawPubKey) const pub = rawPubKey && await cryptoKeys.unmarshalPublicKey(rawPubKey)
if (!rawPrivKey) { if (!rawPrivKey) {
@ -306,11 +282,11 @@ exports.createFromJSON = async (obj) => {
pubDigest = await computeDigest(pub) pubDigest = await computeDigest(pub)
} }
if (pub && !uint8ArrayEquals(privDigest, pubDigest)) { if (pub && !privDigest.equals(pubDigest)) {
throw new Error('Public and private key do not match') throw new Error('Public and private key do not match')
} }
if (id && !uint8ArrayEquals(privDigest, id)) { if (id && !privDigest.equals(id)) {
throw new Error('Id and private key do not match') throw new Error('Id and private key do not match')
} }
@ -319,7 +295,7 @@ exports.createFromJSON = async (obj) => {
exports.createFromProtobuf = async (buf) => { exports.createFromProtobuf = async (buf) => {
if (typeof buf === 'string') { if (typeof buf === 'string') {
buf = uint8ArrayFromString(buf, 'base16') buf = Buffer.from(buf, 'hex')
} }
let { id, privKey, pubKey } = PeerIdProto.decode(buf) let { id, privKey, pubKey } = PeerIdProto.decode(buf)
@ -340,7 +316,7 @@ exports.createFromProtobuf = async (buf) => {
if (privKey) { if (privKey) {
if (pubKey) { if (pubKey) {
if (!uint8ArrayEquals(privDigest, pubDigest)) { if (!privDigest.equals(pubDigest)) {
throw new Error('Public and private key do not match') throw new Error('Public and private key do not match')
} }
} }
@ -368,6 +344,6 @@ exports.isPeerId = (peerId) => {
function toB64Opt (val) { function toB64Opt (val) {
if (val) { if (val) {
return uint8ArrayToString(val, 'base64pad') return val.toString('base64')
} }
} }

View File

@ -2,12 +2,14 @@
/* eslint-env mocha */ /* eslint-env mocha */
'use strict' 'use strict'
const { expect } = require('aegir/utils/chai') const { Buffer } = require('buffer')
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')
@ -54,15 +56,14 @@ 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(uint8ArrayFromString('batatas'))).to.equal(false) expect(PeerId.isPeerId(Buffer.from('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(() => {
// @ts-ignore id.id = Buffer.from('hello')
id.id = uint8ArrayFromString('hello')
}).to.throw(/immutable/) }).to.throw(/immutable/)
}) })
@ -71,7 +72,7 @@ describe('PeerId', () => {
expect(testIdBytes).to.deep.equal(id.toBytes()) expect(testIdBytes).to.deep.equal(id.toBytes())
}) })
it('recreate from a Uint8Array', () => { it('recreate 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()) expect(testIdBytes).to.deep.equal(id.toBytes())
@ -112,8 +113,8 @@ describe('PeerId', () => {
expect(testIdBytes).to.deep.equal(id.toBytes()) expect(testIdBytes).to.deep.equal(id.toBytes())
}) })
it('recreate from CID Uint8Array', () => { it('recreate from CID Buffer', () => {
const id = PeerId.createFromCID(testIdCID.bytes) const id = PeerId.createFromCID(testIdCID.buffer)
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())
}) })
@ -158,7 +159,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 = uint8ArrayFromString(testId.privKey, 'base64pad') const encoded = Buffer.from(testId.privKey, 'base64')
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())
@ -167,11 +168,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 = uint8ArrayFromString(testId.privKey, 'base64pad') const encoded = Buffer.from(testId.privKey, 'base64')
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(uint8ArrayToString(id.marshal(), 'base16')).to.deep.equal(testId.marshaled) expect(id.marshal().toString('hex')).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 () => {
@ -216,7 +217,7 @@ describe('PeerId', () => {
it('toBytes', () => { it('toBytes', () => {
const id = PeerId.createFromHexString(testIdHex) const id = PeerId.createFromHexString(testIdHex)
expect(uint8ArrayToString(id.toBytes(), 'base16')).to.equal(uint8ArrayToString(testIdBytes, 'base16')) expect(id.toBytes().toString('hex')).to.equal(testIdBytes.toString('hex'))
}) })
it('isEqual', async () => { it('isEqual', async () => {
@ -243,18 +244,6 @@ 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)
@ -298,34 +287,22 @@ 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 = uint8ArrayFromString('bufff') peerId.privKey = Buffer.from('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 = uint8ArrayFromString('bufff') peerId.pubKey = Buffer.from('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 = [
uint8ArrayFromString('00010203040506070809', 'base16'), Buffer.from('00010203040506070809', 'hex'),
{}, null, false, undefined, true, 1, 0, {}, null, false, undefined, true, 1, 0,
uint8ArrayFromString(''), 'aGVsbG93b3JsZA==', 'helloworld', '' Buffer.from(''), 'aGVsbG93b3JsZA==', 'helloworld', ''
] ]
const fncs = ['createFromPubKey', 'createFromPrivKey', 'createFromJSON', 'createFromProtobuf'] const fncs = ['createFromPubKey', 'createFromPrivKey', 'createFromJSON', 'createFromProtobuf']