# libp2p-crypto > Crypto primitives for libp2p Latest version **0.21.2** (published 2022-01-20) · MIT license · 0 weekly downloads ## Install ```sh npm install libp2p-crypto pnpm add libp2p-crypto yarn add libp2p-crypto bun add libp2p-crypto ``` ## Health **Score 25/100 (F)** — status: abandoned. Positive: has types; no vulnerabilities; high quality score. Warnings: low downloads; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.21.2 | | Published | 2022-01-20 | | First published | 2016-05-20 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | CommonJS | | Node | >=12.0.0 | | Dependencies | 8 | | Unpacked size | 320.5 KB | | Known vulnerabilities | 0 (+11 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 79 | | Maintainers | jacobheun, daviddias, dignifiedquire, achingbrain, vascosantos | | Keywords | IPFS, libp2p, crypto, rsa, secp256k1 | ## Links - npm: https://www.npmjs.com/package/libp2p-crypto - Repository: https://github.com/libp2p/js-libp2p-crypto - Issues: https://github.com/libp2p/js-libp2p-crypto/issues - npm.io page: https://npm.io/package/libp2p-crypto ## Dependencies (8) - [err-code](https://npm.io/package/err-code.md) ^3.0.1 - [node-forge](https://npm.io/package/node-forge.md) ^1.2.1 - [protobufjs](https://npm.io/package/protobufjs.md) ^6.11.2 - [uint8arrays](https://npm.io/package/uint8arrays.md) ^3.0.0 - [multiformats](https://npm.io/package/multiformats.md) ^9.4.5 - [@noble/ed25519](https://npm.io/package/@noble/ed25519.md) ^1.5.1 - [@noble/secp256k1](https://npm.io/package/@noble/secp256k1.md) ^1.3.0 - [iso-random-stream](https://npm.io/package/iso-random-stream.md) ^2.0.0 ## Alternatives - [@gemini-wallet/core](https://npm.io/package/@gemini-wallet/core.md) — 515.6K weekly downloads - [utility](https://npm.io/package/utility.md) — 416.6K weekly downloads - [@primno/dpapi](https://npm.io/package/@primno/dpapi.md) — 7.2K weekly downloads - [pi-readseek](https://npm.io/package/pi-readseek.md) — 3.7K weekly downloads - [@emilia-protocol/verify](https://npm.io/package/@emilia-protocol/verify.md) — 1.1K weekly downloads ## Recent versions - 0.21.2 (latest) — 2022-01-20 - 0.18.0 (beta) — 2020-08-07 - 0.21.1 — 2022-01-18 - 0.21.0 — 2021-12-01 - 0.20.0 — 2021-10-21 - 0.19.7 — 2021-08-18 - 0.16.4 — 2021-07-30 - 0.19.6 — 2021-07-15 - 0.19.5 — 2021-07-07 - 0.19.4 — 2021-04-20 - 0.19.3 — 2021-04-11 - 0.19.2 — 2021-03-17 - 0.19.1 — 2021-03-15 - 0.19.0 — 2021-01-15 - 0.17.9 — 2020-08-05 - … 52 more at https://npm.io/package/libp2p-crypto/versions ## README # js-libp2p-crypto [![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://protocol.ai) [![](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/) [![](https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23libp2p) [![Discourse posts](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg)](https://discuss.libp2p.io) [![](https://img.shields.io/codecov/c/github/libp2p/js-libp2p-crypto.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-crypto) [![](https://img.shields.io/travis/libp2p/js-libp2p-crypto.svg?style=flat-square)](https://travis-ci.com/libp2p/js-libp2p-crypto) [![Dependency Status](https://david-dm.org/libp2p/js-libp2p-crypto.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-crypto) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard) > 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](https://github.com/libp2p/go-libp2p-crypto). ## Lead Maintainer [Jacob Heun](https://github.com/jacobheun/) ## Table of Contents - [js-libp2p-crypto](#js-libp2p-crypto) - [Lead Maintainer](#lead-maintainer) - [Table of Contents](#table-of-contents) - [Install](#install) - [Usage](#usage) - [Web Crypto API](#web-crypto-api) - [API](#api) - [`crypto.aes`](#cryptoaes) - [`crypto.aes.create(key, iv)`](#cryptoaescreatekey-iv) - [`decrypt(data)`](#decryptdata) - [`encrypt(data)`](#encryptdata) - [`crypto.hmac`](#cryptohmac) - [`crypto.hmac.create(hash, secret)`](#cryptohmaccreatehash-secret) - [`digest(data)`](#digestdata) - [`crypto.keys`](#cryptokeys) - [`crypto.keys.generateKeyPair(type, bits)`](#cryptokeysgeneratekeypairtype-bits) - [`crypto.keys.generateEphemeralKeyPair(curve)`](#cryptokeysgenerateephemeralkeypaircurve) - [`crypto.keys.keyStretcher(cipherType, hashType, secret)`](#cryptokeyskeystretcherciphertype-hashtype-secret) - [`crypto.keys.marshalPublicKey(key, [type])`](#cryptokeysmarshalpublickeykey-type) - [`crypto.keys.unmarshalPublicKey(buf)`](#cryptokeysunmarshalpublickeybuf) - [`crypto.keys.marshalPrivateKey(key, [type])`](#cryptokeysmarshalprivatekeykey-type) - [`crypto.keys.unmarshalPrivateKey(buf)`](#cryptokeysunmarshalprivatekeybuf) - [`crypto.keys.import(encryptedKey, password)`](#cryptokeysimportencryptedkey-password) - [`privateKey.export(password, format)`](#privatekeyexportpassword-format) - [`crypto.randomBytes(number)`](#cryptorandombytesnumber) - [`crypto.pbkdf2(password, salt, iterations, keySize, hash)`](#cryptopbkdf2password-salt-iterations-keysize-hash) - [Contribute](#contribute) - [License](#license) ## Install ```sh npm install --save libp2p-crypto ``` ## Usage ```js const crypto = require('libp2p-crypto') // Now available to you: // // crypto.aes // crypto.hmac // crypto.keys // etc. // // See full API details below... ``` ### Web Crypto API The `libp2p-crypto` library depends on the [Web Crypto API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API) in the browser. Web Crypto is available in all modern browsers, however browsers restrict its usage to [Secure Contexts](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts). **This means you will not be able to use some `libp2p-crypto` functions in the browser when the page is served over HTTP.** To enable the Web Crypto API and allow `libp2p-crypto` to work fully, please serve your page over HTTPS. ## API ### `crypto.aes` Exposes an interface to AES encryption (formerly Rijndael), as defined in U.S. Federal Information Processing Standards Publication 197. This uses `CTR` mode. #### `crypto.aes.create(key, iv)` - `key: Uint8Array` The key, if length `16` then `AES 128` is used. For length `32`, `AES 256` is used. - `iv: Uint8Array` Must have length `16`. Returns `Promise<{decrypt, encrypt}>` ##### `decrypt(data)` - `data: Uint8Array` Returns `Promise` ##### `encrypt(data)` - `data: Uint8Array` Returns `Promise` ```js const crypto = require('libp2p-crypto') // Setting up Key and IV // A 16 bytes array, 128 Bits, AES-128 is chosen const key128 = Uint8Array.from([0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]) // A 16 bytes array, 128 Bits, const IV = Uint8Array.from([0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]) async function main () { const decryptedMessage = 'Hello, world!' // Encrypting const cipher = await crypto.aes.create(key128, IV) const encryptedBuffer = await cipher.encrypt(Uint8Array.from(decryptedMessage)) console.log(encryptedBuffer) // prints: // Decrypting const decipher = await crypto.aes.create(key128, IV) const decryptedBuffer = await cipher.decrypt(encryptedBuffer) console.log(decryptedBuffer) // prints: console.log(decryptedBuffer.toString('utf-8')) // prints: Hello, world! } main() ``` ### `crypto.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. #### `crypto.hmac.create(hash, secret)` - `hash: String` - `secret: Uint8Array` Returns `Promise<{digest}>` ##### `digest(data)` - `data: Uint8Array` Returns `Promise` Example: ```js const crypto = require('libp2p-crypto') async function main () { const hash = 'SHA1' // 'SHA256' || 'SHA512' const hmac = await crypto.hmac.create(hash, uint8ArrayFromString('secret')) const sig = await hmac.digest(uint8ArrayFromString('hello world')) console.log(sig) } main() ``` ### `crypto.keys` **Supported Key Types** The [`generateKeyPair`](#generatekeypairtype-bits), [`marshalPublicKey`](#marshalpublickeykey-type), and [`marshalPrivateKey`](#marshalprivatekeykey-type) functions accept a string `type` argument. Currently the `'RSA'`, `'ed25519'`, and `secp256k1` types are supported, although ed25519 and secp256k1 keys support only signing and verification of messages. For encryption / decryption support, RSA keys should be used. ### `crypto.keys.generateKeyPair(type, bits)` - `type: String`, see [Supported Key Types](#supported-key-types) above. - `bits: Number` Minimum of 1024 Returns `Promise<{privateKey, publicKey}>` Generates a keypair of the given type and bitsize. ### `crypto.keys.generateEphemeralKeyPair(curve)` - `curve: String`, one of `'P-256'`, `'P-384'`, `'P-521'` is currently supported Returns `Promise` 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. Resolves to an object of the form: ```js { key: Uint8Array, genSharedKey: Function } ``` ### `crypto.keys.keyStretcher(cipherType, hashType, secret)` - `cipherType: String`, one of `'AES-128'`, `'AES-256'`, `'Blowfish'` - `hashType: String`, one of `'SHA1'`, `SHA256`, `SHA512` - `secret: Uint8Array` Returns `Promise` Generates a set of keys for each party by stretching the shared key. Resolves to an object of the form: ```js { k1: { iv: Uint8Array, cipherKey: Uint8Array, macKey: Uint8Array }, k2: { iv: Uint8Array, cipherKey: Uint8Array, macKey: Uint8Array } } ``` ### `crypto.keys.marshalPublicKey(key, [type])` - `key: keys.rsa.RsaPublicKey | keys.ed25519.Ed25519PublicKey | keys.secp256k1.Secp256k1PublicKey` - `type: String`, see [Supported Key Types](#supported-key-types) above. Defaults to 'rsa'. Returns `Uint8Array` Converts a public key object into a protobuf serialized public key. ### `crypto.keys.unmarshalPublicKey(buf)` - `buf: Uint8Array` Returns `RsaPublicKey|Ed25519PublicKey|Secp256k1PublicKey` Converts a protobuf serialized public key into its representative object. ### `crypto.keys.marshalPrivateKey(key, [type])` - `key: keys.rsa.RsaPrivateKey | keys.ed25519.Ed25519PrivateKey | keys.secp256k1.Secp256k1PrivateKey` - `type: String`, see [Supported Key Types](#supported-key-types) above. Returns `Uint8Array` Converts a private key object into a protobuf serialized private key. ### `crypto.keys.unmarshalPrivateKey(buf)` - `buf: Uint8Array` Returns `Promise` Converts a protobuf serialized private key into its representative object. ### `crypto.keys.import(encryptedKey, password)` - `encryptedKey: string` - `password: string` Returns `Promise` Converts an exported private key into its representative object. Supported formats are 'pem' (RSA only) and 'libp2p-key'. ### `privateKey.export(password, format)` - `password: string` - `format: string` the format to export to: 'pem' (rsa only), 'libp2p-key' Returns `string` Exports the password protected `PrivateKey`. RSA keys will be exported as password protected PEM by default. Ed25519 and Secp256k1 keys will be exported as password protected AES-GCM base64 encoded strings ('libp2p-key' format). ### `crypto.randomBytes(number)` - `number: Number` Returns `Uint8Array` Generates a Uint8Array with length `number` populated by random bytes. ### `crypto.pbkdf2(password, salt, iterations, keySize, hash)` - `password: String` - `salt: String` - `iterations: Number` - `keySize: Number` in bytes - `hash: String` the hashing algorithm ('sha1', 'sha2-512', ...) Computes the Password Based Key Derivation Function 2; returning a new password. ## Contribute Feel free to join in. All welcome. Open an [issue](https://github.com/libp2p/js-libp2p-crypto/issues)! This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md). [![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/contributing.md) ## License [MIT](./LICENSE) --- _Source: https://npm.io/package/libp2p-crypto · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._