Member Junction
    Preparing search index...

    Interface KeyConfigurationInternal

    Complete key configuration loaded from the database.

    This structure contains everything needed to perform encryption or decryption operations, cached for performance.

    Used by EncryptionEngine for key management

    interface KeyConfiguration {
        algorithm: {
            isAEAD: boolean;
            ivLengthBytes: number;
            keyLengthBits: number;
            name: string;
            nodeCryptoName: string;
        };
        keyId: string;
        keyVersion: string;
        marker: string;
        source: { driverClass: string; lookupValue: string };
    }
    Index

    Properties

    algorithm keyId keyVersion marker source

    Properties

    algorithm: {
        isAEAD: boolean;
        ivLengthBytes: number;
        keyLengthBits: number;
        name: string;
        nodeCryptoName: string;
    }

    Algorithm configuration

    Type Declaration

    • isAEAD: boolean

      Whether the algorithm provides Authenticated Encryption with Associated Data. AEAD algorithms (like AES-GCM) provide both confidentiality and integrity.

    • ivLengthBytes: number

      Required IV length in bytes (e.g., 12 for GCM, 16 for CBC)

    • keyLengthBits: number

      Required key length in bits (e.g., 256 for AES-256)

    • name: string

      Display name of the algorithm (e.g., 'AES-256-GCM')

    • nodeCryptoName: string

      Node.js crypto module algorithm identifier (e.g., 'aes-256-gcm')

    keyId: string

    The encryption key's unique identifier (UUID)

    keyVersion: string

    Current version of the key for this configuration. Incremented during key rotation operations.

    marker: string

    Prefix marker for encrypted values. Defaults to '$ENC$' but can be customized per key.

    source: { driverClass: string; lookupValue: string }

    Key source configuration for retrieving key material

    Type Declaration

    • driverClass: string

      The registered class name of the key source provider. Used with ClassFactory to instantiate the provider.

    • lookupValue: string

      The lookup value passed to the key source. Interpretation depends on the source type.

    Settings

    Member Visibility

    On This Page

    Properties