Skip to content

Commit 72fe25a

Browse files
committed
added dependency hint to readme
1 parent 8c5deda commit 72fe25a

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@
55
# Testing C/C++ for Security and Reliability
66
Building robust C/C++ applications is a highly challenging endeavor that requires thorough testing. While C/C++ enables us to write high-performance code, the memory-unsafety nature of the language brings a broad spectrum of security risks. Memory corruption issues constitute the vast majority of bugs and security vulnerabilities found in C/C++ projects, and their impact is best demonstrated by the [Heartbleed](https://en.wikipedia.org/wiki/Heartbleed) bug on OpenSSL. Regular unit and integration tests are essential to test that our code functions correctly - they are not enough to uncover memory-corruption bugs. (Whitebox and smart) Fuzz testing on the other hand, has established itself as the best practical method to find these issues in large code bases such as Google Chrome.
77

8+
These examples require libssl-dev and libzstd-dev installed on Ubuntu. To install both dependencies you can run:
9+
```sh
10+
sudo apt install libssl-dev libzstd-dev -y
11+
```
12+
If you do not want to install both packages, you can also comment out the include of the simple_examples folder in the main [CMakeLists.txt](CMakeLists.txt#L23) file.
13+
814
In this example, we demonstrate how you can use CI Fuzz to integrate fuzz testing into your C/C++ projects. The example project uses [CMake](https://cmake.org/) as the build system and contains the following examples:
915
* [Simple Checks Example](src/simple_examples/explore_me.cpp#L10):
1016
A simple example that triggers a buffer over when the input parameters satisfy certain criteria.

0 commit comments

Comments
 (0)