@twin.org/crypto 0.0.1-next.9 → 0.0.2-next.3

package/docs/reference/classes/RSA.md

@@ -0,0 +1,213 @@
+# Class: RSA
+
+Implementation of the RSA cipher.
+
+## Constructors
+
+### Constructor
+
+> **new RSA**(`publicKey`, `privateKey?`): `RSA`
+
+Create a new instance of RSA.
+
+#### Parameters
+
+##### publicKey
+
+`Uint8Array`
+
+The public key for encryption (DER format as Uint8Array).
+
+##### privateKey?
+
+`Uint8Array`\<`ArrayBufferLike`\>
+
+The private key for decryption (DER format as Uint8Array).
+
+#### Returns
+
+`RSA`
+
+## Methods
+
+### generateKeyPair()
+
+> `static` **generateKeyPair**(`modulusLength`): `object`
+
+Generate a new RSA key pair in PKCS8 format.
+
+#### Parameters
+
+##### modulusLength
+
+`number` = `2048`
+
+The key size in bits (default: 2048).
+
+#### Returns
+
+`object`
+
+The public and private keys as Uint8Array.
+
+##### publicKey
+
+> **publicKey**: `Uint8Array`
+
+##### privateKey
+
+> **privateKey**: `Uint8Array`
+
+***
+
+### convertPkcs1ToPkcs8()
+
+> `static` **convertPkcs1ToPkcs8**(`pkcs1Key`): `Uint8Array`
+
+Convert a PKCS1 key to a PKCS8 key.
+
+#### Parameters
+
+##### pkcs1Key
+
+`Uint8Array`
+
+The PKCS1 key as Uint8Array.
+
+#### Returns
+
+`Uint8Array`
+
+The PKCS8 key as Uint8Array.
+
+***
+
+### getPrivateKeyComponents()
+
+> `static` **getPrivateKeyComponents**(`pkcs8Key`): `object`
+
+Break the private key down in to its components.
+
+#### Parameters
+
+##### pkcs8Key
+
+`Uint8Array`
+
+The PKCS8 key as Uint8Array.
+
+#### Returns
+
+`object`
+
+The key components.
+
+##### n
+
+> **n**: `bigint`
+
+##### e
+
+> **e**: `bigint`
+
+##### d
+
+> **d**: `bigint`
+
+##### p
+
+> **p**: `bigint`
+
+##### q
+
+> **q**: `bigint`
+
+##### dp
+
+> **dp**: `bigint`
+
+##### dq
+
+> **dq**: `bigint`
+
+##### qi
+
+> **qi**: `bigint`
+
+***
+
+### getPublicKeyComponents()
+
+> `static` **getPublicKeyComponents**(`spkiKey`): `object`
+
+Break the public key down in to its components.
+
+#### Parameters
+
+##### spkiKey
+
+`Uint8Array`
+
+The SPKI key as Uint8Array.
+
+#### Returns
+
+`object`
+
+The key components.
+
+##### n
+
+> **n**: `bigint`
+
+##### e
+
+> **e**: `bigint`
+
+***
+
+### encrypt()
+
+> **encrypt**(`data`): `Uint8Array`
+
+Encrypt the data.
+
+#### Parameters
+
+##### data
+
+`Uint8Array`
+
+The data to encrypt.
+
+#### Returns
+
+`Uint8Array`
+
+The data encrypted.
+
+***
+
+### decrypt()
+
+> **decrypt**(`data`): `Uint8Array`
+
+Decrypt the data.
+
+#### Parameters
+
+##### data
+
+`Uint8Array`
+
+The data to decrypt.
+
+#### Returns
+
+`Uint8Array`
+
+The data decrypted.
+
+#### Throws
+
+GeneralError If no private key is provided.

package/docs/reference/classes/Secp256k1.md

@@ -4,13 +4,13 @@ Implementation of secp256k1.
 
 ## Constructors
 
-### new Secp256k1()
+### Constructor
 
-> **new Secp256k1**(): [`Secp256k1`](Secp256k1.md)
+> **new Secp256k1**(): `Secp256k1`
 
 #### Returns
 
-[`Secp256k1`](Secp256k1.md)
+`Secp256k1`
 
 ## Properties
 
@@ -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

@@ -4,15 +4,15 @@ Perform a SHA-1 hash on the block.
 
 ## Constructors
 
-### new Sha1()
+### Constructor
 
-> **new Sha1**(): [`Sha1`](Sha1.md)
+> **new Sha1**(): `Sha1`
 
 Create a new instance of Sha1.
 
 #### Returns
 
-[`Sha1`](Sha1.md)
+`Sha1`
 
 ## Methods
 
@@ -24,7 +24,9 @@ Perform Sum on the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to operate on.
 
@@ -38,19 +40,21 @@ The sum of the block.
 
 ### update()
 
-> **update**(`block`): [`Sha1`](Sha1.md)
+> **update**(`block`): `Sha1`
 
 Update the hash with the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to update the hash with.
 
 #### Returns
 
-[`Sha1`](Sha1.md)
+`Sha1`
 
 The instance for chaining.
 

package/docs/reference/classes/Sha256.md

@@ -4,21 +4,23 @@ Perform a SHA-256 hash on the block.
 
 ## Constructors
 
-### new Sha256()
+### Constructor
 
-> **new Sha256**(`bits`): [`Sha256`](Sha256.md)
+> **new Sha256**(`bits`): `Sha256`
 
 Create a new instance of Sha256.
 
 #### Parameters
 
-• **bits**: `number` = `Sha256.SIZE_256`
+##### bits
+
+`number` = `Sha256.SIZE_256`
 
 The number of bits.
 
 #### Returns
 
-[`Sha256`](Sha256.md)
+`Sha256`
 
 ## Properties
 
@@ -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.
 
@@ -80,19 +86,21 @@ The sum 224 of the block.
 
 ### update()
 
-> **update**(`block`): [`Sha256`](Sha256.md)
+> **update**(`block`): `Sha256`
 
 Update the hash with the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to update the hash with.
 
 #### Returns
 
-[`Sha256`](Sha256.md)
+`Sha256`
 
 The instance for chaining.
 

package/docs/reference/classes/Sha3.md

@@ -4,21 +4,23 @@ Perform a SHA-3 hash on the block.
 
 ## Constructors
 
-### new Sha3()
+### Constructor
 
-> **new Sha3**(`bits`): [`Sha3`](Sha3.md)
+> **new Sha3**(`bits`): `Sha3`
 
 Create a new instance of Sha3.
 
 #### Parameters
 
-• **bits**: `number` = `Sha3.SIZE_256`
+##### bits
+
+`number` = `Sha3.SIZE_256`
 
 The number of bits.
 
 #### Returns
 
-[`Sha3`](Sha3.md)
+`Sha3`
 
 ## Properties
 
@@ -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.
 
@@ -136,19 +146,21 @@ The sum 512 of the block.
 
 ### update()
 
-> **update**(`block`): [`Sha3`](Sha3.md)
+> **update**(`block`): `Sha3`
 
 Update the hash with the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to update the hash with.
 
 #### Returns
 
-[`Sha3`](Sha3.md)
+`Sha3`
 
 The instance for chaining.
 

package/docs/reference/classes/Sha512.md

@@ -4,21 +4,23 @@ Perform a SHA-512 hash on the block.
 
 ## Constructors
 
-### new Sha512()
+### Constructor
 
-> **new Sha512**(`bits`): [`Sha512`](Sha512.md)
+> **new Sha512**(`bits`): `Sha512`
 
 Create a new instance of Sha512.
 
 #### Parameters
 
-• **bits**: `number` = `Sha512.SIZE_512`
+##### bits
+
+`number` = `Sha512.SIZE_512`
 
 The number of bits.
 
 #### Returns
 
-[`Sha512`](Sha512.md)
+`Sha512`
 
 ## Properties
 
@@ -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.
 
@@ -136,19 +146,21 @@ The sum 224 of the block.
 
 ### update()
 
-> **update**(`block`): [`Sha512`](Sha512.md)
+> **update**(`block`): `Sha512`
 
 Update the hash with the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to update the hash with.
 
 #### Returns
 
-[`Sha512`](Sha512.md)
+`Sha512`
 
 The instance for chaining.
 

package/docs/reference/classes/Slip0010.md

@@ -5,13 +5,13 @@ https://github.com/satoshilabs/slips/blob/master/slip-0010.md.
 
 ## Constructors
 
-### new Slip0010()
+### Constructor
 
-> **new Slip0010**(): [`Slip0010`](Slip0010.md)
+> **new Slip0010**(): `Slip0010`
 
 #### Returns
 
-[`Slip0010`](Slip0010.md)
+`Slip0010`
 
 ## Methods
 
@@ -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.