@twin.org/crypto 0.0.3-next.3 → 0.0.3-next.31

package/docs/reference/classes/HmacSha1.md

@@ -24,7 +24,7 @@ The key for the hmac.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -32,7 +32,7 @@ Runtime name for the class.
 
 ## Methods
 
-### sum()
+### sum() {#sum}
 
 > `static` **sum**(`key`, `block`): `Uint8Array`
 
@@ -60,7 +60,7 @@ The sum of the block.
 
 ***
 
-### update()
+### update() {#update}
 
 > **update**(`block`): `HmacSha1`
 
@@ -82,7 +82,7 @@ The instance for chaining.
 
 ***
 
-### digest()
+### digest() {#digest}
 
 > **digest**(): `Uint8Array`
 

package/docs/reference/classes/HmacSha256.md

@@ -6,7 +6,7 @@ Class to help with HmacSha256 scheme.
 
 ### Constructor
 
-> **new HmacSha256**(`key`, `bits`): `HmacSha256`
+> **new HmacSha256**(`key`, `bits?`): `HmacSha256`
 
 Create a new instance of HmacSha256.
 
@@ -18,7 +18,7 @@ Create a new instance of HmacSha256.
 
 The key for the hmac.
 
-##### bits
+##### bits?
 
 `number` = `HmacSha256.SIZE_256`
 
@@ -30,7 +30,7 @@ The number of bits.
 
 ## Properties
 
-### SIZE\_256
+### SIZE\_256 {#size_256}
 
 > `readonly` `static` **SIZE\_256**: `number` = `256`
 
@@ -38,7 +38,7 @@ Sha256 256.
 
 ***
 
-### SIZE\_224
+### SIZE\_224 {#size_224}
 
 > `readonly` `static` **SIZE\_224**: `number` = `224`
 
@@ -46,7 +46,7 @@ Sha256 224.
 
 ***
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -54,7 +54,7 @@ Runtime name for the class.
 
 ## Methods
 
-### sum224()
+### sum224() {#sum224}
 
 > `static` **sum224**(`key`, `block`): `Uint8Array`
 
@@ -82,7 +82,7 @@ The sum 224 of the block.
 
 ***
 
-### sum256()
+### sum256() {#sum256}
 
 > `static` **sum256**(`key`, `block`): `Uint8Array`
 
@@ -110,7 +110,7 @@ The sum 256 of the block.
 
 ***
 
-### update()
+### update() {#update}
 
 > **update**(`block`): `HmacSha256`
 
@@ -132,7 +132,7 @@ The instance for chaining.
 
 ***
 
-### digest()
+### digest() {#digest}
 
 > **digest**(): `Uint8Array`
 

package/docs/reference/classes/HmacSha512.md

@@ -6,7 +6,7 @@ Class to help with HmacSha512 scheme.
 
 ### Constructor
 
-> **new HmacSha512**(`key`, `bits`): `HmacSha512`
+> **new HmacSha512**(`key`, `bits?`): `HmacSha512`
 
 Create a new instance of HmacSha512.
 
@@ -18,7 +18,7 @@ Create a new instance of HmacSha512.
 
 The key for the hmac.
 
-##### bits
+##### bits?
 
 `number` = `HmacSha512.SIZE_512`
 
@@ -30,7 +30,7 @@ The number of bits.
 
 ## Properties
 
-### SIZE\_224
+### SIZE\_224 {#size_224}
 
 > `static` **SIZE\_224**: `number` = `224`
 
@@ -38,7 +38,7 @@ Sha512 224.
 
 ***
 
-### SIZE\_256
+### SIZE\_256 {#size_256}
 
 > `static` **SIZE\_256**: `number` = `256`
 
@@ -46,7 +46,7 @@ Sha512 256.
 
 ***
 
-### SIZE\_384
+### SIZE\_384 {#size_384}
 
 > `static` **SIZE\_384**: `number` = `384`
 
@@ -54,7 +54,7 @@ Sha512 384.
 
 ***
 
-### SIZE\_512
+### SIZE\_512 {#size_512}
 
 > `static` **SIZE\_512**: `number` = `512`
 
@@ -62,7 +62,7 @@ Sha512 512.
 
 ***
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -70,7 +70,7 @@ Runtime name for the class.
 
 ## Methods
 
-### sum512()
+### sum512() {#sum512}
 
 > `static` **sum512**(`key`, `block`): `Uint8Array`
 
@@ -98,7 +98,7 @@ The sum 512 of the block.
 
 ***
 
-### sum384()
+### sum384() {#sum384}
 
 > `static` **sum384**(`key`, `block`): `Uint8Array`
 
@@ -126,7 +126,7 @@ The sum 384 of the block.
 
 ***
 
-### sum256()
+### sum256() {#sum256}
 
 > `static` **sum256**(`key`, `block`): `Uint8Array`
 
@@ -154,7 +154,7 @@ The sum 256 of the block.
 
 ***
 
-### sum224()
+### sum224() {#sum224}
 
 > `static` **sum224**(`key`, `block`): `Uint8Array`
 
@@ -182,7 +182,7 @@ The sum 224 of the block.
 
 ***
 
-### update()
+### update() {#update}
 
 > **update**(`block`): `HmacSha512`
 
@@ -204,7 +204,7 @@ The instance for chaining.
 
 ***
 
-### digest()
+### digest() {#digest}
 
 > **digest**(): `Uint8Array`
 

package/docs/reference/classes/Hotp.md

@@ -15,7 +15,7 @@ Implementation of https://datatracker.ietf.org/doc/html/rfc4226 .
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -23,7 +23,7 @@ Runtime name for the class.
 
 ## Methods
 
-### generate()
+### generate() {#generate}
 
 > `static` **generate**(`key`, `counter`): `string`
 

package/docs/reference/classes/IntegrityHelper.md

@@ -0,0 +1,85 @@
+# Class: IntegrityHelper
+
+Helper class for creating integrity signatures.
+
+## See
+
+https://www.w3.org/TR/SRI/
+
+## Constructors
+
+### Constructor
+
+> **new IntegrityHelper**(): `IntegrityHelper`
+
+#### Returns
+
+`IntegrityHelper`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### generate() {#generate}
+
+> `static` **generate**(`type`, `content`): `string`
+
+Generate an integrity signature for the given content using the specified hash algorithm.
+
+#### Parameters
+
+##### type
+
+[`IntegrityAlgorithm`](../type-aliases/IntegrityAlgorithm.md)
+
+The hash algorithm to use, either "sha256", "sha384" or "sha512".
+
+##### content
+
+`Uint8Array`
+
+The content to hash as a Uint8Array.
+
+#### Returns
+
+`string`
+
+The integrity signature in the format "type-base64hash".
+
+***
+
+### verify() {#verify}
+
+> `static` **verify**(`integrity`, `content`): `boolean`
+
+Verify an integrity signature for the given content.
+
+#### Parameters
+
+##### integrity
+
+`string`
+
+The integrity signature in the format "type-base64hash".
+
+##### content
+
+`Uint8Array`
+
+The content to hash as a Uint8Array.
+
+#### Returns
+
+`boolean`
+
+True if the integrity signature matches the content.
+
+#### Throws
+
+If the integrity signature is invalid.

package/docs/reference/classes/PasswordGenerator.md

@@ -12,24 +12,60 @@ Generate random passwords.
 
 `PasswordGenerator`
 
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
 ## Methods
 
-### generate()
+### generate() {#generate}
 
-> `static` **generate**(`length`): `string`
+> `static` **generate**(`length?`): `string`
 
 Generate a password of given length.
 
 #### Parameters
 
-##### length
+##### length?
 
-`number`
+`number` = `PasswordGenerator._DEFAULT_MIN_PASSWORD_LENGTH`
 
-The length of the password to generate.
+The length of the password to generate, default to 15.
 
 #### Returns
 
 `string`
 
 The random password.
+
+***
+
+### hashPassword() {#hashpassword}
+
+> `static` **hashPassword**(`passwordBytes`, `saltBytes`): `Promise`\<`string`\>
+
+Hash the password for the user.
+
+#### Parameters
+
+##### passwordBytes
+
+`Uint8Array`
+
+The password bytes.
+
+##### saltBytes
+
+`Uint8Array`
+
+The salt bytes.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The hashed password.

package/docs/reference/classes/PasswordValidator.md

@@ -1,7 +1,10 @@
 # Class: PasswordValidator
 
 Test password strength.
-Ref https://www.owasp.org/index.php/Authentication_Cheat_Sheet#Implement_Proper_Password_Strength_Controls .
+
+## See
+
+https://www.owasp.org/index.php/Authentication_Cheat_Sheet#Implement_Proper_Password_Strength_Controls .
 
 ## Constructors
 
@@ -13,9 +16,17 @@ Ref https://www.owasp.org/index.php/Authentication_Cheat_Sheet#Implement_Proper_
 
 `PasswordValidator`
 
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
 ## Methods
 
-### validate()
+### validate() {#validate}
 
 > `static` **validate**(`property`, `password`, `failures`, `options?`): `void`
 
@@ -49,7 +60,49 @@ Options to configure the testing.
 
 `number`
 
-The minimum length of the password, defaults to 8.
+The minimum length of the password, defaults to 15, can be 8 if MFA is enabled.
+
+###### maxLength?
+
+`number`
+
+The minimum length of the password, defaults to 128.
+
+###### minPhraseLength?
+
+`number`
+
+The minimum length of the password for it to be considered a pass phrase.
+
+#### Returns
+
+`void`
+
+***
+
+### validatePassword() {#validatepassword}
+
+> `static` **validatePassword**(`password`, `options?`): `void`
+
+Validate the password against security policy.
+
+#### Parameters
+
+##### password
+
+`string`
+
+The password to validate.
+
+##### options?
+
+Options to configure the testing.
+
+###### minLength?
+
+`number`
+
+The minimum length of the password, defaults to 15.
 
 ###### maxLength?
 
@@ -66,3 +119,63 @@ The minimum length of the password for it to be considered a pass phrase.
 #### Returns
 
 `void`
+
+#### Throws
+
+Error if the password does not meet the requirements.
+
+***
+
+### comparePasswordBytes() {#comparepasswordbytes}
+
+> `static` **comparePasswordBytes**(`hashedPasswordBytes`, `storedPasswordBytes`): `boolean`
+
+Compare two password byte arrays in constant time to prevent timing attacks.
+
+#### Parameters
+
+##### hashedPasswordBytes
+
+`Uint8Array`
+
+The computed password bytes to compare.
+
+##### storedPasswordBytes
+
+`Uint8Array`
+
+The stored password bytes to compare against.
+
+#### Returns
+
+`boolean`
+
+True if the bytes match, false otherwise.
+
+***
+
+### comparePasswordHashes() {#comparepasswordhashes}
+
+> `static` **comparePasswordHashes**(`hashedPassword`, `storedPassword`): `boolean`
+
+Compare two hashed passwords in constant time to prevent timing attacks.
+
+#### Parameters
+
+##### hashedPassword
+
+`string`
+
+The computed hash to compare.
+
+##### storedPassword
+
+`string`
+
+The stored hash to compare against.
+
+#### Returns
+
+`boolean`
+
+True if the hashes match, false otherwise.

package/docs/reference/classes/Pbkdf2.md

@@ -14,7 +14,7 @@ Implementation of the password based key derivation function 2.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -22,7 +22,7 @@ Runtime name for the class.
 
 ## Methods
 
-### sha256()
+### sha256() {#sha256}
 
 > `static` **sha256**(`password`, `salt`, `iterations`, `keyLength`): `Uint8Array`
 
@@ -62,7 +62,7 @@ The derived key.
 
 ***
 
-### sha512()
+### sha512() {#sha512}
 
 > `static` **sha512**(`password`, `salt`, `iterations`, `keyLength`): `Uint8Array`
 

package/docs/reference/classes/PemHelper.md

@@ -14,7 +14,7 @@ Helper class for working with PEM (Privacy-Enhanced Mail) formatted data.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -22,7 +22,7 @@ Runtime name for the class.
 
 ## Methods
 
-### stripPemMarkers()
+### stripPemMarkers() {#strippemmarkers}
 
 > `static` **stripPemMarkers**(`pemContent`): `string`
 
@@ -44,9 +44,9 @@ The stripped PEM content in bas64 format.
 
 ***
 
-### formatPem()
+### formatPem() {#formatpem}
 
-> `static` **formatPem**(`marker`, `base64Content`, `lineLength`): `string`
+> `static` **formatPem**(`marker`, `base64Content`, `lineLength?`): `string`
 
 Format the PEM content to have a specific line length.
 
@@ -64,7 +64,7 @@ The marker for the PEM content, e.g. RSA PRIVATE KEY
 
 The base64 content to format.
 
-##### lineLength
+##### lineLength?
 
 `number` = `64`
 

package/docs/reference/classes/Secp256k1.md

@@ -14,7 +14,7 @@ Implementation of secp256k1.
 
 ## Properties
 
-### PRIVATE\_KEY\_SIZE
+### PRIVATE\_KEY\_SIZE {#private_key_size}
 
 > `static` **PRIVATE\_KEY\_SIZE**: `number` = `32`
 
@@ -22,7 +22,7 @@ Private Key Size is the size, in bytes, of private keys as used in this package.
 
 ***
 
-### PUBLIC\_KEY\_SIZE
+### PUBLIC\_KEY\_SIZE {#public_key_size}
 
 > `static` **PUBLIC\_KEY\_SIZE**: `number` = `33`
 
@@ -30,7 +30,7 @@ Public Key Size is the size, in bytes, of public keys as used in this package.
 
 ***
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -38,7 +38,7 @@ Runtime name for the class.
 
 ## Methods
 
-### publicKeyFromPrivateKey()
+### publicKeyFromPrivateKey() {#publickeyfromprivatekey}
 
 > `static` **publicKeyFromPrivateKey**(`privateKey`): `Uint8Array`
 
@@ -64,7 +64,7 @@ Error if the private key is not the correct length.
 
 ***
 
-### sign()
+### sign() {#sign}
 
 > `static` **sign**(`privateKey`, `block`): `Uint8Array`
 
@@ -96,7 +96,7 @@ Error if the private key is not the correct length.
 
 ***
 
-### verify()
+### verify() {#verify}
 
 > `static` **verify**(`publicKey`, `block`, `signature`): `boolean`
 

package/docs/reference/classes/Sha1.md

@@ -16,7 +16,7 @@ Create a new instance of Sha1.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -24,7 +24,7 @@ Runtime name for the class.
 
 ## Methods
 
-### sum()
+### sum() {#sum}
 
 > `static` **sum**(`block`): `Uint8Array`
 
@@ -46,7 +46,7 @@ The sum of the block.
 
 ***
 
-### update()
+### update() {#update}
 
 > **update**(`block`): `Sha1`
 
@@ -68,7 +68,7 @@ The instance for chaining.
 
 ***
 
-### digest()
+### digest() {#digest}
 
 > **digest**(): `Uint8Array`