@twin.org/crypto 0.0.3-next.21 → 0.0.3-next.23

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

@@ -18,7 +18,7 @@ https://www.w3.org/TR/SRI/
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -26,7 +26,7 @@ Runtime name for the class.
 
 ## Methods
 
-### generate()
+### generate() {#generate}
 
 > `static` **generate**(`type`, `content`): `string`
 
@@ -54,7 +54,7 @@ The integrity signature in the format "type-base64hash".
 
 ***
 
-### verify()
+### verify() {#verify}
 
 > `static` **verify**(`integrity`, `content`): `boolean`
 

package/docs/reference/classes/PasswordGenerator.md

@@ -14,7 +14,7 @@ Generate random passwords.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -22,15 +22,15 @@ 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` = `PasswordGenerator._DEFAULT_MIN_PASSWORD_LENGTH`
 
@@ -44,7 +44,7 @@ The random password.
 
 ***
 
-### hashPassword()
+### hashPassword() {#hashpassword}
 
 > `static` **hashPassword**(`passwordBytes`, `saltBytes`): `Promise`\<`string`\>
 

package/docs/reference/classes/PasswordValidator.md

@@ -18,7 +18,7 @@ https://www.owasp.org/index.php/Authentication_Cheat_Sheet#Implement_Proper_Pass
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -26,7 +26,7 @@ Runtime name for the class.
 
 ## Methods
 
-### validate()
+### validate() {#validate}
 
 > `static` **validate**(`property`, `password`, `failures`, `options?`): `void`
 
@@ -80,7 +80,7 @@ The minimum length of the password for it to be considered a pass phrase.
 
 ***
 
-### validatePassword()
+### validatePassword() {#validatepassword}
 
 > `static` **validatePassword**(`password`, `options?`): `void`
 
@@ -126,7 +126,7 @@ Error if the password does not meet the requirements.
 
 ***
 
-### comparePasswordBytes()
+### comparePasswordBytes() {#comparepasswordbytes}
 
 > `static` **comparePasswordBytes**(`hashedPasswordBytes`, `storedPasswordBytes`): `boolean`
 
@@ -154,7 +154,7 @@ True if the bytes match, false otherwise.
 
 ***
 
-### comparePasswordHashes()
+### comparePasswordHashes() {#comparepasswordhashes}
 
 > `static` **comparePasswordHashes**(`hashedPassword`, `storedPassword`): `boolean`
 

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`
 

package/docs/reference/classes/Sha256.md

@@ -6,13 +6,13 @@ Perform a SHA-256 hash on the block.
 
 ### Constructor
 
-> **new Sha256**(`bits`): `Sha256`
+> **new Sha256**(`bits?`): `Sha256`
 
 Create a new instance of Sha256.
 
 #### Parameters
 
-##### bits
+##### bits?
 
 `number` = `Sha256.SIZE_256`
 
@@ -24,7 +24,7 @@ The number of bits.
 
 ## Properties
 
-### SIZE\_256
+### SIZE\_256 {#size_256}
 
 > `readonly` `static` **SIZE\_256**: `number` = `256`
 
@@ -32,7 +32,7 @@ Sha256 256.
 
 ***
 
-### SIZE\_224
+### SIZE\_224 {#size_224}
 
 > `readonly` `static` **SIZE\_224**: `number` = `224`
 
@@ -40,7 +40,7 @@ Sha256 224.
 
 ***
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -48,7 +48,7 @@ Runtime name for the class.
 
 ## Methods
 
-### sum256()
+### sum256() {#sum256}
 
 > `static` **sum256**(`block`): `Uint8Array`
 
@@ -70,7 +70,7 @@ The sum 256 of the block.
 
 ***
 
-### sum224()
+### sum224() {#sum224}
 
 > `static` **sum224**(`block`): `Uint8Array`
 
@@ -92,7 +92,7 @@ The sum 224 of the block.
 
 ***
 
-### update()
+### update() {#update}
 
 > **update**(`block`): `Sha256`
 
@@ -114,7 +114,7 @@ The instance for chaining.
 
 ***
 
-### digest()
+### digest() {#digest}
 
 > **digest**(): `Uint8Array`
 

package/docs/reference/classes/Sha3.md

@@ -6,13 +6,13 @@ Perform a SHA-3 hash on the block.
 
 ### Constructor
 
-> **new Sha3**(`bits`): `Sha3`
+> **new Sha3**(`bits?`): `Sha3`
 
 Create a new instance of Sha3.
 
 #### Parameters
 
-##### bits
+##### bits?
 
 `number` = `Sha3.SIZE_256`
 
@@ -24,7 +24,7 @@ The number of bits.
 
 ## Properties
 
-### SIZE\_224
+### SIZE\_224 {#size_224}
 
 > `readonly` `static` **SIZE\_224**: `number` = `224`
 
@@ -32,7 +32,7 @@ Sha3 224.
 
 ***
 
-### SIZE\_256
+### SIZE\_256 {#size_256}
 
 > `readonly` `static` **SIZE\_256**: `number` = `256`
 
@@ -40,7 +40,7 @@ Sha3 256.
 
 ***
 
-### SIZE\_384
+### SIZE\_384 {#size_384}
 
 > `readonly` `static` **SIZE\_384**: `number` = `384`
 
@@ -48,7 +48,7 @@ Sha3 384.
 
 ***
 
-### SIZE\_512
+### SIZE\_512 {#size_512}
 
 > `readonly` `static` **SIZE\_512**: `number` = `512`
 
@@ -56,7 +56,7 @@ Sha3 512.
 
 ***
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -64,7 +64,7 @@ Runtime name for the class.
 
 ## Methods
 
-### sum256()
+### sum256() {#sum256}
 
 > `static` **sum256**(`block`): `Uint8Array`
 
@@ -86,7 +86,7 @@ The sum 256 of the block.
 
 ***
 
-### sum224()
+### sum224() {#sum224}
 
 > `static` **sum224**(`block`): `Uint8Array`
 
@@ -108,7 +108,7 @@ The sum 224 of the block.
 
 ***
 
-### sum384()
+### sum384() {#sum384}
 
 > `static` **sum384**(`block`): `Uint8Array`
 
@@ -130,7 +130,7 @@ The sum 384 of the block.
 
 ***
 
-### sum512()
+### sum512() {#sum512}
 
 > `static` **sum512**(`block`): `Uint8Array`
 
@@ -152,7 +152,7 @@ The sum 512 of the block.
 
 ***
 
-### update()
+### update() {#update}
 
 > **update**(`block`): `Sha3`
 
@@ -174,7 +174,7 @@ The instance for chaining.
 
 ***
 
-### digest()
+### digest() {#digest}
 
 > **digest**(): `Uint8Array`