From d16ce9c2ac12ac89a9ede72c19b9311676d90e5a Mon Sep 17 00:00:00 2001 From: Alex Potsides Date: Fri, 7 Aug 2020 16:36:22 +0100 Subject: [PATCH] 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 --- .aegir.js | 7 ++++++ package.json | 19 +++++++-------- src/index.d.ts | 38 +++++++++++++++--------------- src/index.js | 56 ++++++++++++++++++++++---------------------- test/peer-id.spec.js | 34 +++++++++++++-------------- 5 files changed, 78 insertions(+), 76 deletions(-) create mode 100644 .aegir.js diff --git a/.aegir.js b/.aegir.js new file mode 100644 index 0000000..c20d73f --- /dev/null +++ b/.aegir.js @@ -0,0 +1,7 @@ +'use strict' + +module.exports = { + bundlesize: { + maxSize: '140kB' + } +} diff --git a/package.json b/package.json index cd4f81c..273e662 100644 --- a/package.json +++ b/package.json @@ -17,7 +17,7 @@ "release-minor": "aegir release --type minor", "release-major": "aegir release --type major", "coverage": "aegir coverage", - "size": "bundlesize -f dist/index.min.js -s 140kB" + "size": "aegir build -b" }, "files": [ "src", @@ -38,20 +38,17 @@ "devDependencies": { "@types/chai": "^4.2.7", "@types/dirty-chai": "^2.0.2", - "@types/mocha": "^7.0.2", - "aegir": "^22.0.0", - "bundlesize": "~0.18.0", - "chai": "^4.2.0", - "dirty-chai": "^2.0.1" + "@types/mocha": "^8.0.1", + "aegir": "^25.0.0" }, "dependencies": { - "buffer": "^5.5.0", - "cids": "^0.8.0", + "cids": "^1.0.0", "class-is": "^1.1.0", - "libp2p-crypto": "^0.17.7", + "libp2p-crypto": "^0.18.0", "minimist": "^1.2.5", - "multihashes": "^1.0.1", - "protons": "^1.0.2" + "multihashes": "^3.0.1", + "protons": "^2.0.0", + "uint8arrays": "^1.1.0" }, "repository": { "type": "git", diff --git a/src/index.d.ts b/src/index.d.ts index 0b35564..26e3caf 100644 --- a/src/index.d.ts +++ b/src/index.d.ts @@ -1,4 +1,4 @@ -import crypto, { PrivateKey, PublicKey, KeyType } from "libp2p-crypto"; +import { PrivateKey, PublicKey, KeyType } from "libp2p-crypto"; import CID from 'cids' declare namespace PeerId { @@ -51,36 +51,36 @@ declare namespace PeerId { * @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; + function createFromBytes(buf: Uint8Array): 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; + function createFromCID(cid: CID | Uint8Array | string | object): PeerId; /** * 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; + function createFromPubKey(key: Uint8Array | string): Promise; /** * 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; + function createFromPrivKey(key: Uint8Array | string): Promise; /** * Create PeerId from PeerId JSON formatted object. @@ -91,21 +91,21 @@ declare namespace PeerId { /** * 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; + function createFromProtobuf(buf: Uint8Array | string): Promise; } /** * PeerId is an object representation of a peer identifier. */ declare class PeerId { - constructor(id: Buffer | string, privKey?: PrivateKey, pubKey?: PublicKey); + constructor(id: Uint8Array | string, privKey?: PrivateKey, pubKey?: PublicKey); /** * Raw id. */ - readonly id: Buffer; + readonly id: Uint8Array; /** * Private key. @@ -120,18 +120,18 @@ declare class PeerId { /** * 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. */ - marshalPrivKey(): Buffer; + marshalPrivKey(): Uint8Array; /** * Return the protobuf version of the peer-id. * @param excludePriv Whether to exclude the private key information from the output. */ - marshal(excludePriv?: boolean): Buffer; + marshal(excludePriv?: boolean): Uint8Array; /** * String representation. @@ -153,7 +153,7 @@ declare class PeerId { /** * Return raw id bytes. */ - toBytes(): Buffer; + toBytes(): Uint8Array; /** * Encode to base58 string. @@ -170,14 +170,14 @@ declare class PeerId { * Checks the equality of `this` peer against a given 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. * @deprecated Use {.equals} * @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) diff --git a/src/index.js b/src/index.js index c252be7..7af71f9 100644 --- a/src/index.js +++ b/src/index.js @@ -4,20 +4,22 @@ 'use strict' -const { Buffer } = require('buffer') const mh = require('multihashes') const CID = require('cids') const cryptoKeys = require('libp2p-crypto/src/keys') const withIs = require('class-is') const { PeerIdProto } = require('./proto') +const uint8ArrayEquals = require('uint8arrays/equals') +const uint8ArrayFromString = require('uint8arrays/from-string') +const uint8ArrayToString = require('uint8arrays/to-string') class PeerId { constructor (id, privKey, pubKey) { - if (!Buffer.isBuffer(id)) { + if (!(id instanceof Uint8Array)) { 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') } @@ -142,14 +144,14 @@ class PeerId { /** * Checks the equality of `this` peer against a given PeerId. - * @param {Buffer|PeerId} id + * @param {Uint8Array|PeerId} id * @returns {boolean} */ equals (id) { - if (Buffer.isBuffer(id)) { - return this.id.equals(id) + if (id instanceof Uint8Array) { + return uint8ArrayEquals(this.id, id) } else if (id.id) { - return this.id.equals(id.id) + return uint8ArrayEquals(this.id, id.id) } else { throw new Error('not valid Id') } @@ -158,7 +160,7 @@ class PeerId { /** * Checks the equality of `this` peer against a given PeerId. * @deprecated Use `.equals` - * @param {Buffer|PeerId} id + * @param {Uint8Array|PeerId} id * @returns {boolean} */ isEqual (id) { @@ -173,8 +175,8 @@ class PeerId { return Boolean(this.privKey && this.privKey.public && this.privKey.public.bytes && - Buffer.isBuffer(this.pubKey.bytes) && - this.privKey.public.bytes.equals(this.pubKey.bytes)) + this.pubKey.bytes instanceof Uint8Array && + uint8ArrayEquals(this.privKey.public.bytes, this.pubKey.bytes)) } } @@ -231,16 +233,16 @@ exports.createFromCID = (cid) => { return new PeerIdWithIs(cid.multihash) } -// Public Key input will be a buffer +// Public Key input will be a Uint8Array exports.createFromPubKey = async (key) => { let buf = key if (typeof buf === 'string') { - buf = Buffer.from(key, 'base64') + buf = uint8ArrayFromString(key, 'base64pad') } - if (!Buffer.isBuffer(buf)) { - throw new Error('Supplied key is neither a base64 string nor a buffer') + if (!(buf instanceof Uint8Array)) { + throw new Error('Supplied key is neither a base64 string nor a Uint8Array') } const pubKey = await cryptoKeys.unmarshalPublicKey(buf) @@ -249,24 +251,22 @@ exports.createFromPubKey = async (key) => { // Private key input will be a string exports.createFromPrivKey = async (key) => { - let buf = key - - if (typeof buf === 'string') { - buf = Buffer.from(key, 'base64') + if (typeof key === 'string') { + key = uint8ArrayFromString(key, 'base64pad') } - if (!Buffer.isBuffer(buf)) { - throw new Error('Supplied key is neither a base64 string nor a buffer') + if (!(key instanceof Uint8Array)) { + 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) } exports.createFromJSON = async (obj) => { const id = mh.fromB58String(obj.id) - const rawPrivKey = obj.privKey && Buffer.from(obj.privKey, 'base64') - const rawPubKey = obj.pubKey && Buffer.from(obj.pubKey, 'base64') + const rawPrivKey = obj.privKey && uint8ArrayFromString(obj.privKey, 'base64pad') + const rawPubKey = obj.pubKey && uint8ArrayFromString(obj.pubKey, 'base64pad') const pub = rawPubKey && await cryptoKeys.unmarshalPublicKey(rawPubKey) if (!rawPrivKey) { @@ -282,11 +282,11 @@ exports.createFromJSON = async (obj) => { pubDigest = await computeDigest(pub) } - if (pub && !privDigest.equals(pubDigest)) { + if (pub && !uint8ArrayEquals(privDigest, pubDigest)) { 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') } @@ -295,7 +295,7 @@ exports.createFromJSON = async (obj) => { exports.createFromProtobuf = async (buf) => { if (typeof buf === 'string') { - buf = Buffer.from(buf, 'hex') + buf = uint8ArrayFromString(buf, 'base16') } let { id, privKey, pubKey } = PeerIdProto.decode(buf) @@ -316,7 +316,7 @@ exports.createFromProtobuf = async (buf) => { if (privKey) { if (pubKey) { - if (!privDigest.equals(pubDigest)) { + if (!uint8ArrayEquals(privDigest, pubDigest)) { throw new Error('Public and private key do not match') } } @@ -344,6 +344,6 @@ exports.isPeerId = (peerId) => { function toB64Opt (val) { if (val) { - return val.toString('base64') + return uint8ArrayToString(val, 'base64pad') } } diff --git a/test/peer-id.spec.js b/test/peer-id.spec.js index b21eb80..bf97ee9 100644 --- a/test/peer-id.spec.js +++ b/test/peer-id.spec.js @@ -2,14 +2,12 @@ /* eslint-env mocha */ 'use strict' -const { Buffer } = require('buffer') -const chai = require('chai') -const dirtyChai = require('dirty-chai') -chai.use(dirtyChai) -const expect = chai.expect +const { expect } = require('aegir/utils/chai') const crypto = require('libp2p-crypto') const mh = require('multihashes') const CID = require('cids') +const uint8ArrayFromString = require('uint8arrays/from-string') +const uint8ArrayToString = require('uint8arrays/to-string') const PeerId = require('../src') @@ -56,7 +54,7 @@ describe('PeerId', () => { const id = await PeerId.create(testOpts) expect(PeerId.isPeerId(id)).to.equal(true) 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 () => { @@ -64,7 +62,7 @@ describe('PeerId', () => { expect(id.toB58String().length).to.equal(46) expect(() => { // @ts-ignore - id.id = Buffer.from('hello') + id.id = uint8ArrayFromString('hello') }).to.throw(/immutable/) }) @@ -73,7 +71,7 @@ describe('PeerId', () => { expect(testIdBytes).to.deep.equal(id.toBytes()) }) - it('recreate from a Buffer', () => { + it('recreate from a Uint8Array', () => { const id = PeerId.createFromBytes(testIdBytes) expect(testId.id).to.equal(id.toHexString()) expect(testIdBytes).to.deep.equal(id.toBytes()) @@ -114,8 +112,8 @@ describe('PeerId', () => { expect(testIdBytes).to.deep.equal(id.toBytes()) }) - it('recreate from CID Buffer', () => { - const id = PeerId.createFromCID(testIdCID.buffer) + it('recreate from CID Uint8Array', () => { + const id = PeerId.createFromCID(testIdCID.bytes) expect(testIdCIDString).to.equal(id.toString()) expect(testIdBytes).to.deep.equal(id.toBytes()) }) @@ -160,7 +158,7 @@ describe('PeerId', () => { 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 encoded = uint8ArrayFromString(testId.privKey, 'base64pad') const id2 = await PeerId.createFromPrivKey(encoded) expect(testIdB58String).to.equal(id2.toB58String()) expect(id.marshalPubKey()).to.deep.equal(id2.marshalPubKey()) @@ -169,11 +167,11 @@ describe('PeerId', () => { 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 encoded = uint8ArrayFromString(testId.privKey, 'base64pad') 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) + expect(uint8ArrayToString(id.marshal(), 'base16')).to.deep.equal(testId.marshaled) }) it('can be created from a Secp256k1 public key', async () => { @@ -218,7 +216,7 @@ describe('PeerId', () => { it('toBytes', () => { 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 () => { @@ -288,22 +286,22 @@ describe('PeerId', () => { it('set privKey (invalid)', async () => { const peerId = await PeerId.create(testOpts) // @ts-ignore - peerId.privKey = Buffer.from('bufff') + peerId.privKey = uint8ArrayFromString('bufff') expect(peerId.isValid()).to.equal(false) }) it('set pubKey (invalid)', async () => { const peerId = await PeerId.create(testOpts) // @ts-ignore - peerId.pubKey = Buffer.from('bufff') + peerId.pubKey = uint8ArrayFromString('bufff') expect(peerId.isValid()).to.equal(false) }) describe('returns error via cb instead of crashing', () => { const garbage = [ - Buffer.from('00010203040506070809', 'hex'), + uint8ArrayFromString('00010203040506070809', 'base16'), {}, null, false, undefined, true, 1, 0, - Buffer.from(''), 'aGVsbG93b3JsZA==', 'helloworld', '' + uint8ArrayFromString(''), 'aGVsbG93b3JsZA==', 'helloworld', '' ] const fncs = ['createFromPubKey', 'createFromPrivKey', 'createFromJSON', 'createFromProtobuf']