https://github.com/falk-werner/pe-tools
Tools to work with Microsoft Portable Executable (PE) files
https://github.com/falk-werner/pe-tools
Last synced: 3 months ago
JSON representation
Tools to work with Microsoft Portable Executable (PE) files
- Host: GitHub
- URL: https://github.com/falk-werner/pe-tools
- Owner: falk-werner
- License: mit
- Created: 2024-02-27T19:13:42.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-22T22:52:34.000Z (about 1 year ago)
- Last Synced: 2025-02-01T20:17:17.588Z (5 months ago)
- Language: C
- Size: 77.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://github.com/falk-werner/pe-tools/actions/workflows/build.yml)
# PE Tools
Tools to work with Microsoft Portable Executable (PE) files:
- pe-depends: list and copy dependencies of `.exe` or `.dll` files
- dll-finder: search for a `.dll` file
- pe-info: print information of `.exe` or `.dll` files
## pe-depends
List and / or copy dependencies of `.exe` or `.dll` files.
### Usage
```
pe-depends [--list | --direct | --copy] [-n] [-w ] [-t ]
[-k ] [-p path] ...
```
### Commands
| Long Option | Short Option | Description |
| ----------- | ------------ | ----------- |
| `--list` | `-l` | list dependencies recursivly |
| `--direct` | `-d` | list direct dependencies only |
| `--copy` | `-c` | copy dependencies to target directory |
### Options
| Long Option | Short Option | Argument | Description |
| -------------- | ------------ | -------- | ----------- |
| `--work-dir` | `-w` | PATH | change working directory |
| `--target` | `-t` | PATH | target directory for copy command (default: .) |
| `--known` | `-k` | FILE | add known DLL (can be specified multiple times) |
| `--path` | `-p` | PATH | add search Path (can be specified multiple times) |
| `--no-default` | `-n` | - | disable default search order (see below) |
## dll-finder
Search for a `.dll` file.
### Usage
```
dll-finder [-n] [-w ] [-t ] [-k ] [-p path] ...
```
### Options
| Long Option | Short Option | Argument | Description |
| -------------- | ------------ | -------- | ----------- |
| `--work-dir` | `-w` | PATH | change working directory |
| `--known` | `-k` | FILE | add known DLL (can be specified multiple times) |
| `--path` | `-p` | PATH | add search Path (can be specified multiple times) |
| `--no-default` | `-n` | - | disable default search order (see below) |
## pe-info
Print information of `.exe` or `.dll` files.
### Usage
```
pe-info ...
```
## Known DLLs
A *known DLL* is a DLL that is well known by the system and therefore not copied to the target directory. Windows manages a list of known DLLs in registry (see
`HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\KnownDLLs`).
Use the `-k` option to add extra known DLLs.
Use the `-n` option to ignore registry (extra known DLLs will still be used).
## Default Search Order
The default search order is roughly oriented at DLL search order (see
[https://learn.microsoft.com/en-us/windows/win32/dlls/dynamic-link-library-search-order](https://learn.microsoft.com/en-us/windows/win32/dlls/dynamic-link-library-search-order)). Although, some parts are ignored,
such as DLL redirection, API sets, SxS manifests, loaded module lists,
package manifests and the 16 bit folder. This results effectively in
the following search order:
- known DLLs
- current path
- system directory
- windows directory
- path variable
- extra paths specified by `-p`
Use the `-n` option to default search order and onyl hone extra paths.
## Build
```bash
cmake -B build
cmake --build build
cmake --install build
```
### Run Unit Tests
```bash
cmake -B build
cmake --build build
ctest --test-dir build
```
### Generate Source Code Documentation
```bash
doxygen
```
The generated documentation can be found in the `doc` subdirectory.
## Design Principles
All PE Tools should have a least dependencies as possible so they can be executed on every
MS Windows installation without the need of additional DLLs. Therefore they are build
- without use of any C standard library
- without use of any default libraries
## References
- [PE Format](https://learn.microsoft.com/en-us/windows/win32/debug/pe-format)
- [Dynamic-link library search order](https://learn.microsoft.com/en-us/windows/win32/dlls/dynamic-link-library-search-order)