The LeechCore Memory Acquisition Library focuses on Physical Memory Acquisition using various hardware and software based methods.

Use the LeechCore library locally or connect to, over the network, a LeechAgent to acquire physical memory or run commands remotely. The connection is by default compressed and secured with mutually authenticated kerberos - making it ideal in incident response when combined with analysis and live memory capture using Comae DumpIt or WinPMEM - even over high latency low-bandwidth connections!

The LeechCore library is used by PCILeech and The Memory Process File System (MemProcFS).

The LeechCore library is supported on 32/64-bit Windows (.dll) and 64-bit Linux (.so). No executable exists for LeechCore - the library is always loaded by other applications using it - such as PCILeech and The Memory Process File System MemProcFS.exe.

For detailed information about individual memory acquisition methods or the LeechCore API please check out the LeechCore wiki.

Please find a summary of the supported software based memory acquisition methods listed below. Please note that the LeechService only provides a network connection to a remote LeechCore library. It's possible to use both hardware and software based memory acquisition once connected.

Please find a summary of the supported hardware based memory acquisition methods listed below. All hardware based memory acquisition methods are supported on both Windows and Linux. The FPGA based methods however sports a slight performance penalty on Linux and will max out at approx: 90MB/s compared to 150MB/s on Windows.

The LeechAgent Memory Acquisition and Analysis Agent exists for Windows only. It allows users of the LeechCore library (PCILeech and MemProcFS) to connect to remotely installed LeechAgents over the network. The connection is secured, by default, with mutually authenticated encrypted kerberos.

Once connected physical memory may be acquired over the secure compressed connection. Memory analysis scripts, written in Python, may also be submitted for remote processing by the LeechAgent.

The LeechAgent authenticates all incoming connections against membership in the Local Administrators group. The clients must also authenticate the agent itself against the SPN used by the agent - please check the Application Event Log for information about the SPN and also successful authentication events against the agent.

There is also a possibility to run the LeechAgent in interactive mode (as a normal program). If run in interactive mode a user may also start the LeechAgent in "insecure" mode - which means no authentication or logging at all.

The LeechAgent listens on the port tcp/28473 - please ensure network connectivity for this port in the firewall. Also, if doing live capture ensure that LeechAgent (if running in interactive mode) is started as an administrator.

For more information please check the LeechCore wiki and the blog entry about remote live memory capture with the LeechAgent.

The video below shows the process of installing the LeechAgent to a remote computer, connecting to it with MemProcFS to analyze and dump the memory while also connecting to it in parallel with PCILecch to submit a Python memory analysis script that make use of the MemProcFS API to analyze the remote CPU page tables for rwx-sections. Click on the video to open a higher-quality version on Youtube.

Examples:

Installing the LeechAgent on the local system (run as elevated administrator)'. Please ensure that the LeechAgent.exe is on the local C: drive before installing the agent service. Please also ensure that dependencies such as required .dll and/or .sys files (and optional Python sub-subfolder) are put in the same directory as the LeechAgent before running the install command.

• LeechAgent.exe -install

Installing the LeechAgent on a remote system (or on the local system) in the Program Files\LeechAgent folder. An Actice Directory environment with remote access to the Service Manager of the target system is required. For additional information see the wiki entry about installing LeechAgent.

• LeechSvc.exe -remoteinstall <remotecomputer.contoso.com>

Uninstall an existing, locally installed, LeechAgent. The agent service will be uninstalled but any files will remain.

• LeechAgent.exe -uninstall

Uninstall a LeechAgent from a remote system and delete the Program Files\LeechAgent folder.

• LeechAgent.exe -remoteuninstall <remotecomputer.contoso.com>

Start the LeechAgent in interactive mode only accepting connections from administative users over kerberos-secured connections. Remember to start as elevated administrator if clients accessing LeechAgent should load WinPMEM to access live memory.

• LeechAgent.exe -interactive

Start the LeechAgent in interactive insecure mode - accepting connections from all clients with access to port tcp/28473. NB! unauthenticated clients may dump memory and submit Python scripts running as SYSTEM. Use with care for testing only!

• LeechAgent.exe -interactive -insecure

Start the LeechAgent in interactive mode with DumpIt LIVEKD to allow connecting clients to access live memory. Start as elevated administrator. Only accept connections from administative users over kerberos-secured connections.

• DumpIt.exe /LIVEKD /A LeechAgent.exe /C -interactive

Start the LeevhAgent in interactive mode with DumpIt LIVEKD to allow connecting clients to access live memory. Start as elevated administrator. Accept connections from all clients with access to port tcp/28473 without any form of authentication.

• DumpIt.exe /LIVEKD /A LeechAgent.exe /C "-interactive -insecure"

Pre-built binaries, modules and configuration files are found in the latest release. Build instructions are found in the Wiki in the Building section.

• Blog: http://blog.frizk.net
• Twitter: https://twitter.com/UlfFrisk
• PCILeech: https://github.com/ufrisk/pcileech/
• The Memory Process File System: https://github.com/ufrisk/MemProcFS/

v1.0

• Initial Release.

v1.1

• Multiple bug fixes including pmem device.
• LeechService: Multiple parallel connections and connection timeouts supported.

v1.2

• Project upgrade to Visual Studio 2019.
• Release of the LeechAgent - remote memory acquisition and remote physical memory analysis.
• LeechCore Windows x86 support. Now Windows x86/x64 and Linux x64 is supported.
• Bug fixes and additional functionality to support LeechAgent.

v1.3

• Bug fixes.
• Use libusb for FPGA USB access on Linux. Contribution by: Jérémie Boutoille / Synacktiv. Based in part on PCIeScreamer kernel driver from LambdaConcept.

v1.4

• Minor API fixes and additions to allow extended MemProcFS dump file functionality.

v1.5

• Move binaries into releases section.
• RawUDP device (NeTV2 FPGA over UDP).
• ELF Core Dump support (VirtualBox VBoxManage debugvm dumpvmcore).

v1.6

• Code Signing.
• FPGA: Support for writing to custom shadow configuration space.
• FPGA: Examples: PCIe Configuration Space & Dynamic Reconfiguration Port Interface.

v1.7

• FPGA: New options format and additional options.
• Hyper-V Saved State: Performance Improvements.
• Initial support for VMware memory save files.