TODO

   1 $Id: TODO,v 1.141 2016/01/21 15:57:30 fabiankeil Exp $
   2
   3 Some Privoxy-related tasks, sorted by the time they
   4 have been added, not by priority.
   5
   6 The latest version should be available at:
   7 http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/current/TODO
   8
   9 There's work in progress to fund development on these items using
  10 donations. If you want to donate, please have a look at:
  11 http://www.privoxy.org/faq/general.html#DONATE
  12
  13 1)  Add more regression tests. Filters should be tested automatically
  14     (variables too). Could probably reuse large parts of Privoxy-Filter-Test.
  15     Note that there is currently work in progress to leverage curl's
  16     test suite, patches have been submitted upstream:
  17     http://curl.haxx.se/mail/lib-2014-06/0070.html
  18
  19 3)  Fix some more XXX: comments.
  20
  21 6)  Remove actions that aren't needed anymore:
  22
  23     content-type-overwrite should probably stay as it's also
  24     used by some of the CGI pages (XXX: name them).
  25
  26     crunch-client-header and crunch-server-header should probably
  27     go, their only advantage is that their search strings can be
  28     controlled through the CGI pages, other than that they only
  29     have disadvantages.
  30
  31     crunch-if-none-match can be replaced with a header filter.
  32
  33     prevent-compression has a misleading name and could
  34     be replaced with a header filter.
  35
  36 7)  force-text-mode has a stupid name and should probably
  37     be renamed to force-filter-mode.
  38
  39 8)  handle-as-empty-document and handle-as-image should
  40     be merged to something like handle-as{something} to
  41     prevent them from being activated at the same time.
  42
  43 10) There's a bug in the CGI editor that turns the
  44     first section's "Insert new section below" into
  45     a "Insert new section above" button.
  46
  47 11) CGI templates should use semantically-correct HTML
  48     and scale properly.
  49
  50     Work in progress.
  51
  52 12) Support pipelining for outgoing connections.
  53
  54 14) Allow to filter POST parameters.
  55
  56 15) If trusted CGI pages are requested without trusted referrer,
  57     set the status code to 403 instead of 200.
  58
  59 16) Filter SSL encrypted content as well.
  60
  61     At the beginning we could use a unencrypted connection between
  62     client and Privoxy, and use an encrypted connection between
  63     Privoxy and the server.
  64
  65     This should be good enough for most of the content the
  66     user would want to filter.
  67
  68     Interested donors: 2.
  69
  70 19) enable-forward-fallback. Syntax? Suggested by K.R.
  71
  72 21) User Manual delivery doesn't accept multiple slashes. Should it?
  73
  74 22) Verify action files properly (Including arguments) and
  75     act accordingly (should probably intercept all requests
  76     with a "Invalid option foo detected" CGI page).
  77
  78 23) Do the same in case of syntax errors in the configuration file,
  79     instead of just exiting or ignoring the problem.
  80
  81 25) Handle multiple filters with the same name better. Reject them?
  82
  83 26) Let show-url-info detect clearly invalid URLs.
  84
  85 27) Make errno logging less thread-unsafe.
  86     Verify that it's really an improvement.
  87
  88 28) Don't take default ports in case of invalid forwarding ports.
  89
  90 31) If a string action foo is disabled csp->action->string[ACTION_STRING_FOO]
  91     doesn't necessarily contain NULL, but may contain the string of an
  92     enabled foo action in an overruled section. Is it a bug? Does it matter?
  93
  94 32) In case of forwarding failures with socks port == 9050,
  95     show extra info about Tor (the whole FAQ entry?).
  96
  97 36) Unload unused action files directly, even if they are
  98     disabled without replacement.
  99
 100 38) In the final results, explicitly list disabled multi actions
 101     with their parameters. Not as trivial as it sounds.
 102
 103 40) When running in daemon mode, Privoxy's working directory is '/'
 104     which means it may not have permissions to dump core when necessary.
 105     Figure out a way to solve this. Introduce a cwd config option?
 106
 107 41) Change documentation framework to one that works cross-platform.
 108     Evaluate WML.
 109
 110 42) Add a DTrace USDT provider. Now that FreeBSD has userland DTrace
 111     support there's no longer any reason not to.
 112
 113 43) Write a tool to check URL patterns against URLs in the log file.
 114     This could be included in Privoxy-Regression-Test.
 115
 116 44) Privoxy-Log-Parser: Consider highlighting "Connection" in:
 117     23:13:03.506 283b6100 Header: Replaced: 'Connection: Keep-Alive' with 'Connection: close'
 118
 119 50) Investigate possible PCRS template speedup when searching
 120     macros with strstr() before compiling pcrs commands.
 121     Investigated, needs some restructuring but is probably worth it.
 122
 123 51) Make user-manual directive more generic to allow serving the FAQ
 124     and files from user-specified directories. Consider changing the
 125     port for "same origin policy" issues.
 126
 127 53) Find a more reliable hoster. Involves finding out what our
 128     requirements are and which SF alternatives fulfil them.
 129     It would probably also make sense to look into what other
 130     projects did when migrating away from SF.
 131
 132     2014-05-13: Work in progress. Hosting wish list at the end
 133     of this file.
 134
 135     Interested donors: 1.
 136
 137 54) Move away from CVS to a more modern revision control system.
 138     Find out if there are any objection against going with Git.
 139     Using Git would also have the advantage that SF now pretends
 140     to support it, so we could do it independently from 53).
 141
 142 58) Move more template strings from the code into the actual templates.
 143
 144 59) Import the German template translation.
 145
 146 60) Ask the Russian translators for input on how to make their
 147     life easier.
 148
 149 61) Consider (optionally?) skipping the hostname comparison when
 150     checking if a connections that goes to a HTTP proxy can be reused.
 151     Do all HTTP proxy support that? Is it worth it?
 152
 153 63) Reject clearly too large requests earlier?
 154
 155 64) Use proper copyright attribution. "Privoxy Developers"
 156     is no legal entity.
 157
 158 65) Polish Website. Probably involves ditching the Docbook
 159     mess in favour of wml. There are already several threads
 160     in the mailinglist archives about this. See also #41.
 161
 162 66) Stop hard-coding the number of action and filter files.
 163
 164 67) Clean up source code directory layout. Depends on 54 so
 165     we don't lose the revision history.
 166
 167 68) Use standard make syntax so we don't depend on GNU make.
 168
 169 69) Update autoconf setup (or move away from it).
 170
 171 70) If the server connection is reset but the headers are
 172     received, consider passing the mess to the client instead
 173     of showing the connect-failed template. Relates to #2698674.
 174
 175 74) Let Privoxy-Regression-Test optionally check that action
 176     sections which disable actions actually are preceded by
 177     sections that enable said actions.
 178
 179 75) Create a tool that creates Privoxy action (and filter?) files
 180     out of adblock files. Could be implemented as option for
 181     url-pattern-translator.pl.
 182
 183 76) Cache DNS responses. Note that this has been requested
 184     several times by users, but is not a developer priority.
 185     If you care about this, feel free to submit patches.
 186
 187 77) Allow to configure the IP address used in outgoing connections.
 188
 189 78) Allow to optionally use pcre's DFA algorithm.
 190
 191 79) Evaluate pcre alternatives.
 192
 193 80) Change FEATURE_EXTENDED_HOST_PATTERNS to support both
 194     extended and vanilla host patterns at the same time.
 195
 196     Note that the requirement is to allow the user to decide
 197     if the domain pattern should be interpreted as regex or
 198     traditional host pattern and if it's not obvious that the
 199     user made any decision, default to the latter.
 200
 201     Possible solutions would be:
 202
 203     1. An always-use-regex-domain-patterns config option
 204     2. An enable-regex-domain-patterns-for-this-action-file option
 205     3. An enable-regex-domain-patterns-for-this-action-file-until-the-user-says-otherwise option
 206     4. A treat-the-domain-pattern-in-this-line-as-regex(-or-not) option
 207     5. Combinations of the options above
 208
 209     With 2+4, 3+4 or 2+3+4 being the preferences until
 210     further discussion.
 211
 212 82) Detect if the system time goes back in time let the user
 213     know if it caused any connections to get closed.
 214
 215 85) Once #84 is done, write a script that populates a directory with
 216     various common third-party icons (stumbleupon.png, facebook.png ...)
 217     and redirect requests for them to Privoxy.
 218
 219 86) Add a server-body-tagger action. This is trivial as as all the
 220     functionality required to do it already exists.
 221
 222 87) Add a client-body-tagger action. This is less trivial as we currently
 223     don't buffer client bodies. After 14) is implemented it would be
 224     trivial, though.
 225
 226 88) Investigate if there's a Perl module that Privoxy-Regression-Test
 227     could optionally use to keep connections alive, preferably while
 228     requiring less forks at the same time.
 229
 230 89) When multiple block actions apply, consider showing all the block
 231     reasons on the blocked page that haven't been overruled, not just
 232     the last one.
 233
 234 91) Add an optional limit for internal redirects. It would probably
 235     be reasonable to default to a limit of one and showing an error
 236     message if the request for the redirect URL would be redirected
 237     again.
 238
 239 92) The statistics currently aren't calculated correctly by Privoxy
 240     as each thread is only counted as one request which is no longer
 241     correct. This should be fixed, or the statistic code removed.
 242     Privoxy-Log-Parser's provides more detailed statistics, anyway.
 243
 244 93) Add a config directive to let Privoxy explicitly request either
 245     IPv4 (or IPv6) addresses, even if the system supports both.
 246     Could be useful as a workaround for misconfigured setups where the
 247     libc returns IPv6 addresses even if there's no IPv6 connectivity.
 248
 249 94) Add a config directive to let Privoxy prefer either IPv4 (or IPv6)
 250     addresses, instead of trusting the libc to return them in an order
 251     that makes sense. Like #93, this could be useful as a workaround
 252     for misconfigured setups.
 253
 254 95) Support a non-standard client header in CONNECT requests that
 255     contains the URL of the requested resource, which is then treated
 256     like the request URL.
 257
 258     This way the client could opt-in for path-based blocking of https
 259     requests. Given that the headers from the CONNECT request aren't
 260     forwarded to the destination server, an unencrypted URL should be
 261     acceptable if the client and Privoxy are running on the same system
 262     or in a trusted environment.
 263
 264 96) Filters should be easier to look up. Currently get_filter() has to
 265     go through all filters and skip the filter types the caller isn't
 266     interested in.
 267
 268 98) When showing action section on the CGI pages, properly escape
 269     line breaks so they can be copy&pasted into action files without
 270     adjustments.
 271
 272 99) Figure out a mechanism through which a user can easily enable
 273     site-specific action sections that are too aggressive to be
 274     enabled by default. This could be similar to the presettings
 275     in default.action, but could also be just another action file
 276     that isn't used by default.
 277
 278 100) Create a cross-platform Privoxy control program and retire
 279      the win32 GUI. Integrate support for Privoxy-Regression-Test,
 280      Privoxy-Log-Parser, Privoxy-Filter-Test, uagen and similar tools.
 281      Interested donors: 1.
 282
 283 102) Add an include directive to split the config file into several parts.
 284
 285 103) Potential performance improvement for large action files:
 286      when figuring out which actions apply, check the action bit mask
 287      before pattern matching and skip section that wouldn't modify the
 288      actions already set. To increase the impact the sections would have
 289      to be applied in reverse.
 290
 291 104) The code to modify global_toggle_state should be factored out into
 292      a separate function. Currently we mess with it in three different
 293      files, but only in w32log.c the tray icon is explicitly set.
 294      The logging is inconsistent as well. For details see #3525694.
 295
 296 105) Add support for socks authentication.
 297
 298 106) actionlist.h should be embedded in a way that causes less text
 299      segment bloat.
 300
 301 107) Support more pcrs variables, for example $destination-ip-address
 302      and $source-ip-address.
 303
 304 108) Allow to use a somewhat random string instead of PRIVOXY-FORCE.
 305
 306 109) Let log_error() support the format specifier %S which should
 307      work like %s but escape new lines like %N. This would be useful
 308      to log the result of header filters which may inject new lines.
 309
 310 110) Add a global-buffer-limit directive that roughly limits how
 311      much malloc'ed memory Privoxy will use and can potentially
 312      be smaller than (buffer-limit * max-client-connections).
 313
 314 111) Reject requests if hosts and ports in request line and Host
 315      header don't match (before filters have been applied).
 316
 317 112) If a header filter is used to inject another header by inserting
 318      a \r\n (undocumented feature), detect it and split the headers so
 319      following header actions do not treat them as a single string.
 320      Alternatively add another header injection mechanism.
 321
 322 113) Log statistics upon receiving a certain signal (SIGINFO or SIGUSR1).
 323
 324 114) Properly deal with status code 100. The current "Continue hack"
 325      can cause problems for gpg when uploading keys through Privoxy.
 326
 327 115) Add ICAP (RFC 3507) support. FR #3615158.
 328
 329 116) Due to the use of sscanf(), Privoxy currently will fail to properly
 330      parse chunks whose size can't be represented with 32 bit. This is
 331      unlikely to cause problems in the real world, but should eventually
 332      be fixed anyway. See also:
 333      https://bugzilla.mozilla.org/show_bug.cgi?id=959100
 334
 335 118) There should be "escaped" dynamic variables that are guaranteed
 336      not to break filters.
 337
 338 119) Evaluate using pcre's jit mode.
 339
 340 120) Add an option to limit pcre's recursion limit below the default.
 341      On some platforms the recursion limit doesn't prevent pcre from
 342      running out of stack space, causing the kernel to kill Privoxy
 343      ungracefully.
 344
 345 121) Add HTTP/2 support. As a first step, incomming HTTP/1.x requests
 346      should be translated to outgoing HTTP/2 requests where possible
 347      (and if desired by the user).
 348      Interested donors: 1.
 349
 350 122) Allow customized log messages.
 351
 352 123) Evaluate if the voluntarily-disclose-session-keys option in Firefox
 353      (and other browsers) can be leveraged. Probably depends on #16.
 354
 355 124) Add support for the "lightweight OS capability and sandbox framework"
 356      Capsicum. http://www.cl.cam.ac.uk/research/security/capsicum/
 357      Interested donors: 1.
 358
 359 125) Allow clients to HTTPS-encrypt the proxy connection.
 360      Interested donors: 1.
 361
 362 126) Run the Co-Advisor HTTP compliance tests, evaluate the results,
 363      fix the compliance issues that aren't by design and document
 364      the rest.
 365      Note that Privoxy developers qualify for free account upgrades:
 366      http://coad.measurement-factory.com/details.html#pricing
 367
 368 127) Add "real" CGI support (serve program output instead of forwarding
 369      the request). The work is mostly done due to +external-filter{}.
 370
 371 128) Add a config directive to control the stack limit.
 372
 373 129) Completely implement RFC 7230 4.1 (Chunked Transfer Coding).
 374      Currently Privoxy doesn't properly deal with trailers which
 375      are rarely used in the real world but should be supported anyway.
 376
 377 130) Move header_tagger() out of the parser structs and let it execute
 378      taggers one-by-one against all headers so the header order has less
 379      influence on the tagging result. As a bonus, dynamic taggers would
 380      have to be compiled less often.
 381
 382 131) The handle-as-empty-doc-returns-ok directive should be replaced with
 383      an action so the behaviour can be enabled on a per-request basis.
 384      Interested donors: 1.
 385
 386 132) Provide a Tor hidden service to reach the Privoxy website.
 387      Work in progress: http://jvauzb4sb3bwlsnc.onion/
 388      This hidden service serves a copy of the www.privoxy.org content
 389      (filtered through Privoxy to replace some absolute URLs).
 390      Interested donors: 1.
 391
 392 133) Consider allowing bitcoin donations.
 393      Interested donors: 2.
 394
 395 134) Track the total number of bytes written to and received from a socket.
 396
 397 135) Add OpenBSM audit support.
 398
 399 136) Make builds reproducible.
 400
 401 137) Add a (preferably vector-based) logo.
 402
 403 138) Bring back the scripts to provide actions file feedback.
 404
 405      Once upon a time (~2003) there were scripts on the webserver
 406      to make reporting action file feedback more convenient for the
 407      user and the actual reports more useful for the developers.
 408      They have been unusable for years and have thus been disabled,
 409      but making the reporting mechanism available again would be a
 410      good idea.
 411
 412 140) Toggling Privoxy off currently also disables stuff that
 413      probably shouldn't be affected (such as actions like
 414      forward-override). Investigate and fix or document.
 415
 416 141) Port Privoxy to CloudABI, which, despite the name, is actually
 417      rather neet. https://github.com/NuxiNL/cloudlibc
 418
 419 142) Remove or update the "internal" pcre version.
 420
 421 143) Add support for OpenBSD's pledge feature once it's stablelized.
 422      This should be a lot less work then #124.
 423
 424 144) Allow Privoxy admins to pre-define tags that are be set for
 425      clients that previously opted-in through the CGI interface.
 426
 427      This would be useful in multi-user setups where admins may
 428      want to allow users to disable certain actions and filters
 429      for themselves without affecting others.
 430
 431      Even in single-user setups this could be useful to allow
 432      more fine-grained toggling. For example to disable request
 433      blocking while still crunching cookies, or to disable
 434      experimental filters only.
 435
 436      Interested donors: 1.
 437
 438 145) Once #144 is implemented, allow clients to opt-in to the
 439      tagging for a limited amount of time (or number of requests).
 440
 441      Interested donors: 1.
 442
 443 146) Once #144 is implemented, optionally allow to save the opt-in
 444      status to disk.
 445
 446 147) Improve "Building from Source" section in the user manual.
 447      A common problem seems to be that it's not obvious to non-technical
 448      users how the listed dependencies can be installed on the commonly
 449      used platforms. Adding a couple of examples should also be useful for
 450      technical users (like Privoxy developers) who want to install or test
 451      Privoxy on platforms they are not familiar with.
 452
 453 ##########################################################################
 454
 455 Hosting wish list (relevant for #53)
 456
 457 What we need:
 458
 459 - Bug tracker
 460 - Mailinglists (Mailman with public archives preferred)
 461 - Webspace (on a Unix-like OS that works with the webserver targets
 462   in GNUMakefile)
 463 - Source code repositories (currently CVS, but migrating away
 464   from it is TODO #54 anyway and shouldn't be too much trouble)
 465 - Commit mails (preferably with unified diffs)
 466
 467 (Unsorted) details to look at when evaluating hosters:
 468
 469 1. Preferably no third-party ads and trackers.
 470    External images, CSS and JavaScript may count as trackers
 471    but texts like "supported by company XYZ" may be acceptable.
 472
 473 2. JavaScript should be optional or not used at all.
 474
 475 3. Services we don't need shouldn't be enabled anyway.
 476    (We currently don't use Web forums, wikis, surveys etc.)
 477
 478 4. It would be preferable if the hoster didn't have a bad track
 479    record as far as user experience, security and privacy are
 480    concerned and if the terms of service are "reasonable" and
 481    haven't changed too often in the past. Updates in the past
 482    should have been improvements and not regressions.
 483
 484 5. It would be preferable if most of the server administration
 485    is done by a trusted third-party (or at least not a lot of work
 486    for us).
 487
 488 6. The server(s) should be located in a country with laws we can
 489    understand and follow (or at least not unintentionally violate).
 490
 491 7. A server location in a country with some kind of due process
 492    and strong data protection laws (at least on paper) would be
 493    preferable.
 494
 495 8. Given that Privoxy is a free software project it would be
 496    preferable if the hoster would use free software where possible.
 497
 498 9. Migrating away from the hoster in the future without losing
 499    any important data should be possible without writing web
 500    scrapers first.