https://github.com/iseki0/executables
Library for executable/object files parsing(include PE version info, virtual memory), in Kotlin multiplatform.
https://github.com/iseki0/executables
exe fileformat kotlin kotlin-multiplatform pe pefile
Last synced: 5 months ago
JSON representation
Library for executable/object files parsing(include PE version info, virtual memory), in Kotlin multiplatform.
- Host: GitHub
- URL: https://github.com/iseki0/executables
- Owner: iseki0
- License: apache-2.0
- Created: 2024-12-19T17:11:25.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2025-07-21T17:55:46.000Z (5 months ago)
- Last Synced: 2025-07-21T19:38:19.170Z (5 months ago)
- Topics: exe, fileformat, kotlin, kotlin-multiplatform, pe, pefile
- Language: Kotlin
- Homepage: https://iseki0.github.io/Executables/
- Size: 3.99 MB
- Stars: 13
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Executables
[](https://central.sonatype.com/artifact/space.iseki.executables/executables-files)
An executable file parsing library, written in Kotlin Multiplatform.
Currently, this library can:
| | PE | ELF | Mach-O |
|----------------------------|----|-----|--------|
| Read headers | ✅ | ✅ | ✅ |
| Read import/export symbols | ✅ | ✅ | 🚧 |
| Read sections | ✅ | ✅ | ✅ |
| Read resources | ✅ | N/A | N/A |
| Reading in VA | ✅ | ✅ | ✅ |
- [x] Kotlin/Native: File access
- [x] SBOM: Go
- [ ] SBOM: GraalVM Native Image
> This project is currently in the early stages of development. This means it is still evolving and may undergo frequent
> updates and changes.
>
> Due to the current status of Kotlin/Multiplatform, it can be expected that for a period of time following the stable
> release, binary compatibility guarantees will only be provided for Kotlin/JVM.
## Kotlin targets
All targets supported.
### Quick start
> For someone who doesn't want to read the documentation
```kotlin
import space.iseki.executables.common.FileFormat
fun main(vararg args: String) {
FileFormat.open(args[0])?.use { file ->
println(file)
// do what you want to do
}
}
```
## Getting Started
### Add dependency
This project contains ~~several~~ modules on Maven Central:
- [space.iseki.executables:executables-files] contains the code shared by pe, elf, and macho
#### Gradle
```kotlin
dependencies {
implementation("space.iseki.executables:executables-files:0.1.7")
}
```
#### Maven
Since the project is in Kotlin Multiplatform, for Maven user you have to specify the platform explicitly.
(The `-jvm` suffix)
```xml
space.iseki.executables
executables-files-jvm
0.1.7
```
### Samples
#### Print information of a PE file
```kotlin
import java.nio.file.Path
import kotlinx.serialization.json.Json
import space.iseki.executables.pe.PEFile
fun main() {
val file = Path.of("C:\\System32\\notepad.exe")
PEFile.open(file).use { peFile: PEFile ->
println(peFile.coffHeader)
println(peFile.summary)
println(Json.encodeToString(peFile.summary))
println(peFile.versionInfo)
}
}
```
#### Detect the type of file
```kotlin
import java.nio.file.Path
import space.iseki.executables.common.FileFormat
fun main() {
val file = Path.of("C:\\System32\\notepad.exe")
println(FileFormat.detect(file))
}
```
#### Read PE file import symbols
> This API also works for ELF files.
```kotlin
import java.nio.file.Path
import space.iseki.executables.pe.PEFile
fun main() {
val file = Path.of("C:\\System32\\notepad.exe")
PEFile.open(file).use { peFile ->
// Get all imported DLLs and functions
peFile.importSymbols.forEach { symbol ->
println("Imported: ${symbol.file}::${symbol.name}")
if (symbol.isOrdinal) {
println(" - Ordinal: ${symbol.ordinal}")
}
}
}
}
```
#### Read PE file export symbols
> This API also works for ELF files.
```kotlin
import java.nio.file.Path
import space.iseki.executables.pe.PEFile
fun main() {
val file = Path.of("C:\\System32\\kernel32.dll")
PEFile.open(file).use { peFile ->
// Get all exported functions
val exportSymbols = peFile.exportSymbols
println("Number of exported functions: ${exportSymbols.size}")
// Print the first 10 exported functions
exportSymbols.take(10).forEach { symbol ->
println(" - ${symbol.name}, Ordinal: ${symbol.ordinal}")
if (symbol.isForwarder) {
println(" Forwards to: ${symbol.forwarderString}")
}
}
}
}
```
#### Read ELF symbol tables
> Since PE splits the symbol table into import/export, this API is ELF specified.
```kotlin
import java.nio.file.Path
import space.iseki.executables.elf.ELFFile
fun main() {
val file = Path.of("/bin/ls") // ELF file on Linux system
ELFFile.open(file).use { elfFile ->
// Get all symbols
elfFile.symbols.forEach { symbol ->
val name = symbol.name ?: ""
println(" - $name: Name=${symbol.name}, Binding=${symbol.binding}")
}
}
}
```
## References
- PE Format: https://docs.microsoft.com/en-us/windows/win32/debug/pe-format
- PE VS_VERSIONINFO: https://learn.microsoft.com/en-us/windows/win32/menurc/vs-versioninfo
- ELF Format: https://refspecs.linuxfoundation.org/elf/elf.pdf
- Macho Format: https://github.com/apple/darwin-xnu/blob/main/EXTERNAL_HEADERS/mach-o/loader.h
[VS_VERSIONINFO]: https://learn.microsoft.com/en-us/windows/win32/menurc/vs-versioninfo
[space.iseki.executables:executables-files]: https://central.sonatype.com/artifact/space.iseki.executables/executables-files