README.md

Binary Security

These are open educational resources (OER) for Binary Security classes.

Using the Content

Content is located in the chapters/ directory. Each chapter has its own directory:

• Binary Analysis
• Exploitation Techniques
• Mitigations and Defensive Strategies
• Extra

Chapter Contents

Chapters consists of sections, each presenting a given topic. Each chapter has a directory, with a subdirectory for each section. Content types are stored for each section.

Content is written in GitHub Markdown.

Contributing

Contributions are welcome. See the contribution guide on how you could report or fix issues and on how you can improve the content.

Reviewers are requested to follow the reviewing guide.

Publishing the Content

In order to publish the content of this repository, we use a GitHub workflow located in .github/workflows/deployment.yml. This workflow will build the site using Docusaurus and publish the contents to https://open-education-hub.github.io/methodology/.

Running Locally

When testing locally, you will have to build the container that will run the builder based on the Dockerfile. For this, the simplest way is the use the Makefile.

To generate the web contents locally, run:

make

To view the local contents, start a web server by running the command:

make serve

As the output of the command tells, point your browser to http://localhost:8080/binary-security.