Diffie Hellman Key Exchange :key:


Diffie Hellman key exchange framework

* Install
* Example
* API

Install

To install diffie-hellman-key-exchange, simply use npm:

``
npm install diffie-hellman-key-exchange --save
`

Example

$3

`javascript
const Dh = require('diffie-hellman-key-exchange')

const alice = Dh('alice', {
prime: 'prime',
listen: 8000,
log_level: 'info',
apps: {
'bob': {
host: '127.0.0.1',
port: '8001'
}
}
})

// on incoming message

const decrypted = alice.decrypt('bob', message)
`

$3

`javascript
const Dh = require('diffie-hellman-key-exchange')

const bob = Dh('bob', {
prime: 'prime',
listen: 8001,
apps: {
'alice': {
host: '127.0.0.1',
port: '8000'
}
}
})

if (bob.getAppPublicKey('alice')) {
const message = this.encrypt('alice', 'hello')

// send message
} else {
bob.initalizeSession('alice', function(err, secret) {
const message = this.encrypt('alice', 'hello')

// send message
})
}
`

$3

`javascript
const Swim = require('swim')
const Dh = require('diffie-hellman-key-exchange')

const swim = new Swim({
local: {
host: 'my_host:port',
meta: {
// must have this object in order to communicate my connection info
dh: {
name: 'bob',
host: 'my_host',
port: 8001
}
}
}
})

swim.bootstrap(hostsToJoin)

const bob = Dh('bob', {
prime: 'prime',
listen: 8001,
apps: swim // it will load all the app from swim
})
`

API

* Dh()
* instance.createDH()
* instance.generateNewKeys()
* instance.initalizeSession()
* instance.addApp()
* instance.setAppPublicKey()
* instance.getAppPublicKey()
* instance.encrypt()
* instance.decrypt()
* instance.dh
* instance.crypter

-------------------------------------------------------


$3

Creates a new instance of Dh.

* app_name, the unique name of this app
* opts
* prime, the prime for DH
* generator, the generator for DH
* listen, on which port the application will listen for the handshake public key exchange [default: 8000]
* log_level, log level for the pino instance [default: warn]
* crypter
* algorithm, algorithm used to encrypt [default: aes-256-ctr]
* apps, could be a Swim instance or object that contains all the apps [es: 'bob': { host: '127.0.0.1', port: 8000 } ]

-------------------------------------------------------


$3

Set a new DH instance, available by the dh attribute. [es: instance.dh]

-------------------------------------------------------


$3

Generate a new pair of keys

-------------------------------------------------------


$3

Initialize the public key (each other) in order to start the communication

* other_app_name, app that i want to communicate
* cb, function(err, secret_key) { assert.ok(this instanceof Dh) }

-------------------------------------------------------


$3

Add one app connection to che instance configuration

* app_name
* opts, [es: 'bob': { host: '127.0.0.1', port: 8000 } ]

-------------------------------------------------------


$3

Set the public key for the specified app

* app_name
* public_key, [type: 'hex']

-------------------------------------------------------


$3

Return the public key if present

* app_name

-------------------------------------------------------


$3

Encrypt data for the given app name

* app_name
* data, [type: 'string']

-------------------------------------------------------


$3

Decrypt data with the public key of the given app name

* app_name
* data, [type: 'string']

-------------------------------------------------------


$3

Attribute with the DH nodejs crypto class

-------------------------------------------------------


$3

Attribute with the Crypter class

Methods:
* encrypt(data, secret)
* decrypt(data, secret)`