Compare commits

...

23 Commits

Author SHA1 Message Date
3ef704ba32 use static keyword 2016-12-05 20:48:29 +01:00
1be7d888d6 cleanup comments 2016-12-05 20:37:38 +01:00
0d3d9f835b docs: fix typo 2016-12-05 14:57:50 +01:00
c1ed9751e3 docs: adjust intro styling 2016-12-02 16:02:04 +01:00
01957fa095 docs: Add jsdoc api docs 2016-12-02 15:08:51 +01:00
06f93cd961 chore(package): update aegir to version 9.1.2 (#39)
https://greenkeeper.io/
2016-11-28 15:52:39 +00:00
1452f233c8 chore(package): update multihashes to version 0.3.0 (#40)
https://greenkeeper.io/
2016-11-28 15:34:50 +00:00
77900c7b45 chore(package): update aegir to version 9.1.0 (#38)
https://greenkeeper.io/
2016-11-03 17:59:54 +00:00
564489b0ea chore: release version v0.8.0 2016-11-03 07:52:10 +00:00
65c2ac8dca chore: update contributors 2016-11-03 07:52:10 +00:00
31701e236d Async Crypto Endeavour (#33)
* refactor: make import and creation async - This allows the use of native key generation in the browser

BREAKING CHANGE:

This changes the interface of .create, .createFromPrivKey,
.createFromPubKey, .createFromJSON
2016-11-03 07:51:29 +00:00
e08907ff94 Merge pull request #34 from RichardLitt/master
Update README URLs based on HTTP redirects
2016-10-02 15:06:15 +01:00
f6a42fef76 Update README URLs based on HTTP redirects 2016-10-02 10:03:56 -04:00
ba8aa3ff34 Merge pull request #32 from libp2p/greenkeeper-libp2p-crypto-0.6.1
Update libp2p-crypto to version 0.6.1 🚀
2016-09-13 17:23:40 +02:00
ae81e95927 chore(package): update libp2p-crypto to version 0.6.1
https://greenkeeper.io/
2016-09-13 12:35:32 +02:00
d24500a042 Update README.md 2016-09-11 16:40:26 -04:00
5fec44833e Update README.md 2016-09-11 16:40:09 -04:00
2432c56ad5 Merge pull request #30 from npmcdn-to-unpkg-bot/npmcdn-to-unpkg
Replace npmcdn.com with unpkg.com
2016-09-11 13:03:07 -04:00
f0e380af58 Replace npmcdn.com with unpkg.com 2016-09-11 12:29:33 +01:00
24cd31b2d1 Merge pull request #29 from libp2p/greenkeeper-aegir-8.0.0
Update aegir to version 8.0.0 🚀
2016-09-06 21:15:05 +02:00
5f9136b3ca chore(package): update aegir to version 8.0.0
https://greenkeeper.io/
2016-09-06 15:11:37 +02:00
4fe3e12b3c Merge pull request #26 from libp2p/greenkeeper-update-all
Update all dependencies 🌴
2016-08-04 20:43:19 +02:00
49d454da7d chore(package): update dependencies
https://greenkeeper.io/
2016-08-04 19:11:03 +02:00
10 changed files with 548 additions and 308 deletions

View File

@ -1,16 +0,0 @@
'use strict'
const path = require('path')
module.exports = {
webpack: {
resolve: {
alias: {
'node-forge': path.resolve(
path.dirname(require.resolve('libp2p-crypto')),
'../vendor/forge.bundle.js'
)
}
}
}
}

2
.gitignore vendored
View File

@ -26,5 +26,5 @@ build/Release
# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
node_modules
lib
dist
docs

View File

@ -1,9 +1,16 @@
sudo: false
language: node_js
node_js:
- 4
- 5
- stable
matrix:
include:
- node_js: 4
env: CXX=g++-4.8
- node_js: 6
env:
- SAUCE=true
- CXX=g++-4.8
- node_js: stable
env: CXX=g++-4.8
# Make sure we have new NPM.
before_install:
@ -14,12 +21,17 @@ script:
- npm test
- npm run coverage
addons:
firefox: 'latest'
before_script:
- export DISPLAY=:99.0
- sh -e /etc/init.d/xvfb start
after_success:
- npm run coverage-publish
addons:
firefox: latest
apt:
sources:
- ubuntu-toolchain-r-test
packages:
- g++-4.8

132
README.md
View File

@ -2,18 +2,33 @@
[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
[![Build Status](https://travis-ci.org/diasdavid/js-peer-id.svg?style=flat-square)](https://travis-ci.org/diasdavid/js-peer-id)
[![Coverage Status](https://coveralls.io/repos/github/diasdavid/js-peer-id/badge.svg?branch=master)](https://coveralls.io/github/diasdavid/js-peer-id?branch=master)
[![Dependency Status](https://david-dm.org/diasdavid/js-peer-id.svg?style=flat-square)](https://david-dm.org/diasdavid/js-peer-id)
[![Build Status](https://travis-ci.org/libp2p/js-peer-id.svg?style=flat-square)](https://travis-ci.org/libp2p/js-peer-id)
[![Coverage Status](https://coveralls.io/repos/github/libp2p/js-peer-id/badge.svg?branch=master)](https://coveralls.io/github/libp2p/js-peer-id?branch=master)
[![Dependency Status](https://david-dm.org/libp2p/js-peer-id.svg?style=flat-square)](https://david-dm.org/libp2p/js-peer-id)
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)
![](https://img.shields.io/badge/npm-%3E%3D3.0.0-orange.svg?style=flat-square)
![](https://img.shields.io/badge/Node.js-%3E%3D4.0.0-orange.svg?style=flat-square)
[![Sauce Test Status](https://saucelabs.com/browser-matrix/ipfs-js-peer-id.svg)](https://saucelabs.com/u/ipfs-js-peer-id)
> [IPFS](https://github.com/ipfs/ipfs) Peer ID implementation in JavaScript.
- [Description](#description)
- [Example](#example)
- [Installation](#installation)
- [npm](#npm)
- [Setup](#setup)
- [Node.js](#nodejs)
- [Browser: Browserify, Webpack, other bundlers](#browser-browserify-webpack-other-bundlers)
- [Browser: `<script>` Tag](#browser-script-tag)
- [API](#api)
- [License](#license)
# Description
Generate, import, and export PeerIDs, for use with [IPFS](https://github.com/ipfs/ipfs).
*A Peer ID is the SHA-256 [multihash](https://github.com/jbenet/multihash) of a
*A Peer ID is the SHA-256 [multihash](https://github.com/multiformats/multihash) of a
public key.*
*The public key is a base64 encoded string of a protobuf containing an RSA DER
@ -24,19 +39,18 @@ to the multihash for ID generation.*
```js
var PeerId = require('peer-id')
var bs58 = require('bs58')
var id = PeerId.create({ bits: 32 })
console.log('id ', id.toB58String())
console.log('priv key ', bs58.encode(id.privKey.bytes))
console.log('pub key ', bs58.encode(id.pubKey.bytes))
PeerId.create({ bits: 1024 }, (err, id) => {
console.log(JSON.stringify(id.toJSON(), null, 2)
})
```
```
id QmeeLFb92nkZJGj3gXLqXrEMzCMYs6uBgQLVNbrcXEvYXk
priv key 6ibrcPAbevzvPpkq6EA6XmLyuhmUrJrEvUfgQDtEiSEPzGnGU8Ejwf6b11DVm6opnFGo
pub key 2BeBZVKJ9RQs4i4LbGv4ReEeuBA5dck2Gje3wt67e44XuyyPq5jE
{
"id": "Qma9T5YraSnpRDZqRR4krcSJabThc8nwZuJV3LercPHufi",
"privKey": "CAAS4AQwggJcAgEAAoGBAMBgbIqyOL26oV3nGPBYrdpbv..",
"pubKey": "CAASogEwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMBgbIqyOL26oV3nGPBYrdpbvzCY..."
}
```
# Installation
@ -72,101 +86,13 @@ Loading this module through a script tag will make the `PeerId` obj available in
the global namespace.
```html
<script src="https://npmcdn.com/peer-id/dist/index.min.js"></script>
<script src="https://unpkg.com/peer-id/dist/index.min.js"></script>
<!-- OR -->
<script src="https://npmcdn.com/peer-id/dist/index.js"></script>
<script src="https://unpkg.com/peer-id/dist/index.js"></script>
```
# API
```js
const PeerId = require('peer-id')
```
## Create
### `new PeerId(id[, privKey, pubKey])`
- `id: Buffer` - The multihash of the publick key as `Buffer`
- `privKey: RsaPrivateKey` - The private key
- `pubKey: RsaPublicKey` - The public key
The key format is detailed in [libp2p-crypto](https://github.com/ipfs/js-libp2p-crypto).
### `create([opts])`
Generates a new Peer ID, complete with public/private keypair.
- `opts: Object`: Default: `{bits: 2048}`
## Import
### `createFromHexString(str)`
Creates a Peer ID from hex string representing the key's multihash.
### `createFromBytes(buf)`
Creates a Peer ID from a buffer representing the key's multihash.
### `createFromB58String(str)`
Creates a Peer ID from a Base58 string representing the key's multihash.
### `createFromPubKey(pubKey)`
Creates a Peer ID from a buffer containing a public key.
### `createFromPrivKey(privKey)`
Creates a Peer ID from a buffer containing a private key.
### `createFromJSON(obj)`
- `obj.id: String` - The multihash encoded in `base58`
- `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'
## Export
### `toHexString()`
Returns the Peer ID's `id` as a hex string.
```
1220d6243998f2fc56343ad7ed0342ab7886a4eb18d736f1b67d44b37fcc81e0f39f
```
### `toBytes()`
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>
```
### `toB58String()`
Returns the Peer ID's `id` as a base58 string.
```
QmckZzdVd72h9QUFuJJpQqhsZqGLwjhh81qSvZ9BhB2FQi
```
### `toJSON()`
Returns an `obj` of the form
- `obj.id: String` - The multihash encoded in `base58`
- `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'
### `toPrint()`
Alias for `.toJSON()`.
# License
MIT

5
documentation.yml Normal file
View File

@ -0,0 +1,5 @@
toc:
- name: Introduction
file: intro.md
- PeerId
- PeerIdJson

61
intro.md Normal file
View File

@ -0,0 +1,61 @@
Generate, import, and export PeerIDs, for use with [IPFS](https://github.com/ipfs/ipfs).
> A Peer ID is the SHA-256 [multihash](https://github.com/multiformats/multihash) of a public key.
>
> The public key is a base64 encoded string of a protobuf containing an RSA DER buffer. This uses a node buffer to pass the base64 encoded public key protobuf to the multihash for ID generation.
## Example
```js
var PeerId = require('peer-id')
PeerId.create({ bits: 1024 }, (err, id) => {
console.log(JSON.stringify(id.toJSON(), null, 2)
})
```
```json
{
"id": "Qma9T5YraSnpRDZqRR4krcSJabThc8nwZuJV3LercPHufi",
"privKey": "CAAS4AQwggJcAgEAAoGBAMBgbIqyOL26oV3nGPBYrdpbv..",
"pubKey": "CAASogEwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMBgbIqyOL26oV3nGPBYrdpbvzCY..."
}
```
## Installation
### npm
```sh
> npm i peer-id
```
## Setup
### Node.js
```js
var PeerId = require('peer-id')
```
### Browser: Browserify, Webpack, other bundlers
The code published to npm that gets loaded on require is in fact a ES5
transpiled version with the right shims added. This means that you can require
it and use with your favourite bundler without having to adjust asset management
process.
```js
var PeerId = require('peer-id')
```
### Browser: `<script>` Tag
Loading this module through a script tag will make the `PeerId` obj available in
the global namespace.
```html
<script src="https://unpkg.com/peer-id/dist/index.min.js"></script>
<!-- OR -->
<script src="https://unpkg.com/peer-id/dist/index.js"></script>
```

View File

@ -1,10 +1,9 @@
{
"name": "peer-id",
"version": "0.7.0",
"version": "0.8.0",
"description": "IPFS Peer Id implementation in Node.js",
"main": "lib/index.js",
"main": "src/index.js",
"bin": "src/bin.js",
"jsnext:main": "src/index.js",
"scripts": {
"lint": "aegir-lint",
"build": "aegir-build",
@ -15,7 +14,8 @@
"release-minor": "aegir-release --type minor",
"release-major": "aegir-release --type major",
"coverage": "aegir-coverage",
"coverage-publish": "aegir-coverage publish"
"coverage-publish": "aegir-coverage publish",
"docs": "aegir-docs"
},
"keywords": [
"IPFS"
@ -27,30 +27,34 @@
"test"
],
"engines": {
"node": "^4.3.0"
"node": ">=4.0.0"
},
"bugs": {
"url": "https://github.com/diasdavid/js-peer-id/issues"
"url": "https://github.com/libp2p/js-peer-id/issues"
},
"homepage": "https://github.com/diasdavid/js-peer-id",
"homepage": "https://github.com/libp2p/js-peer-id",
"devDependencies": {
"aegir": "^3.1.1",
"aegir": "^9.1.2",
"chai": "^3.5.0",
"pre-commit": "^1.1.3"
},
"dependencies": {
"libp2p-crypto": "^0.5.0",
"multihashes": "^0.2.2"
"async": "^2.0.1",
"libp2p-crypto": "^0.7.0",
"multihashes": "^0.3.0"
},
"repository": {
"type": "git",
"url": "https://github.com/diasdavid/js-peer-id.git"
"url": "https://github.com/libp2p/js-peer-id.git"
},
"contributors": [
"David Dias <daviddias.p@gmail.com>",
"David Dias <mail@daviddias.me>",
"Friedel Ziegelmayer <dignifiedquire@gmail.com>",
"Richard Littauer <richard.littauer@gmail.com>",
"Stephen Whitmore <stephen.whitmore@gmail.com>",
"dignifiedquire <dignifiedquire@gmail.com>",
"nginnever <ginneversource@gmail.com>"
"greenkeeperio-bot <support@greenkeeper.io>",
"nginnever <ginneversource@gmail.com>",
"npmcdn-to-unpkg-bot <npmcdn-to-unpkg-bot@users.noreply.github.com>"
]
}

View File

@ -4,4 +4,10 @@
const PeerId = require('./index.js')
console.log(JSON.stringify(PeerId.create().toJSON(), null, ' '))
PeerId.create((err, id) => {
if (err) {
throw err
}
console.log(JSON.stringify(id.toJSON(), null, 2))
})

View File

@ -1,34 +1,61 @@
/*
* Id is an object representation of a peer Id. a peer Id is a multihash
*/
'use strict'
const mh = require('multihashes')
const crypto = require('libp2p-crypto')
const assert = require('assert')
const waterfall = require('async/waterfall')
/**
* @name PeerIdJson
* @type {Object}
* @typedef {Object} PeerIdJson
* @param {string} id - `Base58` encoded peer id
* @param {string=} privKey - The RSA private key in protobuf format, encoded in `base64`.
* @param {string=} pubKey - The RSA public key in protobuf format, encoded in `base64`.
*/
/**
* A Peer ID is the SHA-256
* [multihash](https://github.com/multiformats/multihash) of a
* public key.
* @class PeerId
* @see [libp2p-crypto](htttps://github.com/libp2p/js-libp2p-crypto)
*/
class PeerId {
/**
* @param {Buffer} id
* @param {RSAPrivateKey=} privKey
* @param {RSAPublickKey=} pubKey
*/
constructor (id, privKey, pubKey) {
assert(Buffer.isBuffer(id), 'invalid id provided')
if (pubKey) {
assert(id.equals(pubKey.hash()), 'inconsistent arguments')
}
if (privKey) {
assert(id.equals(privKey.public.hash()), 'inconsistent arguments')
}
if (privKey && pubKey) {
assert(privKey.public.bytes.equals(pubKey.bytes), 'inconsistent arguments')
}
/**
* @type {Buffer}
*/
this.id = id
this.privKey = privKey
this._privKey = privKey
this._pubKey = pubKey
}
/**
* The private key of this id, if it exists.
*
* @type {RSAPrivateKey|undefined}
*/
get privKey () {
return this._privKey
}
/**
* The public key of this id, if it exists.
*
* @type {(RSAPublicKey|undefined)}
*/
get pubKey () {
if (this._pubKey) {
return this._pubKey
@ -39,29 +66,43 @@ class PeerId {
}
}
// Return the protobuf version of the public key,
// matching go ipfs formatting
/** Create the protobuf version of the public key,
* matching go-ipfs formatting.
*
* @returns {Buffer} - The marshalled public key
*/
marshalPubKey () {
if (this.pubKey) {
return crypto.marshalPublicKey(this.pubKey)
}
}
// Return the protobuf version of the private key,
// matching go ipfs formatting
/** Create the protobuf version of the private key,
* matching go-ipfs formatting.
*
* @returns {Buffer}
*/
marshalPrivKey () {
if (this.privKey) {
return crypto.marshalPrivateKey(this.privKey)
}
}
// pretty print
/**
* Alias for `toJSON`.
*
* @returns {PeerIdJson}
*/
toPrint () {
return this.toJSON()
}
// return the jsonified version of the key, matching the formatting
// of go-ipfs for its config file
/**
* Return the jsonified version of the key, matching the formatting
* of go-ipfs for its config file.
*
* @returns {PeerIdJson}
*/
toJSON () {
return {
id: mh.toB58String(this.id),
@ -70,83 +111,229 @@ class PeerId {
}
}
// encode/decode functions
/**
* Returns the Peer ID's `id` as a hex string.
*
* @returns {String}
*/
toHexString () {
return mh.toHexString(this.id)
}
/**
* Returns the Peer ID's `id` as a buffer.
*
* @returns {Buffer}
*/
toBytes () {
return this.id
}
/**
* Returns the Peer ID's `id` as a base58 string.
*
* @returns {String}
*/
toB58String () {
return mh.toB58String(this.id)
}
/**
* Create a new `PeerId` by generating a new public/private keypair.
*
* @param {Object=} opts - Configuration object.
* @param {number} [opts.bits=2048] - How many bits to use for the RSA key generation.
* @param {function(Error, PeerId)} callback - Node.js style callback.
* @returns {undefined}
*
* @example
* const PeerId = require('peer-id')
*
* PeerId.create((err, id) => {
* if (err) {
* throw err
* }
* console.log('id', JSON.stringify(id))
* })
*
*/
static create (opts, callback) {
if (typeof opts === 'function') {
callback = opts
opts = {}
}
exports = module.exports = PeerId
exports.Buffer = Buffer
// generation
exports.create = function (opts) {
opts = opts || {}
opts.bits = opts.bits || 2048
const privKey = crypto.generateKeyPair('RSA', opts.bits)
return new PeerId(privKey.public.hash(), privKey)
waterfall([
(cb) => crypto.generateKeyPair('RSA', opts.bits, cb),
(privKey, cb) => privKey.public.hash((err, digest) => {
cb(err, digest, privKey)
})
], (err, digest, privKey) => {
if (err) {
return callback(err)
}
exports.createFromHexString = function (str) {
callback(null, new PeerId(digest, privKey))
})
}
/**
* Creates a Peer ID from hex string representing the key's multihash.
*
* @param {string} str - Hex encoded id
* @returns {PeerId}
*/
static createFromHexString (str) {
return new PeerId(mh.fromHexString(str))
}
exports.createFromBytes = function (buf) {
/**
* Creates a Peer ID from a buffer representing the key's multihash.
*
* @param {Buffer} buf
* @returns {PeerId}
*/
static createFromBytes (buf) {
return new PeerId(buf)
}
exports.createFromB58String = function (str) {
/**
* Creates a Peer ID from a `base58` string representing the
* key's multihash.
*
* @param {string} str - `base58` encoded id
* @returns {PeerId}
*/
static createFromB58String (str) {
return new PeerId(mh.fromB58String(str))
}
// Public Key input will be a buffer
exports.createFromPubKey = function (key) {
/**
* Creates a Peer ID from a buffer containing a public key.
*
* @param {string|Buffer} key
* @param {function(Error, PeerId)} callback
* @returns {undefined}
*/
static createFromPubKey (key, callback) {
let buf = key
if (typeof buf === 'string') {
buf = new Buffer(key, 'base64')
}
if (typeof callback !== 'function') {
throw new Error('callback is required')
}
const pubKey = crypto.unmarshalPublicKey(buf)
return new PeerId(pubKey.hash(), null, pubKey)
pubKey.hash((err, digest) => {
if (err) {
return callback(err)
}
// Private key input will be a string
exports.createFromPrivKey = function (key) {
callback(null, new PeerId(digest, null, pubKey))
})
}
/**
* Creates a Peer ID from a buffer containing a private key.
*
* @param {string|Buffer} key - The private key, if passed as
* string `base64` encoding is assumed.
* @param {function(Error, PeerId)} callback
* @returns {undefined}
*/
static createFromPrivKey (key, callback) {
let buf = key
if (typeof buf === 'string') {
buf = new Buffer(key, 'base64')
}
const privKey = crypto.unmarshalPrivateKey(buf)
return new PeerId(privKey.public.hash(), privKey)
if (typeof callback !== 'function') {
throw new Error('callback is required')
}
exports.createFromJSON = function (obj) {
let priv
let pub
if (obj.privKey) {
priv = crypto.unmarshalPrivateKey(new Buffer(obj.privKey, 'base64'))
waterfall([
(cb) => crypto.unmarshalPrivateKey(buf, cb),
(privKey, cb) => privKey.public.hash((err, digest) => {
cb(err, digest, privKey)
})
], (err, digest, privKey) => {
if (err) {
return callback(err)
}
if (obj.pubKey) {
pub = crypto.unmarshalPublicKey(new Buffer(obj.pubKey, 'base64'))
callback(null, new PeerId(digest, privKey))
})
}
return new PeerId(mh.fromB58String(obj.id), priv, pub)
/**
* Import a `PeerId` from a serialized JSON object.
*
* @param {PeerIdJson} obj
* @param {function(Error, PeerId)} callback
* @returns {undefined}
*/
static createFromJSON (obj, callback) {
if (typeof callback !== 'function') {
throw new Error('callback is required')
}
const id = mh.fromB58String(obj.id)
const rawPrivKey = obj.privKey && new Buffer(obj.privKey, 'base64')
const rawPubKey = obj.pubKey && new Buffer(obj.pubKey, 'base64')
const pub = rawPubKey && crypto.unmarshalPublicKey(rawPubKey)
if (rawPrivKey) {
waterfall([
(cb) => crypto.unmarshalPrivateKey(rawPrivKey, cb),
(priv, cb) => priv.public.hash((err, digest) => {
cb(err, digest, priv)
}),
(privDigest, priv, cb) => {
if (pub) {
pub.hash((err, pubDigest) => {
cb(err, privDigest, priv, pubDigest)
})
} else {
cb(null, privDigest, priv)
}
}
], (err, privDigest, priv, pubDigest) => {
if (err) {
return callback(err)
}
if (pub && !privDigest.equals(pubDigest)) {
return callback(new Error('Public and private key do not match'))
}
if (id && !privDigest.equals(id)) {
return callback(new Error('Id and private key do not match'))
}
callback(null, new PeerId(id, priv, pub))
})
} else {
callback(null, new PeerId(id, null, pub))
}
}
}
/**
* Convert a given `Buffer` to a `base64` encoded string.
* If no `val` is given it just returns `undefined`.
*
* @private
* @param {Buffer=} val
* @returns {string|undefined}
*/
function toB64Opt (val) {
if (val) {
return val.toString('base64')
}
}
exports = module.exports = PeerId

View File

@ -1,9 +1,11 @@
/* eslint max-nested-callbacks: ["error", 8] */
/* eslint-env mocha */
'use strict'
const expect = require('chai').expect
const crypto = require('libp2p-crypto')
const mh = require('multihashes')
const parallel = require('async/parallel')
const PeerId = require('../src')
@ -19,9 +21,12 @@ describe('PeerId', () => {
expect(PeerId).to.throw(Error)
})
it('create a new id', () => {
const id = PeerId.create()
it('create a new id', (done) => {
PeerId.create((err, id) => {
expect(err).to.not.exist
expect(id.toB58String().length).to.equal(46)
done()
})
})
it('recreate an Id from Hex string', () => {
@ -39,38 +44,60 @@ describe('PeerId', () => {
expect(testIdB58String).to.equal(id.toB58String())
})
it('Recreate from a Public Key', () => {
const id = PeerId.createFromPubKey(testId.pubKey)
it('Recreate from a Public Key', (done) => {
PeerId.createFromPubKey(testId.pubKey, (err, id) => {
expect(err).to.not.exist
expect(testIdB58String).to.equal(id.toB58String())
done()
})
})
it('Recreate from a Private Key', () => {
const id = PeerId.createFromPrivKey(testId.privKey)
it('Recreate from a Private Key', (done) => {
PeerId.createFromPrivKey(testId.privKey, (err, id) => {
expect(err).to.not.exist
expect(testIdB58String).to.equal(id.toB58String())
const id2 = PeerId.createFromPrivKey(new Buffer(testId.privKey, 'base64'))
const encoded = new Buffer(testId.privKey, 'base64')
PeerId.createFromPrivKey(encoded, (err, id2) => {
expect(err).to.not.exist
expect(testIdB58String).to.equal(id2.toB58String())
done()
})
})
})
it('Compare generated ID with one created from PubKey', () => {
const id1 = PeerId.create()
const id2 = PeerId.createFromPubKey(id1.marshalPubKey())
it('Compare generated ID with one created from PubKey', (done) => {
PeerId.create((err, id1) => {
expect(err).to.not.exist
PeerId.createFromPubKey(id1.marshalPubKey(), (err, id2) => {
expect(err).to.not.exist
expect(id1.id).to.be.eql(id2.id)
done()
})
})
})
it('Non-default # of bits', () => {
const shortId = PeerId.create({ bits: 128 })
const longId = PeerId.create({ bits: 256 })
it('Non-default # of bits', (done) => {
PeerId.create({ bits: 1024 }, (err, shortId) => {
expect(err).to.not.exist
PeerId.create({ bits: 4096 }, (err, longId) => {
expect(err).to.not.exist
expect(shortId.privKey.bytes.length).is.below(longId.privKey.bytes.length)
done()
})
})
})
it('Pretty printing', () => {
const id = PeerId.createFromPrivKey(testId.privKey)
const out = id.toPrint()
expect(out.id).to.equal(testIdB58String)
expect(out.privKey).to.equal(testId.privKey)
expect(out.pubKey).to.equal(testId.pubKey)
it('Pretty printing', (done) => {
PeerId.create((err, id1) => {
expect(err).to.not.exist
PeerId.createFromPrivKey(id1.toPrint().privKey, (err, id2) => {
expect(err).to.not.exist
expect(id1.toPrint()).to.be.eql(id2.toPrint())
done()
})
})
})
it('toBytes', () => {
@ -78,90 +105,118 @@ describe('PeerId', () => {
expect(id.toBytes().toString('hex')).to.equal(testIdBytes.toString('hex'))
})
describe('toJSON', () => {
it('full node', () => {
const id = PeerId.create({bits: 64})
describe('fromJSON', () => {
it('full node', (done) => {
PeerId.create({bits: 1024}, (err, id) => {
expect(err).to.not.exist
PeerId.createFromJSON(id.toJSON(), (err, other) => {
expect(err).to.not.exist
expect(
id.toB58String()
).to.equal(
PeerId.createFromJSON(id.toJSON()).toB58String()
other.toB58String()
)
expect(
id.privKey.bytes
).to.deep.equal(
PeerId.createFromJSON(id.toJSON()).privKey.bytes
other.privKey.bytes
)
expect(
id.pubKey.bytes
).to.deep.equal(
PeerId.createFromJSON(id.toJSON()).pubKey.bytes
other.pubKey.bytes
)
done()
})
})
})
it('only id', () => {
const key = crypto.generateKeyPair('RSA', 64)
const id = PeerId.createFromBytes(key.public.hash())
it('only id', (done) => {
crypto.generateKeyPair('RSA', 1024, (err, key) => {
expect(err).to.not.exist
key.public.hash((err, digest) => {
expect(err).to.not.exist
const id = PeerId.createFromBytes(digest)
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(
PeerId.createFromJSON(id.toJSON()).toB58String()
other.toB58String()
)
expect(id.privKey).to.not.exist
expect(id.pubKey).to.not.exist
done()
})
})
})
})
it('go interop', () => {
const id = PeerId.createFromJSON(goId)
it('go interop', (done) => {
PeerId.createFromJSON(goId, (err, id) => {
expect(err).to.not.exist
id.privKey.public.hash((err, digest) => {
expect(err).to.not.exist
expect(
mh.toB58String(id.privKey.public.hash())
mh.toB58String(digest)
).to.be.eql(
goId.id
)
done()
})
})
})
})
describe('throws on inconsistent data', () => {
const k1 = crypto.generateKeyPair('RSA', 64)
const k2 = crypto.generateKeyPair('RSA', 64)
const k3 = crypto.generateKeyPair('RSA', 64)
let k1, k2, k3
before((done) => {
parallel([
(cb) => crypto.generateKeyPair('RSA', 1024, cb),
(cb) => crypto.generateKeyPair('RSA', 1024, cb),
(cb) => crypto.generateKeyPair('RSA', 1024, cb)
], (err, keys) => {
if (err) {
return done(err)
}
it('missmatch id - private key', () => {
expect(
() => new PeerId(k1.public.hash(), k2)
).to.throw(
/inconsistent arguments/
)
k1 = keys[0]
k2 = keys[1]
k3 = keys[2]
done()
})
})
it('missmatch id - public key', () => {
it('missmatch private - public key', (done) => {
k1.public.hash((err, digest) => {
expect(err).to.not.exist
expect(
() => new PeerId(k1.public.hash(), null, k2.public)
() => new PeerId(digest, k1, k2.public)
).to.throw(
/inconsistent arguments/
)
done()
})
})
it('missmatch private - public key', () => {
it('missmatch id - private - public key', (done) => {
k1.public.hash((err, digest) => {
expect(err).to.not.exist
expect(
() => new PeerId(k1.public.hash(), k1, k2.public)
() => new PeerId(digest, k1, k3.public)
).to.throw(
/inconsistent arguments/
)
done()
})
it('missmatch id - private - public key', () => {
expect(
() => new PeerId(k1.public.hash(), k1, k3.public)
).to.throw(
/inconsistent arguments/
)
})
it('invalid id', () => {
expect(
() => new PeerId(k1.public.hash().toString())
() => new PeerId('hello world')
).to.throw(
/invalid id/
)