fluencelabs/js-libp2p-crypto
1
0
Fork 0
mirror of https://github.com/fluencelabs/js-libp2p-crypto synced 2025-03-15 09:41:03 +00:00
Code Issues Projects Releases Wiki Activity

fix: fix links in README (#148)

Browse Source
This commit is contained in:
Arve Knudsen 2019-07-04 14:31:43 +02:00 committed by Jacob Heun
parent 0ffe31821a
commit 5cd0e8cc1a
1 changed files with 16 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -21,23 +21,24 @@ This repo contains the JavaScript implementation of the crypto primitives needed
- [Install](#install) - [Install](#install)
- [API](#api) - [API](#api)
- [`crypto.hmac`](#hmac) - [`crypto.hmac`](#cryptohmac)
- [`create(hash, secret, callback)`](#createhash-secret-callback) - [`create(hash, secret, callback)`](#cryptohmaccreatehash-secret-callback)
- [`digest(data, callback)`](#digestdata-callback) - [`digest(data, callback)`](#digestdata-callback)
- [`crypto.aes`](#aes) - [`crypto.aes`](#cryptoaes)
- [`create(key, iv, callback)`](#createkey-iv-callback) - [`create(key, iv, callback)`](#cryptoaescreatekey-iv-callback)
- [`encrypt(data, callback)`](#encryptdata-callback) - [`encrypt(data, callback)`](#encryptdata-callback)
- [`decrypt(data, callback)`](#decryptdata-callback) - [`decrypt(data, callback)`](#decryptdata-callback)
- [`keys`](#keys) - [`keys`](#cryptokeys)
- [`generateKeyPair(type, bits, callback)`](#generatekeypairtype-bits-callback) - [`generateKeyPair(type, bits, callback)`](#cryptokeysgeneratekeypairtype-bits-callback)
- [`generateEphemeralKeyPair(curve, callback)`](#generateephemeralkeypaircurve-callback) - [`generateEphemeralKeyPair(curve, callback)`](#cryptokeysgenerateephemeralkeypaircurve-callback)
- [`keyStretcher(cipherType, hashType, secret, callback)`](#keystretcherciphertype-hashtype-secret-callback) - [`keyStretcher(cipherType, hashType, secret, callback)`](#cryptokeyskeystretcherciphertype-hashtype-secret-callback)
- [`marshalPublicKey(key[, type], callback)`](#marshalpublickeykey-type-callback) - [`marshalPublicKey(key[, type], callback)`](#cryptokeysmarshalpublickeykey-type-callback)
- [`unmarshalPublicKey(buf)`](#unmarshalpublickeybuf) - [`unmarshalPublicKey(buf)`](#cryptokeysunmarshalpublickeybuf)
- [`marshalPrivateKey(key[, type])`](#marshalprivatekeykey-type) - [`marshalPrivateKey(key[, type])`](#cryptokeysmarshalprivatekeykey-type)
- [`unmarshalPrivateKey(buf, callback)`](#unmarshalprivatekeybuf-callback) - [`unmarshalPrivateKey(buf, callback)`](#cryptokeysunmarshalprivatekeybuf-callback)
- [`import(pem, password, callback)`](#importpem-password-callback) - [`import(pem, password, callback)`](#cryptokeysimportpem-password-callback)
- [`webcrypto`](#webcrypto) - [`randomBytes(number)`](#cryptorandombytesnumber)
- [`pbkdf2(password, salt, iterations, keySize, hash)`](#cryptopbkdf2password-salt-iterations-keysize-hash)
- [Contribute](#contribute) - [Contribute](#contribute)
- [License](#license) - [License](#license)
@ -155,7 +156,7 @@ crypto.hmac.create(hash, Buffer.from('secret'), (err, hmac) => {
**Supported Key Types** **Supported Key Types**
The [`generateKeyPair`](#generatekeypairtype-bits-callback), [`marshalPublicKey`](#marshalpublickeykey-type-callback), and [`marshalPrivateKey`](#marshalprivatekeykey-type) functions accept a string `type` argument. The [`generateKeyPair`](#cryptokeysgeneratekeypairtype-bits-callback), [`marshalPublicKey`](#cryptokeysmarshalpublickeykey-type-callback), and [`marshalPrivateKey`](#cryptokeysmarshalprivatekeykey-type) 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. 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.