@twin.org/crypto 0.0.1-next.1

package/docs/reference/classes/Slip0010.md

@@ -0,0 +1,114 @@
+# Class: Slip0010
+
+Class to help with slip0010 key derivation
+https://github.com/satoshilabs/slips/blob/master/slip-0010.md.
+
+## Constructors
+
+### new Slip0010()
+
+> **new Slip0010**(): [`Slip0010`](Slip0010.md)
+
+#### Returns
+
+[`Slip0010`](Slip0010.md)
+
+## Methods
+
+### getMasterKeyFromSeed()
+
+> `static` **getMasterKeyFromSeed**(`seed`, `keyType`): `object`
+
+Get the master key from the seed.
+
+#### Parameters
+
+• **seed**: `Uint8Array`
+
+The seed to generate the master key from.
+
+• **keyType**: [`KeyType`](../type-aliases/KeyType.md) = `KeyType.Ed25519`
+
+The key type.
+
+#### Returns
+
+`object`
+
+The key and chain code.
+
+##### privateKey
+
+> **privateKey**: `Uint8Array`
+
+##### chainCode
+
+> **chainCode**: `Uint8Array`
+
+#### Throws
+
+If the seed is invalid.
+
+***
+
+### derivePath()
+
+> `static` **derivePath**(`seed`, `path`, `keyType`): `object`
+
+Derive a key from the path.
+
+#### Parameters
+
+• **seed**: `Uint8Array`
+
+The seed.
+
+• **path**: [`Bip32Path`](Bip32Path.md)
+
+The path.
+
+• **keyType**: [`KeyType`](../type-aliases/KeyType.md) = `KeyType.Ed25519`
+
+The key type.
+
+#### Returns
+
+`object`
+
+The key and chain code.
+
+##### privateKey
+
+> **privateKey**: `Uint8Array`
+
+##### chainCode
+
+> **chainCode**: `Uint8Array`
+
+***
+
+### getPublicKey()
+
+> `static` **getPublicKey**(`privateKey`, `keyType`, `withZeroByte`): `Uint8Array`
+
+Get the public key from the private key.
+
+#### Parameters
+
+• **privateKey**: `Uint8Array`
+
+The private key.
+
+• **keyType**: [`KeyType`](../type-aliases/KeyType.md) = `KeyType.Ed25519`
+
+The key type.
+
+• **withZeroByte**: `boolean` = `true`
+
+Include a zero bute prefix.
+
+#### Returns
+
+`Uint8Array`
+
+The public key.

package/docs/reference/classes/Totp.md

@@ -0,0 +1,148 @@
+# Class: Totp
+
+Perform TOTP.
+Implementation of https://datatracker.ietf.org/doc/html/rfc4226 .
+
+## Constructors
+
+### new Totp()
+
+> **new Totp**(): [`Totp`](Totp.md)
+
+#### Returns
+
+[`Totp`](Totp.md)
+
+## Methods
+
+### generate()
+
+> `static` **generate**(`key`, `interval`, `timestamp`): `string`
+
+Generate a time based One Time Password.
+
+#### Parameters
+
+• **key**: `Uint8Array`
+
+Key for the one time password.
+
+• **interval**: `number` = `30`
+
+The time step of the counter.
+
+• **timestamp**: `number` = `...`
+
+The timestamp.
+
+#### Returns
+
+`string`
+
+The one time password.
+
+***
+
+### verify()
+
+> `static` **verify**(`token`, `key`, `window`, `interval`, `timestamp`): `undefined` \| `number`
+
+Check a One Time Password based on a timer.
+
+#### Parameters
+
+• **token**: `string`
+
+Passcode to validate.
+
+• **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`
+
+The allowable margin for the counter.
+
+• **interval**: `number` = `30`
+
+The time step of the counter.
+
+• **timestamp**: `number` = `...`
+
+The timestamp now.
+
+#### Returns
+
+`undefined` \| `number`
+
+Undefined if failure, delta on success
+
+***
+
+### generateSecret()
+
+> `static` **generateSecret**(`length`): `string`
+
+Generate a secret.
+
+#### Parameters
+
+• **length**: `number`
+
+The length of the secret to generate.
+
+#### Returns
+
+`string`
+
+The secret encoded as base32.
+
+***
+
+### secretToBytes()
+
+> `static` **secretToBytes**(`secretBase32`): `Uint8Array`
+
+Convert the secret back to bytes.
+
+#### Parameters
+
+• **secretBase32**: `string`
+
+The secret encoded as base32.
+
+#### Returns
+
+`Uint8Array`
+
+The bytes of the secret.
+
+***
+
+### generateAuthUrl()
+
+> `static` **generateAuthUrl**(`issuer`, `label`, `secretBase32`): `string`
+
+Generate a url for use with authenticator apps.
+See https://github.com/google/google-authenticator/wiki/Key-Uri-Format .
+
+#### Parameters
+
+• **issuer**: `string`
+
+The issuer of the totp.
+
+• **label**: `string`
+
+The label that will show in auth apps.
+
+• **secretBase32**: `string`
+
+The secret as base 32.
+
+#### Returns
+
+`string`
+
+The url.

package/docs/reference/classes/X25519.md

@@ -0,0 +1,57 @@
+# Class: X25519
+
+Implementation of X25519.
+
+## Constructors
+
+### new X25519()
+
+> **new X25519**(): [`X25519`](X25519.md)
+
+#### Returns
+
+[`X25519`](X25519.md)
+
+## Methods
+
+### convertPrivateKeyToX25519()
+
+> `static` **convertPrivateKeyToX25519**(`ed25519PrivateKey`): `Uint8Array`
+
+Convert Ed25519 private key to X25519 private key.
+
+#### Parameters
+
+• **ed25519PrivateKey**: `Uint8Array`
+
+The ed25519 private key to convert.
+
+#### Returns
+
+`Uint8Array`
+
+The x25519 private key.
+
+***
+
+### convertPublicKeyToX25519()
+
+> `static` **convertPublicKeyToX25519**(`ed25519PublicKey`): `Uint8Array`
+
+Convert Ed25519 public key to X25519 public key.
+
+#### Parameters
+
+• **ed25519PublicKey**: `Uint8Array`
+
+The ed25519 public key to convert.
+
+#### Returns
+
+`Uint8Array`
+
+The x25519 public key.
+
+#### Throws
+
+GeneralError On invalid public key.

package/docs/reference/classes/Zip215.md

@@ -0,0 +1,43 @@
+# Class: Zip215
+
+Implementation of Zip215.
+
+## Constructors
+
+### new Zip215()
+
+> **new Zip215**(): [`Zip215`](Zip215.md)
+
+#### Returns
+
+[`Zip215`](Zip215.md)
+
+## Methods
+
+### verify()
+
+> `static` **verify**(`publicKey`, `block`, `sig`): `boolean`
+
+Verify reports whether sig is a valid signature of block by
+publicKey, using precisely-specified validation criteria (ZIP 215) suitable
+for use in consensus-critical contexts.
+
+#### Parameters
+
+• **publicKey**: `Uint8Array`
+
+The public key for the block.
+
+• **block**: `Uint8Array`
+
+The block content to validate.
+
+• **sig**: `Uint8Array`
+
+The signature to verify.
+
+#### Returns
+
+`boolean`
+
+True if the signature is valid.

package/docs/reference/index.md

@@ -0,0 +1,34 @@
+# @twin.org/crypto
+
+## Classes
+
+- [Bech32](classes/Bech32.md)
+- [Bip44](classes/Bip44.md)
+- [ChaCha20Poly1305](classes/ChaCha20Poly1305.md)
+- [Ed25519](classes/Ed25519.md)
+- [Secp256k1](classes/Secp256k1.md)
+- [X25519](classes/X25519.md)
+- [Zip215](classes/Zip215.md)
+- [Blake2b](classes/Blake2b.md)
+- [HmacSha1](classes/HmacSha1.md)
+- [HmacSha256](classes/HmacSha256.md)
+- [HmacSha512](classes/HmacSha512.md)
+- [Pbkdf2](classes/Pbkdf2.md)
+- [Sha1](classes/Sha1.md)
+- [Sha256](classes/Sha256.md)
+- [Sha512](classes/Sha512.md)
+- [Bip32Path](classes/Bip32Path.md)
+- [Bip39](classes/Bip39.md)
+- [Slip0010](classes/Slip0010.md)
+- [Hotp](classes/Hotp.md)
+- [Totp](classes/Totp.md)
+- [PasswordGenerator](classes/PasswordGenerator.md)
+- [PasswordValidator](classes/PasswordValidator.md)
+
+## Type Aliases
+
+- [KeyType](type-aliases/KeyType.md)
+
+## Variables
+
+- [KeyType](variables/KeyType.md)

package/docs/reference/type-aliases/KeyType.md

@@ -0,0 +1,5 @@
+# Type Alias: KeyType
+
+> **KeyType**: *typeof* [`KeyType`](../variables/KeyType.md)\[keyof *typeof* [`KeyType`](../variables/KeyType.md)\]
+
+Key types.

package/docs/reference/variables/KeyType.md

@@ -0,0 +1,19 @@
+# Variable: KeyType
+
+> `const` **KeyType**: `object`
+
+The names of the key types.
+
+## Type declaration
+
+### Ed25519
+
+> `readonly` **Ed25519**: `0` = `0`
+
+Ed25519.
+
+### Secp256k1
+
+> `readonly` **Secp256k1**: `1` = `1`
+
+Secp256k1.

package/locales/en.json

@@ -0,0 +1,71 @@
+{
+	"error": {
+		"guard": {
+			"length32Multiple": "Property \"{property}\" should be a multiple of 32, it is {value}",
+			"lengthEntropy": "Property \"{property}\" should be a multiple of 4, >=16 and <= 32, it is {value}",
+			"length3Multiple": "Property \"{property}\" should be a multiple of 3, it is {value}",
+			"greaterThan0": "Property \"{property}\" must be greater than zero, it is {value}"
+		},
+		"bip39": {
+			"missingMnemonicWord": "The mnemonic contains a word not in the wordlist, \"{value}\"",
+			"checksumMismatch": "The checksum does not match \"{newChecksum}\" != \"{checksumBits}\""
+		},
+		"ed25519": {
+			"privateKeyLength": "The private key length is incorrect, it should be \"{requiredSize}\" but is \"{actualSize}\"",
+			"publicKeyLength": "The public key length is incorrect, it should be \"{requiredSize}\" but is \"{actualSize}\""
+		},
+		"secp256k1": {
+			"privateKeyLength": "The private key length is incorrect, it should be \"{requiredSize}\" but is \"{actualSize}\"",
+			"publicKeyLength": "The public key length is incorrect, it should be \"{requiredSize}\" but is \"{actualSize}\""
+		},
+		"x25519": {
+			"invalidPublicKey": "Invalid Ed25519 Public Key"
+		},
+		"blake2b": {
+			"outputLength64": "The output length should be between 1 and 64, it is \"{outputLength}\"",
+			"keyLength64": "The key length should be between 1 and 64, it is \"{keyLength}\""
+		},
+		"sha512": {
+			"bitSize": "Only 224, 256, 384 or 512 bits are supported, it is \"{bitSize}\""
+		},
+		"sha256": {
+			"bitSize": "Only 224 or 256 bits are supported, it is \"{bitSize}\""
+		},
+		"hmacSha256": {
+			"bitSize": "Only 224 or 256 bits are supported, it is \"{bitSize}\""
+		},
+		"hmacSha512": {
+			"bitSize": "Only 224, 256, 384 or 512 bits are supported, it is \"{bitSize}\""
+		},
+		"base32": {
+			"invalidCharacter": "Data contains a character \"{invalidCharacter}\" which is not in the charset"
+		},
+		"base64": {
+			"length4Multiple": "Invalid length should be a multiple of 4, it is \"{value}\""
+		},
+		"bech32": {
+			"decodeFailed": "The address contains decoding failed for address \"{bech32}\"",
+			"invalidChecksum": "The address contains an invalid checksum in address, \"{bech32}\"",
+			"separatorMisused": "The separator character '1' should only be used between hrp and data, \"{bech32}\"",
+			"lowerUpper": "The address my use either lowercase or uppercase, \"{bech32}\"",
+			"dataTooShort": "The address does not contain enough data to decode, \"{bech32}\""
+		},
+		"pbkdf2": {
+			"keyTooLong": "The requested key length \"{keyLength}\" is too long, based on the \"{macLength}\""
+		},
+		"chaCha20Poly1305": {
+			"noAadWithData": "You can not set the aad when there is already data",
+			"noAuthTag": "Can not finalise when the auth tag is not set",
+			"authenticationFailed": "The data could not be authenticated",
+			"authTagDecrypting": "Can not get the auth tag when decrypting",
+			"authTagEncrypting": "Can not set the auth tag when encrypting",
+			"noAuthTagSet": "The auth tag has not been set"
+		},
+		"bip44": {
+			"unsupportedKeyType": "The key type \"{keyType}\" is not supported"
+		},
+		"slip0010": {
+			"invalidSeed": "The seed is invalid \"{seed}\""
+		}
+	}
+}

package/package.json

@@ -0,0 +1,71 @@
+{
+	"name": "@twin.org/crypto",
+	"version": "0.0.1-next.1",
+	"description": "Contains helper methods and classes which implement cryptographic functions",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/framework.git",
+		"directory": "packages/crypto"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"scripts": {
+		"clean": "rimraf dist coverage docs/reference",
+		"build": "tspc",
+		"test": "vitest --run --config ./vitest.config.ts --no-cache",
+		"coverage": "vitest --run --coverage --config ./vitest.config.ts --no-cache",
+		"bundle:esm": "rollup --config rollup.config.mjs --environment MODULE:esm",
+		"bundle:cjs": "rollup --config rollup.config.mjs --environment MODULE:cjs",
+		"bundle": "npm run bundle:esm && npm run bundle:cjs",
+		"docs:clean": "rimraf docs/reference",
+		"docs:generate": "typedoc",
+		"docs": "npm run docs:clean && npm run docs:generate",
+		"dist": "npm run clean && npm run build && npm run test && npm run bundle && npm run docs"
+	},
+	"dependencies": {
+		"@twin.org/core": "0.0.1-next.1",
+		"@twin.org/nameof": "next",
+		"@noble/ciphers": "1.0.0",
+		"@noble/curves": "1.6.0",
+		"@noble/hashes": "1.5.0",
+		"@scure/base": "1.1.9",
+		"@scure/bip32": "1.5.0",
+		"@scure/bip39": "1.4.0",
+		"micro-key-producer": "0.7.0"
+	},
+	"devDependencies": {
+		"@twin.org/nameof-transformer": "next",
+		"@vitest/coverage-v8": "2.1.1",
+		"copyfiles": "2.4.1",
+		"rimraf": "6.0.1",
+		"rollup": "4.21.3",
+		"rollup-plugin-typescript2": "0.36.0",
+		"ts-patch": "3.2.1",
+		"typedoc": "0.26.7",
+		"typedoc-plugin-markdown": "4.2.7",
+		"typescript": "5.6.2",
+		"vitest": "2.1.1"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.mjs",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs",
+			"types": "./dist/types/index.d.ts"
+		},
+		"./locales": "./locales"
+	},
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"locales",
+		"docs"
+	]
+}