@twin.org/crypto 0.0.1-next.1

package/docs/reference/classes/Hotp.md

@@ -0,0 +1,39 @@
+# Class: Hotp
+
+Perform HOTP.
+Implementation of https://datatracker.ietf.org/doc/html/rfc4226 .
+
+## Constructors
+
+### new Hotp()
+
+> **new Hotp**(): [`Hotp`](Hotp.md)
+
+#### Returns
+
+[`Hotp`](Hotp.md)
+
+## Methods
+
+### generate()
+
+> `static` **generate**(`key`, `counter`): `string`
+
+Generate a counter based One Time Password.
+
+#### Parameters
+
+• **key**: `Uint8Array`
+
+Key for the one time password.
+
+• **counter**: `number`
+
+This should be stored by the application,
+must be user specific, and be incremented for each request.
+
+#### Returns
+
+`string`
+
+The one time password.

package/docs/reference/classes/PasswordGenerator.md

@@ -0,0 +1,33 @@
+# Class: PasswordGenerator
+
+Generate random passwords.
+
+## Constructors
+
+### new PasswordGenerator()
+
+> **new PasswordGenerator**(): [`PasswordGenerator`](PasswordGenerator.md)
+
+#### Returns
+
+[`PasswordGenerator`](PasswordGenerator.md)
+
+## Methods
+
+### generate()
+
+> `static` **generate**(`length`): `string`
+
+Generate a password of given length.
+
+#### Parameters
+
+• **length**: `number`
+
+The length of the password to generate.
+
+#### Returns
+
+`string`
+
+The random password.

package/docs/reference/classes/PasswordValidator.md

@@ -0,0 +1,56 @@
+# Class: PasswordValidator
+
+Test password strength.
+Ref https://www.owasp.org/index.php/Authentication_Cheat_Sheet#Implement_Proper_Password_Strength_Controls .
+
+## Constructors
+
+### new PasswordValidator()
+
+> **new PasswordValidator**(): [`PasswordValidator`](PasswordValidator.md)
+
+#### Returns
+
+[`PasswordValidator`](PasswordValidator.md)
+
+## Methods
+
+### validate()
+
+> `static` **validate**(`property`, `password`, `failures`, `options`?): `void`
+
+Test the strength of the password.
+
+#### Parameters
+
+• **property**: `string`
+
+The name of the property.
+
+• **password**: `string`
+
+The password to test.
+
+• **failures**: `IValidationFailure`[]
+
+The list of failures to add to.
+
+• **options?**
+
+Options to configure the testing.
+
+• **options.minLength?**: `number`
+
+The minimum length of the password, defaults to 8.
+
+• **options.maxLength?**: `number`
+
+The minimum length of the password, defaults to 128.
+
+• **options.minPhraseLength?**: `number`
+
+The minimum length of the password for it to be considered a pass phrase.
+
+#### Returns
+
+`void`

package/docs/reference/classes/Pbkdf2.md

@@ -0,0 +1,77 @@
+# Class: Pbkdf2
+
+Implementation of the password based key derivation function 2.
+
+## Constructors
+
+### new Pbkdf2()
+
+> **new Pbkdf2**(): [`Pbkdf2`](Pbkdf2.md)
+
+#### Returns
+
+[`Pbkdf2`](Pbkdf2.md)
+
+## Methods
+
+### sha256()
+
+> `static` **sha256**(`password`, `salt`, `iterations`, `keyLength`): `Uint8Array`
+
+Derive a key from the parameters using Sha256.
+
+#### Parameters
+
+• **password**: `Uint8Array`
+
+The password to derive the key from.
+
+• **salt**: `Uint8Array`
+
+The salt for the derivation.
+
+• **iterations**: `number`
+
+Number of iterations to perform.
+
+• **keyLength**: `number`
+
+The length of the key to derive.
+
+#### Returns
+
+`Uint8Array`
+
+The derived key.
+
+***
+
+### sha512()
+
+> `static` **sha512**(`password`, `salt`, `iterations`, `keyLength`): `Uint8Array`
+
+Derive a key from the parameters using Sha512.
+
+#### Parameters
+
+• **password**: `Uint8Array`
+
+The password to derive the key from.
+
+• **salt**: `Uint8Array`
+
+The salt for the derivation.
+
+• **iterations**: `number`
+
+Number of iterations to perform.
+
+• **keyLength**: `number`
+
+The length of the key to derive.
+
+#### Returns
+
+`Uint8Array`
+
+The derived key.

package/docs/reference/classes/Secp256k1.md

@@ -0,0 +1,113 @@
+# Class: Secp256k1
+
+Implementation of secp256k1.
+
+## Constructors
+
+### new Secp256k1()
+
+> **new Secp256k1**(): [`Secp256k1`](Secp256k1.md)
+
+#### Returns
+
+[`Secp256k1`](Secp256k1.md)
+
+## Properties
+
+### PRIVATE\_KEY\_SIZE
+
+> `static` **PRIVATE\_KEY\_SIZE**: `number` = `32`
+
+Private Key Size is the size, in bytes, of private keys as used in this package.
+
+***
+
+### PUBLIC\_KEY\_SIZE
+
+> `static` **PUBLIC\_KEY\_SIZE**: `number` = `33`
+
+Public Key Size is the size, in bytes, of public keys as used in this package.
+
+## Methods
+
+### publicKeyFromPrivateKey()
+
+> `static` **publicKeyFromPrivateKey**(`privateKey`): `Uint8Array`
+
+Public returns the PublicKey corresponding to private.
+
+#### Parameters
+
+• **privateKey**: `Uint8Array`
+
+The private key to get the corresponding public key.
+
+#### Returns
+
+`Uint8Array`
+
+The public key.
+
+#### Throws
+
+Error if the private key is not the correct length.
+
+***
+
+### sign()
+
+> `static` **sign**(`privateKey`, `block`): `Uint8Array`
+
+Sign the block with privateKey and returns a signature.
+
+#### Parameters
+
+• **privateKey**: `Uint8Array`
+
+The private key.
+
+• **block**: `Uint8Array`
+
+The block to sign.
+
+#### Returns
+
+`Uint8Array`
+
+The signature.
+
+#### Throws
+
+Error if the private key is not the correct length.
+
+***
+
+### verify()
+
+> `static` **verify**(`publicKey`, `block`, `signature`): `boolean`
+
+Verify reports whether sig is a valid signature of block by publicKey.
+
+#### Parameters
+
+• **publicKey**: `Uint8Array`
+
+The public key to verify the signature.
+
+• **block**: `Uint8Array`
+
+The block for the signature.
+
+• **signature**: `Uint8Array`
+
+The signature.
+
+#### Returns
+
+`boolean`
+
+True if the signature matches.
+
+#### Throws
+
+Error if the public key is not the correct length.

package/docs/reference/classes/Sha1.md

@@ -0,0 +1,69 @@
+# Class: Sha1
+
+Perform a SHA-1 hash on the block.
+
+## Constructors
+
+### new Sha1()
+
+> **new Sha1**(): [`Sha1`](Sha1.md)
+
+Create a new instance of Sha1.
+
+#### Returns
+
+[`Sha1`](Sha1.md)
+
+## Methods
+
+### sum()
+
+> `static` **sum**(`block`): `Uint8Array`
+
+Perform Sum on the block.
+
+#### Parameters
+
+• **block**: `Uint8Array`
+
+The block to operate on.
+
+#### Returns
+
+`Uint8Array`
+
+The sum of the block.
+
+***
+
+### update()
+
+> **update**(`block`): [`Sha1`](Sha1.md)
+
+Update the hash with the block.
+
+#### Parameters
+
+• **block**: `Uint8Array`
+
+The block to update the hash with.
+
+#### Returns
+
+[`Sha1`](Sha1.md)
+
+The instance for chaining.
+
+***
+
+### digest()
+
+> **digest**(): `Uint8Array`
+
+Get the digest for the hash.
+
+#### Returns
+
+`Uint8Array`
+
+The instance for chaining.

package/docs/reference/classes/Sha256.md

@@ -0,0 +1,111 @@
+# Class: Sha256
+
+Perform a SHA-256 hash on the block.
+
+## Constructors
+
+### new Sha256()
+
+> **new Sha256**(`bits`): [`Sha256`](Sha256.md)
+
+Create a new instance of Sha256.
+
+#### Parameters
+
+• **bits**: `number` = `Sha256.SIZE_256`
+
+The number of bits.
+
+#### Returns
+
+[`Sha256`](Sha256.md)
+
+## Properties
+
+### SIZE\_256
+
+> `readonly` `static` **SIZE\_256**: `number` = `256`
+
+Sha256 256.
+
+***
+
+### SIZE\_224
+
+> `readonly` `static` **SIZE\_224**: `number` = `224`
+
+Sha256 224.
+
+## 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.
+
+***
+
+### update()
+
+> **update**(`block`): [`Sha256`](Sha256.md)
+
+Update the hash with the block.
+
+#### Parameters
+
+• **block**: `Uint8Array`
+
+The block to update the hash with.
+
+#### Returns
+
+[`Sha256`](Sha256.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

@@ -0,0 +1,167 @@
+# Class: Sha512
+
+Perform a SHA-512 hash on the block.
+
+## Constructors
+
+### new Sha512()
+
+> **new Sha512**(`bits`): [`Sha512`](Sha512.md)
+
+Create a new instance of Sha512.
+
+#### Parameters
+
+• **bits**: `number` = `Sha512.SIZE_512`
+
+The number of bits.
+
+#### Returns
+
+[`Sha512`](Sha512.md)
+
+## Properties
+
+### SIZE\_224
+
+> `static` **SIZE\_224**: `number` = `224`
+
+Sha512 224.
+
+***
+
+### SIZE\_256
+
+> `static` **SIZE\_256**: `number` = `256`
+
+Sha512 256.
+
+***
+
+### SIZE\_384
+
+> `static` **SIZE\_384**: `number` = `384`
+
+Sha512 384.
+
+***
+
+### SIZE\_512
+
+> `static` **SIZE\_512**: `number` = `512`
+
+Sha512 512.
+
+## Methods
+
+### 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.
+
+***
+
+### 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.
+
+***
+
+### 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.
+
+***
+
+### update()
+
+> **update**(`block`): [`Sha512`](Sha512.md)
+
+Update the hash with the block.
+
+#### Parameters
+
+• **block**: `Uint8Array`
+
+The block to update the hash with.
+
+#### Returns
+
+[`Sha512`](Sha512.md)
+
+The instance for chaining.
+
+***
+
+### digest()
+
+> **digest**(): `Uint8Array`
+
+Get the digest for the hash.
+
+#### Returns
+
+`Uint8Array`
+
+The instance for chaining.