Class Keychain

constructor

• new Keychain(
      key?: string | Uint8Array<ArrayBufferLike>,
      salt?: string | Uint8Array<ArrayBufferLike>,
  ): Keychain

  Parameters

  • Optionalkey: string | Uint8Array<ArrayBufferLike>
  • Optionalsalt: string | Uint8Array<ArrayBufferLike>

  Returns Keychain

authTokenPromise

key

mainKeyPromise

metaKeyPromise

salt

keyB64

• get keyB64(): string

  Get the main key as a base64url encoded string

  Returns string

saltB64

• get saltB64(): string

  Get the salt as base64 string

  Returns string

authHeader

• authHeader(tokenString?: string): Promise<string>

  Get a header string: Bearer sync-v1 ${authTokenB64}. Pass in a token, or else this will use the authToken derived from the main key.

  Parameters

  • OptionaltokenString: string

  Returns Promise<string>

authToken

• authToken(): Promise<Uint8Array<ArrayBufferLike>>

  get a promise for the auth token.

  Returns Promise<Uint8Array<ArrayBufferLike>>

authTokenB64

• authTokenB64(): Promise<string>

  Get the auth token as a base64 string

  Returns Promise<string>

decryptBytes

• decryptBytes(bytes: Uint8Array): Promise<ArrayBuffer>

  Decrypt in memory, not streaming.

  Parameters

  • bytes: Uint8Array

  Returns Promise<ArrayBuffer>

decryptMeta

• decryptMeta(ivEncryptedMeta: Uint8Array): Promise<Uint8Array<ArrayBufferLike>>

  Parameters

  • ivEncryptedMeta: Uint8Array

  Returns Promise<Uint8Array<ArrayBufferLike>>

decryptStream

• decryptStream(
      encryptedStream: ReadableStream<Uint8Array<ArrayBufferLike>>,
  ): Promise<ReadableStream<Uint8Array<ArrayBufferLike>>>

  Take an encrypted stream, return a decrypted stream.

  Parameters

  • encryptedStream: ReadableStream<Uint8Array<ArrayBufferLike>>

    The input (encrypted) stream

  Returns Promise<ReadableStream<Uint8Array<ArrayBufferLike>>>

  The decrypted stream

decryptStreamRange

• decryptStreamRange(
      offset: number,
      length: number,
      totalEncryptedLength: number,
  ): Promise<
      {
          decrypt: (streams: ReadableStream<any>[]) => ReadableStream;
          ranges: { length: number; offset: number }[];
      },
  >

  Returns an object containing ranges, an array of objects containing offset and length integers specifying the encrypted byte ranges that are needed to decrypt the client's specified range, and a decrypt function.

  Parameters

  • offset: number

    Integer
  • length: number

    Integer
  • totalEncryptedLength: number

    Integer

  Returns Promise<
      {
          decrypt: (streams: ReadableStream<any>[]) => ReadableStream;
          ranges: { length: number; offset: number }[];
      },
  >

encryptBytes

• encryptBytes(
      bytes: ArrayBuffer | Uint8Array<ArrayBufferLike>,
      opts?: { iv?: Uint8Array<ArrayBufferLike>; size?: number },
  ): Promise<Uint8Array<ArrayBufferLike>>

  Encrypt and return some data; don't stream.

  NOTE: This generates a new key each time it is called, via this.generateKey.

  Parameters

  • bytes: ArrayBuffer | Uint8Array<ArrayBufferLike>
  • Optionalopts: { iv?: Uint8Array<ArrayBufferLike>; size?: number }

    Optional params, iv and size. If size is omitted, default is 16 bytes. iv is a random 12 bits, will be generated if not passed in.

  Returns Promise<Uint8Array<ArrayBufferLike>>

encryptMeta

• encryptMeta(meta: Uint8Array): Promise<Uint8Array<ArrayBufferLike>>

  Parameters

  • meta: Uint8Array

  Returns Promise<Uint8Array<ArrayBufferLike>>

encryptStream

• encryptStream(
      stream: ReadableStream<Uint8Array<ArrayBufferLike>>,
  ): Promise<ReadableStream<Uint8Array<ArrayBufferLike>>>

  Take a stream, return an encrypted stream.

  Parameters

  • stream: ReadableStream<Uint8Array<ArrayBufferLike>>

    Input stream

  Returns Promise<ReadableStream<Uint8Array<ArrayBufferLike>>>

generateKey

• generateKey(keyLength?: number): Promise<CryptoKey>

  Derive a new AES-GCM key from the main key.

  Parameters

  • OptionalkeyLength: number

    Optional size for the key, in bytes, eg, 16 or 32.

  Returns Promise<CryptoKey>

setAuthToken

• setAuthToken(authToken?: string | Uint8Array<ArrayBufferLike>): void

  Set the auth token

  Parameters

  • OptionalauthToken: string | Uint8Array<ArrayBufferLike>

    The new token

  Returns void

StaticAuthHeader

• AuthHeader(
      secretKey: string,
      salt: string | Uint8Array<ArrayBufferLike>,
  ): Promise<string>

  Get an authentication header as a static method.

  Parameters

  • secretKey: string
  • salt: string | Uint8Array<ArrayBufferLike>

  Returns Promise<string>

StaticHeader

• Header(writeToken: string): string

  Parameters

  • writeToken: string

  Returns string