Class EccKeys

constructor

• new EccKeys(opts: KeyArgs): EccKeys

  Parameters

  • opts: KeyArgs

  Returns EccKeys

StaticEXCHANGE_KEY_NAME

StaticINFO

StaticTYPE

StaticWRITE_KEY_NAME

publicExchangeKey

• get publicExchangeKey(): CryptoKey & {
      asString: (format?: SupportedEncodings) => Promise<string>;
  }

  Returns CryptoKey & { asString: (format?: SupportedEncodings) => Promise<string> }

publicWriteKey

• get publicWriteKey(): CryptoKey & {
      asString: (format?: SupportedEncodings) => Promise<string>;
  }

  Returns CryptoKey & { asString: (format?: SupportedEncodings) => Promise<string> }

decrypt

• decrypt(
      msg: string | ArrayBuffer | Uint8Array<ArrayBufferLike>,
      publicKey?: string | CryptoKey,
      aesAlgorithm?: string,
      info?: string,
  ): Promise<ArrayBuffer | Uint8Array<ArrayBufferLike>>

  Decrypt the given message. The encrypted message should be salt + iv + cipher text.

  Parameters

  • msg: string | ArrayBuffer | Uint8Array<ArrayBufferLike>

    The encrypted content
  • OptionalpublicKey: string | CryptoKey

    The public key used to generate the AES key used on this message. If omitted, decrypt with our own public key.
  • OptionalaesAlgorithm: string
  • Optionalinfo: string

  Returns Promise<ArrayBuffer | Uint8Array<ArrayBufferLike>>

  The decrypted content.

decryptAsString

• decryptAsString(
      msg: string | ArrayBuffer | Uint8Array<ArrayBufferLike>,
      publicKey?: string | CryptoKey,
      aesAlgorithm?: string,
      info?: string,
  ): Promise<string>

  Decrypt and return as string.

  Parameters

  • msg: string | ArrayBuffer | Uint8Array<ArrayBufferLike>
  • OptionalpublicKey: string | CryptoKey
  • OptionalaesAlgorithm: string
  • Optionalinfo: string

  Returns Promise<string>

encrypt

• encrypt(
      content: string | Uint8Array<ArrayBufferLike>,
      recipient?: string | CryptoKey,
      info?: string,
      aesKey?: string | Uint8Array<ArrayBufferLike> | CryptoKey,
      keysize?: SymmKeyLength,
  ): Promise<Uint8Array<ArrayBufferLike>>

  Encrypt the given content to the given public key, or encrypt to our public key if it is not passed in.

  Parameters

  • content: string | Uint8Array<ArrayBufferLike>

    Content to encrypt
  • Optionalrecipient: string | CryptoKey

    Their public key. Optional b/c we will use our own public key if not passed in.
  • Optionalinfo: string

    info tag for HKDF. Default is the class property.
  • OptionalaesKey: string | Uint8Array<ArrayBufferLike> | CryptoKey

    This is not relevant for most use cases.
  • Optionalkeysize: SymmKeyLength

    Default is 256

  Returns Promise<Uint8Array<ArrayBufferLike>>

  Buffer of salt + iv + cipher text

encryptAsString

• encryptAsString(
      content: string | Uint8Array<ArrayBufferLike>,
      recipient?: string | CryptoKey,
      info?: string,
      aesKey?: string | Uint8Array<ArrayBufferLike> | CryptoKey,
      keysize?: SymmKeyLength,
  ): Promise<string>

  Encrypt and return as base64 string.

  Parameters

  • content: string | Uint8Array<ArrayBufferLike>
  • Optionalrecipient: string | CryptoKey
  • Optionalinfo: string
  • OptionalaesKey: string | Uint8Array<ArrayBufferLike> | CryptoKey
  • Optionalkeysize: SymmKeyLength

  Returns Promise<string>

getAesKey

• getAesKey(
      publicKey?: null | string | CryptoKey,
      info?: null | string,
  ): Promise<CryptoKey>

  Do DHKE, create a new AES-GCM key.

  Parameters

  • OptionalpublicKey: null | string | CryptoKey

    Public key to use in DHKE. Will use our public key if it is not passed in.
  • Optionalinfo: null | string

    The info parameter for DHKE. Will use the class property INFO if it is not passed in.

  Returns Promise<CryptoKey>

  New AES key

sign

• sign(msg: Msg, _charsize?: CharSize): Promise<Uint8Array<ArrayBufferLike>>

  Sign the given content using our private write key.

  Parameters

  • msg: Msg
  • Optional_charsize: CharSize

  Returns Promise<Uint8Array<ArrayBufferLike>>

signAsString

• signAsString(msg: string, _charsize?: CharSize): Promise<string>

  Sign the given content and return as base64 string.

  Parameters

  • msg: string
  • Optional_charsize: CharSize

  Returns Promise<string>

toJson

• toJson(
      format?: SupportedEncodings,
  ): Promise<{ DID: `did:key:z${string}`; publicExchangeKey: string }>

  Serialize this keys instance. Will return an object of { DID, publicExchangeKey }, where DID is the public write key, and publicExchangeKey is the encryption key, base64 encoded.

  Parameters

  • Optionalformat: SupportedEncodings

  Returns Promise<{ DID: `did:key:z${string}`; publicExchangeKey: string }>

Static_createExchangeKeys

• _createExchangeKeys(): Promise<CryptoKeyPair>

  Returns Promise<CryptoKeyPair>

Static_createWriteKeys

• _createWriteKeys(): Promise<CryptoKeyPair>

  Returns Promise<CryptoKeyPair>

Staticload

• load<T extends EccKeys = EccKeys>(
      this: typeof EccKeys,
      opts?: Partial<
          { encryptionKeyName: string; session: boolean; signingKeyName: string },
      >,
  ): Promise<T>

  Restore some keys from indexedDB, or create a new keypair if it doesn't exist yet. Overrides base class to use ECC-specific key names.

  Type Parameters

  • T extends EccKeys = EccKeys

  Parameters

  • this: typeof EccKeys
  • opts: Partial<{ encryptionKeyName: string; session: boolean; signingKeyName: string }> = ...

  Returns Promise<T>