docs: [argon2]improve documentation and update TS definition files

packages/argon2/README.md

@@ -3,7 +3,29 @@
 ![](https://github.com/napi-rs/node-rs/workflows/CI/badge.svg)
 ![](https://img.shields.io/npm/dm/@node-rs/argon2.svg?sanitize=true)
 
-[argon2](https://crates.io/crates/argon2) binding for Node.js.
+[RustCrypto: Argon2](https://crates.io/crates/argon2) binding for Node.js.
+
+Argon2 is a [key derivation function](https://en.wikipedia.org/wiki/Key_derivation_function) that was selected as the winner of the [Password Hashing Competition(PHC)](https://password-hashing.net) in July 2015.
+
+Argon2 summarizes the state of the art in the design of memory-hard functions and can be used to hash passwords for credential storage, key derivation, or other applications.
+
+It has a simple design aimed at the highest memory filling rate and effective use of multiple computing units, while still providing defense against tradeoff attacks (by exploiting the cache and memory organization of the recent processors).
+
+## Features
+
+- Faster performance.
+- No node-gyp and postinstall.
+- Cross-platform support, including [Apple M1](https://www.apple.com/newsroom/2020/11/apple-unleashes-m1/).
+- Smaller file size after npm installation(476K vs [node-argon2](https://github.com/ranisalt/node-argon2) 3.7M).
+- `@node-rs/argon2` supports all three algorithms:
+
+  - Argon2i: Optimizes against GPU cracking attacks but vulnerable to side-channels.
+    Accesses the memory array in a password dependent order, reducing the possibility of time–memory tradeoff (TMTO) attacks.
+  - Argon2d: Optimized to resist side-channel attacks.
+    Accesses the memory array in a password independent order, increasing the possibility of time-memory tradeoff (TMTO) attacks.
+  - **Argon2id**: default value, this is the default algorithm for normative recommendations.
+    Hybrid that mixes Argon2i and Argon2d passes.
+    Uses the Argon2i approach for the first half pass over memory and Argon2d approach for subsequent passes. This effectively places it in the “middle” between the other two: it doesn’t provide as good TMTO/GPU cracking resistance as Argon2d, nor as good of side-channel resistance as Argon2i, but overall provides the most well-rounded approach to both classes of attacks.
 
 ## Support matrix
 
@@ -23,6 +45,10 @@
 | Android armv7       | ✓      | ✓      | ✓      | ✓      |
 | FreeBSD x64         | ✓      | ✓      | ✓      | ✓      |
 
+# Benchmarks
+
+See [benchmark/](benchmark/argon2.js).
+
 ## API
 
 ```typescript
@@ -32,25 +58,44 @@ export const enum Algorithm {
   Argon2id = 2,
 }
 export const enum Version {
+  /** Version 16 (0x10 in hex) */
   V0x10 = 0,
+  /**
+   * Default value
+   * Version 19 (0x13 in hex, default)
+   */
   V0x13 = 1,
 }
 export interface Options {
   /**
-   * Memory size, expressed in kilobytes, between 1 and (2^32)-1.
-   * Value is an integer in decimal (1 to 10 digits).
+   * The amount of memory to be used by the hash function, in kilobytes. Each thread will have a memory pool of this size. Note that large values for highly concurrent usage will cause starvation and thrashing if your system memory gets full.
+   *
+   * Value is an integer in decimal (1 to 10 digits), between 1 and (2^32)-1.
+   *
+   * The default value is 4096, meaning a pool of 4 MiB per thread.
    */
   memoryCost?: number | undefined | null
   /**
-   * Number of iterations, between 1 and (2^32)-1.
-   * Value is an integer in decimal (1 to 10 digits).
+   * The time cost is the amount of passes (iterations) used by the hash function. It increases hash strength at the cost of time required to compute.
+   *
+   * Value is an integer in decimal (1 to 10 digits), between 1 and (2^32)-1.
+   *
+   * The default value is 3.
    */
   timeCost?: number | undefined | null
   /**
-   * Degree of parallelism, between 1 and 255.
-   * Value is an integer in decimal (1 to 3 digits).
+   * The hash length is the length of the hash function output in bytes. Note that the resulting hash is encoded with Base 64, so the digest will be ~1/3 longer.
+   *
+   * The default value is 32, which produces raw hashes of 32 bytes or digests of 43 characters.
    */
   outputLen?: number | undefined | null
+  /**
+   * The amount of threads to compute the hash on. Each thread has a memory pool with memoryCost size. Note that changing it also changes the resulting hash.
+   *
+   * Value is an integer in decimal (1 to 3 digits), between 1 and 255.
+   *
+   * The default value is 1, meaning a single thread is used.
+   */
   parallelism?: number | undefined | null
   algorithm?: Algorithm | undefined | null
   version?: Version | undefined | null

packages/argon2/index.d.ts

@@ -10,30 +10,62 @@ export class ExternalObject<T> {
   }
 }
 export const enum Algorithm {
+  /**
+   * Optimizes against GPU cracking attacks but vulnerable to side-channels.
+   * Accesses the memory array in a password dependent order, reducing the possibility of time–memory tradeoff (TMTO) attacks.
+   */
   Argon2d = 0,
+  /**
+   * Optimized to resist side-channel attacks.
+   * Accesses the memory array in a password independent order, increasing the possibility of time-memory tradeoff (TMTO) attacks.
+   */
   Argon2i = 1,
+  /**
+   * Default value, this is the default algorithm for normative recommendations.
+   * Hybrid that mixes Argon2i and Argon2d passes.
+   * Uses the Argon2i approach for the first half pass over memory and Argon2d approach for subsequent passes. This effectively places it in the “middle” between the other two: it doesn’t provide as good TMTO/GPU cracking resistance as Argon2d, nor as good of side-channel resistance as Argon2i, but overall provides the most well-rounded approach to both classes of attacks.
+   */
   Argon2id = 2,
 }
 export const enum Version {
+  /** Version 16 (0x10 in hex) */
   V0x10 = 0,
+  /**
+   * Default value
+   * Version 19 (0x13 in hex, default)
+   */
   V0x13 = 1,
 }
 export interface Options {
   /**
-   * Memory size, expressed in kilobytes, between 1 and (2^32)-1.
-   * Value is an integer in decimal (1 to 10 digits).
+   * The amount of memory to be used by the hash function, in kilobytes. Each thread will have a memory pool of this size. Note that large values for highly concurrent usage will cause starvation and thrashing if your system memory gets full.
+   *
+   * Value is an integer in decimal (1 to 10 digits), between 1 and (2^32)-1.
+   *
+   * The default value is 4096, meaning a pool of 4 MiB per thread.
    */
   memoryCost?: number | undefined | null
   /**
-   * Number of iterations, between 1 and (2^32)-1.
-   * Value is an integer in decimal (1 to 10 digits).
+   * The time cost is the amount of passes (iterations) used by the hash function. It increases hash strength at the cost of time required to compute.
+   *
+   * Value is an integer in decimal (1 to 10 digits), between 1 and (2^32)-1.
+   *
+   * The default value is 3.
    */
   timeCost?: number | undefined | null
   /**
-   * Degree of parallelism, between 1 and 255.
-   * Value is an integer in decimal (1 to 3 digits).
+   * The hash length is the length of the hash function output in bytes. Note that the resulting hash is encoded with Base 64, so the digest will be ~1/3 longer.
+   *
+   * The default value is 32, which produces raw hashes of 32 bytes or digests of 43 characters.
    */
   outputLen?: number | undefined | null
+  /**
+   * The amount of threads to compute the hash on. Each thread has a memory pool with memoryCost size. Note that changing it also changes the resulting hash.
+   *
+   * Value is an integer in decimal (1 to 3 digits), between 1 and 255.
+   *
+   * The default value is 1, meaning a single thread is used.
+   */
   parallelism?: number | undefined | null
   algorithm?: Algorithm | undefined | null
   version?: Version | undefined | null

packages/argon2/npm/android-arm-eabi/package.json

@@ -11,6 +11,18 @@
   "files": [
     "argon2.android-arm-eabi.node"
   ],
+  "description": "RustCrypto: Argon2 binding for Node.js",
+  "keywords": [
+    "argon2",
+    "argon2-password",
+    "crypto",
+    "password",
+    "encryption",
+    "hashing",
+    "hash",
+    "secure",
+    "verify"
+  ],
   "license": "MIT",
   "engines": {
     "node": ">= 10"

packages/argon2/npm/android-arm64/package.json

@@ -11,6 +11,18 @@
   "files": [
     "argon2.android-arm64.node"
   ],
+  "description": "RustCrypto: Argon2 binding for Node.js",
+  "keywords": [
+    "argon2",
+    "argon2-password",
+    "crypto",
+    "password",
+    "encryption",
+    "hashing",
+    "hash",
+    "secure",
+    "verify"
+  ],
   "license": "MIT",
   "engines": {
     "node": ">= 10"

packages/argon2/npm/darwin-arm64/package.json

@@ -11,6 +11,18 @@
   "files": [
     "argon2.darwin-arm64.node"
   ],
+  "description": "RustCrypto: Argon2 binding for Node.js",
+  "keywords": [
+    "argon2",
+    "argon2-password",
+    "crypto",
+    "password",
+    "encryption",
+    "hashing",
+    "hash",
+    "secure",
+    "verify"
+  ],
   "license": "MIT",
   "engines": {
     "node": ">= 10"

packages/argon2/npm/darwin-x64/package.json

@@ -11,6 +11,18 @@
   "files": [
     "argon2.darwin-x64.node"
   ],
+  "description": "RustCrypto: Argon2 binding for Node.js",
+  "keywords": [
+    "argon2",
+    "argon2-password",
+    "crypto",
+    "password",
+    "encryption",
+    "hashing",
+    "hash",
+    "secure",
+    "verify"
+  ],
   "license": "MIT",
   "engines": {
     "node": ">= 10"

packages/argon2/npm/freebsd-x64/package.json

@@ -11,6 +11,18 @@
   "files": [
     "argon2.freebsd-x64.node"
   ],
+  "description": "RustCrypto: Argon2 binding for Node.js",
+  "keywords": [
+    "argon2",
+    "argon2-password",
+    "crypto",
+    "password",
+    "encryption",
+    "hashing",
+    "hash",
+    "secure",
+    "verify"
+  ],
   "license": "MIT",
   "engines": {
     "node": ">= 10"

packages/argon2/npm/linux-arm-gnueabihf/package.json

@@ -11,6 +11,18 @@
   "files": [
     "argon2.linux-arm-gnueabihf.node"
   ],
+  "description": "RustCrypto: Argon2 binding for Node.js",
+  "keywords": [
+    "argon2",
+    "argon2-password",
+    "crypto",
+    "password",
+    "encryption",
+    "hashing",
+    "hash",
+    "secure",
+    "verify"
+  ],
   "license": "MIT",
   "engines": {
     "node": ">= 10"

packages/argon2/npm/linux-arm64-gnu/package.json

@@ -11,6 +11,18 @@
   "files": [
     "argon2.linux-arm64-gnu.node"
   ],
+  "description": "RustCrypto: Argon2 binding for Node.js",
+  "keywords": [
+    "argon2",
+    "argon2-password",
+    "crypto",
+    "password",
+    "encryption",
+    "hashing",
+    "hash",
+    "secure",
+    "verify"
+  ],
   "license": "MIT",
   "engines": {
     "node": ">= 10"

packages/argon2/npm/linux-arm64-musl/package.json

@@ -11,6 +11,18 @@
   "files": [
     "argon2.linux-arm64-musl.node"
   ],
+  "description": "RustCrypto: Argon2 binding for Node.js",
+  "keywords": [
+    "argon2",
+    "argon2-password",
+    "crypto",
+    "password",
+    "encryption",
+    "hashing",
+    "hash",
+    "secure",
+    "verify"
+  ],
   "license": "MIT",
   "engines": {
     "node": ">= 10"

packages/argon2/npm/linux-x64-gnu/package.json

@@ -11,6 +11,18 @@
   "files": [
     "argon2.linux-x64-gnu.node"
   ],
+  "description": "RustCrypto: Argon2 binding for Node.js",
+  "keywords": [
+    "argon2",
+    "argon2-password",
+    "crypto",
+    "password",
+    "encryption",
+    "hashing",
+    "hash",
+    "secure",
+    "verify"
+  ],
   "license": "MIT",
   "engines": {
     "node": ">= 10"

packages/argon2/npm/linux-x64-musl/package.json

@@ -11,6 +11,18 @@
   "files": [
     "argon2.linux-x64-musl.node"
   ],
+  "description": "RustCrypto: Argon2 binding for Node.js",
+  "keywords": [
+    "argon2",
+    "argon2-password",
+    "crypto",
+    "password",
+    "encryption",
+    "hashing",
+    "hash",
+    "secure",
+    "verify"
+  ],
   "license": "MIT",
   "engines": {
     "node": ">= 10"

packages/argon2/npm/win32-arm64-msvc/package.json

@@ -11,6 +11,18 @@
   "files": [
     "argon2.win32-arm64-msvc.node"
   ],
+  "description": "RustCrypto: Argon2 binding for Node.js",
+  "keywords": [
+    "argon2",
+    "argon2-password",
+    "crypto",
+    "password",
+    "encryption",
+    "hashing",
+    "hash",
+    "secure",
+    "verify"
+  ],
   "license": "MIT",
   "engines": {
     "node": ">= 10"

packages/argon2/npm/win32-ia32-msvc/package.json

@@ -11,6 +11,18 @@
   "files": [
     "argon2.win32-ia32-msvc.node"
   ],
+  "description": "RustCrypto: Argon2 binding for Node.js",
+  "keywords": [
+    "argon2",
+    "argon2-password",
+    "crypto",
+    "password",
+    "encryption",
+    "hashing",
+    "hash",
+    "secure",
+    "verify"
+  ],
   "license": "MIT",
   "engines": {
     "node": ">= 10"