verifiablecredentials-crypto-sdk-typescript-protocols-common/dist/lib/IPayloadProtectionEncrypting.d.ts

Package with common classes for crypto protocols.

/// <reference types="node" />
import IPayloadProtectionOptions from './IPayloadProtectionOptions';
import { PublicKey } from 'verifiablecredentials-crypto-sdk-typescript-keys';
import { ICryptoToken } from './ICryptoToken';
/**
 * Interface defining the implementation of the selected protocol for encryption.
 */
export interface IPayloadProtectionEncrypting {
    /**
     * Encrypt content using the given public keys in JWK format.
     * The key type enforces the key encryption algorithm.
     * The options can override certain algorithm choices.
     *
     * @param recipients List of recipients' public keys.
     * @param payload to encrypt.
     * @param format of the final serialization.
     * @param options used for the signature. These options override the options provided in the constructor.
     * @returns JweToken with encrypted payload.
     */
    encrypt(recipients: PublicKey[], payload: Buffer, format: string, options?: IPayloadProtectionOptions): Promise<ICryptoToken>;
    /**
     * Decrypt the content.
     *
     * @param decryptionKeyReference Reference to the decryption key.
     * @param token The crypto token to decrypt.
     * @param options used for the decryption. These options override the options provided in the constructor.
     * @returns Decrypted payload.
     */
    decrypt(decryptionKeyReference: string, cipher: ICryptoToken, options?: IPayloadProtectionOptions): Promise<Buffer>;
}