Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
libp2p-crypto
Advanced tools
[](https://saucelabs.com/u/ipfs-js- libp2p-crypto)
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.
npm install --save libp2p-crypto
const crypto = require('libp2p-crypto')
crypto.generateKeyPair('RSA', 2048, (err, key) => {
})
hmac
Exposes an interface to the Keyed-Hash Message Authentication Code (HMAC) as defined in U.S. Federal Information Processing Standards Publication 198. An HMAC is a cryptographic hash that uses a key to sign a message. The receiver verifies the hash by recomputing it using the same key.
create(hash, secret, callback)
hash: String
secret: Buffer
callback: Function
digest(data, callback)
data: Buffer
callback: Function
aes
Expoes an interface to AES encryption (formerly Rijndael), as defined in U.S. Federal Information Processing Standards Publication 197.
This uses CTR
mode.
create(key, iv, callback)
key: Buffer
The key, if length 16
then AES 128
is used. For length 32
, AES 256
is used.iv: Buffer
Must have length 16
.callback: Function
encrypt(data, callback)
data: Buffer
callback: Function
encrypt(data, callback)
data: Buffer
callback: Function
webcrypto
Depending on the environment this is either an instance of node-webcrypto-ossl or the result of window.crypto
.
keys
The generateKeyPair
, marshalPublicKey
, and
marshalPrivateKey
functions accept a string type
argument.
Currently the 'RSA'
and 'ed25519'
types are supported, although ed25519 keys support only signing and
verification of messages. For encryption / decryption support, RSA keys should be used.
Installing the libp2p-crypto-secp256k1 module adds support for the
'secp256k1'
type, which supports ECDSA signatures using the secp256k1 elliptic curve popularized by Bitcoin. This module
is not installed by default, and should be explicitly depended on if your project requires secp256k1 support.
generateKeyPair(type, bits, callback)
type: String
, see Supported Key Types above.bits: Number
Minimum of 1024callback: Function
Generates a keypair of the given type and bitsize.
generateEphemeralKeyPair(curve, callback)
curve: String
, one of 'P-256'
, 'P-384'
, 'P-521'
is currently supportedcallback: Function
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.
Calls back with an object of the form
{
key: Buffer,
genSharedKey: Function
}
keyStretcher(cipherType, hashType, secret, callback)
cipherType: String
, one of 'AES-128'
, 'AES-256'
, 'Blowfish'
hashType: String
, one of 'SHA1'
, SHA256
, SHA512
secret: Buffer
callback: Function
Generates a set of keys for each party by stretching the shared key.
Calls back with an object of the form
{
k1: {
iv: Buffer,
cipherKey: Buffer,
macKey: Buffer
},
k2: {
iv: Buffer,
cipherKey: Buffer,
macKey: Buffer
}
}
marshalPublicKey(key[, type], callback)
key: keys.rsa.RsaPublicKey | keys.ed25519.Ed25519PublicKey | require('libp2p-crypto-secp256k1').Secp256k1PublicKey
type: String
, see Supported Key Types above.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: keys.rsa.RsaPrivateKey | keys.ed25519.Ed25519PrivateKey | require('libp2p-crypto-secp256k1').Secp256k1PrivateKey
type: String
, see Supported Key Types above.Converts a private key object into a protobuf serialized private key.
unmarshalPrivateKey(buf, callback)
buf: Buffer
callback: Function
Converts a protobuf serialized private key into its representative object.
randomBytes(number)
number: Number
Generates a Buffer with length number
populated by random bytes.
Feel free to join in. All welcome. Open an issue!
This repository falls under the IPFS Code of Conduct.
0.8.7 (2017-03-21)
<a name="0.8.6"></a>
FAQs
Crypto primitives for libp2p
The npm package libp2p-crypto receives a total of 27,717 weekly downloads. As such, libp2p-crypto popularity was classified as popular.
We found that libp2p-crypto demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.