[HTTPS-E Rulesets] Another documentation

Korte korte at free.de
Tue Jan 24 02:48:43 PST 2012


Hi

Maybe this is helpful for someone.

Jens


an incomplete documentation for writing https-everywhere rules
(copied many lines from other sources, see end of text)

Rulesets are simple xml files. Optional features are in [].

<ruleset name="name of website [(hint why default_off)]"
[default_off="explanation why default off"]>

In preferences the long explanation will be shown in the last column "Notes"

<ruleset name="EFF">
<ruleset name="Bandcamp (buggy)" default_off="breaks streaming">

some hints and explanations used:
(broken), (disabled), (pending)
reported broken, self-signed, certificate mismatch, CACert signed, Cert
expired in ..., site operator says not ready yet, breaks some news
sites, different content between HTTP and HTTPS

  <!-- Comment
       second line -->

 <target host="http://servername.to.match/" />
 [<target host="other servername to match" />]

One or more lines, no regular expressions, but a wildcard is allowed.
For more details see [4]
<target host="*.ccc.de" />

 [<exclusion pattern="http://example.com/"/>]
but don't match this one:
<exclusion pattern="^http://blog.chaosradio\.ccc\.de/"/><!-- invalid
cert -->

 <rule from="^http://(www\.)?example.com/" to="https://www.example.com/"/>
 [<rule from="^http://(www\.)?otherservername.com"
to="https://otherservername.com"/>]

One or more lines rewrite the URL. The "from" and "to" clauses in each
rule are JavaScript regular expressions [3].

<rule from="^http://([^/:@\.]+)\.ccc\.de/" to="https://$1.ccc.de/"/>

Note that if your rules include ampersands (&), they need to be
appropriately XML-encoded: replace each occurence of & with &#x26;.

</ruleset>

Sources and see also:
[1] HTTPS Everywhere Rulesets: https://www.eff.org/https-everywhere/rulesets
[2] many Rules:
https://gitweb.torproject.org/https-everywhere.git/tree/HEAD:/src/chrome/content/rules
[3] JavaScript regular expressions:
http://www.regular-expressions.info/javascript.html
[4] read above this anchor:
https://www.eff.org/https-everywhere/rulesets#footnoteref1_jqyoo4i
[5] this document:
https://mail1.eff.org/pipermail/https-everywhere-rules/2012-January/000929.html



More information about the HTTPS-Everywhere-Rules mailing list