@twin.org/crypto 0.0.1-next.18 → 0.0.1-next.19

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

@@ -12,7 +12,9 @@ Create a new instance of Sha3.
 
 #### Parameters
 
-• **bits**: `number` = `Sha3.SIZE_256`
+##### bits
+
+`number` = `Sha3.SIZE_256`
 
 The number of bits.
 
@@ -62,7 +64,9 @@ Perform Sum 256 on the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to operate on.
 
@@ -82,7 +86,9 @@ Perform Sum 224 on the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to operate on.
 
@@ -102,7 +108,9 @@ Perform Sum 384 on the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to operate on.
 
@@ -122,7 +130,9 @@ Perform Sum 512 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.
 

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.
 

package/docs/reference/classes/Slip0010.md

@@ -23,11 +23,15 @@ Get the master key from the seed.
 
 #### Parameters
 
-• **seed**: `Uint8Array`
+##### seed
+
+`Uint8Array`
 
 The seed to generate the master key from.
 
-• **keyType**: [`KeyType`](../type-aliases/KeyType.md) = `KeyType.Ed25519`
+##### keyType
+
+[`KeyType`](../type-aliases/KeyType.md) = `KeyType.Ed25519`
 
 The key type.
 
@@ -59,15 +63,21 @@ Derive a key from the path.
 
 #### Parameters
 
-• **seed**: `Uint8Array`
+##### seed
+
+`Uint8Array`
 
 The seed.
 
-• **path**: [`Bip32Path`](Bip32Path.md)
+##### path
+
+[`Bip32Path`](Bip32Path.md)
 
 The path.
 
-• **keyType**: [`KeyType`](../type-aliases/KeyType.md) = `KeyType.Ed25519`
+##### keyType
+
+[`KeyType`](../type-aliases/KeyType.md) = `KeyType.Ed25519`
 
 The key type.
 
@@ -95,15 +105,21 @@ Get the public key from the private key.
 
 #### Parameters
 
-• **privateKey**: `Uint8Array`
+##### privateKey
+
+`Uint8Array`
 
 The private key.
 
-• **keyType**: [`KeyType`](../type-aliases/KeyType.md) = `KeyType.Ed25519`
+##### keyType
+
+[`KeyType`](../type-aliases/KeyType.md) = `KeyType.Ed25519`
 
 The key type.
 
-• **withZeroByte**: `boolean` = `true`
+##### withZeroByte
+
+`boolean` = `true`
 
 Include a zero bute prefix.
 

package/docs/reference/classes/Totp.md

@@ -23,15 +23,21 @@ Generate a time based One Time Password.
 
 #### Parameters
 
-• **key**: `Uint8Array`
+##### key
+
+`Uint8Array`
 
 Key for the one time password.
 
-• **interval**: `number` = `30`
+##### interval
+
+`number` = `30`
 
 The time step of the counter.
 
-• **timestamp**: `number` = `...`
+##### timestamp
+
+`number` = `...`
 
 The timestamp.
 
@@ -51,24 +57,34 @@ Check a One Time Password based on a timer.
 
 #### Parameters
 
-• **token**: `string`
+##### token
+
+`string`
 
 Passcode to validate.
 
-• **key**: `Uint8Array`
+##### key
+
+`Uint8Array`
 
 Key for the one time password. This should be unique and secret for
 every user as it is the seed used to calculate the HMAC.
 
-• **window**: `number` = `2`
+##### window
+
+`number` = `2`
 
 The allowable margin for the counter.
 
-• **interval**: `number` = `30`
+##### interval
+
+`number` = `30`
 
 The time step of the counter.
 
-• **timestamp**: `number` = `...`
+##### timestamp
+
+`number` = `...`
 
 The timestamp now.
 
@@ -88,7 +104,9 @@ Generate a secret.
 
 #### Parameters
 
-• **length**: `number`
+##### length
+
+`number`
 
 The length of the secret to generate.
 
@@ -108,7 +126,9 @@ Convert the secret back to bytes.
 
 #### Parameters
 
-• **secretBase32**: `string`
+##### secretBase32
+
+`string`
 
 The secret encoded as base32.
 
@@ -129,15 +149,21 @@ See https://github.com/google/google-authenticator/wiki/Key-Uri-Format .
 
 #### Parameters
 
-• **issuer**: `string`
+##### issuer
+
+`string`
 
 The issuer of the totp.
 
-• **label**: `string`
+##### label
+
+`string`
 
 The label that will show in auth apps.
 
-• **secretBase32**: `string`
+##### secretBase32
+
+`string`
 
 The secret as base 32.
 

package/docs/reference/classes/X25519.md

@@ -22,7 +22,9 @@ Convert Ed25519 private key to X25519 private key.
 
 #### Parameters
 
-• **ed25519PrivateKey**: `Uint8Array`
+##### ed25519PrivateKey
+
+`Uint8Array`
 
 The ed25519 private key to convert.
 
@@ -42,7 +44,9 @@ Convert Ed25519 public key to X25519 public key.
 
 #### Parameters
 
-• **ed25519PublicKey**: `Uint8Array`
+##### ed25519PublicKey
+
+`Uint8Array`
 
 The ed25519 public key to convert.