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

package/docs/reference/classes/Ed25519.md

@@ -4,13 +4,13 @@ Implementation of Ed25519.
 
 ## Constructors
 
-### new Ed25519()
+### Constructor
 
-> **new Ed25519**(): [`Ed25519`](Ed25519.md)
+> **new Ed25519**(): `Ed25519`
 
 #### Returns
 
-[`Ed25519`](Ed25519.md)
+`Ed25519`
 
 ## 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.
 
@@ -111,3 +123,47 @@ True if the signature matches.
 #### Throws
 
 Error if the public key is not the correct length.
+
+***
+
+### privateKeyToPkcs8()
+
+> `static` **privateKeyToPkcs8**(`privateKey`): `Promise`\<`CryptoKey`\>
+
+Convert a private key in PKCS8 format.
+
+#### Parameters
+
+##### privateKey
+
+`Uint8Array`
+
+The private key to convert.
+
+#### Returns
+
+`Promise`\<`CryptoKey`\>
+
+The private key in PKCS8 format.
+
+***
+
+### pkcs8ToPrivateKey()
+
+> `static` **pkcs8ToPrivateKey**(`cryptoKey`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
+
+Convert a crypto key to raw private key.
+
+#### Parameters
+
+##### cryptoKey
+
+`CryptoKey`
+
+The crypto key to convert.
+
+#### Returns
+
+`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
+
+The raw private key.

package/docs/reference/classes/HmacSha1.md

@@ -4,21 +4,23 @@ Class to help with HmacSha1 scheme.
 
 ## Constructors
 
-### new HmacSha1()
+### Constructor
 
-> **new HmacSha1**(`key`): [`HmacSha1`](HmacSha1.md)
+> **new HmacSha1**(`key`): `HmacSha1`
 
 Create a new instance of HmacSha1.
 
 #### Parameters
 
-• **key**: `Uint8Array`
+##### key
+
+`Uint8Array`
 
 The key for the hmac.
 
 #### Returns
 
-[`HmacSha1`](HmacSha1.md)
+`HmacSha1`
 
 ## Methods
 
@@ -30,11 +32,15 @@ Perform Sum on the block.
 
 #### Parameters
 
-• **key**: `Uint8Array`
+##### key
+
+`Uint8Array`
 
 The key for the hmac.
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to operate on.
 
@@ -48,19 +54,21 @@ The sum of the block.
 
 ### update()
 
-> **update**(`block`): [`HmacSha1`](HmacSha1.md)
+> **update**(`block`): `HmacSha1`
 
 Update the hash with the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to update the hash with.
 
 #### Returns
 
-[`HmacSha1`](HmacSha1.md)
+`HmacSha1`
 
 The instance for chaining.
 

package/docs/reference/classes/HmacSha256.md

@@ -4,25 +4,29 @@ Class to help with HmacSha256 scheme.
 
 ## Constructors
 
-### new HmacSha256()
+### Constructor
 
-> **new HmacSha256**(`key`, `bits`): [`HmacSha256`](HmacSha256.md)
+> **new HmacSha256**(`key`, `bits`): `HmacSha256`
 
 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.
 
 #### Returns
 
-[`HmacSha256`](HmacSha256.md)
+`HmacSha256`
 
 ## Properties
 
@@ -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.
 
@@ -92,19 +104,21 @@ The sum 256 of the block.
 
 ### update()
 
-> **update**(`block`): [`HmacSha256`](HmacSha256.md)
+> **update**(`block`): `HmacSha256`
 
 Update the hash with the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to update the hash with.
 
 #### Returns
 
-[`HmacSha256`](HmacSha256.md)
+`HmacSha256`
 
 The instance for chaining.
 

package/docs/reference/classes/HmacSha512.md

@@ -4,25 +4,29 @@ Class to help with HmacSha512 scheme.
 
 ## Constructors
 
-### new HmacSha512()
+### Constructor
 
-> **new HmacSha512**(`key`, `bits`): [`HmacSha512`](HmacSha512.md)
+> **new HmacSha512**(`key`, `bits`): `HmacSha512`
 
 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.
 
 #### Returns
 
-[`HmacSha512`](HmacSha512.md)
+`HmacSha512`
 
 ## Properties
 
@@ -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.
 
@@ -156,19 +176,21 @@ The sum 224 of the block.
 
 ### update()
 
-> **update**(`block`): [`HmacSha512`](HmacSha512.md)
+> **update**(`block`): `HmacSha512`
 
 Update the hash with the block.
 
 #### Parameters
 
-• **block**: `Uint8Array`
+##### block
+
+`Uint8Array`
 
 The block to update the hash with.
 
 #### Returns
 
-[`HmacSha512`](HmacSha512.md)
+`HmacSha512`
 
 The instance for chaining.
 

package/docs/reference/classes/Hotp.md

@@ -5,13 +5,13 @@ Implementation of https://datatracker.ietf.org/doc/html/rfc4226 .
 
 ## Constructors
 
-### new Hotp()
+### Constructor
 
-> **new Hotp**(): [`Hotp`](Hotp.md)
+> **new Hotp**(): `Hotp`
 
 #### Returns
 
-[`Hotp`](Hotp.md)
+`Hotp`
 
 ## Methods
 
@@ -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

@@ -4,13 +4,13 @@ Generate random passwords.
 
 ## Constructors
 
-### new PasswordGenerator()
+### Constructor
 
-> **new PasswordGenerator**(): [`PasswordGenerator`](PasswordGenerator.md)
+> **new PasswordGenerator**(): `PasswordGenerator`
 
 #### Returns
 
-[`PasswordGenerator`](PasswordGenerator.md)
+`PasswordGenerator`
 
 ## Methods
 
@@ -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

@@ -5,49 +5,61 @@ Ref https://www.owasp.org/index.php/Authentication_Cheat_Sheet#Implement_Proper_
 
 ## Constructors
 
-### new PasswordValidator()
+### Constructor
 
-> **new PasswordValidator**(): [`PasswordValidator`](PasswordValidator.md)
+> **new PasswordValidator**(): `PasswordValidator`
 
 #### Returns
 
-[`PasswordValidator`](PasswordValidator.md)
+`PasswordValidator`
 
 ## Methods
 
 ### validate()
 
-> `static` **validate**(`property`, `password`, `failures`, `options`?): `void`
+> `static` **validate**(`property`, `password`, `failures`, `options?`): `void`
 
 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

@@ -4,13 +4,13 @@ Implementation of the password based key derivation function 2.
 
 ## Constructors
 
-### new Pbkdf2()
+### Constructor
 
-> **new Pbkdf2**(): [`Pbkdf2`](Pbkdf2.md)
+> **new Pbkdf2**(): `Pbkdf2`
 
 #### Returns
 
-[`Pbkdf2`](Pbkdf2.md)
+`Pbkdf2`
 
 ## Methods
 
@@ -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/PemHelper.md

@@ -0,0 +1,69 @@
+# Class: PemHelper
+
+Helper class for working with PEM (Privacy-Enhanced Mail) formatted data.
+
+## Constructors
+
+### Constructor
+
+> **new PemHelper**(): `PemHelper`
+
+#### Returns
+
+`PemHelper`
+
+## Methods
+
+### stripPemMarkers()
+
+> `static` **stripPemMarkers**(`pemContent`): `string`
+
+Strip the PEM content of its headers, footers, and newlines.
+
+#### Parameters
+
+##### pemContent
+
+`string`
+
+The PEM content to strip.
+
+#### Returns
+
+`string`
+
+The stripped PEM content in bas64 format.
+
+***
+
+### formatPem()
+
+> `static` **formatPem**(`marker`, `base64Content`, `lineLength`): `string`
+
+Format the PEM content to have a specific line length.
+
+#### Parameters
+
+##### marker
+
+`string`
+
+The marker for the PEM content, e.g. RSA PRIVATE KEY
+
+##### base64Content
+
+`string`
+
+The base64 content to format.
+
+##### lineLength
+
+`number` = `64`
+
+The length of each line in the PEM content, default is 64 characters.
+
+#### Returns
+
+`string`
+
+The formatted PEM content.