@ndn/packet/lib/security/encryption.d.ts

NDNts: Network Layer Packets

import type { Data } from "../data.js";
/** Low level encryption function. */
export type LLEncrypt = (params: LLEncrypt.Params) => Promise<LLEncrypt.Result>;
export declare namespace LLEncrypt {
    /** Input of LLEncrypt function. */
    interface Params {
        plaintext: Uint8Array;
        iv?: Uint8Array;
        additionalData?: Uint8Array;
    }
    /** Output of LLEncrypt function. */
    interface Result {
        ciphertext: Uint8Array;
        iv?: Uint8Array;
        authenticationTag?: Uint8Array;
    }
    /** Object that provides LLEncrypt function, such as secret key. */
    interface Key {
        readonly llEncrypt: LLEncrypt;
    }
}
/** Low level decryption function. */
export type LLDecrypt = (params: LLDecrypt.Params) => Promise<LLDecrypt.Result>;
export declare namespace LLDecrypt {
    /** Input of LLDecrypt function. */
    interface Params {
        ciphertext: Uint8Array;
        iv?: Uint8Array;
        authenticationTag?: Uint8Array;
        additionalData?: Uint8Array;
    }
    /** Output of LLDecrypt function. */
    interface Result {
        plaintext: Uint8Array;
    }
    /** Object that provides LLDecrypt function, such as secret key. */
    interface Key {
        readonly llDecrypt: LLDecrypt;
    }
}
/**
 * High level encrypter.
 *
 * @remarks
 * This captures both the encryption key and the wire format of encrypted content.
 */
export interface Encrypter<T = Data> {
    /**
     * Encrypt a packet.
     * The packet is modified in-place.
     */
    encrypt: (pkt: T) => Promise<void>;
}
/**
 * High level decrypter.
 *
 * @remarks
 * This captures both the decryption key and the wire format of encrypted content.
 */
export interface Decrypter<T = Data> {
    /**
     * Decrypt a packet.
     * The packet is modified in-place.
     */
    decrypt: (pkt: T) => Promise<void>;
}
/** Encrypter and decrypter that do nothing. */
export declare const noopEncryption: Encrypter<any> & Decrypter<any>;