Class ConfigFileKeySource

Encryption key source that retrieves keys from configuration files.

Uses cosmiconfig to locate configuration in standard locations:

mj.config.cjs (recommended)
mj.config.js
.mjrc.json
.mjrc.yaml

Keys are read from the encryptionKeys section of the configuration.

Example

// Configuration file (mj.config.cjs):
module.exports = {
  encryptionKeys: {
    pii_master: 'base64-encoded-key-here',
    financial_data: 'another-base64-key'
  }
};

// Usage (typically automatic via ClassFactory):
const source = new ConfigFileKeySource();
await source.Initialize(); // Load the config file

const key = await source.GetKey('pii_master');

Hierarchy (View Summary)

EncryptionKeySourceBase
- ConfigFileKeySource

Index

Constructors

constructor

new ConfigFileKeySource(config?: EncryptionKeySourceConfig): ConfigFileKeySource
Creates a new key source instance.

Note: The config may be empty/undefined when using ClassFactory. Configuration is typically loaded from the database and passed when retrieving keys.
Parameters
- Optionalconfig: EncryptionKeySourceConfig
  Optional configuration for the key source
Returns ConfigFileKeySource
Inherited from EncryptionKeySourceBase.constructor
- Defined in Encryption/src/EncryptionKeySourceBase.ts:94

Properties

`Protected`_config

_config: EncryptionKeySourceConfig

Configuration passed during instantiation. Contains lookupValue and any source-specific additional config.

Accessors

SourceName

get SourceName(): string
Human-readable name for this source.

Returns string
Overrides EncryptionKeySourceBase.SourceName
- Defined in Encryption/src/providers/ConfigFileKeySource.ts:114

Methods

Dispose

Dispose(): Promise<void>
Cleans up resources (no-op for config file source).

Returns Promise<void>
Overrides EncryptionKeySourceBase.Dispose
- Defined in Encryption/src/providers/ConfigFileKeySource.ts:383

GetKey

GetKey(lookupValue: string, keyVersion?: string): Promise<Buffer>
Retrieves key material from the configuration file.

Keys should be stored as base64-encoded strings in the encryptionKeys section of the configuration file.

For versioned keys, the version is appended with an underscore:
- key_name for version 1 (default)
- key_name_v2 for version 2
Parameters
- lookupValue: string
  The key name in the configuration
- OptionalkeyVersion: string
  Optional version number (defaults to '1')
Returns Promise<Buffer>
Promise resolving to the decoded key bytes
Throws
Error if Initialize() was not called

Throws
Error if the key is not found

Throws
Error if the value is not valid base64
Example
```
// Config file has: encryptionKeys: { pii_master: '...' }
const key = await source.GetKey('pii_master');

// For versioned keys during rotation:
// Config has: pii_master, pii_master_v2
const newKey = await source.GetKey('pii_master', '2');
```
Overrides EncryptionKeySourceBase.GetKey
- Defined in Encryption/src/providers/ConfigFileKeySource.ts:227

Initialize

Initialize(): Promise<void>
Initializes the key source by loading the configuration file.

Uses cosmiconfig to search for configuration in standard locations. Must be called before any key operations.

Returns Promise<void>
Throws
Error if cosmiconfig module cannot be loaded
Overrides EncryptionKeySourceBase.Initialize
- Defined in Encryption/src/providers/ConfigFileKeySource.ts:126

KeyExists

KeyExists(lookupValue: string): Promise<boolean>
Checks if a key exists in the configuration file.
Parameters
- lookupValue: string
  The key name to check
Returns Promise<boolean>
Promise resolving to true if the key exists
Overrides EncryptionKeySourceBase.KeyExists
- Defined in Encryption/src/providers/ConfigFileKeySource.ts:182

ValidateConfiguration

ValidateConfiguration(): boolean
Validates that the configuration file was loaded successfully.

Returns boolean
true if the config file was loaded and contains encryptionKeys
Overrides EncryptionKeySourceBase.ValidateConfiguration
- Defined in Encryption/src/providers/ConfigFileKeySource.ts:172

ValidateKeyAccessibility

ValidateKeyAccessibility(
    lookupValue: string,
    keyVersion?: string,
    expectedKeyLengthBytes?: number,
): Promise<KeyValidationResult>
Validates that the encryption key in the config file is accessible and usable.

Checks: config loaded, key exists, valid base64, and (if specified) correct length. Key material is decoded internally for validation only — never returned to the caller.
Parameters
- lookupValue: string
- OptionalkeyVersion: string
- OptionalexpectedKeyLengthBytes: number
Returns Promise<KeyValidationResult>
Overrides EncryptionKeySourceBase.ValidateKeyAccessibility
- Defined in Encryption/src/providers/ConfigFileKeySource.ts:310

Class ConfigFileKeySource

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ConfigFileKeySource

Properties

`Protected`_config

Accessors

SourceName

Returns string

Methods

Dispose

Returns Promise<void>

GetKey

Parameters

Returns Promise<Buffer>

Throws

Throws

Throws

Example

Initialize

Returns Promise<void>

Throws

KeyExists

Parameters

Returns Promise<boolean>

ValidateConfiguration

Returns boolean

ValidateKeyAccessibility

Parameters

Returns Promise<KeyValidationResult>

Settings

On This Page

Class ConfigFileKeySource

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ConfigFileKeySource

Properties

Protected_config

Accessors

SourceName

Returns string

Methods

Dispose

Returns Promise<void>

GetKey

Parameters

Returns Promise<Buffer>

Throws

Throws

Throws

Example

Initialize

Returns Promise<void>

Throws

KeyExists

Parameters

Returns Promise<boolean>

ValidateConfiguration

Returns boolean

ValidateKeyAccessibility

Parameters

Returns Promise<KeyValidationResult>

Settings

On This Page

`Protected`_config