Friedel Ziegelmayer 08c5df5e79 feat: use webcrypto in favor of node-forge
BREAKING CHANGE: generateKeyPair is now async
2016-11-01 12:47:58 +01:00
2016-05-19 18:47:48 +02:00
2016-05-19 18:47:48 +02:00
2016-05-19 18:47:48 +02:00
2016-05-19 18:47:48 +02:00
2016-05-19 18:47:48 +02:00

js-libp2p-crypto

standard-readme compliant Coverage Status Travis CI Circle CI Dependency Status js-standard-style

Crypto primitives for libp2p in JavaScript

This repo contains the JavaScript implementation of the crypto primitives needed for libp2p. This is based on this go implementation.

Table of Contents

Install

npm install --save libp2p-crypto

Usage

Example

const crypto = require('libp2p-crypto')

crypto.generateKeyPair('RSA', 2048, (err, key) => {
})

API

generateKeyPair(type, bits, cb)

  • type: String, only 'RSA' is currently supported
  • bits: Number
  • cb: Function

Generates a keypair of the given type and bitsize.

generateEphemeralKeyPair(curve)

  • curve: String, one of 'P-256', 'P-384', 'P-521' is currently supported

Generates an ephemeral public key and returns a function that will compute the shared secret key.

Focuses only on ECDH now, but can be made more general in the future.

Returns an object of the form

{
  key: Buffer,
  genSharedKey: Function
}

keyStretcher(cipherType, hashType, secret)

  • cipherType: String, one of 'AES-128', 'AES-256', 'Blowfish'
  • hashType: String, one of 'SHA1', SHA256, SHA512
  • secret: Buffer

Generates a set of keys for each party by stretching the shared key.

Returns an object of the form

{
  k1: {
    iv: Buffer,
    cipherKey: Buffer,
    macKey: Buffer
  },
  k2: {
    iv: Buffer,
    cipherKey: Buffer,
    macKey: Buffer
  }
}

marshalPublicKey(key[, type])

  • key: crypto.rsa.RsaPublicKey
  • type: String, only 'RSA' is currently supported

Converts a public key object into a protobuf serialized public key.

unmarshalPublicKey(buf)

  • buf: Buffer

Converts a protobuf serialized public key into its representative object.

marshalPrivateKey(key[, type])

  • key: crypto.rsa.RsaPrivateKey
  • type: String, only 'RSA' is currently supported

Converts a private key object into a protobuf serialized private key.

unmarshalPrivateKey(buf)

  • buf: Buffer

Converts a protobuf serialized private key into its representative object.

Contribute

Feel free to join in. All welcome. Open an issue!

This repository falls under the IPFS Code of Conduct.

License

MIT

Description
No description provided
Readme 2 MiB
Languages
JavaScript 100%