libp2p-crypto

0.17.2
Need help reading this?

Intro

Installable via npm install --save libp2p-crypto, it can also be used directly in the browser.

Download

The source is available for download from GitHub. Alternatively, you can install using npm:

$ npm install --save libp2p-crypto

You can then require() libp2p-crypto as normal:

const libp2PCrypto = require('libp2p-crypto')

In the Browser

Libp2p-crypto should work in any ES2015 environment out of the box.

Usage:

<script type="text/javascript" src="index.js"></script>

The portable versions of libp2p-crypto, including index.js and index.min.js, are included in the /dist folder. Libp2p-crypto can also be found on unpkg.com under

id

src/keys/rsa-class.js

Gets the ID of the key.

The key id is the base58 encoding of the SHA-256 multihash of its public key. The public key is a protobuf encoding containing a type and the DER encoding of the PKCS SubjectPublicKeyInfo.

id(): Promise<String>
Returns
Promise<String>:

export

src/keys/rsa-class.js

Exports the key into a password protected PEM format

export(password: string, format: string?)
Parameters
password (string) The password to read the encrypted PEM
format (string? = 'pkcs-8') Defaults to 'pkcs-8'.

keypair

src/keys/rsa.js
keypair

Type: PrivateKey

id

src/keys/ed25519-class.js

Gets the ID of the key.

The key id is the base58 encoding of the SHA-256 multihash of its public key. The public key is a protobuf encoding containing a type and the DER encoding of the PKCS SubjectPublicKeyInfo.

id(): Promise<String>
Returns
Promise<String>:

src/pbkdf2.js

Computes the Password-Based Key Derivation Function 2.

Parameters
password (string)
salt (string)
iterations (number)
keySize (number) (in bytes)
hash (string) The hash name ('sha1', 'sha2-512, ...)
Returns
string: A new password