@bryopsida/crypto/lib/crypto.d.ts

A crypto library utilizing @bryopsida/key-store to protect data using data encryption keys

/// <reference types="node" />
/// <reference types="node" />
import { Stream } from 'stream';
import { IUsableClosable } from './using.js';
import { IKeyStore } from '@bryopsida/key-store';
export type Data = string | Buffer;
export type DataOrStream = Data | Stream;
export interface KeyOpts {
    keyId: string;
    rootKeyId: string;
    dekContext?: string;
    rootKeyContext?: string;
}
export interface CipherText extends KeyOpts {
    ciphertext: DataOrStream;
    iv: Buffer;
    authTag?: Buffer;
    algorithm: string;
    context?: string;
}
export interface EncryptOpts extends KeyOpts {
    plaintext: DataOrStream;
    keyId: string;
    iv?: Buffer;
    algorithm?: string;
    context?: Buffer;
}
export type DecryptOpts = CipherText;
export interface SealedKey {
    keyId: string;
    rootKeyId?: string;
    iv: Buffer;
    authTag?: Buffer;
    keyCipherText: Buffer;
}
export interface IDataEncryptor {
    generateRootKey(size: number, context: string | undefined): Promise<string>;
    generateDataEncKey(size: number, rootKeyId: string, rootKeyContext: string | undefined, context: string | undefined): Promise<string>;
    hasDataEncKey(keyId: string): Promise<boolean>;
    hasRootKey(rootKeyId: string): Promise<boolean>;
    validate(keyOpts: KeyOpts, message: Buffer, digest: Buffer): Promise<boolean>;
    mac(keyOpts: KeyOpts, message: Buffer): Promise<Buffer>;
    destroyDataEncKey(keyId: string): Promise<void>;
    destroyRootKey(rootKeyId: string): Promise<void>;
    encrypt(encryptRequest: EncryptOpts): Promise<CipherText>;
    decrypt(decryptOpts: DecryptOpts): Promise<Buffer | Stream | string>;
    encodeCipherText(cipherTxt: CipherText): Promise<string>;
    encryptAndEncode(encryptOpts: EncryptOpts): Promise<string>;
    decryptEncoded(encodedCipherText: string, rootKeyContext: string, dekContext: string, context: string): Promise<Buffer>;
}
export declare class Crypto implements IDataEncryptor, IUsableClosable {
    private readonly masterKeyPath;
    private readonly masterKeyContext;
    private readonly keyStore;
    constructor(keyStore: IKeyStore, masterKeyPath: string, masterKeyContext: string);
    encodeCipherText(cipherTxt: CipherText): Promise<string>;
    encryptAndEncode(encryptOpts: EncryptOpts): Promise<string>;
    decryptEncoded(encodedCipherText: string, rootKeyContext: string, dekContext: string, context: string): Promise<Buffer>;
    private readFileFromPath;
    private unsealRootKey;
    private unsealDekKey;
    private seal;
    private saveSealedKey;
    private saveSealedRootKey;
    generateRootKey(size: number, context: string | undefined): Promise<string>;
    generateDataEncKey(size: number, rootKeyId: string, rootKeyContext: string | undefined, dekContext: string | undefined): Promise<string>;
    destroyDataEncKey(keyId: string): Promise<void>;
    destroyRootKey(rootKeyId: string): Promise<void>;
    encrypt(encryptRequest: EncryptOpts): Promise<CipherText>;
    decrypt(decryptOpts: CipherText): Promise<string | Buffer | Stream>;
    close(): Promise<void>;
    hasDataEncKey(keyId: string): Promise<boolean>;
    hasRootKey(rootKeyId: string): Promise<boolean>;
    mac(keyOpts: KeyOpts, message: Buffer): Promise<Buffer>;
    validate(opts: KeyOpts, message: Buffer, digest: Buffer): Promise<boolean>;
}