Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dawoox/efc
Check if a binary contains banned functions. This program is made for Epitech student (and can be used in automated CI !)
https://github.com/dawoox/efc
banned-function checker ci epitech
Last synced: 28 days ago
JSON representation
Check if a binary contains banned functions. This program is made for Epitech student (and can be used in automated CI !)
- Host: GitHub
- URL: https://github.com/dawoox/efc
- Owner: Dawoox
- License: gpl-3.0
- Created: 2023-11-25T11:16:36.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-01-05T10:09:40.000Z (10 months ago)
- Last Synced: 2024-01-05T11:38:26.619Z (10 months ago)
- Topics: banned-function, checker, ci, epitech
- Language: Python
- Homepage:
- Size: 77.1 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [EFC] Epitech Banned Function Checker
This tool allow you to check if your binary contains any function banned in your current subject.
It was made to be used in an automated CI.
> **Warning**: The program will only run on UNIX systems.
> ***Note**: The program is only tested on NixOS.*
---
## Dependencies
### On Nix systems
Nothing ! Everything is provided by the [flake.nix](./flake.nix) file.
### On other systems
- [GNU binutils](https://www.gnu.org/software/binutils/)
- [Python 3](https://www.python.org/)
## Usage
If you don't specify the path to the authorized functions,
the program will use the default one: `./bonus/authorized_functions.txt`
### On Nix systems
```bash
nix run github:Dawoox/efc [/path/to/authorized_functions.txt]
```
### On other systems
```bash
python3 ./EpiFunctionChecker/main.py [/path/to/authorized_functions.txt]
```
## authorized_functions.txt
The file must contain the list of authorized functions, one per line.
*For example (from the setting_up project):*
```txt
open
read
write
close
malloc
free
stat
```
Each line is treated as **a regex expression**, so you can ues wildcard to allow
a full library.
*For example (in the my_hunter project) to include all the CSFML functions:*
```txt
sf*
```
## Limitations
- On some projects, the TA authorizes some functions without it being writing on the subject. On the setting_up project for example, the TA authorizes the use of `memset` without it being written on the subject.
- We can't provide a trace back to the line where the banned function is used. We can only provide the name of the function (and the address where it is used, but it won't show up in the output).
- Doesn't work on library file (.a), see [this issue](https://github.com/Dawoox/efc/issues/1)
- CSFML colors need to be added to the `authorized_functions.txt` file, see [this issue](https://github.com/Dawoox/efc/issues/5)