Member Junction
    Preparing search index...

    Interface KeyValidationResult

    Result of validating whether a specific encryption key's material is accessible.

    Returned by EncryptionKeySourceBase.ValidateKeyAccessibility. Each key source provider generates source-specific error messages with actionable remediation steps, keeping that knowledge encapsulated within the provider rather than in the engine.

    interface KeyValidationResult {
        Error?: string;
        IsAccessible: boolean;
    }
    Index

    Properties

    Error? IsAccessible

    Properties

    Error?: string

    Human-readable error with source-specific remediation steps. Only present when IsAccessible is false.

    Examples:

    • EnvVar: 'Environment variable "MJ_BASE_ENCRYPTION_KEY" is not set. Set it with: export MJ_BASE_ENCRYPTION_KEY=$(openssl rand -base64 32)'
    • ConfigFile: 'Key "pii_master" not found in mj.config.cjs. Add it to the "encryptionKeys" section.'
    • AWS KMS: 'AWS KMS access denied. Ensure kms:Decrypt permission is granted.'
    • Azure: 'Azure Key Vault secret not accessible. Check vault URL and credentials.'
    IsAccessible: boolean

    Whether the key material was successfully accessed and validated

    Settings

    Member Visibility

    On This Page

    Properties