Skip to content

cad-polito-it/byron

Repository files navigation

byron 🖋

Codename PyPI - Status GitHub License GitHub repo size PyPI - Python Version GitHub Workflow Status (with event) FOSSA Status Documentation Status PyPI - Version PyPI - Downloads

Formerly known as MicroGP v4

Byron is a generic optimizer designed to support source code fuzzing, either in assembly or in higher level languages. It starts by generating a set of random programs, which are then iteratively improved by an evolutionary algorithm. It can handle quite complex structures including subroutines, local and global variables, jumps, conditionals, and loops.

Test programs do not need to be designed, but merely evaluated using an external tool, such as an interpreter or a simulator. Different types of parallelization are supported out of the box, from simple multithreading to the creation of temporary directories where multiple subprocesses are concurrently spawned.

📦 The Python package is available on PyPi; this repo is only useful if you want to hack the code.

TL;DR

  • Byron is currently in alpha and under active development
  • The default branch is always the more stable
  • Do not clone experimental branches exp/* unless you really know what you are doing
  • Follow this style guide and keep the code formatted with Black
  • Follow this convention when drafting commit messages
  • Write as few lines of code and as many lines of comments as possible (ie. use builtins, exploit generators and list comprehension)
  • Be paranoid (cit. "I need someone to show me the things")
  • Use pytest and Coverage.py for unit testing (ie. coverage run --module pytest --all)
  • Use pylint for basic linting and possibly mypy for additional type checking
  • Use direnv to patch environment variables
  • And remember that it may be wise to contact Giovanni before trying to change anything

Contacts

Main Contributors

Licence

Copyright (c) 2023-24 Giovanni Squillero and Alberto Tonda
Byron is free and open-source software, and it is distributed under the permissive Apache License 2.0.