memflow connector backend to interface with pcileech devices

You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Go to file

ko1N e679a403e1 Updated leechcore submodule and fixed linux warnings		4 years ago
.cargo	Recoded pcileech connector by using the leechcore library. Some test-implementations for read/write already exist; very WIP	4 years ago
.github/workflows	Updated ci	4 years ago
leechcore-sys	Updated leechcore submodule and fixed linux warnings	4 years ago
memflow-pcileech	Fixed formatting	4 years ago
.gitignore	Moved to seperate project from memflow	5 years ago
.gitmodules	Recoded pcileech connector by using the leechcore library. Some test-implementations for read/write already exist; very WIP	4 years ago
Cargo.toml	Cleaned up code, updated Readme and added the option to load custom memory maps via the arguments	4 years ago
LICENSE	Recoded pcileech connector by using the leechcore library. Some test-implementations for read/write already exist; very WIP	4 years ago
README.md	Updated readme and added github ci	4 years ago
install.sh	Recoded pcileech connector by using the leechcore library. Some test-implementations for read/write already exist; very WIP	4 years ago
memmap.toml	Updated leechcore submodule and fixed linux warnings	4 years ago

README.md

This repository is currently work-in-progress and might not fully work.

memflow-pcileech

This connector implements a rust-native implementation of the pcileech interface.

More information about pcileech can be found under https://github.com/ufrisk/pcileech.

Compilation

First make sure that the leechcore submodule is checked out:

git submodule init
git submodule sync
git submodule update

Install the following build tools:

gcc
clang
libusb-1.0 (only required on linux)

On Windows you additionally need to supply the proprietary FTD3XX.dll.

On Linux you need to check-out and compile the leechcore_ft601_driver_linux project from the LeechCore-Plugins repository.

More information about these requirements can be found in the LeechCore-Plugins repository.

Using the install script

The ./install.sh script will just compile and install the plugin. The connector will be installed to ~/.local/lib/memflow by default. Additionally the --system flag can be specified which will install the connector in /usr/lib/memflow as well.

Using the library in a rust project

To use the plugin in a rust project just include it in your Cargo.toml

memflow-pcileech = "0.1"

Make sure to not enable the plugin feature when importing multiple connectors in a rust project without using the memflow plugin inventory. This might cause duplicated exports being generated in your project.

Building the stand-alone connector for dynamic loading

The stand-alone connector of this library is feature-gated behind the inventory feature. To compile a dynamic library for use with the connector inventory use the following command:

cargo build --release --all-features

Installing the library

Alternatively to manually placing the library in the PATH the connector can be installed with the install.sh script. It will place it inside ~/.local/lib/memflow directory. Add ~/.local/lib directory to PATH to use the connector in other memflow projects.

Arguments

The following arguments can be used when loading the connector:

device - the name of the pcileech device to open (e.g. FPGA) (default argument, required)
memmap - a file that contains a custom memory map in TOML format (optional)

The memory map file must contain a mapping table in the following format:

[[range]]
base=0x1000
length=0x1000

[[range]]
base=0x2000
length=0x1000
real_base=0x3000

The real_base parameter is optional. If it is not set there will be no re-mapping.

License

Licensed under GPL-3.0 License, see LICENSE.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, shall be licensed as above, without any additional terms or conditions.