encryption_support.hpp

1. Overview

The encryption_support.hpp file implements higher-level detection and unlock workflows for encrypted recovery targets.

This is an interface and data-contract file. It declares the public and internal types used by this subsystem, allowing implementation files and callers to share a stable compile-time contract.

Its paired source or interface file is encryption_support.cpp.

Primary responsibilities:

  • Detect encrypted candidates among scan results
  • Invoke required helper tools
  • Track temporary mappings and mounts
  • Clean up privileged resources reliably

2. File Identity and Scope

  • Source path: src/encryption_support.hpp
  • Language: C++
  • File role: interface and data-contract file
  • Physical lines: 40
  • Non-empty lines: 33
  • SHA-256: 6cccfaea7835bdbfbcc36c26565a89e5c94efa2ea1a507b50844e79a40d3d198

The declarations in this file use the global namespace.

3. Dependencies

3.1 Project Headers

  • disk_reader.hpp
  • models.hpp

3.2 Standard and External Headers

  • string
  • vector

These dependencies define the file’s compile-time integration with the recovery engine, GTK interface, on-disk format decoders, operating-system services, or C++ standard library.

4. Declared Types

  • struct UnlockSession.
  • class EncryptionSupport.

5. Constants and Configuration Values

No preprocessor or compile-time constants were detected as top-level declarations in this file.

6. Data Members and Persistent State

The interface declares the following state-bearing members:

  • std::string container_type
  • std::string source_path
  • uint64_t source_offset {0}
  • std::string mapped_path
  • std::string loop_path
  • std::string mapper_name
  • std::string helper_mount_dir
  • std::string helper_loop_path
  • bool uses_dislocker {false}

These members hold configuration, parser context, UI widgets, source references, progress state, recovered metadata, or temporary resources according to the owning type.

7. API and Function Inventory

The following callable interfaces or definitions were detected:

  • void cleanup(std::vector<std::string>&logs) – Manages the corresponding resource lifecycle or resets internal state.
  • static std::vector<ScanResult> detect_encrypted_volumes(DiskReader&reader,const std::vector<ScanResult>&seed_results,std::vector<std::string>&logs) – Inspects the source and reports matching candidates or detected metadata.
  • static bool export_encrypted_metadata(DiskReader&reader,const ScanResult&result,const std::string&output_dir,std::vector<std::string>&logs,std::string&error) – Persists or exports the supplied state to the relevant destination.
  • static bool try_unlock_volume(const std::string&source_path,const ScanResult&result,UnlockSession&session,std::vector<std::string>&logs,std::string&error) – Implements the operation identified by this API and updates or returns the associated state.

8. Operational Flow

The subsystem represented by this file normally participates in the following flow:

  1. Detect encrypted candidates among scan results.
  2. Invoke required helper tools.
  3. Track temporary mappings and mounts.
  4. Clean up privileged resources reliably.
  5. Expose or execute the detected APIs: cleanup, detect_encrypted_volumes, export_encrypted_metadata, try_unlock_volume.
  6. Return explicit results, progress data, recovered records, or diagnostics to the calling layer.

9. Validation and Error Handling

  • Errors are propagated through Boolean results, error strings, logs, exceptions, or status records depending on the API.
  • Byte offsets, sizes and lengths must be validated before arithmetic and before every read to avoid overflow and out-of-bounds access.
  • Input and output paths require existence checks, permission handling and safe destination construction.

10. Runtime, Concurrency, and Resource Management

  • Privileges: some paths involve raw devices, mappings or mounts and therefore require carefully bounded elevated execution.
  • Temporary loop devices, mappings and mounts require deterministic reverse-order cleanup.

11. Security and Data-Recovery Considerations

  • Recovery code should prefer read-only source access and avoid writing to the original damaged medium.
  • Raw devices and image files are treated as untrusted binary input; every offset and length must remain bounded by the source size.
  • Recovered names and destination paths must be sanitized to prevent directory traversal and accidental overwrite outside the selected export directory.
  • Operations that open block devices, create mappings or mount filesystems require elevated privileges and should expose the smallest possible privileged surface.

12. Implementation Considerations

  • Changes to public declarations can affect every translation unit that includes this header and should preserve binary and source compatibility where required.
  • State-bearing members should have explicit ownership and initialization semantics, especially for references, pointers, file descriptors and GTK widgets.
  • Large-device arithmetic uses 64-bit values; additions and multiplications should be checked before use as offsets or allocation sizes.

13. Integration with the Recovery Pipeline

  • The file belongs to the source-discovery, parsing or support layer.
  • Its results feed scanner, recovery or reporting modules through shared models.
  • The API should remain deterministic so higher layers can combine results safely.

14. Licensing and Provenance

No explicit copyright or software-license statement was detected in the opening section of this individual file. Distribution terms should therefore be verified against the project-level license and repository metadata.

The SHA-256 value in this document can be used to associate the generated documentation with the exact source version analyzed.

Published on:
Last updated on: