From: Andrew Bartlett <abartlet@samba.org>
Date: Wed, 20 Nov 2019 21:21:54 +0000 (+1300)
Subject: lib/fuzzing: Add oss-fuzz info to README.md
X-Git-Tag: ldb-2.1.0~643
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f8947538b5e445ab9c1931d1f7826771ee582385;p=thirdparty%2Fsamba.git

lib/fuzzing: Add oss-fuzz info to README.md

Note that Samba has not been accepted yet, but will be soon once some requirements
are addressed per:

https://github.com/google/oss-fuzz/pull/2993

Signed-off-by: Andrew Bartlett <abartlet@samba.org>
Reviewed-by: Douglas Bagnall <douglas.bagnall@catalyst.net.nz>
Reviewed-by: Uri Simchoni <uri@samba.org>

Autobuild-User(master): Douglas Bagnall <dbagnall@samba.org>
Autobuild-Date(master): Thu Nov 21 00:45:33 UTC 2019 on sn-devel-184
---

diff --git a/lib/fuzzing/README.md b/lib/fuzzing/README.md
index 3848838ba02..97b49ed0fb1 100644
--- a/lib/fuzzing/README.md
+++ b/lib/fuzzing/README.md
@@ -32,4 +32,30 @@ buildtools/bin/waf --targets=fuzz_tiniparser build && \
   --rlimit_rss 100 -f .../tiniparser-corpus -- bin/fuzz_tiniparser
 ```
 
+# oss-fuzz
+
+Samba can be fuzzed by Google's oss-fuzz system.  Assuming you have an
+oss-fuzz checkout from https://github.com/google/oss-fuzz with Samba's
+metadata in projects/samba, the following guides will help:
+
+## Testing locally
+
+https://google.github.io/oss-fuzz/getting-started/new-project-guide/#testing-locally
+
+## Debugging oss-fuzz
+
+See https://google.github.io/oss-fuzz/advanced-topics/debugging/
+
+## Samba-specific hints
+
+A typical debugging workflow is:
+
+oss-fuzz$ python infra/helper.py shell samba
+git fetch $REMOTE $BRANCH
+git checkout FETCH_HEAD
+lib/fuzzing/oss-fuzz/build_image.sh
+compile
+
+This will pull in any new Samba deps and build Samba's fuzzers.
+
 # vim: set sw=8 sts=8 ts=8 tw=79 :