fluencelabs/js-libp2p-crypto
1
0
Fork 0
mirror of https://github.com/fluencelabs/js-libp2p-crypto synced 2025-03-15 11:11:01 +00:00
Code Issues Projects Releases Wiki Activity
js-libp2p-crypto/README.md
dignifiedquire ca0b5305a2 feat: add marshal and unmarshl methods
2016-05-19 21:45:43 +02:00

2.1 KiB
Raw Blame History

JavaScript libp2p Crytpo

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

Crypto primitives for libp2p in JavaScript

Description

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

API

generateKeyPair(type, bits, cb)

  • type: String, only 'RSA' is currently supported
  • bits: Number
  • cb: Function, with the signature function (err, privateKey)

Generates a keypair of the given type and bitsize.

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.