From: Guido Vranken <guidovranken@users.noreply.github.com>
Date: Mon, 26 Jun 2017 21:06:15 +0000 (+0200)
Subject: Update README
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d30698412b7f38b2a1950e312a286e14af938f88;p=thirdparty%2Fopenvpn.git

Update README

Describe procedure to built fuzzers
---

diff --git a/README b/README
index 103a75a69..d80d408a6 100644
--- a/README
+++ b/README
@@ -1,74 +1,32 @@
-OpenVPN -- A Secure tunneling daemon
+OpenVPN fuzzers
 
-Copyright (C) 2002-2010 OpenVPN Technologies, Inc. This program is free software;
-you can redistribute it and/or modify
-it under the terms of the GNU General Public License version 2
-as published by the Free Software Foundation.
+Get clang:
 
-*************************************************************************
+```c
+git clone https://chromium.googlesource.com/chromium/src/tools/clang
+clang/scripts/update.py
+```
 
-To get the latest release of OpenVPN, go to:
+and update your ```PATH```.
 
-	https://openvpn.net/index.php/download/community-downloads.html
+Get libFuzzer:
 
-To Build and Install,
+```c
+svn co http://llvm.org/svn/llvm-project/llvm/trunk/lib/Fuzzer
+cd Fuzzer
+clang++ -c -g -O2 -std=c++11 *.cpp
+ar r libFuzzer.a *.o
+ranlib libFuzzer.a
+```
 
-	tar -zxf openvpn-<version>.tar.gz
-	cd openvpn-<version>
-	./configure
-	make
-	make install
+Put libFuzzer in src/openvpn
 
-or see the file INSTALL for more info.
+Make OpenVPN
 
-*************************************************************************
+```
+autoreconf -ivf; ./configure && make -j6
+```
 
-For detailed information on OpenVPN, including examples, see the man page
-  http://openvpn.net/man.html
+You don't need to set ```CC``` or ```CFLAGS```; they are hard-coded in this branch.
 
-For a sample VPN configuration, see
-  http://openvpn.net/howto.html
-
-To report an issue, see
-  https://community.openvpn.net/openvpn/report
-
-For a description of OpenVPN's underlying protocol,
-  see the file ssl.h included in the source distribution.
-
-*************************************************************************
-
-Other Files & Directories:
-
-* configure.ac -- script to rebuild our configure
-  script and makefile.
-
-* sample/sample-scripts/verify-cn
-
-  A sample perl script which can be used with OpenVPN's
-  --tls-verify option to provide a customized authentication
-  test on embedded X509 certificate fields.
-
-* sample/sample-keys/
-
-  Sample RSA keys and certificates.  DON'T USE THESE FILES
-  FOR ANYTHING OTHER THAN TESTING BECAUSE THEY ARE TOTALLY INSECURE.
-
-* sample/sample-config-files/
-
-  A collection of OpenVPN config files and scripts from
-  the HOWTO at http://openvpn.net/howto.html
-
-*************************************************************************
-
-Note that easy-rsa and tap-windows are now maintained in their own subprojects.
-Their source code is available here:
-
-  https://github.com/OpenVPN/easy-rsa
-  https://github.com/OpenVPN/tap-windows
-
-The old cross-compilation environment (domake-win) and the Python-based
-buildsystem have been replaced with openvpn-build:
-
-  https://github.com/OpenVPN/openvpn-build
-
-See the INSTALL file for usage information.
+After compiling, you can find the fuzzers in src/openvpn.