quantumcoin 6.14.2 → 6.14.5

package/src.ts/crypto/scrypt.ts

@@ -1,114 +1,114 @@
-import { scrypt as _nobleSync, scryptAsync as _nobleAsync } from "@noble/hashes/scrypt";
-
-import { getBytes, hexlify as H } from "../utils/index.js";
-
-import type { BytesLike } from "../utils/index.js";
-
-/**
- *  A callback during long-running operations to update any
- *  UI or provide programatic access to the progress.
- *
- *  The %%percent%% is a value between ``0`` and ``1``.
- *
- *  @_docloc: api/crypto:Passwords
- */
-export type ProgressCallback = (percent: number) => void;
-
-
-let lockedSync = false, lockedAsync = false;
-
-const _scryptAsync = async function(passwd: Uint8Array, salt: Uint8Array, N: number, r: number, p: number, dkLen: number, onProgress?: ProgressCallback) {
-    return await _nobleAsync(passwd, salt, { N, r, p, dkLen, onProgress });
-}
-const _scryptSync = function(passwd: Uint8Array, salt: Uint8Array, N: number, r: number, p: number, dkLen: number) {
-    return _nobleSync(passwd, salt, { N, r, p, dkLen });
-}
-
-let __scryptAsync: (passwd: Uint8Array, salt: Uint8Array, N: number, r: number, p: number, dkLen: number, onProgress?: ProgressCallback) => Promise<BytesLike> = _scryptAsync;
-let __scryptSync: (passwd: Uint8Array, salt: Uint8Array, N: number, r: number, p: number, dkLen: number) => BytesLike = _scryptSync
-
-
-/**
- *  The [[link-wiki-scrypt]] uses a memory and cpu hard method of
- *  derivation to increase the resource cost to brute-force a password
- *  for a given key.
- *
- *  This means this algorithm is intentionally slow, and can be tuned to
- *  become slower. As computation and memory speed improve over time,
- *  increasing the difficulty maintains the cost of an attacker.
- *
- *  For example, if a target time of 5 seconds is used, a legitimate user
- *  which knows their password requires only 5 seconds to unlock their
- *  account. A 6 character password has 68 billion possibilities, which
- *  would require an attacker to invest over 10,000 years of CPU time. This
- *  is of course a crude example (as password generally aren't random),
- *  but demonstrates to value of imposing large costs to decryption.
- *
- *  For this reason, if building a UI which involved decrypting or
- *  encrypting datsa using scrypt, it is recommended to use a
- *  [[ProgressCallback]] (as event short periods can seem lik an eternity
- *  if the UI freezes). Including the phrase //"decrypting"// in the UI
- *  can also help, assuring the user their waiting is for a good reason.
- *
- *  @_docloc: api/crypto:Passwords
- *
- *  @example:
- *    // The password must be converted to bytes, and it is generally
- *    // best practices to ensure the string has been normalized. Many
- *    // formats explicitly indicate the normalization form to use.
- *    password = "hello"
- *    passwordBytes = toUtf8Bytes(password, "NFKC")
- *
- *    salt = id("some-salt")
- *
- *    // Compute the scrypt
- *    scrypt(passwordBytes, salt, 1024, 8, 1, 16)
- *    //_result:
- */
-export async function scrypt(_passwd: BytesLike, _salt: BytesLike, N: number, r: number, p: number, dkLen: number, progress?: ProgressCallback): Promise<string> {
-    const passwd = getBytes(_passwd, "passwd");
-    const salt = getBytes(_salt, "salt");
-    return H(await __scryptAsync(passwd, salt, N, r, p, dkLen, progress));
-}
-scrypt._ = _scryptAsync;
-scrypt.lock = function(): void { lockedAsync = true; }
-scrypt.register = function(func: (passwd: Uint8Array, salt: Uint8Array, N: number, r: number, p: number, dkLen: number, progress?: ProgressCallback) => Promise<BytesLike>) {
-    if (lockedAsync) { throw new Error("scrypt is locked"); }
-    __scryptAsync = func;
-}
-Object.freeze(scrypt);
-
-/**
- *  Provides a synchronous variant of [[scrypt]].
- *
- *  This will completely lock up and freeze the UI in a browser and will
- *  prevent any event loop from progressing. For this reason, it is
- *  preferred to use the [async variant](scrypt).
- *
- *  @_docloc: api/crypto:Passwords
- *
- *  @example:
- *    // The password must be converted to bytes, and it is generally
- *    // best practices to ensure the string has been normalized. Many
- *    // formats explicitly indicate the normalization form to use.
- *    password = "hello"
- *    passwordBytes = toUtf8Bytes(password, "NFKC")
- *
- *    salt = id("some-salt")
- *
- *    // Compute the scrypt
- *    scryptSync(passwordBytes, salt, 1024, 8, 1, 16)
- *    //_result:
- */
-export function scryptSync(_passwd: BytesLike, _salt: BytesLike, N: number, r: number, p: number, dkLen: number): string {
-    const passwd = getBytes(_passwd, "passwd");
-    const salt = getBytes(_salt, "salt");
-    return H(__scryptSync(passwd, salt, N, r, p, dkLen));
-}
-scryptSync._ = _scryptSync;
-scryptSync.lock = function(): void { lockedSync = true; }
-scryptSync.register = function(func: (passwd: Uint8Array, salt: Uint8Array, N: number, r: number, p: number, dkLen: number) => BytesLike) {
-    if (lockedSync) { throw new Error("scryptSync is locked"); }
-    __scryptSync = func;
-}
-Object.freeze(scryptSync);
+import { scrypt as _nobleSync, scryptAsync as _nobleAsync } from "@noble/hashes/scrypt";
+
+import { getBytes, hexlify as H } from "../utils/index.js";
+
+import type { BytesLike } from "../utils/index.js";
+
+/**
+ *  A callback during long-running operations to update any
+ *  UI or provide programatic access to the progress.
+ *
+ *  The %%percent%% is a value between ``0`` and ``1``.
+ *
+ *  @_docloc: api/crypto:Passwords
+ */
+export type ProgressCallback = (percent: number) => void;
+
+
+let lockedSync = false, lockedAsync = false;
+
+const _scryptAsync = async function(passwd: Uint8Array, salt: Uint8Array, N: number, r: number, p: number, dkLen: number, onProgress?: ProgressCallback) {
+    return await _nobleAsync(passwd, salt, { N, r, p, dkLen, onProgress });
+}
+const _scryptSync = function(passwd: Uint8Array, salt: Uint8Array, N: number, r: number, p: number, dkLen: number) {
+    return _nobleSync(passwd, salt, { N, r, p, dkLen });
+}
+
+let __scryptAsync: (passwd: Uint8Array, salt: Uint8Array, N: number, r: number, p: number, dkLen: number, onProgress?: ProgressCallback) => Promise<BytesLike> = _scryptAsync;
+let __scryptSync: (passwd: Uint8Array, salt: Uint8Array, N: number, r: number, p: number, dkLen: number) => BytesLike = _scryptSync
+
+
+/**
+ *  The [[link-wiki-scrypt]] uses a memory and cpu hard method of
+ *  derivation to increase the resource cost to brute-force a password
+ *  for a given key.
+ *
+ *  This means this algorithm is intentionally slow, and can be tuned to
+ *  become slower. As computation and memory speed improve over time,
+ *  increasing the difficulty maintains the cost of an attacker.
+ *
+ *  For example, if a target time of 5 seconds is used, a legitimate user
+ *  which knows their password requires only 5 seconds to unlock their
+ *  account. A 6 character password has 68 billion possibilities, which
+ *  would require an attacker to invest over 10,000 years of CPU time. This
+ *  is of course a crude example (as password generally aren't random),
+ *  but demonstrates to value of imposing large costs to decryption.
+ *
+ *  For this reason, if building a UI which involved decrypting or
+ *  encrypting datsa using scrypt, it is recommended to use a
+ *  [[ProgressCallback]] (as event short periods can seem lik an eternity
+ *  if the UI freezes). Including the phrase //"decrypting"// in the UI
+ *  can also help, assuring the user their waiting is for a good reason.
+ *
+ *  @_docloc: api/crypto:Passwords
+ *
+ *  @example:
+ *    // The password must be converted to bytes, and it is generally
+ *    // best practices to ensure the string has been normalized. Many
+ *    // formats explicitly indicate the normalization form to use.
+ *    password = "hello"
+ *    passwordBytes = toUtf8Bytes(password, "NFKC")
+ *
+ *    salt = id("some-salt")
+ *
+ *    // Compute the scrypt
+ *    scrypt(passwordBytes, salt, 1024, 8, 1, 16)
+ *    //_result:
+ */
+export async function scrypt(_passwd: BytesLike, _salt: BytesLike, N: number, r: number, p: number, dkLen: number, progress?: ProgressCallback): Promise<string> {
+    const passwd = getBytes(_passwd, "passwd");
+    const salt = getBytes(_salt, "salt");
+    return H(await __scryptAsync(passwd, salt, N, r, p, dkLen, progress));
+}
+scrypt._ = _scryptAsync;
+scrypt.lock = function(): void { lockedAsync = true; }
+scrypt.register = function(func: (passwd: Uint8Array, salt: Uint8Array, N: number, r: number, p: number, dkLen: number, progress?: ProgressCallback) => Promise<BytesLike>) {
+    if (lockedAsync) { throw new Error("scrypt is locked"); }
+    __scryptAsync = func;
+}
+Object.freeze(scrypt);
+
+/**
+ *  Provides a synchronous variant of [[scrypt]].
+ *
+ *  This will completely lock up and freeze the UI in a browser and will
+ *  prevent any event loop from progressing. For this reason, it is
+ *  preferred to use the [async variant](scrypt).
+ *
+ *  @_docloc: api/crypto:Passwords
+ *
+ *  @example:
+ *    // The password must be converted to bytes, and it is generally
+ *    // best practices to ensure the string has been normalized. Many
+ *    // formats explicitly indicate the normalization form to use.
+ *    password = "hello"
+ *    passwordBytes = toUtf8Bytes(password, "NFKC")
+ *
+ *    salt = id("some-salt")
+ *
+ *    // Compute the scrypt
+ *    scryptSync(passwordBytes, salt, 1024, 8, 1, 16)
+ *    //_result:
+ */
+export function scryptSync(_passwd: BytesLike, _salt: BytesLike, N: number, r: number, p: number, dkLen: number): string {
+    const passwd = getBytes(_passwd, "passwd");
+    const salt = getBytes(_salt, "salt");
+    return H(__scryptSync(passwd, salt, N, r, p, dkLen));
+}
+scryptSync._ = _scryptSync;
+scryptSync.lock = function(): void { lockedSync = true; }
+scryptSync.register = function(func: (passwd: Uint8Array, salt: Uint8Array, N: number, r: number, p: number, dkLen: number) => BytesLike) {
+    if (lockedSync) { throw new Error("scryptSync is locked"); }
+    __scryptSync = func;
+}
+Object.freeze(scryptSync);

package/src.ts/crypto/sha2.ts

@@ -1,78 +1,78 @@
-import { createHash } from "./crypto.js";
-
-import { getBytes, hexlify } from "../utils/index.js";
-
-import type { BytesLike } from "../utils/index.js";
-
-
-const _sha256 = function(data: Uint8Array): Uint8Array {
-    return createHash("sha256").update(data).digest();
-}
-
-const _sha512 = function(data: Uint8Array): Uint8Array {
-    return createHash("sha512").update(data).digest();
-}
-
-let __sha256: (data: Uint8Array) => BytesLike = _sha256;
-let __sha512: (data: Uint8Array) => BytesLike = _sha512;
-
-let locked256 = false, locked512 = false;
-
-
-/**
- *  Compute the cryptographic SHA2-256 hash of %%data%%.
- *
- *  @_docloc: api/crypto:Hash Functions
- *  @returns DataHexstring
- *
- *  @example:
- *    sha256("0x")
- *    //_result:
- *
- *    sha256("0x1337")
- *    //_result:
- *
- *    sha256(new Uint8Array([ 0x13, 0x37 ]))
- *    //_result:
- *
- */
-export function sha256(_data: BytesLike): string {
-    const data = getBytes(_data, "data");
-    return hexlify(__sha256(data));
-}
-sha256._ = _sha256;
-sha256.lock = function(): void { locked256 = true; }
-sha256.register = function(func: (data: Uint8Array) => BytesLike): void {
-    if (locked256) { throw new Error("sha256 is locked"); }
-    __sha256 = func;
-}
-Object.freeze(sha256);
-
-
-/**
- *  Compute the cryptographic SHA2-512 hash of %%data%%.
- *
- *  @_docloc: api/crypto:Hash Functions
- *  @returns DataHexstring
- *
- *  @example:
- *    sha512("0x")
- *    //_result:
- *
- *    sha512("0x1337")
- *    //_result:
- *
- *    sha512(new Uint8Array([ 0x13, 0x37 ]))
- *    //_result:
- */
-export function sha512(_data: BytesLike): string {
-    const data = getBytes(_data, "data");
-    return hexlify(__sha512(data));
-}
-sha512._ = _sha512;
-sha512.lock = function(): void { locked512 = true; }
-sha512.register = function(func: (data: Uint8Array) => BytesLike): void {
-    if (locked512) { throw new Error("sha512 is locked"); }
-    __sha512 = func;
-}
-Object.freeze(sha256);
+import { createHash } from "./crypto.js";
+
+import { getBytes, hexlify } from "../utils/index.js";
+
+import type { BytesLike } from "../utils/index.js";
+
+
+const _sha256 = function(data: Uint8Array): Uint8Array {
+    return createHash("sha256").update(data).digest();
+}
+
+const _sha512 = function(data: Uint8Array): Uint8Array {
+    return createHash("sha512").update(data).digest();
+}
+
+let __sha256: (data: Uint8Array) => BytesLike = _sha256;
+let __sha512: (data: Uint8Array) => BytesLike = _sha512;
+
+let locked256 = false, locked512 = false;
+
+
+/**
+ *  Compute the cryptographic SHA2-256 hash of %%data%%.
+ *
+ *  @_docloc: api/crypto:Hash Functions
+ *  @returns DataHexstring
+ *
+ *  @example:
+ *    sha256("0x")
+ *    //_result:
+ *
+ *    sha256("0x1337")
+ *    //_result:
+ *
+ *    sha256(new Uint8Array([ 0x13, 0x37 ]))
+ *    //_result:
+ *
+ */
+export function sha256(_data: BytesLike): string {
+    const data = getBytes(_data, "data");
+    return hexlify(__sha256(data));
+}
+sha256._ = _sha256;
+sha256.lock = function(): void { locked256 = true; }
+sha256.register = function(func: (data: Uint8Array) => BytesLike): void {
+    if (locked256) { throw new Error("sha256 is locked"); }
+    __sha256 = func;
+}
+Object.freeze(sha256);
+
+
+/**
+ *  Compute the cryptographic SHA2-512 hash of %%data%%.
+ *
+ *  @_docloc: api/crypto:Hash Functions
+ *  @returns DataHexstring
+ *
+ *  @example:
+ *    sha512("0x")
+ *    //_result:
+ *
+ *    sha512("0x1337")
+ *    //_result:
+ *
+ *    sha512(new Uint8Array([ 0x13, 0x37 ]))
+ *    //_result:
+ */
+export function sha512(_data: BytesLike): string {
+    const data = getBytes(_data, "data");
+    return hexlify(__sha512(data));
+}
+sha512._ = _sha512;
+sha512.lock = function(): void { locked512 = true; }
+sha512.register = function(func: (data: Uint8Array) => BytesLike): void {
+    if (locked512) { throw new Error("sha512 is locked"); }
+    __sha512 = func;
+}
+Object.freeze(sha256);