Skip to content

A fully open source & end-to-end encrypted note taking alternative to Evernote.

2.3 KB
Raw Blame
/*
This file is part of the Notesnook project (https://notesnook.com/)

Copyright (C) 2023 Streetwriters (Private) Limited

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

import {
  Cipher,
  EncryptionKey,
  DataFormat,
  SerializedKey,
  Chunk,
  Output,
  Input,
  EncryptionKeyPair,
  SerializedKeyPair
} from "./types.js";

export interface IStreamable {
  read(): Promise<Chunk | undefined>;
  write(chunk: Chunk | undefined): Promise<void>;
}

export interface INNCrypto {
  encrypt<TOutputFormat extends DataFormat>(
    key: SerializedKey,
    data: Input<DataFormat>,
    format: DataFormat,
    outputFormat?: TOutputFormat
  ): Promise<Cipher<TOutputFormat>>;

  encryptMulti<TOutputFormat extends DataFormat>(
    key: SerializedKey,
    data: Input<DataFormat>[],
    format: DataFormat,
    outputFormat?: TOutputFormat
  ): Promise<Cipher<TOutputFormat>[]>;

  decrypt<TOutputFormat extends DataFormat>(
    key: SerializedKey,
    cipherData: Cipher<DataFormat>,
    outputFormat?: TOutputFormat
  ): Promise<Output<TOutputFormat>>;

  decryptMulti<TOutputFormat extends DataFormat>(
    key: SerializedKey,
    cipherData: Cipher<DataFormat>[],
    outputFormat?: TOutputFormat
  ): Promise<Output<TOutputFormat>[]>;

  hash(password: string, salt: string): Promise<string>;

  deriveKey(password: string, salt?: string): Promise<EncryptionKey>;

  deriveKeyPair(): Promise<EncryptionKeyPair>;

  exportKey(password: string, salt?: string): Promise<SerializedKey>;

  exportKeyPair(): Promise<SerializedKeyPair>;

  createEncryptionStream(
    key: SerializedKey
  ): Promise<{ iv: string; stream: TransformStream<Chunk, Uint8Array> }>;

  createDecryptionStream(
    key: SerializedKey,
    iv: string
  ): Promise<TransformStream<Uint8Array, Uint8Array>>;
}