pelfy 1.0.0__tar.gz

pelfy-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Nicolas Kruse
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pelfy-1.0.0/PKG-INFO

@@ -0,0 +1,123 @@
+Metadata-Version: 2.2
+Name: pelfy
+Version: 1.0.0
+Summary: Parser for ELF files written in python
+Author-email: Nicolas Kruse <nicolas.kruse@nonan.net>
+Project-URL: Homepage, https://github.com/Nonannet/pelfy
+Project-URL: Issues, https://github.com/Nonannet/pelfy/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# pelfy
+
+## Description
+Pelfy (Python Executable and Linkable Format analyzer) is an ELF parser written
+in python. It shows header fields, sections, symbols and relocation and gives
+access to all raw data as well as human readable representations. 
+
+### Key Features
+- Provide names for fields and values as well as descriptions
+- Relocation types for x86, MIPS, ARM and RISC-V all in 32 and 64 bit
+- Outputs tables in nicely formatted HTML, markdown or text
+- Uses HTML outputs for Jupyter Notebook integration
+- Compact code base
+- Pure fully static typed python and no other dependencies
+
+### Usage Scenarios
+- Reverse engineering tools
+- Testing
+- Documentation
+
+## Installation
+The package has no additional decencies. It can be installed with pip:
+
+```bash
+pip install pelfy
+```
+
+## Usage
+Example code and its outputs:
+
+```python
+import pelfy
+
+elf = pelfy.open_elf_file('obj/test-c-riscv64-linux-gnu-gcc-12-O3.o')
+elf.sections
+```
+| index | name              | type         | description                       |
+|------:|-------------------|--------------|-----------------------------------|
+|     0 |                   | SHT_NULL     | Section header table entry unused |
+|     1 | .text             | SHT_PROGBITS | Program data                      |
+|     2 | .rela.text        | SHT_RELA     | Relocation entries with addends   |
+|     3 | .data             | SHT_PROGBITS | Program data                      |
+|     4 | .bss              | SHT_NOBITS   | Program space with no data (bss)  |
+|     5 | .comment          | SHT_PROGBITS | Program data                      |
+|     6 | .note.GNU-stack   | SHT_PROGBITS | Program data                      |
+|     7 | .riscv.attributes | 0x70000003   | Application-specific              |
+|     8 | .symtab           | SHT_SYMTAB   | Symbol table                      |
+|     9 | .strtab           | SHT_STRTAB   | String table                      |
+|    10 | .shstrtab         | SHT_STRTAB   | String table                      |
+```python
+elf.functions
+```
+| index | name               | info     | size | stb        | description             |
+|-------|--------------------|----------|-----:|------------|-------------------------|
+|    11 | result_float       | STT_FUNC |    8 | STB_GLOBAL | Symbol is a code object |
+|    12 | result_float_float | STT_FUNC |   12 | STB_GLOBAL | Symbol is a code object |
+|    13 | add_float_float    | STT_FUNC |   12 | STB_GLOBAL | Symbol is a code object |
+|    14 | mul_float_float    | STT_FUNC |   12 | STB_GLOBAL | Symbol is a code object |
+|    15 | read_float         | STT_FUNC |   16 | STB_GLOBAL | Symbol is a code object |
+```python
+elf.symbols['read_float'].get_relocations()
+```
+| index | symbol name        | type                 | calculation |
+|-------|--------------------|----------------------|-------------|
+|     4 | .LANCHOR0          | R_RISCV_PCREL_HI20   | S + A - P   |
+|     5 |                    | R_RISCV_RELAX        |             |
+|     6 | .L0                | R_RISCV_PCREL_LO12_I | S - P       |
+|     7 |                    | R_RISCV_RELAX        |             |
+|     8 | result_float_float | R_RISCV_CALL_PLT     | S + A - P   |
+|     9 |                    | R_RISCV_RELAX        |             |
+
+## Contributing
+Contributions are welcome! Please open an issue or submit a pull request on GitHub.
+
+## Developer Guide
+To get started with developing the `pelfy` package, follow these steps:
+
+First, clone the repository to your local machine using Git:
+
+```bash
+git clone https://github.com/Nonannet/pelfy.git
+cd pelfy
+```
+
+Install the package while keeping files in the current dev directory:
+
+```bash
+pip install -e .
+```
+
+Install pytest (unit testing), mypy (type checking) and flake8 (style guide checking):
+
+```bash
+pip install pytest mypy flake8
+```
+
+Ensure that everything is set up correctly by running the tests:
+
+```bash
+pytest
+```
+
+For creating additional test object files place the source c-files in the `tests/src/` directory,
+change the current directory to `tests/src/` and run `bash run_cross_compilation.sh`. This
+script uses a docker container to cross compile all c-files to object files and outputs
+them in the tests/obj directory.
+   
+## License
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

pelfy-1.0.0/README.md

@@ -0,0 +1,109 @@
+# pelfy
+
+## Description
+Pelfy (Python Executable and Linkable Format analyzer) is an ELF parser written
+in python. It shows header fields, sections, symbols and relocation and gives
+access to all raw data as well as human readable representations. 
+
+### Key Features
+- Provide names for fields and values as well as descriptions
+- Relocation types for x86, MIPS, ARM and RISC-V all in 32 and 64 bit
+- Outputs tables in nicely formatted HTML, markdown or text
+- Uses HTML outputs for Jupyter Notebook integration
+- Compact code base
+- Pure fully static typed python and no other dependencies
+
+### Usage Scenarios
+- Reverse engineering tools
+- Testing
+- Documentation
+
+## Installation
+The package has no additional decencies. It can be installed with pip:
+
+```bash
+pip install pelfy
+```
+
+## Usage
+Example code and its outputs:
+
+```python
+import pelfy
+
+elf = pelfy.open_elf_file('obj/test-c-riscv64-linux-gnu-gcc-12-O3.o')
+elf.sections
+```
+| index | name              | type         | description                       |
+|------:|-------------------|--------------|-----------------------------------|
+|     0 |                   | SHT_NULL     | Section header table entry unused |
+|     1 | .text             | SHT_PROGBITS | Program data                      |
+|     2 | .rela.text        | SHT_RELA     | Relocation entries with addends   |
+|     3 | .data             | SHT_PROGBITS | Program data                      |
+|     4 | .bss              | SHT_NOBITS   | Program space with no data (bss)  |
+|     5 | .comment          | SHT_PROGBITS | Program data                      |
+|     6 | .note.GNU-stack   | SHT_PROGBITS | Program data                      |
+|     7 | .riscv.attributes | 0x70000003   | Application-specific              |
+|     8 | .symtab           | SHT_SYMTAB   | Symbol table                      |
+|     9 | .strtab           | SHT_STRTAB   | String table                      |
+|    10 | .shstrtab         | SHT_STRTAB   | String table                      |
+```python
+elf.functions
+```
+| index | name               | info     | size | stb        | description             |
+|-------|--------------------|----------|-----:|------------|-------------------------|
+|    11 | result_float       | STT_FUNC |    8 | STB_GLOBAL | Symbol is a code object |
+|    12 | result_float_float | STT_FUNC |   12 | STB_GLOBAL | Symbol is a code object |
+|    13 | add_float_float    | STT_FUNC |   12 | STB_GLOBAL | Symbol is a code object |
+|    14 | mul_float_float    | STT_FUNC |   12 | STB_GLOBAL | Symbol is a code object |
+|    15 | read_float         | STT_FUNC |   16 | STB_GLOBAL | Symbol is a code object |
+```python
+elf.symbols['read_float'].get_relocations()
+```
+| index | symbol name        | type                 | calculation |
+|-------|--------------------|----------------------|-------------|
+|     4 | .LANCHOR0          | R_RISCV_PCREL_HI20   | S + A - P   |
+|     5 |                    | R_RISCV_RELAX        |             |
+|     6 | .L0                | R_RISCV_PCREL_LO12_I | S - P       |
+|     7 |                    | R_RISCV_RELAX        |             |
+|     8 | result_float_float | R_RISCV_CALL_PLT     | S + A - P   |
+|     9 |                    | R_RISCV_RELAX        |             |
+
+## Contributing
+Contributions are welcome! Please open an issue or submit a pull request on GitHub.
+
+## Developer Guide
+To get started with developing the `pelfy` package, follow these steps:
+
+First, clone the repository to your local machine using Git:
+
+```bash
+git clone https://github.com/Nonannet/pelfy.git
+cd pelfy
+```
+
+Install the package while keeping files in the current dev directory:
+
+```bash
+pip install -e .
+```
+
+Install pytest (unit testing), mypy (type checking) and flake8 (style guide checking):
+
+```bash
+pip install pytest mypy flake8
+```
+
+Ensure that everything is set up correctly by running the tests:
+
+```bash
+pytest
+```
+
+For creating additional test object files place the source c-files in the `tests/src/` directory,
+change the current directory to `tests/src/` and run `bash run_cross_compilation.sh`. This
+script uses a docker container to cross compile all c-files to object files and outputs
+them in the tests/obj directory.
+   
+## License
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

pelfy-1.0.0/pyproject.toml

@@ -0,0 +1,40 @@
+[project]
+name = "pelfy"
+version = "1.0.0"
+authors = [
+  { name="Nicolas Kruse", email="nicolas.kruse@nonan.net" },
+]
+description = "Parser for ELF files written in python"
+readme = "README.md"
+requires-python = ">=3.9"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+Homepage = "https://github.com/Nonannet/pelfy"
+Issues = "https://github.com/Nonannet/pelfy/issues"
+
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.mypy]
+files = ["src", "tests"]
+strict = true
+warn_return_any = true
+warn_unused_configs = true
+check_untyped_defs = true
+no_implicit_optional = true
+show_error_codes = true
+
+[tool.pytest.ini_options]
+minversion = "6.0"
+addopts = "-ra -q"
+testpaths = ["tests"]
+pythonpath = ["src"]

pelfy-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+