X-Git-Url: http://www.privoxy.org/gitweb/?a=blobdiff_plain;f=doc%2Fsource%2Fdeveloper-manual.sgml;h=c23da1daba94727b6ae284fbef291657b0115511;hb=2e8c7e4321104708859ad7bf3e5697c0897778c5;hp=35a2b8227a0a4b709dc3a9fc70bcab2020802038;hpb=4690cdc25fe58ef80bc299f8daea7245476df09f;p=privoxy.git
diff --git a/doc/source/developer-manual.sgml b/doc/source/developer-manual.sgml
index 35a2b822..c23da1da 100644
--- a/doc/source/developer-manual.sgml
+++ b/doc/source/developer-manual.sgml
@@ -5,10 +5,10 @@
-
-
-
-
+
+
+
+
@@ -21,9 +21,9 @@
This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: developer-manual.sgml,v 2.62 2016/01/22 12:14:51 ler762 Exp $
+ $Id: developer-manual.sgml,v 2.83 2017/06/08 13:08:39 fabiankeil Exp $
- Copyright (C) 2001-2016 Privoxy Developers http://www.privoxy.org/
+ Copyright (C) 2001-2016 Privoxy Developers https://www.privoxy.org/
See LICENSE.
========================================================================
@@ -42,14 +42,14 @@
- Copyright
+ Copyright
&my-copy; 2001-2016 by
- Privoxy Developers
+ Privoxy Developers
- $Id: developer-manual.sgml,v 2.62 2016/01/22 12:14:51 ler762 Exp $
+ $Id: developer-manual.sgml,v 2.83 2017/06/08 13:08:39 fabiankeil Exp $
-
-
@@ -137,7 +134,7 @@ Hal.
Quickstart to Privoxy Development
The first step is to join the developer's mailing list.
+ url="https://lists.privoxy.org/mailman/listinfo/privoxy-devel">privoxy-devel mailing list.
You can submit your ideas, or even better patches. Patches are best
submitted to the Sourceforge tracker set up for this purpose, but
can be sent to the list for review too.
@@ -168,11 +165,8 @@ Hal.
Access to CVS
The project's CVS repository is hosted on
- SourceForge.
- Please refer to the chapters 6 and 7 in
- SF's site
- documentation for the technical access details for your
- operating system. For historical reasons, the CVS server is
+ SourceForge.
+ For historical reasons, the CVS server is
called ijbswa.cvs.sourceforge.net, the repository is
called ijbswa, and the source tree module is called
current.
@@ -186,7 +180,8 @@ Hal.
mentioned, the sources are in the current
module
. Other modules are present for platform specific
issues. There is a webview of the CVS hierarchy at http://ijbswa.cvs.sourceforge.net/ijbswa/,
+ url="http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/"
+ >http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/,
which might help with visualizing how these pieces fit together.
d$";
* Purpose : (Fill me in with a good description!)
*
* Copyright : Written by and Copyright (C) 2001-2009
- * the Privoxy team. http://www.privoxy.org/
+ * the Privoxy team. https://www.privoxy.org/
*
* This program is free software; you can redistribute it
* and/or modify it under the terms of the GNU General
@@ -1840,7 +1835,7 @@ const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
Note: This declares the rcs variables that should be
- added to the "show-proxy-args" page. If this is a brand new
+ added to the "show-version" page. If this is a brand new
creation by you, you are free to change the "Copyright" section
to represent the rights you wish to maintain.
@@ -1862,7 +1857,7 @@ const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
* Purpose : (Fill me in with a good description!)
*
* Copyright : Written by and Copyright (C) 2001-2009
- * the Privoxy team. http://www.privoxy.org/
+ * the Privoxy team. https://www.privoxy.org/
*
* This program is free software; you can redistribute it
* and/or modify it under the terms of the GNU General
@@ -1979,24 +1974,71 @@ Install the rpm. Any error messages?
+
- Test reports
-
-Please submit test reports only with the test form
-at sourceforge. Three simple steps:
-
-
- Select category: the distribution you test on.
- Select group: the version of Privoxy that we are about to release.
- Fill the Summary and Detailed Description with something
- intelligent (keep it short and precise).
-
-
- Do not mail to the mailing list (we cannot keep track on issues there).
-
+ Fuzzing Privoxy
+
+ To make fuzzing more convenient, Privoxy can be configured
+ with --enable-fuzz which will result in the --fuzz option
+ becoming available.
+
+
+ Example (tested on ElectroBSD):
+
+
+# Compile Privoxy with instrumentation for afl
+$ export CC=afl-clang
+$ export CFLAGS="-fsanitize=address -ggdb"
+$ export CPPFLAGS=-I/usr/local/include/
+$ export LDFLAGS="-fsanitize=address -L/usr/local/lib"
+$ export AFL_USE_ASAN=1
+$ export AFL_HARDEN=1
+$ ./configure --with-debug --enable-extended-host-patterns --enable-accept-filter --enable-no-gifs --enable-compression --enable-strptime-sanity-checks --enable-external-filters --enable-fuzz
+
+$ ./privoxy --fuzz
+Privoxy version 3.0.24 (http://www.privoxy.org/)
+Usage: ./privoxy [--config-test] [--chroot] [--help] [--no-daemon] [--pidfile pidfile] [--pre-chroot-nslookup hostname] [--user user[.group]] [--version] [configfile]
+ ./privoxy --fuzz fuzz-mode ./path/to/fuzzed/input [--stfu]
+
+Supported fuzz modes and the expected input:
+ action: Text to parse as action file.
+ client-request: Client request to parse. Currently incomplete
+ client-header: Client header to parse.
+ chunked-transfer-encoding: Chunk-encoded data to dechunk.
+ deflate: deflate-compressed data to decompress.
+ filter: Text to parse as filter file.
+ gif: gif to deanimate.
+ gzip: gzip-compressed data to decompress.
+ pcrs-substitute: A pcrs-substitute to compile. Not a whole pcrs job! Example: Bla $1 bla C $3 blah.
+ server-header: Server header to parse.
+ server-response: Server response to parse.
+
+The following fuzz modes read data from stdin if the 'file' is '-'
+ client-request
+ client-header
+ chunked-transfer-encoding
+ deflate
+ gif
+ gzip
+ pcrs-substitute
+ server-header
+ server-response
+
+Aborting
+
+$ export ASAN_OPTIONS='abort_on_error=1'
+$ mkdir input output
+$ echo '$1 bla fasel $2' > input/pcrs
+$ afl-fuzz -i input -o output -m none ~/git/privoxy/privoxy --fuzz pcrs-substitute - --stfu
+
+$ cat >input/pcrs.txt
+FILTER: bla fasel
+s@(.{1})[432](\d+)@$1$2$hostname@UgisT
+
+$ afl-fuzz -i input/ -o output/ -f bla.filter -m none privoxy --fuzz filter bla.filter --stfu
+
-
@@ -2124,25 +2166,29 @@ at sourceforge. Three simple steps:
Increment the version number (point from odd to even in development
- branches!) in configure.in. (RPM spec files
- will need to be incremented as well.)
+ branches!) in configure.in and update the code
+ status (CODE_STATUS="xxx") to one of "alpha", "beta" or "stable".
+ Rebuild configure and GNUMakefile to make sure the updated values are
+ being used.
- If default.action has changed since last
- release (i.e. software release or standalone actions file release),
- bump up its version info to A.B in this line:
+ Use the dok-release target to update the sgml documentation source files.
+
+
+ If action file processing has changed and is not backward-compatible,
+ make sure the "for-privoxy-version=x.y.z" minimum version number in
+ default.action.master has been updated:
- {+add-header{X-Actions-File-Version: A.B} -filter -no-popups}
+{{settings}}
+#############################################################################
+#MASTER# COMMENT: The minimum Privoxy version:
+for-privoxy-version=3.0.11
-
- Then change the version info in doc/webserver/actions/index.php,
- line: '$required_actions_file_version = "A.B";'
-
@@ -2151,7 +2197,7 @@ at sourceforge. Three simple steps:
without the ability to build these). Some docs may require
rather obscure processing tools. config,
the man page (and the html version of the man page)
- fall in this category. REAMDE, the man page, AUTHORS, and config
+ fall in this category. README, the man page, AUTHORS, and config
should all also be committed to CVS for other packagers. The
formal docs should be uploaded to the webserver. See the
Section "Updating the webserver" in this manual for details.
@@ -2429,7 +2475,7 @@ at sourceforge. Three simple steps:
be reset to one if this is the first RPM for
dist which is built from version
X.Y.Z. Check the
- file
+ file
list if unsure. Else, it must be set to the highest already available RPM
release number for that version plus one.
@@ -2736,77 +2782,8 @@ at sourceforge. Three simple steps:
FreeBSD
- Login to Sourceforge's compile-farm via ssh:
-
-
-
- ssh cf.sourceforge.net
-
-
-
- Choose the right operating system.
- When logged in, make sure that you have freshly exported the right
- version into an empty directory. (See "Building and releasing
- packages" above). Then run:
-
-
-
- cd current
- autoheader && autoconf && ./configure
-
-
-
- Then run:
-
-
-
- gmake freebsd-dist
-
-
-
- which creates a gzip'ed tar archive. Sadly, you cannot use make
- freebsd-upload on the Sourceforge machine (no ncftpput). You now have
- to manually upload the archive to Sourceforge's ftp server and release
- the file publicly. Use the release notes and Change Log from the
- source tarball package.
-
-
-
- AIX
-
- Login to Sourceforge's compilefarm via ssh:
-
-
-
- ssh cf.sourceforge.net
-
-
-
- Choose the right operating system.
- When logged in, make sure that you have freshly exported the right
- version into an empty directory. (See "Building and releasing
- packages" above). Then run:
-
-
-
- cd current
- autoheader && autoconf && ./configure
-
-
-
- Then run:
-
-
-
- make aix-dist
-
-
-
- which creates a gzip'ed tar archive. Sadly, you cannot use make
- aix-upload on the Sourceforge machine (no ncftpput). You now have
- to manually upload the archive to Sourceforge's ftp server and release
- the file publicly. Use the release notes and Change Log from the
- source tarball package.
+ Update the www/privoxy port and submit a diff upstream.
+ For details see the FreeBSD Porter's Handbook.
@@ -2873,10 +2850,10 @@ at sourceforge. Three simple steps:
After the Release
When all (or: most of the) packages have been uploaded and made available,
- send an email to the announce
+ send an email to the announce
mailing list, Subject: "Version X.Y.Z available for download". Be sure to
include the
- download
+ download
location, the release notes and the Changelog. Also, post an
updated News item on the project page Sourceforge, and update the Home
page and docs linked from the Home page (see below). Other news sites
@@ -2931,7 +2908,7 @@ at sourceforge. Three simple steps:
- This will do the upload to the
+ This will do the upload to the
webserver (www.privoxy.org) and ensure all files and directories
there are group writable.