Class UnifiedCrypto

ed25519KeyPair

enigma

masterSeed

rsaKeyPair

StaticsupportedPQCAlgorithms

decrypt

• decrypt(encryptedObject): Promise<Uint8Array<ArrayBufferLike>>

• Decrypts an encrypted object based on the algorithm

  Parameters

  • encryptedObject: encryptedObject

    The encrypted object to decrypt

  Returns Promise<Uint8Array<ArrayBufferLike>>

  The decrypted data

deriveSeed

• deriveSeed(algorithm, seed?): Promise<Uint8Array<ArrayBufferLike>>

• Derives a seed for the given algorithm

  Parameters

  • algorithm:
        | "falcon"
        | "ml-dsa"
        | "ed25519"
        | "ml-kem-aes"
        | "rsa"

    The algorithm to derive the seed for
  • Optionalseed: Uint8Array<ArrayBufferLike>

    (optional) The seed to derive the seed from, or undefined to generate a new one or use the master seed if set

  Returns Promise<Uint8Array<ArrayBufferLike>>

  The derived seed

encrypt

• encrypt(algorithm, data, peerPublicKey): Promise<encryptedObject>

• Encrypts a message based on the algorithm using the previously generated identity

  Parameters

  • algorithm: "ml-kem-aes" | "rsa"

    The algorithm to encrypt the message with
  • data: Uint8Array<ArrayBufferLike>

    The message to encrypt
  • peerPublicKey: Uint8Array<ArrayBufferLike>

    The public key of the peer to encrypt the message to

  Returns Promise<encryptedObject>

  The encrypted object as an encryptedObject

ensureSeed

• ensureSeed(masterSeed?): Promise<void>

• Ensures that the master seed is set and generates a new one if not set

  Parameters

  • OptionalmasterSeed: Uint8Array<ArrayBufferLike>

    (optional) The master seed to set, or undefined to generate a new one

  Returns Promise<void>

generateAllIdentities

• generateAllIdentities(masterSeed?): Promise<void>

• Parameters

  • OptionalmasterSeed: Uint8Array<ArrayBufferLike>

  Returns Promise<void>

generateIdentity

• generateIdentity(algorithm, masterSeed?): Promise<void>

• Parameters

  • algorithm:
        | "falcon"
        | "ml-dsa"
        | "ed25519"
        | "ml-kem-aes"
        | "rsa"
  • OptionalmasterSeed: Uint8Array<ArrayBufferLike>

  Returns Promise<void>

getId

• getId(): string

• Returns string

getIdentity

• getIdentity(algorithm): Promise<{
      genKey?: Uint8Array<ArrayBufferLike>;
      privateKey: NativeBuffer | Uint8Array<ArrayBufferLike> | PrivateKey;
      publicKey: PublicKey | NativeBuffer | Uint8Array<ArrayBufferLike>;
  }>

• Parameters

  • algorithm:
        | "falcon"
        | "ml-dsa"
        | "ed25519"
        | "ml-kem-aes"
        | "rsa"

  Returns Promise<{
      genKey?: Uint8Array<ArrayBufferLike>;
      privateKey: NativeBuffer | Uint8Array<ArrayBufferLike> | PrivateKey;
      publicKey: PublicKey | NativeBuffer | Uint8Array<ArrayBufferLike>;
  }>

sign

• sign(algorithm, data): Promise<signedObject>

• Signs a message based on the algorithm using the previously generated identity

  Parameters

  • algorithm: "falcon" | "ml-dsa" | "ed25519"

    The algorithm to sign the message with
  • data: Uint8Array<ArrayBufferLike>

    The message to sign

  Returns Promise<signedObject>

  The signed object as a signedObject

verify

• verify(signedObject): Promise<boolean>

• Verifies a signed object based on the algorithm

  Parameters

  • signedObject: signedObject

    The signed object to verify

  Returns Promise<boolean>

  True if the signed object is valid, false otherwise

  Throws

  Error if publicKey is not in the expected format for the algorithm

StaticgetInstance

• getInstance(instanceId?, masterSeed?): UnifiedCrypto

• Parameters

  • OptionalinstanceId: string
  • OptionalmasterSeed: Uint8Array<ArrayBufferLike>

  Returns UnifiedCrypto

StaticgetInstanceIds

• getInstanceIds(): string[]

• Returns string[]

StaticremoveInstance

• removeInstance(instanceId): boolean

• Parameters

  • instanceId: string

  Returns boolean