@twin.org/crypto 0.0.1-next.2 → 0.0.1-next.21

package/docs/reference/classes/HmacSha256.md

@@ -12,11 +12,15 @@ Create a new instance of HmacSha256.
 
 #### Parameters
 
-• **key**: `Uint8Array`
+##### key
+
+`Uint8Array`
 
 The key for the hmac.
 
-• **bits**: `number` = `HmacSha256.SIZE_256`
+##### bits
+
+`number` = `HmacSha256.SIZE_256`
 
 The number of bits.
 
@@ -50,11 +54,15 @@ Perform Sum 224 on the block.
 
 #### Parameters
 
-• **key**: `Uint8Array`
+##### key
+
+`Uint8Array`
 
 The key for the hmac.
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to operate on.
 
@@ -74,11 +82,15 @@ Perform Sum 256 on the block.
 
 #### Parameters
 
-• **key**: `Uint8Array`
+##### key
+
+`Uint8Array`
 
 The key for the hmac.
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to operate on.
 
@@ -98,7 +110,9 @@ Update the hash with the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to update the hash with.
 

package/docs/reference/classes/HmacSha512.md

@@ -12,11 +12,15 @@ Create a new instance of HmacSha512.
 
 #### Parameters
 
-• **key**: `Uint8Array`
+##### key
+
+`Uint8Array`
 
 The key for the hmac.
 
-• **bits**: `number` = `HmacSha512.SIZE_512`
+##### bits
+
+`number` = `HmacSha512.SIZE_512`
 
 The number of bits.
 
@@ -66,11 +70,15 @@ Perform Sum 512 on the block.
 
 #### Parameters
 
-• **key**: `Uint8Array`
+##### key
+
+`Uint8Array`
 
 The key for the hmac.
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to operate on.
 
@@ -90,11 +98,15 @@ Perform Sum 384 on the block.
 
 #### Parameters
 
-• **key**: `Uint8Array`
+##### key
+
+`Uint8Array`
 
 The key for the hmac.
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to operate on.
 
@@ -114,11 +126,15 @@ Perform Sum 256 on the block.
 
 #### Parameters
 
-• **key**: `Uint8Array`
+##### key
+
+`Uint8Array`
 
 The key for the hmac.
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to operate on.
 
@@ -138,11 +154,15 @@ Perform Sum 224 on the block.
 
 #### Parameters
 
-• **key**: `Uint8Array`
+##### key
+
+`Uint8Array`
 
 The key for the hmac.
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to operate on.
 
@@ -162,7 +182,9 @@ Update the hash with the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to update the hash with.
 

package/docs/reference/classes/Hotp.md

@@ -23,11 +23,15 @@ Generate a counter based One Time Password.
 
 #### Parameters
 
-• **key**: `Uint8Array`
+##### key
+
+`Uint8Array`
 
 Key for the one time password.
 
-• **counter**: `number`
+##### counter
+
+`number`
 
 This should be stored by the application,
 must be user specific, and be incremented for each request.

package/docs/reference/classes/PasswordGenerator.md

@@ -22,7 +22,9 @@ Generate a password of given length.
 
 #### Parameters
 
-• **length**: `number`
+##### length
+
+`number`
 
 The length of the password to generate.
 

package/docs/reference/classes/PasswordValidator.md

@@ -23,31 +23,43 @@ Test the strength of the password.
 
 #### Parameters
 
-• **property**: `string`
+##### property
+
+`string`
 
 The name of the property.
 
-• **password**: `string`
+##### password
+
+`string`
 
 The password to test.
 
-• **failures**: `IValidationFailure`[]
+##### failures
+
+`IValidationFailure`[]
 
 The list of failures to add to.
 
-• **options?**
+##### options?
 
 Options to configure the testing.
 
-• **options.minLength?**: `number`
+###### minLength
+
+`number`
 
 The minimum length of the password, defaults to 8.
 
-• **options.maxLength?**: `number`
+###### maxLength
+
+`number`
 
 The minimum length of the password, defaults to 128.
 
-• **options.minPhraseLength?**: `number`
+###### minPhraseLength
+
+`number`
 
 The minimum length of the password for it to be considered a pass phrase.
 

package/docs/reference/classes/Pbkdf2.md

@@ -22,19 +22,27 @@ Derive a key from the parameters using Sha256.
 
 #### Parameters
 
-• **password**: `Uint8Array`
+##### password
+
+`Uint8Array`
 
 The password to derive the key from.
 
-• **salt**: `Uint8Array`
+##### salt
+
+`Uint8Array`
 
 The salt for the derivation.
 
-• **iterations**: `number`
+##### iterations
+
+`number`
 
 Number of iterations to perform.
 
-• **keyLength**: `number`
+##### keyLength
+
+`number`
 
 The length of the key to derive.
 
@@ -54,19 +62,27 @@ Derive a key from the parameters using Sha512.
 
 #### Parameters
 
-• **password**: `Uint8Array`
+##### password
+
+`Uint8Array`
 
 The password to derive the key from.
 
-• **salt**: `Uint8Array`
+##### salt
+
+`Uint8Array`
 
 The salt for the derivation.
 
-• **iterations**: `number`
+##### iterations
+
+`number`
 
 Number of iterations to perform.
 
-• **keyLength**: `number`
+##### keyLength
+
+`number`
 
 The length of the key to derive.
 

package/docs/reference/classes/Secp256k1.md

@@ -38,7 +38,9 @@ Public returns the PublicKey corresponding to private.
 
 #### Parameters
 
-• **privateKey**: `Uint8Array`
+##### privateKey
+
+`Uint8Array`
 
 The private key to get the corresponding public key.
 
@@ -62,11 +64,15 @@ Sign the block with privateKey and returns a signature.
 
 #### Parameters
 
-• **privateKey**: `Uint8Array`
+##### privateKey
+
+`Uint8Array`
 
 The private key.
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to sign.
 
@@ -90,15 +96,21 @@ Verify reports whether sig is a valid signature of block by publicKey.
 
 #### Parameters
 
-• **publicKey**: `Uint8Array`
+##### publicKey
+
+`Uint8Array`
 
 The public key to verify the signature.
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block for the signature.
 
-• **signature**: `Uint8Array`
+##### signature
+
+`Uint8Array`
 
 The signature.
 

package/docs/reference/classes/Sha1.md

@@ -24,7 +24,9 @@ Perform Sum on the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to operate on.
 
@@ -44,7 +46,9 @@ Update the hash with the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to update the hash with.
 

package/docs/reference/classes/Sha256.md

@@ -12,7 +12,9 @@ Create a new instance of Sha256.
 
 #### Parameters
 
-• **bits**: `number` = `Sha256.SIZE_256`
+##### bits
+
+`number` = `Sha256.SIZE_256`
 
 The number of bits.
 
@@ -46,7 +48,9 @@ Perform Sum 256 on the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to operate on.
 
@@ -66,7 +70,9 @@ Perform Sum 224 on the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to operate on.
 
@@ -86,7 +92,9 @@ Update the hash with the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to update the hash with.
 

package/docs/reference/classes/Sha3.md

@@ -0,0 +1,179 @@
+# Class: Sha3
+
+Perform a SHA-3 hash on the block.
+
+## Constructors
+
+### new Sha3()
+
+> **new Sha3**(`bits`): [`Sha3`](Sha3.md)
+
+Create a new instance of Sha3.
+
+#### Parameters
+
+##### bits
+
+`number` = `Sha3.SIZE_256`
+
+The number of bits.
+
+#### Returns
+
+[`Sha3`](Sha3.md)
+
+## Properties
+
+### SIZE\_224
+
+> `readonly` `static` **SIZE\_224**: `number` = `224`
+
+Sha3 224.
+
+***
+
+### SIZE\_256
+
+> `readonly` `static` **SIZE\_256**: `number` = `256`
+
+Sha3 256.
+
+***
+
+### SIZE\_384
+
+> `readonly` `static` **SIZE\_384**: `number` = `384`
+
+Sha3 384.
+
+***
+
+### SIZE\_512
+
+> `readonly` `static` **SIZE\_512**: `number` = `512`
+
+Sha3 512.
+
+## Methods
+
+### sum256()
+
+> `static` **sum256**(`block`): `Uint8Array`
+
+Perform Sum 256 on the block.
+
+#### Parameters
+
+##### block
+
+`Uint8Array`
+
+The block to operate on.
+
+#### Returns
+
+`Uint8Array`
+
+The sum 256 of the block.
+
+***
+
+### sum224()
+
+> `static` **sum224**(`block`): `Uint8Array`
+
+Perform Sum 224 on the block.
+
+#### Parameters
+
+##### block
+
+`Uint8Array`
+
+The block to operate on.
+
+#### Returns
+
+`Uint8Array`
+
+The sum 224 of the block.
+
+***
+
+### sum384()
+
+> `static` **sum384**(`block`): `Uint8Array`
+
+Perform Sum 384 on the block.
+
+#### Parameters
+
+##### block
+
+`Uint8Array`
+
+The block to operate on.
+
+#### Returns
+
+`Uint8Array`
+
+The sum 384 of the block.
+
+***
+
+### sum512()
+
+> `static` **sum512**(`block`): `Uint8Array`
+
+Perform Sum 512 on the block.
+
+#### Parameters
+
+##### block
+
+`Uint8Array`
+
+The block to operate on.
+
+#### Returns
+
+`Uint8Array`
+
+The sum 512 of the block.
+
+***
+
+### update()
+
+> **update**(`block`): [`Sha3`](Sha3.md)
+
+Update the hash with the block.
+
+#### Parameters
+
+##### block
+
+`Uint8Array`
+
+The block to update the hash with.
+
+#### Returns
+
+[`Sha3`](Sha3.md)
+
+The instance for chaining.
+
+***
+
+### digest()
+
+> **digest**(): `Uint8Array`
+
+Get the digest for the hash.
+
+#### Returns
+
+`Uint8Array`
+
+The instance for chaining.

package/docs/reference/classes/Sha512.md

@@ -12,7 +12,9 @@ Create a new instance of Sha512.
 
 #### Parameters
 
-• **bits**: `number` = `Sha512.SIZE_512`
+##### bits
+
+`number` = `Sha512.SIZE_512`
 
 The number of bits.
 
@@ -62,7 +64,9 @@ Perform Sum 512 on the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to operate on.
 
@@ -82,7 +86,9 @@ Perform Sum 384 on the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to operate on.
 
@@ -102,7 +108,9 @@ Perform Sum 256 on the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to operate on.
 
@@ -122,7 +130,9 @@ Perform Sum 224 on the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to operate on.
 
@@ -142,7 +152,9 @@ Update the hash with the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to update the hash with.