\n
\n\n**Returns**\n\nType: `boolean`\n\n`true` if the provided HMAC matches the generated one. `false` otherwise.\n\n---\n\n##### Example Usage\n\n###### Generating an HMAC\n\n```ts\nimport { Hmac } from '@alessiofrittoli/crypto-key'\n// or\nimport { Hmac } from '@alessiofrittoli/crypto-key/Hmac'\n\nconsole.log(\n Hmac.digest( 'raw string value', 'mysecretkey', 'SHA-256', 'hex' )\n) // Outputs the HMAC value in HEX format.\n```\n\n###### Validating an HMAC\n\n```ts\nimport { Hmac } from '@alessiofrittoli/crypto-key'\n// or\nimport { Hmac } from '@alessiofrittoli/crypto-key/Hmac'\n\nconst message\t= 'raw string value'\nconst secret\t= 'mysecretkey'\nconst hmac\t\t= Hmac.digest( message, secret )\n\nconsole.log(\n Hmac.isValid( hmac, message, secret )\n) // Outputs: `true`\n```\n\n---\n\n#### `Scrypt` Class\n\nThe `Scrypt` class provides methods for hashing and securely comparing keys using the `scrypt` key derivation algorithm.\\\nIt supports customizable options for computational cost, memory usage, and parallelization to balance security and performance.\n\n##### Scrypt Type Interfaces\n\n###### `ScryptOptions`\n\nDefines customization options for the `scrypt` algorithm.\n\nParameters
\n\n| Parameter | Type | Default | Description |\n|-------------|---------------------|-----------|-------------------------------------------------|\n| `digest` | `CoerceToUint8ArrayInput` | - | The HMAC digest to validate. |\n| `message` | `crypto.BinaryLike` | - | The original message used to generate the HMAC. |\n| `secret` | `crypto.BinaryLike \\| crypto.KeyObject` | - | The secret key used for generating the HMAC. |\n| `algorithm` | `Algo.Hash` | 'SHA-256' | (Optional) The hash algorithm used for generating the HMAC. |\n| `encoding` | `BufferEncoding` | - | (Optional) The encoding used to generate the hash output. |\n| `options` | `stream.TransformOptions` | - | (Optional) Additional stream transform options used for generating the HMAC. |\n\n\n
\n\nProperties
\n\n| Property | Type | Default | Description |\n|-------------------|----------|-----------|-------------|\n| `cost` | `number` | `16384` | Computational cost factor. Must be a power of 2. Higher values increase security but are slower. |\n| `blockSize` | `number` | `8` | Memory cost factor. Higher values increase memory usage, improving security against GPU attacks. |\n| `parallelization` | `number` | `1` | Parallelization factor. Determines how many threads can be used. |\n| `maxmem` | `number` | `32 * 1024 * 1024` (32MB) | Maximum memory (in bytes) to be used during key derivation. |\n| `N` | `number` | `16384` | Alias for `cost`. |\n| `r` | `number` | `8` | Alias for `blockSize`. |\n| `p` | `number` | `1` | Alias for `parallelization`. |\n\n\n
\n\n---\n\n###### `ScryptHashOptions`\n\nDefines options for the `hash` and `isValid` methods.\n\nSuggested options
\n\n| Scope | `cost` (N) | `blockSize` (r) | `parallelization` (p) | `maxmem` |\n|-----------------------------|------------|-----------------|-----------------------|----------|\n| Standard security (default) | `16384` | `8` | `1` | 32 MB |\n| High security | `65536` | `16` | `1` | 64 MB |\n| Limited resources | `8192` | `4` | `1` | 16 MB |\n\n\n
\n\n---\n\n##### Methods\n\n###### `Scrypt.hash()`\n\nGenerates a hash for a given key using the `scrypt` key derivation algorithm.\n\nProperties
\n\n| Property | Type | Default | Description |\n|--------------|-----------------|-----------|-------------|\n| `length` | `number` | `64` | The hash length. Must be between `16` and `256`. |\n| `saltLength` | `number` | `32` | The salt length. Must be between `16` and `64`. |\n| `options` | `ScryptOptions` | See above | Custom options for the `scrypt` algorithm. |\n\n\n
\n\n**Returns**\n\nType: `Buffer`\n\nA Buffer containing the salt (first saltLength bytes) followed by the derived hash.\n\n---\n\n###### `Scrypt.isValid()`\n\nValidates the given `key` with the given `hash`.\n\nParameters
\n\n| Parameter | Type | Default | Description |\n|-----------|---------------------|---------|-------------|\n| `key` | `crypto.BinaryLike` | - | The key to hash. |\n| `options` | `ScryptHashOptions` | - | (Optional) Configuration options for hashing. |\n\n\n
\n\n**Returns**\n\nType: `boolean`\n\n`true` if the key is valid, `false` otherwise.\n\n---\n\n##### Example Usage\n\n###### Hashing a Key\n\n```ts\nimport { Scrypt } from '@alessiofrittoli/crypto-key'\n// or\nimport { Scrypt } from '@alessiofrittoli/crypto-key/Scrypt'\n\nconsole.log(\n Scrypt.hash( 'user-provided-password' )\n .toString( 'hex' )\n) // Outputs the hash in HEX format.\n```\n\n###### Validating a Key\n\n```ts\nimport { Scrypt } from '@alessiofrittoli/crypto-key'\n// or\nimport { Scrypt } from '@alessiofrittoli/crypto-key/Scrypt'\n\nimport { Scrypt } from './Scrypt';\n\nconst password\t= 'user-provided-password';\nconst hash\t\t= Scrypt.hash( password, { length: 32, saltLength: 16 } )\n\nconsole.log(\n Scrypt.isValid( password, hash, { length: 32, saltLength: 16 } )\n) // Outputs: true\n```\n\n---\n\n### Development\n\n#### Install depenendencies\n\n```bash\nnpm install\n```\n\nor using `pnpm`\n\n```bash\npnpm i\n```\n\n#### Build the source code\n\nRun the following command to test and build code for distribution.\n\n```bash\npnpm build\n```\n\n#### [ESLint](https://www.npmjs.com/package/eslint)\n\nwarnings / errors check.\n\n```bash\npnpm lint\n```\n\n#### [Jest](https://npmjs.com/package/jest)\n\nRun all the defined test suites by running the following:\n\n```bash\n# Run tests and watch file changes.\npnpm test:watch\n\n# Run tests in a CI environment.\npnpm test:ci\n```\n\n- See [`package.json`](./package.json) file scripts for more info.\n\nRun tests with coverage.\n\nAn HTTP server is then started to serve coverage files from `./coverage` folder.\n\nā ļø You may see a blank page the first time you run this command. Simply refresh the browser to see the updates.\n\n```bash\ntest:coverage:serve\n```\n\n---\n\n### Contributing\n\nContributions are truly welcome!\n\nPlease refer to the [Contributing Doc](./CONTRIBUTING.md) for more information on how to start contributing to this project.\n\nHelp keep this project up to date with [GitHub Sponsor][sponsor-url].\n\n[![GitHub Sponsor][sponsor-badge]][sponsor-url]\n\n---\n\n### Security\n\nIf you believe you have found a security vulnerability, we encourage you to **_responsibly disclose this and NOT open a public issue_**. We will investigate all legitimate reports. Email `security@alessiofrittoli.it` to disclose any security vulnerabilities.\n\n### Made with ā\n\nParameters
\n\n| Parameter | Type | Default | Description |\n|-----------|---------------------|---------|-------------|\n| `key` | `crypto.BinaryLike` | - | The key to validate. |\n| `hash` | `CoerceToUint8ArrayInput` | - | The hash to compare against. |\n| `options` | `ScryptHashOptions` | - | (Optional) Configuration options. Must match those used for hashing. |\n\n\n  \n | \n \n
| \n