Getting started
.msl
User guide
memdiver web
Architecture
Design notes
Reference
context.extra
note
--key-sizes
--stride
--pcap-max-records
--pcap-max-challenges
generic_aes_gcm.py
gocryptfs.py
tls13_stub.py
[memdiver]
AnalysisContext
AnalysisContext.library
AnalysisContext.protocol_version
AnalysisContext.phase
AnalysisContext.secrets
AnalysisContext.extra
AnalysisContext.tls_version
AnalysisContext.__init__()
Match
Match.offset
Match.length
Match.confidence
Match.label
Match.data
Match.metadata
Match.__init__()
AlgorithmResult
AlgorithmResult.algorithm_name
AlgorithmResult.confidence
AlgorithmResult.matches
AlgorithmResult.metadata
AlgorithmResult.__init__()
BaseAlgorithm
BaseAlgorithm.name
BaseAlgorithm.description
BaseAlgorithm.mode
BaseAlgorithm.run()
BaseAlgorithm.estimate_working_set()
ALGORITHM_ENTRY_POINT_GROUP
AlgorithmRegistry
AlgorithmRegistry.__init__()
AlgorithmRegistry.discover()
AlgorithmRegistry.get()
AlgorithmRegistry.list_all()
AlgorithmRegistry.list_by_mode()
AlgorithmRegistry.names
get_registry()
deprecated_kwarg()
CryptoSecret
CryptoSecret.secret_type
CryptoSecret.identifier
CryptoSecret.secret_value
CryptoSecret.protocol
CryptoSecret.client_random
CryptoSecret.__init__()
TLSSecret
KeyOccurrence
KeyOccurrence.offset
KeyOccurrence.secret
KeyOccurrence.context_before
KeyOccurrence.key_bytes
KeyOccurrence.context_after
KeyOccurrence.context_start_offset
KeyOccurrence.__init__()
DumpFile
DumpFile.path
DumpFile.timestamp
DumpFile.phase_prefix
DumpFile.phase_name
DumpFile.canonical_phase
DumpFile.kind
DumpFile.full_phase
DumpFile.canonical_or_raw
DumpFile.__init__()
RunDirectory
RunDirectory.path
RunDirectory.library
RunDirectory.protocol_version
RunDirectory.run_number
RunDirectory.dumps
RunDirectory.secrets
RunDirectory.secret_source
RunDirectory.phase_mappings
RunDirectory.meta
RunDirectory.capture_path
RunDirectory.capture_status
RunDirectory.tls_version
RunDirectory.get_dump_for_phase()
RunDirectory.available_phases()
RunDirectory.__init__()
ComparisonRegion
ComparisonRegion.secret_type
ComparisonRegion.key_length
ComparisonRegion.context_size
ComparisonRegion.run_data
ComparisonRegion.__init__()
ComparisonRegion.run_labels
ComparisonRegion.run_offsets
entropy_from_freq()
entropy_term_lut()
entropy_from_freq_batch()
shannon_entropy()
HISTOGRAM_CHUNK_BYTES
ZERO_BLOCK_BYTES
byte_histogram()
entropy_from_byte_counts()
compute_entropy_profile()
SORTED_SLAB_WINDOW_BYTES
SORTED_PATH_MAX_WINDOW
sorted_path_matches_numpy()
window_entropies()
STREAM_SLAB_BYTES
stream_entropy_profile()
DEFAULT_ENTROPY_WINDOW
REFERENCE_ENTROPY_THRESHOLD
max_window_entropy()
random_window_entropy()
default_entropy_threshold()
threshold_is_reachable()
find_high_entropy_regions()
TLS12PRF
TLS12PRF.p_hash()
TLS12PRF.prf()
TLS12PRF.derive_master_secret()
TLS12PRF.derive_key_block()
TLS13HKDF
TLS13HKDF.hkdf_extract()
TLS13HKDF.hkdf_expand()
TLS13HKDF.hkdf_expand_label()
TLS13HKDF.derive_secret()
KDFParams
KDFParams.hash_algo
KDFParams.key_lengths
KDFParams.labels
KDFParams.context
KDFParams.extra
KDFParams.__init__()
BaseKDF
BaseKDF.name
BaseKDF.protocol
BaseKDF.versions
BaseKDF.derive()
BaseKDF.expand_traffic_secret()
BaseKDF.validate_pair()
BaseKDF.supported_secret_types()
KDF_ENTRY_POINT_GROUP
KDFRegistry
KDFRegistry.__init__()
KDFRegistry.discover()
KDFRegistry.get()
KDFRegistry.get_for_protocol()
KDFRegistry.list_all()
get_kdf_registry()
ByteClass
ByteClass.INVARIANT
ByteClass.STRUCTURAL
ByteClass.POINTER
ByteClass.KEY_CANDIDATE
ByteClass.__new__()
VarianceThresholds
VarianceThresholds.invariant_max
VarianceThresholds.structural_max
VarianceThresholds.pointer_max
VarianceThresholds.validate()
VarianceThresholds.__new__()
compute_variance()
WelfordVariance
WelfordVariance.__init__()
WelfordVariance.num_dumps
WelfordVariance.size
WelfordVariance.add_dump()
WelfordVariance.variance()
WelfordVariance.variance_summary()
WelfordVariance.reset()
WelfordVariance.state_arrays()
WelfordVariance.from_state()
classify_variance()
normalize_byte_classes()
class_mask()
find_contiguous_runs()
count_classifications()
pairwise_leaves_sum()
RunningTopK
RunningTopK.__init__()
RunningTopK.add_slab()
RunningTopK.result()
UNPARSED_TIMESTAMP
parse_phase_timestamp()
PhaseMapping
PhaseMapping.raw_phase
PhaseMapping.canonical_phase
PhaseMapping.timestamp
PhaseMapping.dump_file
PhaseMapping.__init__()
PhaseNormalizer
PhaseNormalizer.KEY_UPDATE_NAMES
PhaseNormalizer.CLEANUP_NAMES
PhaseNormalizer.normalize_run()
PhaseNormalizer.available_canonical_phases()
PhaseNormalizer.get_canonical_display()
AnalysisPipeline
AnalysisPipeline.__init__()
AnalysisPipeline.analyze_library()
AnalysisPipeline.run()
Oracle
Oracle.verify()
Oracle.__init__()
OracleLoadError
OracleBuildError
RESERVED_CONFIG_TABLE
load_oracle_config()
validate_oracle_sandboxed()
assert_oracle_not_hostile()
load_oracle()
ConsensusVector
ConsensusVector.__init__()
ConsensusVector.classifications
ConsensusVector.build()
ConsensusVector.build_from_sources()
ConsensusVector.dump_index_for_path()
ConsensusVector.slab_to_va()
ConsensusVector.project_va_window()
ConsensusVector.project_vas_window()
ConsensusVector.project_slab_window()
ConsensusVector.class_window_va()
ConsensusVector.va_overview()
ConsensusVector.build_incremental()
ConsensusVector.add_source()
ConsensusVector.get_live_variance()
ConsensusVector.welford_state()
ConsensusVector.finalize()
ConsensusVector.iter_regions()
ConsensusVector.count_regions()
ConsensusVector.rank_regions_by_length()
ConsensusVector.get_regions()
ConsensusVector.get_static_regions()
ConsensusVector.get_volatile_regions()
ConsensusVector.get_aligned_candidates()
ConsensusVector.classification_counts()
ConsensusMatrix
AlignmentReport
AlignmentReport.method
AlignmentReport.bytes_compared
AlignmentReport.bytes_discarded
AlignmentReport.sizes_differed
AlignmentReport.n_sources
AlignmentReport.warnings
AlignmentReport.diagnostics
AlignmentReport.diagnostic_dicts
AlignmentReport.to_dict()
AlignmentReport.__init__()
AlignedSegment
AlignedSegment.window_offset
AlignedSegment.length
AlignedSegment.slab_offset
AlignedSegment.layout_row
AlignedSegment.vas
AlignedSegment.to_dict()
AlignedSegment.__init__()
WindowProjection
WindowProjection.anchor_index
WindowProjection.start
WindowProjection.length
WindowProjection.segments
WindowProjection.gaps
WindowProjection.classes
WindowProjection.covered
WindowProjection.to_dict()
WindowProjection.__init__()
MAX_CONSENSUS_WINDOW
flat_alignment_report()
DumpIngestor
DumpIngestor.__init__()
DumpIngestor.scan()
DumpIngestor.dataset_info
DumpIngestor.load_library_runs()
DumpIngestor.load_dump_data()
DumpIngestor.get_dump_paths_for_phase()
DumpIngestor.list_libraries()
DumpIngestor.list_scenarios()
SidecarParser
SidecarParser.SIDECAR_EXTENSIONS
SidecarParser.find_sidecar()
SidecarParser.parse()
MetadataStore
MetadataStore.__init__()
MetadataStore.add_run()
MetadataStore.get_runs_for_library()
MetadataStore.summary()
MetadataStore.filter_by()
CapturedRun
CapturedRun.va_start
CapturedRun.length
CapturedRun.buf_offset
CapturedRun.avail
CapturedRun.vas_offset
CapturedRun.block
CapturedRun.__new__()
CapturedRunIndex
CapturedRunIndex.runs
CapturedRunIndex.by_va
CapturedRunIndex.va_starts
CapturedRunIndex.vas_starts
CapturedRunIndex.__new__()
FIND_WINDOW
MslReader
MslReader.__init__()
MslReader.open()
MslReader.close()
MslReader.file_header
MslReader.SUPPORTED_MAJOR_VERSION
MslReader.KNOWN_MAX_MINOR_VERSION
MslReader.post_tag_offset
MslReader.scan_extension_segments()
MslReader.iter_extension_blocks()
MslReader.sealed_segments()
MslReader.sealed_trailing_bytes
MslReader.trailing_bytes
MslReader.iter_blocks()
MslReader.read_bytes()
MslReader.buffer_length
MslReader.read_view()
MslReader.iter_find()
MslReader.decompressed_payload()
MslReader.run_span()
MslReader.run_view()
MslReader.iter_find_run()
MslReader.read_block_payload()
MslReader.iter_blocks_of_type()
MslReader.iter_region_headers()
MslReader.collect_regions()
MslReader.captured_run_index()
MslReader.collect_key_hints()
MslReader.collect_modules()
MslReader.collect_process_identity()
MslReader.collect_vas_map()
MslReader.collect_related_dumps()
MslReader.collect_end_of_capture()
MslReader.collect_import_provenance()
MslReader.collect_module_list_index()
MslReader.collect_processes()
MslReader.collect_connections()
MslReader.collect_handles()
MslReader.collect_connectivity_tables()
MslReader.collect_thread_contexts()
MslReader.collect_file_descriptors()
MslReader.collect_network_connections()
MslReader.collect_environment_blocks()
MslReader.collect_security_tokens()
MslReader.collect_system_context()
MslReader.collect_end_of_extension()
MslReader.collect_pointer_graphs()
MslReader.collect_extension_vas_maps()
MslReader.effective_vas_map()
CapBit
CapBit.MEMORY_REGIONS
CapBit.MODULE_LIST
CapBit.THREAD_CONTEXTS
CapBit.FILE_DESCRIPTORS
CapBit.NETWORK_STATE
CapBit.ENVIRONMENT_VARS
CapBit.SHARED_MEMORY
CapBit.SECURITY_CONTEXT
CapBit.PROCESS_IDENTITY
CapBit.RELATED_DUMPS
CapBit.CRYPTO_HINTS
CapBit.SYSTEM_CONTEXT
CapBit.SYSTEM_PROCESS_TABLE
CapBit.SYSTEM_NETWORK_TABLE
CapBit.SYSTEM_HANDLE_TABLE
CapBit.PAGE_STATES_INFERRED
TableBit
TableBit.PROCESS_TABLE
TableBit.CONNECTION_TABLE
TableBit.HANDLE_TABLE
ModuleEntrySpec
ModuleEntrySpec.base_addr
ModuleEntrySpec.module_size
ModuleEntrySpec.path
ModuleEntrySpec.version
ModuleEntrySpec.disk_hash
ModuleEntrySpec.module_uuid
ModuleEntrySpec.__init__()
ProcessTableEntry
ProcessTableEntry.pid
ProcessTableEntry.ppid
ProcessTableEntry.uid
ProcessTableEntry.is_target
ProcessTableEntry.start_time_ns
ProcessTableEntry.rss
ProcessTableEntry.exe_name
ProcessTableEntry.cmd_line
ProcessTableEntry.user
ProcessTableEntry.__init__()
ConnectionTableEntry
ConnectionTableEntry.pid
ConnectionTableEntry.family
ConnectionTableEntry.protocol
ConnectionTableEntry.state
ConnectionTableEntry.local_addr
ConnectionTableEntry.local_port
ConnectionTableEntry.remote_addr
ConnectionTableEntry.remote_port
ConnectionTableEntry.__init__()
HandleTableEntry
HandleTableEntry.pid
HandleTableEntry.fd
HandleTableEntry.handle_type
HandleTableEntry.path
HandleTableEntry.__init__()
ExtensionBlock
ExtensionBlock.block_type
ExtensionBlock.payload
ExtensionBlock.block_uuid
ExtensionBlock.parent_uuid
ExtensionBlock.flags
ExtensionBlock.__init__()
MslEncryptionConfig
MslEncryptionConfig.enc_algo
MslEncryptionConfig.kdf_type
MslEncryptionConfig.key_encap
MslEncryptionConfig.raw_key
MslEncryptionConfig.passphrase
MslEncryptionConfig.recipient_public
MslEncryptionConfig.kdf_time
MslEncryptionConfig.kdf_memory
MslEncryptionConfig.kdf_lanes
MslEncryptionConfig.nonce
MslEncryptionConfig.kdf_salt
MslEncryptionConfig.rewrap_material
MslEncryptionConfig.rewrap()
MslEncryptionConfig.__init__()
MslWriter
MslWriter.__init__()
MslWriter.dump_uuid
MslWriter.add_memory_region()
MslWriter.add_memory_region_source()
MslWriter.region_for_va()
MslWriter.add_key_hint()
MslWriter.add_import_provenance()
MslWriter.add_related_dump()
MslWriter.add_process_identity()
MslWriter.add_module_list_index()
MslWriter.add_thread_context()
MslWriter.add_raw_block()
MslWriter.add_capabilities()
MslWriter.add_raw_appendix()
MslWriter.add_extension_segment()
MslWriter.extension_segment_count
MslWriter.add_vas_map()
MslWriter.add_system_context()
MslWriter.add_process_table()
MslWriter.add_connection_table()
MslWriter.add_handle_table()
MslWriter.add_pointer_graph()
MslWriter.add_connectivity_table()
MslWriter.add_end_of_capture()
MslWriter.write()
MslWriter.write_streaming()
build_import_provenance_payload()
ImportResult
ImportResult.source_path
ImportResult.output_path
ImportResult.regions_written
ImportResult.key_hints_written
ImportResult.total_bytes
ImportResult.selection
ImportResult.excluded_region_count
ImportResult.excluded_bytes
ImportResult.secrets_only_in_excluded
ImportResult.warnings
ImportResult.materialized
ImportResult.dropped_key_hints
ImportResult.reencrypted
ImportResult.decrypted_output
ImportResult.has_selection_info
ImportResult.selection_summary()
ImportResult.__init__()
import_elf_core()
RegionSpec
RegionSpec.base
RegionSpec.page_states
RegionSpec.data
RegionSpec.protection
RegionSpec.region_type
RegionSpec.data_len
RegionSpec.__init__()
StreamedRegionSpec
StreamedRegionSpec.base
StreamedRegionSpec.page_states
StreamedRegionSpec.runs
StreamedRegionSpec.protection
StreamedRegionSpec.region_type
StreamedRegionSpec.data_len
StreamedRegionSpec.__init__()
import_minidump()
import_raw_dump()
import_regioned_raw()
import_msl_passthrough()
RUN_META_MAPS_KEY
run_directory_declared_maps()
run_directory_dump_files()
run_directory_maps_for()
import_run_directory()
import_dump()
Endianness
Endianness.LITTLE
Endianness.BIG
Endianness.__new__()
HeaderFlag
HeaderFlag.IMPORTED
HeaderFlag.INVESTIGATION
HeaderFlag.ENCRYPTED
HeaderFlag.__new__()
BlockType
BlockType.INVALID
BlockType.MEMORY_REGION
BlockType.MODULE_ENTRY
BlockType.MODULE_LIST_INDEX
BlockType.THREAD_CONTEXT
BlockType.FILE_DESCRIPTOR
BlockType.NETWORK_CONNECTION
BlockType.ENVIRONMENT_BLOCK
BlockType.SECURITY_TOKEN
BlockType.KEY_HINT
BlockType.IMPORT_PROVENANCE
BlockType.PROCESS_IDENTITY
BlockType.RELATED_DUMP
BlockType.SYSTEM_CONTEXT
BlockType.PROCESS_TABLE
BlockType.CONNECTION_TABLE
BlockType.HANDLE_TABLE
BlockType.CONNECTIVITY_TABLE
BlockType.END_OF_EXTENSION
BlockType.END_OF_CAPTURE
BlockType.VAS_MAP
BlockType.POINTER_GRAPH
BlockType.__new__()
BlockFlag
BlockFlag.COMPRESSED
BlockFlag.COMP_ZSTD
BlockFlag.COMP_LZ4
BlockFlag.HAS_KEY_HINTS
BlockFlag.HAS_CHILDREN
BlockFlag.CONTINUATION
BlockFlag.__new__()
CompAlgo
CompAlgo.NONE
CompAlgo.ZSTD
CompAlgo.LZ4
CompAlgo.__new__()
PageState
PageState.CAPTURED
PageState.FAILED
PageState.UNMAPPED
PageState.NOT_RESIDENT
PageState.RESERVED
PageState.__new__()
Protection
Protection.READ
Protection.WRITE
Protection.EXECUTE
Protection.GUARD
Protection.COW
Protection.__new__()
RegionType
RegionType.UNKNOWN
RegionType.HEAP
RegionType.STACK
RegionType.IMAGE
RegionType.MAPPED_FILE
RegionType.ANONYMOUS
RegionType.SHARED_MEM
RegionType.OTHER
RegionType.__new__()
ThreadState
ThreadState.UNKNOWN
ThreadState.RUNNING
ThreadState.SLEEPING
ThreadState.STOPPED
ThreadState.WAITING
ThreadState.UNINTERRUPTIBLE
ThreadState.HALTED
ThreadState.ZOMBIE
ThreadState.__new__()
VasNameSource
VasNameSource.UNSPECIFIED
VasNameSource.LIVE
VasNameSource.SOURCE_METADATA
VasNameSource.SYNTHESIZED
VasNameSource.__new__()
OSType
OSType.WINDOWS
OSType.LINUX
OSType.MACOS
OSType.ANDROID
OSType.IOS
OSType.FREEBSD
OSType.UNKNOWN
OSType.__new__()
ArchType
ArchType.X86
ArchType.X86_64
ArchType.ARM64
ArchType.ARM32
ArchType.UNKNOWN
ArchType.__new__()
SourceFormat
SourceFormat.RAW_DUMP
SourceFormat.ELF_CORE
SourceFormat.MINIDUMP
SourceFormat.MSL
SourceFormat.REGIONED_RAW
SourceFormat.__new__()
MslKeyType
MslKeyType.UNKNOWN
MslKeyType.PRE_MASTER_SECRET
MslKeyType.MASTER_SECRET
MslKeyType.SESSION_KEY
MslKeyType.HANDSHAKE_SECRET
MslKeyType.APP_TRAFFIC_SECRET
MslKeyType.RSA_PRIVATE_KEY
MslKeyType.ECDH_PRIVATE_KEY
MslKeyType.IKE_SA_KEY
MslKeyType.ESP_AH_KEY
MslKeyType.SSH_SESSION_KEY
MslKeyType.WIREGUARD_KEY
MslKeyType.ML_KEM_PRIVATE_KEY
MslKeyType.OTHER
MslKeyType.__new__()
MslProtocol
MslProtocol.UNKNOWN
MslProtocol.TLS_12
MslProtocol.TLS_13
MslProtocol.DTLS_12
MslProtocol.DTLS_13
MslProtocol.QUIC
MslProtocol.IKEV2_IPSEC
MslProtocol.SSH
MslProtocol.WIREGUARD
MslProtocol.PQ_TLS
MslProtocol.OTHER
MslProtocol.__new__()
Confidence
Confidence.SPECULATIVE
Confidence.HEURISTIC
Confidence.CONFIRMED
Confidence.__new__()
KeyState
KeyState.UNKNOWN
KeyState.ACTIVE
KeyState.EXPIRED
KeyState.__new__()
HandleType
HandleType.UNKNOWN
HandleType.FILE
HandleType.DIR
HandleType.SOCKET
HandleType.PIPE
HandleType.MUTEX
HandleType.TIMER
HandleType.OTHER
HandleType.__new__()
ConnRowType
ConnRowType.IPV4_ROUTE
ConnRowType.IPV6_ROUTE
ConnRowType.ARP_ENTRY
ConnRowType.PACKET_SOCKET
ConnRowType.IFACE_STATS
ConnRowType.SOCKET_FAMILY_AGG
ConnRowType.MIB_COUNTER
ConnRowType.__new__()
HashAlgo
HashAlgo.BLAKE3
HashAlgo.SHA256
HashAlgo.SHA512_256
HashAlgo.OTHER
HashAlgo.__new__()
EncAlgo
EncAlgo.AES_256_GCM
EncAlgo.XCHACHA20_POLY1305
EncAlgo.__new__()
KdfType
KdfType.NONE
KdfType.ARGON2ID
KdfType.__new__()
KeyEncap
KeyEncap.NONE
KeyEncap.X25519
KeyEncap.ML_KEM_768
KeyEncap.ML_KEM_1024
KeyEncap.X25519_ML_KEM_768
KeyEncap.OTHER
KeyEncap.__new__()
TagStatus
TagStatus.NOT_ENCRYPTED
TagStatus.VALID
TagStatus.CORRUPTED
TagStatus.MISSING_KEY
NodeKind
NodeKind.ADDRESS
NodeKind.OFFSET
NodeKind.SYMBOL
NodeKind.__new__()
EdgeKind
EdgeKind.POINTER
EdgeKind.CALL
EdgeKind.IMPORT
EdgeKind.__new__()
PatternGenerator
PatternGenerator.generate()
PatternGenerator.find_anchors()
PatternGenerator.anchor_distinctiveness()
PatternGenerator.infer_fields()
YaraExporter
YaraExporter.export()
key_locator_from_pattern()
JsonExporter
JsonExporter.export()
JsonExporter.save()
JsonExporter.to_string()
Volatility3Exporter
Volatility3Exporter.export()
Volatility3Exporter.save()
scan_dataset()
list_phases()
list_protocols()
set_region_filter()
get_region_filter()
analyze_library()
preview_import()
Project
memdiver.oracles
DumpSource
Stage