@twin.org/crypto 0.0.1-next.1

package/docs/reference/classes/Blake2b.md

@@ -0,0 +1,155 @@
+# Class: Blake2b
+
+Class to help with Blake2B Signature scheme.
+
+## Constructors
+
+### new Blake2b()
+
+> **new Blake2b**(`outputLength`, `key`?): [`Blake2b`](Blake2b.md)
+
+Create a new instance of Blake2b.
+
+#### Parameters
+
+• **outputLength**: `number`
+
+The output length.
+
+• **key?**: `Uint8Array`
+
+Optional key for the hash.
+
+#### Returns
+
+[`Blake2b`](Blake2b.md)
+
+## Properties
+
+### SIZE\_160
+
+> `static` **SIZE\_160**: `number` = `20`
+
+Blake2b 160.
+
+***
+
+### SIZE\_256
+
+> `static` **SIZE\_256**: `number` = `32`
+
+Blake2b 256.
+
+***
+
+### SIZE\_512
+
+> `static` **SIZE\_512**: `number` = `64`
+
+Blake2b 512.
+
+## Methods
+
+### sum160()
+
+> `static` **sum160**(`block`, `key`?): `Uint8Array`
+
+Perform Sum 160 on the block.
+
+#### Parameters
+
+• **block**: `Uint8Array`
+
+The block to operate on.
+
+• **key?**: `Uint8Array`
+
+Optional key for the hash.
+
+#### Returns
+
+`Uint8Array`
+
+The sum 160 of the block.
+
+***
+
+### sum256()
+
+> `static` **sum256**(`block`, `key`?): `Uint8Array`
+
+Perform Sum 256 on the block.
+
+#### Parameters
+
+• **block**: `Uint8Array`
+
+The block to operate on.
+
+• **key?**: `Uint8Array`
+
+Optional key for the hash.
+
+#### Returns
+
+`Uint8Array`
+
+The sum 256 of the block.
+
+***
+
+### sum512()
+
+> `static` **sum512**(`block`, `key`?): `Uint8Array`
+
+Perform Sum 512 on the block.
+
+#### Parameters
+
+• **block**: `Uint8Array`
+
+The block to operate on.
+
+• **key?**: `Uint8Array`
+
+Optional key for the hash.
+
+#### Returns
+
+`Uint8Array`
+
+The sum 512 of the block.
+
+***
+
+### update()
+
+> **update**(`block`): [`Blake2b`](Blake2b.md)
+
+Update the hash with the block.
+
+#### Parameters
+
+• **block**: `Uint8Array`
+
+The block to update the hash with.
+
+#### Returns
+
+[`Blake2b`](Blake2b.md)
+
+The instance for chaining.
+
+***
+
+### digest()
+
+> **digest**(): `Uint8Array`
+
+Get the digest for the hash.
+
+#### Returns
+
+`Uint8Array`
+
+The instance for chaining.

package/docs/reference/classes/ChaCha20Poly1305.md

@@ -0,0 +1,69 @@
+# Class: ChaCha20Poly1305
+
+Implementation of the ChaCha20Poly1305 cipher.
+
+## Constructors
+
+### new ChaCha20Poly1305()
+
+> **new ChaCha20Poly1305**(`key`, `nonce`, `aad`?): [`ChaCha20Poly1305`](ChaCha20Poly1305.md)
+
+Create a new instance of ChaCha20Poly1305.
+
+#### Parameters
+
+• **key**: `Uint8Array`
+
+The key.
+
+• **nonce**: `Uint8Array`
+
+The nonce.
+
+• **aad?**: `Uint8Array`
+
+The additional authenticated data.
+
+#### Returns
+
+[`ChaCha20Poly1305`](ChaCha20Poly1305.md)
+
+## Methods
+
+### encrypt()
+
+> **encrypt**(`block`): `Uint8Array`
+
+Encrypt the block.
+
+#### Parameters
+
+• **block**: `Uint8Array`
+
+The block to encrypt.
+
+#### Returns
+
+`Uint8Array`
+
+The block encrypted.
+
+***
+
+### decrypt()
+
+> **decrypt**(`block`): `Uint8Array`
+
+Decrypt the block.
+
+#### Parameters
+
+• **block**: `Uint8Array`
+
+The block to decrypt.
+
+#### Returns
+
+`Uint8Array`
+
+The block decrypted.

package/docs/reference/classes/Ed25519.md

@@ -0,0 +1,113 @@
+# Class: Ed25519
+
+Implementation of Ed25519.
+
+## Constructors
+
+### new Ed25519()
+
+> **new Ed25519**(): [`Ed25519`](Ed25519.md)
+
+#### Returns
+
+[`Ed25519`](Ed25519.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` = `32`
+
+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/HmacSha1.md

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

package/docs/reference/classes/HmacSha256.md

@@ -0,0 +1,123 @@
+# Class: HmacSha256
+
+Class to help with HmacSha256 scheme.
+
+## Constructors
+
+### new HmacSha256()
+
+> **new HmacSha256**(`key`, `bits`): [`HmacSha256`](HmacSha256.md)
+
+Create a new instance of HmacSha256.
+
+#### Parameters
+
+• **key**: `Uint8Array`
+
+The key for the hmac.
+
+• **bits**: `number` = `HmacSha256.SIZE_256`
+
+The number of bits.
+
+#### Returns
+
+[`HmacSha256`](HmacSha256.md)
+
+## Properties
+
+### SIZE\_256
+
+> `readonly` `static` **SIZE\_256**: `number` = `256`
+
+Sha256 256.
+
+***
+
+### SIZE\_224
+
+> `readonly` `static` **SIZE\_224**: `number` = `224`
+
+Sha256 224.
+
+## Methods
+
+### sum224()
+
+> `static` **sum224**(`key`, `block`): `Uint8Array`
+
+Perform Sum 224 on the block.
+
+#### Parameters
+
+• **key**: `Uint8Array`
+
+The key for the hmac.
+
+• **block**: `Uint8Array`
+
+The block to operate on.
+
+#### Returns
+
+`Uint8Array`
+
+The sum 224 of the block.
+
+***
+
+### sum256()
+
+> `static` **sum256**(`key`, `block`): `Uint8Array`
+
+Perform Sum 256 on the block.
+
+#### Parameters
+
+• **key**: `Uint8Array`
+
+The key for the hmac.
+
+• **block**: `Uint8Array`
+
+The block to operate on.
+
+#### Returns
+
+`Uint8Array`
+
+The sum 256 of the block.
+
+***
+
+### update()
+
+> **update**(`block`): [`HmacSha256`](HmacSha256.md)
+
+Update the hash with the block.
+
+#### Parameters
+
+• **block**: `Uint8Array`
+
+The block to update the hash with.
+
+#### Returns
+
+[`HmacSha256`](HmacSha256.md)
+
+The instance for chaining.
+
+***
+
+### digest()
+
+> **digest**(): `Uint8Array`
+
+Get the digest for the hash.
+
+#### Returns
+
+`Uint8Array`
+
+The instance for chaining.

package/docs/reference/classes/HmacSha512.md

@@ -0,0 +1,187 @@
+# Class: HmacSha512
+
+Class to help with HmacSha512 scheme.
+
+## Constructors
+
+### new HmacSha512()
+
+> **new HmacSha512**(`key`, `bits`): [`HmacSha512`](HmacSha512.md)
+
+Create a new instance of HmacSha512.
+
+#### Parameters
+
+• **key**: `Uint8Array`
+
+The key for the hmac.
+
+• **bits**: `number` = `HmacSha512.SIZE_512`
+
+The number of bits.
+
+#### Returns
+
+[`HmacSha512`](HmacSha512.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**(`key`, `block`): `Uint8Array`
+
+Perform Sum 512 on the block.
+
+#### Parameters
+
+• **key**: `Uint8Array`
+
+The key for the hmac.
+
+• **block**: `Uint8Array`
+
+The block to operate on.
+
+#### Returns
+
+`Uint8Array`
+
+The sum 512 of the block.
+
+***
+
+### sum384()
+
+> `static` **sum384**(`key`, `block`): `Uint8Array`
+
+Perform Sum 384 on the block.
+
+#### Parameters
+
+• **key**: `Uint8Array`
+
+The key for the hmac.
+
+• **block**: `Uint8Array`
+
+The block to operate on.
+
+#### Returns
+
+`Uint8Array`
+
+The sum 384 of the block.
+
+***
+
+### sum256()
+
+> `static` **sum256**(`key`, `block`): `Uint8Array`
+
+Perform Sum 256 on the block.
+
+#### Parameters
+
+• **key**: `Uint8Array`
+
+The key for the hmac.
+
+• **block**: `Uint8Array`
+
+The block to operate on.
+
+#### Returns
+
+`Uint8Array`
+
+The sum 256 of the block.
+
+***
+
+### sum224()
+
+> `static` **sum224**(`key`, `block`): `Uint8Array`
+
+Perform Sum 224 on the block.
+
+#### Parameters
+
+• **key**: `Uint8Array`
+
+The key for the hmac.
+
+• **block**: `Uint8Array`
+
+The block to operate on.
+
+#### Returns
+
+`Uint8Array`
+
+The sum 224 of the block.
+
+***
+
+### update()
+
+> **update**(`block`): [`HmacSha512`](HmacSha512.md)
+
+Update the hash with the block.
+
+#### Parameters
+
+• **block**: `Uint8Array`
+
+The block to update the hash with.
+
+#### Returns
+
+[`HmacSha512`](HmacSha512.md)
+
+The instance for chaining.
+
+***
+
+### digest()
+
+> **digest**(): `Uint8Array`
+
+Get the digest for the hash.
+
+#### Returns
+
+`Uint8Array`
+
+The instance for chaining.