File-src-minisql-tools-encryption-ml-391879592.md

src/minisql/tools/encryption.ml

Home · Files

Provides minisql tools encryption facilities for this project.

Package: minisql.tools.encryption

Reachable from entry: yes

Imports

• minisql/catalog/catalog.ml as catalog → src/minisql/catalog/catalog.ml
• minisql/catalog/schema_history.ml as schema_history → src/minisql/catalog/schema_history.ml
• minisql/common/uuid.ml as uuid → src/minisql/common/uuid.ml
• minisql/platform/file.ml as file_api → src/minisql/platform/file.ml
• minisql/platform/lock.ml as file_lock → src/minisql/platform/lock.ml
• minisql/security/key_provider.ml as key_provider → src/minisql/security/key_provider.ml
• minisql/server/database_manager.ml as database_manager → src/minisql/server/database_manager.ml
• minisql/storage/paged_file.ml as paged_file → src/minisql/storage/paged_file.ml

Declarations

addIfExists

function addIfExists(paths, path)

Adds one existing physical artifact to a migration plan.

Parameter	Type	Default	Description
paths	dynamic	—	paths value consumed by this operation.
path	dynamic	—	Path of the file or directory used by the operation.

View source

componentName

function componentName()

Returns the stable component name.

View source

contains

function contains(values, wanted)

Tests integer membership in a bounded metadata array.

Parameter	Type	Default	Description
values	dynamic	—	values value consumed by this operation.
wanted	dynamic	—	wanted value consumed by this operation.

View source

enable

function enable(databasePath, keyFilePath)

Enables resumable TDE migration. Mixed plaintext/encrypted files are valid during conversion because every superblock carries its own feature bit. Enables or resumes offline TDE migration for one database.

Parameter	Type	Default	Description
databasePath	dynamic	—	Path associated with database.
keyFilePath	dynamic	—	Path associated with key file.

View source

fail

function fail(operation, message)

Creates a structured encryption-administration error.

Parameter	Type	Default	Description
operation	dynamic	—	operation value consumed by this operation.
message	dynamic	—	Human-readable message associated with the operation.

View source

generateKeyFile

function generateKeyFile(path)

Creates a durable new raw 256-bit provider key.

Parameter	Type	Default	Description
path	dynamic	—	Path of the file or directory used by the operation.

View source

indexIds

function indexIds(state)

Collects unique physical index identifiers from schema constraints.

Parameter	Type	Default	Description
state	dynamic	—	Mutable state inspected or updated by the operation.

View source

INVALID_ARGUMENT

const INVALID_ARGUMENT = 9001

Defines the invalid argument constant used by the minisql tools encryption module.

View source

isImplemented

function isImplemented()

Returns whether implemented satisfies the condition required by the minisql tools encryption module.

View source

releaseMigrationLock

function releaseMigrationLock(lockToken, lockFile)

Releases the migration's process-visible database lock and owning handle.

Parameter	Type	Default	Description
lockToken	dynamic	—	lockToken value consumed by this operation.
lockFile	dynamic	—	lockFile value consumed by this operation.

View source

rotate

function rotate(databasePath, newKeyFilePath)

Rewraps the database DEK under a new external KEK.

Parameter	Type	Default	Description
databasePath	dynamic	—	Path associated with database.
newKeyFilePath	dynamic	—	Path associated with new key file.

View source

targetMilestone

function targetMilestone()

Returns the milestone introducing this component.

View source