From: Nikos Mavrogiannopoulos <nmav@gnutls.org>
Date: Fri, 24 Jan 2020 22:11:34 +0000 (+0100)
Subject: README-adding-traces.md: updated with more precise information
X-Git-Tag: 3.6.12~11^2~1
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=9bf69f837c979fb850d2ff4afa492611073ea366;p=thirdparty%2Fgnutls.git

README-adding-traces.md: updated with more precise information

Signed-off-by: Nikos Mavrogiannopoulos <nmav@gnutls.org>
---

diff --git a/fuzz/README-adding-traces.md b/fuzz/README-adding-traces.md
index 485c8bbb3d..20866f6ff3 100644
--- a/fuzz/README-adding-traces.md
+++ b/fuzz/README-adding-traces.md
@@ -1,10 +1,14 @@
 # Generate and add new protocol traces 
 
+## Step 1: compilation
+
 Compile GnuTLS as:
 ```
 ./configure --enable-fuzzer-target --disable-doc
 ```
 
+## Step 2: Get the traces
+
 Start the server with the necessary parameters (here TLS1.3 is assumed).
 ```
 ./gnutls-http-serv --priority NORMAL:-VERS-ALL:+VERS-TLS1.3
@@ -17,6 +21,19 @@ gnutls-cli localhost:5556 --priority NORMAL:-VERS-ALL:+VERS-TLS1.3:-KX-ALL:+PSK
 gnutls-cli localhost:5556 --priority NORMAL:-VERS-ALL:+VERS-TLS1.3:-KX-ALL:+DHE-PSK --insecure --save-server-trace /tmp/server-trace-psk2 --save-client-trace /tmp/client-trace-psk2 --pskusername test --pskkey 8a7759b3f26983c453e448060bde8981
 ```
 
+## Step 3: Ensure server can read them
+
+If there is a new key type tested, ensure that `gnutls_server_fuzzer` and
+`gnutls_client_fuzzer` enable it, and set the appropriate keys.
+
+To verify that connection proceeds past to reading the first packet use:
+$ make gnutls_server_fuzzer gnutls_client_fuzzer
+$ GNUTLS_DEBUG_LEVEL=6 gnutls_server_fuzzer /tmp/server-trace-x509
+$ GNUTLS_DEBUG_LEVEL=6 gnutls_client_fuzzer /tmp/client-trace-x509
+
+
+## Step 4: Copy the traces
+
 cp /tmp/server-trace-x509 fuzz/gnutls_client_fuzzer.in/$(sha1sum /tmp/server-trace-x509|cut -d ' ' -f 1)
 cp /tmp/server-trace-psk1 fuzz/gnutls_psk_client_fuzzer.in/$(sha1sum /tmp/server-trace-psk1|cut -d ' ' -f 1)
 cp /tmp/server-trace-psk2 fuzz/gnutls_psk_client_fuzzer.in/$(sha1sum /tmp/server-trace-psk2|cut -d ' ' -f 1)