dilithium-crystals-js 1.0.0 → 1.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.
- package/README.md +7 -7
- package/dilithium.js +1 -1
- package/dilithium.wasm +0 -0
- package/dist/dilithium.min.js +1 -1
- package/package.json +5 -1
- package/src/common.js +0 -2
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
#
|
|
1
|
+
# dilithium-crystals-js
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
dilithium-crystals-js is a JavaScript implementation of the Dilithium post-quantum cryptographic signature scheme. This package provides a unified API for both Node.js and browser environments, offering robust quantum-resistant digital signatures.
|
|
4
4
|
|
|
5
5
|
## Features
|
|
6
6
|
|
|
@@ -14,7 +14,7 @@ Dilithium-JS is a JavaScript implementation of the Dilithium post-quantum crypto
|
|
|
14
14
|
You can install the package using npm:
|
|
15
15
|
|
|
16
16
|
```bash
|
|
17
|
-
npm install dilithium-js
|
|
17
|
+
npm install dilithium-crystals-js
|
|
18
18
|
```
|
|
19
19
|
|
|
20
20
|
## Usage
|
|
@@ -24,7 +24,7 @@ npm install dilithium-js
|
|
|
24
24
|
In a Node.js environment, you can use the package as follows:
|
|
25
25
|
|
|
26
26
|
```javascript
|
|
27
|
-
const Dilithium = require("dilithium-js");
|
|
27
|
+
const Dilithium = require("dilithium-crystals-js");
|
|
28
28
|
|
|
29
29
|
Dilithium.then((dilithium) => {
|
|
30
30
|
// Generate keys
|
|
@@ -115,7 +115,7 @@ Verifies a signature.
|
|
|
115
115
|
|
|
116
116
|
## Dilithium Parameter Sets
|
|
117
117
|
|
|
118
|
-
|
|
118
|
+
dilithium-crystals-js supports all four parameter sets of the Dilithium signature scheme:
|
|
119
119
|
|
|
120
120
|
- **0**: Dilithium2 (NIST security level 2)
|
|
121
121
|
- **1**: Dilithium3 (NIST security level 3)
|
|
@@ -126,7 +126,7 @@ Choose the appropriate parameter set based on your security requirements.
|
|
|
126
126
|
|
|
127
127
|
## Contributing
|
|
128
128
|
|
|
129
|
-
Contributions to
|
|
129
|
+
Contributions to dilithium-crystals-js are welcome! Please follow these steps:
|
|
130
130
|
|
|
131
131
|
1. Fork the repository
|
|
132
132
|
2. Create a new branch for your feature or bug fix
|
|
@@ -135,6 +135,6 @@ Contributions to Dilithium-JS are welcome! Please follow these steps:
|
|
|
135
135
|
|
|
136
136
|
Please ensure your code adheres to the existing style and includes appropriate test coverage.
|
|
137
137
|
|
|
138
|
-
If you encounter any issues or have questions about
|
|
138
|
+
If you encounter any issues or have questions about dilithium-crystals-js, please file an issue on the GitHub repository.
|
|
139
139
|
|
|
140
140
|
## Acknowledgments
|