improve example, list requirements

[mark-pictor-csec]

It'd be nice to have a complete use example that can be copied and pasted. The current example has some commands that need to run within the fuzz_ng/ dir and some without.

I'd also like a list of required tools/libs and their versions.
For example, something like

• requires protoc >= v1.2.3 from http://example.com/protoc
• requires libFuzzer from
• requires a C++ compiler
  • known to work with clang >= v4.5.6
  • known to work with gcc <= v2.72
• requires go >=v1.17.0 from

Also, why is go114-fuzz-build named such? Until I noticed the go.mod I assumed the tool must be limited to features available in go1.14. It might be worthwhile to rename this.

[catenacyber]

Thanks @mark-pictor-csec for your interest in this project.

Indeed, this is missing documentation.
The best one is the oss-fuzz builders :
https://github.com/google/oss-fuzz/tree/master/projects/ngolo-fuzzing
https://github.com/google/oss-fuzz/tree/master/projects/ngolo-fuzzing-x

The Dockerfile there install all the required tools/libs that you list.
I do not know the minimum supported version for these tools...

Also, why is go114-fuzz-build named such?

I think this is because go1.14 introduced libFuzzer support
cf https://github.com/mdempsky/go114-fuzz-build

(Likewise, go119-fuzz-build is about native fuzzing introduced in golang 1.19)

But this currently works with go1.21 on oss-fuzz

Is this helping you ?
Please feel free to open a PR to bring more documentation in ;-)

[mark-pictor-csec]

Thanks!

go119-fuzz-build is about native fuzzing introduced in golang 1.19

So ngolo-fuzzing works with this? If so, where would I find it?

[catenacyber]

https://github.com/AdamKorcz/go-118-fuzz-build

ngolo-fuzzing uses libFuzzer style and not golang native.
Should not be too hard to add...