Class Keys

constructor

• new Keys(opts: ConstructorOpts): Keys

• Parameters

  • opts: ConstructorOpts

  Returns Keys

DID

ENCRYPTION_KEY_NAME

SIGNING_KEY_NAME

privateKey

• get privateKey(): CryptoKey

• Returns CryptoKey

publicEncryptKey

• get publicEncryptKey(): CryptoKey

• Returns CryptoKey

publicSignKey

• get publicSignKey(): CryptoKey

• Returns CryptoKey

decrypt

• decrypt(msg: EncryptedMessage): Promise<Uint8Array<ArrayBufferLike>>

• Parameters

  • msg: EncryptedMessage

  Returns Promise<Uint8Array<ArrayBufferLike>>

decryptKey

• decryptKey(
      key: string | Uint8Array<ArrayBufferLike>,
  ): Promise<Uint8Array<ArrayBufferLike>>

• Parameters

  • key: string | Uint8Array<ArrayBufferLike>

  Returns Promise<Uint8Array<ArrayBufferLike>>

decryptKeyAsString

• decryptKeyAsString(msg: string | Uint8Array<ArrayBufferLike>): Promise<string>

• Parameters

  • msg: string | Uint8Array<ArrayBufferLike>

  Returns Promise<string>

decryptToString

• decryptToString(msg: EncryptedMessage): Promise<string>

• Parameters

  • msg: EncryptedMessage

  Returns Promise<string>

getDeviceName

• getDeviceName(): Promise<string>

• Returns Promise<string>

getPublicEncryptKey

• getPublicEncryptKey(): Promise<string>

• Get the public encryption key as a string.

  Returns Promise<string>

  Return a string b/c mostly would use this for serializing the public encryption key.

persist

• persist(): Promise<void>

• Returns Promise<void>

sign

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

• Sign a string. Return the signature as Uint8Array.

  Parameters

  • msg: Msg

    The message to sign
  • Optionalcharsize: CharSize

  Returns Promise<Uint8Array<ArrayBufferLike>>

  The signature

signAsString

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

• Parameters

  • msg: Msg
  • Optionalcharsize: CharSize

  Returns Promise<string>

Staticcreate

• create(): Promise<Keys>

• Returns Promise<Keys>

StaticdeviceName

• deviceName(did: `did:key:z${string}`): Promise<string>

• Return a 32-character, DNS-friendly hash of the given DID.

  Parameters

  • did: `did:key:z${string}`

    a DID format string

  Returns Promise<string>

  32 character, base32 hash of the DID

Staticload

• load(opts?: { encryptionKeyName: any; signingKeyName: any }): Promise<Keys>

• Restore some keys from indexedDB.

  Parameters

  • opts: { encryptionKeyName: any; signingKeyName: any } = ...

    Strings to use as keys in indexedDB.

  Returns Promise<Keys>