@libp2p/crypto 4.0.2-fb7c51c3c → 4.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/README.md +25 -0
  2. package/dist/src/hmac/index.d.ts +1 -1
  3. package/dist/src/hmac/index.js +1 -1
  4. package/dist/typedoc-urls.json +42 -0
  5. package/package.json +6 -5
  6. package/src/hmac/index.ts +1 -1
package/README.md CHANGED
@@ -1,3 +1,5 @@
1
+ # @libp2p/crypto
2
+
1
3
  [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
2
4
  [![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io)
3
5
  [![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p)
@@ -5,6 +7,29 @@
5
7
 
6
8
  > Crypto primitives for libp2p
7
9
 
10
+ # About
11
+
12
+ <!--
13
+
14
+ !IMPORTANT!
15
+
16
+ Everything in this README between "# About" and "# Install" is automatically
17
+ generated and will be overwritten the next time the doc generator is run.
18
+
19
+ To make changes to this section, please update the @packageDocumentation section
20
+ of src/index.js or src/index.ts
21
+
22
+ To experiment with formatting, please run "npm run docs" from the root of this
23
+ repo and examine the changes made.
24
+
25
+ -->
26
+
27
+ 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).
28
+
29
+ *This means you will not be able to use some `@libp2p/crypto` functions in the browser when the page is served over HTTP.*
30
+
31
+ To enable the Web Crypto API and allow `@libp2p/crypto` to work fully, please serve your page over HTTPS.
32
+
8
33
  # Install
9
34
 
10
35
  ```console
package/dist/src/hmac/index.d.ts CHANGED
@@ -5,7 +5,7 @@
5
5
  *
6
6
  * @example
7
7
  *
8
- * ```js
8
+ * ```TypeScript
9
9
  * import { create } from '@libp2p/hmac'
10
10
  *
11
11
  * const hash = 'SHA1' // 'SHA256' || 'SHA512'
package/dist/src/hmac/index.js CHANGED
@@ -5,7 +5,7 @@
5
5
  *
6
6
  * @example
7
7
  *
8
- * ```js
8
+ * ```TypeScript
9
9
  * import { create } from '@libp2p/hmac'
10
10
  *
11
11
  * const hash = 'SHA1' // 'SHA256' || 'SHA512'
package/dist/typedoc-urls.json ADDED
@@ -0,0 +1,42 @@
1
+ {
2
+ "HMAC": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_crypto.hmac.HMAC.html",
3
+ "./hmac:HMAC": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_crypto.hmac.HMAC.html",
4
+ "create": "https://libp2p.github.io/js-libp2p/functions/_libp2p_crypto.hmac.create.html",
5
+ "./hmac:create": "https://libp2p.github.io/js-libp2p/functions/_libp2p_crypto.hmac.create.html",
6
+ "pbkdf2": "https://libp2p.github.io/js-libp2p/functions/_libp2p_crypto.index.pbkdf2.html",
7
+ "randomBytes": "https://libp2p.github.io/js-libp2p/functions/_libp2p_crypto.index.randomBytes.html",
8
+ "codec": "https://libp2p.github.io/js-libp2p/functions/_libp2p_crypto.keys.keysPBM.KeyType.codec.html",
9
+ "decode": "https://libp2p.github.io/js-libp2p/functions/_libp2p_crypto.keys.keysPBM.PrivateKey.decode.html",
10
+ "encode": "https://libp2p.github.io/js-libp2p/functions/_libp2p_crypto.keys.keysPBM.PrivateKey.encode.html",
11
+ "KeyType": "https://libp2p.github.io/js-libp2p/enums/_libp2p_crypto.keys.keysPBM.KeyType-1.html",
12
+ "PrivateKey": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_crypto.keys.keysPBM.PrivateKey-1.html",
13
+ "PublicKey": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_crypto.keys.keysPBM.PublicKey-1.html",
14
+ "Ed25519PrivateKey": "https://libp2p.github.io/js-libp2p/classes/_libp2p_crypto.keys.Ed25519PrivateKey.html",
15
+ "Ed25519PublicKey": "https://libp2p.github.io/js-libp2p/classes/_libp2p_crypto.keys.Ed25519PublicKey.html",
16
+ "RsaPrivateKey": "https://libp2p.github.io/js-libp2p/classes/_libp2p_crypto.keys.RsaPrivateKey.html",
17
+ "RsaPublicKey": "https://libp2p.github.io/js-libp2p/classes/_libp2p_crypto.keys.RsaPublicKey.html",
18
+ "Secp256k1PrivateKey": "https://libp2p.github.io/js-libp2p/classes/_libp2p_crypto.keys.Secp256k1PrivateKey.html",
19
+ "Secp256k1PublicKey": "https://libp2p.github.io/js-libp2p/classes/_libp2p_crypto.keys.Secp256k1PublicKey.html",
20
+ "JWKKeyPair": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_crypto.keys.JWKKeyPair.html",
21
+ "KeyTypes": "https://libp2p.github.io/js-libp2p/types/_libp2p_crypto.keys.KeyTypes.html",
22
+ "./keys:KeyTypes": "https://libp2p.github.io/js-libp2p/types/_libp2p_crypto.keys.KeyTypes.html",
23
+ "MAX_RSA_KEY_SIZE": "https://libp2p.github.io/js-libp2p/variables/_libp2p_crypto.keys.MAX_RSA_KEY_SIZE.html",
24
+ "supportedKeys": "https://libp2p.github.io/js-libp2p/variables/_libp2p_crypto.keys.supportedKeys.html",
25
+ "./keys:supportedKeys": "https://libp2p.github.io/js-libp2p/variables/_libp2p_crypto.keys.supportedKeys.html",
26
+ "generateEphemeralKeyPair": "https://libp2p.github.io/js-libp2p/functions/_libp2p_crypto.keys.generateEphemeralKeyPair.html",
27
+ "generateKeyPair": "https://libp2p.github.io/js-libp2p/functions/_libp2p_crypto.keys.generateKeyPair.html",
28
+ "./keys:generateKeyPair": "https://libp2p.github.io/js-libp2p/functions/_libp2p_crypto.keys.generateKeyPair.html",
29
+ "generateKeyPairFromSeed": "https://libp2p.github.io/js-libp2p/functions/_libp2p_crypto.keys.generateKeyPairFromSeed.html",
30
+ "./keys:generateKeyPairFromSeed": "https://libp2p.github.io/js-libp2p/functions/_libp2p_crypto.keys.generateKeyPairFromSeed.html",
31
+ "importKey": "https://libp2p.github.io/js-libp2p/functions/_libp2p_crypto.keys.importKey.html",
32
+ "./keys:importKey": "https://libp2p.github.io/js-libp2p/functions/_libp2p_crypto.keys.importKey.html",
33
+ "keyStretcher": "https://libp2p.github.io/js-libp2p/functions/_libp2p_crypto.keys.keyStretcher.html",
34
+ "marshalPrivateKey": "https://libp2p.github.io/js-libp2p/functions/_libp2p_crypto.keys.marshalPrivateKey.html",
35
+ "./keys:marshalPrivateKey": "https://libp2p.github.io/js-libp2p/functions/_libp2p_crypto.keys.marshalPrivateKey.html",
36
+ "marshalPublicKey": "https://libp2p.github.io/js-libp2p/functions/_libp2p_crypto.keys.marshalPublicKey.html",
37
+ "./keys:marshalPublicKey": "https://libp2p.github.io/js-libp2p/functions/_libp2p_crypto.keys.marshalPublicKey.html",
38
+ "unmarshalPrivateKey": "https://libp2p.github.io/js-libp2p/functions/_libp2p_crypto.keys.unmarshalPrivateKey.html",
39
+ "./keys:unmarshalPrivateKey": "https://libp2p.github.io/js-libp2p/functions/_libp2p_crypto.keys.unmarshalPrivateKey.html",
40
+ "unmarshalPublicKey": "https://libp2p.github.io/js-libp2p/functions/_libp2p_crypto.keys.unmarshalPublicKey.html",
41
+ "./keys:unmarshalPublicKey": "https://libp2p.github.io/js-libp2p/functions/_libp2p_crypto.keys.unmarshalPublicKey.html"
42
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@libp2p/crypto",
3
- "version": "4.0.2-fb7c51c3c",
3
+ "version": "4.0.3",
4
4
  "description": "Crypto primitives for libp2p",
5
5
  "license": "Apache-2.0 OR MIT",
6
6
  "homepage": "https://github.com/libp2p/js-libp2p/tree/main/packages/crypto#readme",
@@ -71,6 +71,7 @@
71
71
  "clean": "aegir clean",
72
72
  "lint": "aegir lint",
73
73
  "dep-check": "aegir dep-check",
74
+ "doc-check": "aegir doc-check",
74
75
  "build": "aegir build",
75
76
  "test": "aegir test",
76
77
  "test:chrome": "aegir test -t browser",
@@ -83,18 +84,18 @@
83
84
  "generate": "protons ./src/keys/keys.proto"
84
85
  },
85
86
  "dependencies": {
86
- "@libp2p/interface": "1.1.3-fb7c51c3c",
87
+ "@libp2p/interface": "^1.1.4",
87
88
  "@noble/curves": "^1.3.0",
88
89
  "@noble/hashes": "^1.3.3",
89
90
  "asn1js": "^3.0.5",
90
- "multiformats": "^13.0.1",
91
+ "multiformats": "^13.1.0",
91
92
  "protons-runtime": "^5.4.0",
92
93
  "uint8arraylist": "^2.4.8",
93
- "uint8arrays": "^5.0.1"
94
+ "uint8arrays": "^5.0.2"
94
95
  },
95
96
  "devDependencies": {
96
97
  "@types/mocha": "^10.0.6",
97
- "aegir": "^42.2.3",
98
+ "aegir": "^42.2.4",
98
99
  "benchmark": "^2.1.4",
99
100
  "protons": "^7.5.0"
100
101
  },
package/src/hmac/index.ts CHANGED
@@ -5,7 +5,7 @@
5
5
  *
6
6
  * @example
7
7
  *
8
- * ```js
8
+ * ```TypeScript
9
9
  * import { create } from '@libp2p/hmac'
10
10
  *
11
11
  * const hash = 'SHA1' // 'SHA256' || 'SHA512'