ssmixtools.decryption package

Data decryption utilities for ssmixtools.

This module provides:

  • decrypt(): Decrypts the extracted data by ssmixtools.extraction.

ssmixtools.decryption.decrypt(source_dir: str, output_dir: str, private_key_path: str, max_workers: int | None = None) → None[source]

Top-Level Module for Decrypting Clinical Records

This module decrypts clinical records extracted using ssmixtools.extraction.extract(). The encrypted data is processed using a hybrid cryptosystem (AES + RSA) to ensure secure handling and decryption.

Note

  • Private Key Requirement: The RSA private key used for decryption must match the public key used during encryption.

  • Input Directory Structure: The source_dir must contain files encrypted using`ssmixtools.extraction.extract`.

Parameters:

  • source_dir (str) – Absolute path to the directory containing encrypted files.

  • output_dir (str) – Absolute path to the directory for saving decrypted files.

  • private_key_path (str) – Path to the RSA private key used for decryption.

  • max_workers (int, optional) – Maximum number of parallel workers for decryption. Defaults to the number of physical CPU cores minus 1.

Returns:

This function saves decrypted files to the specified output directory.

Return type:

None

Workflow

  1. Initialization:

    • Verifies input paths and prepares temporary storage for decryption.

  2. Decryption:

    • Decrypts encrypted files using the specified private key.

    • Organizes decrypted files by identity tags.

  3. Finalization:

    • Validates and prepares decrypted files for downstream processes.

Example Usage

Decrypt files using the decrypt function:

import ssmixtools

def main():
    ssmixtools.decryption.decrypt(
        source_dir="/path/to/extracted/binary/files",
        output_dir="/directory/for/saving/decrypted/files",
        private_key_path="/path/to/your/private/key",
        max_workers=None,
    )

if __name__ == "__main__":
    main()

Decrypted Records

The decrypted files are organized into subdirectories based on identity tags. For example, if the data is extracted from two storages with identity tags UT and UK, the output directory structure will look like this:

output_dir
├── UT
│   ├── patient_id_UT.csv
│   ├── DOB_UT.csv
│   ├── patient_metadata_UT.csv
│   ├── ADT-12_0_UT.csv
│   └── ...
└── UK
    ├── patient_id_UK.csv
    ├── ...
    └── OML-11_35_UK.csv

Post-Decryption