From 2c5009bac5a4133b3f204dbe8b9ec557c05a16d2 Mon Sep 17 00:00:00 2001 From: Hugo Gruson Date: Tue, 14 May 2019 15:54:39 +0200 Subject: [PATCH 1/5] Update outdated paragraph about MCB and Tor This can cause confusion for users, as shown in https://github.com/EFForg/https-everywhere/issues/17882#issuecomment-489828459 --- docs/en_US/rulesets.md | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/docs/en_US/rulesets.md b/docs/en_US/rulesets.md index cf607772cf8a..d27edd4aed06 100644 --- a/docs/en_US/rulesets.md +++ b/docs/en_US/rulesets.md @@ -200,13 +200,9 @@ file. #### [Mixed Content Blocking (MCB)](#mixed-content-blocking-mcb) Some rulesets may trigger active mixed content (i.e. scripts loaded over HTTP -instead of HTTPS). This type of mixed content is blocked in both -[Chrome](https://trac.torproject.org/projects/tor/ticket/6975) and Firefox, +instead of HTTPS). This type of mixed content is blocked in most major browsers, before HTTPS Everywhere has a chance to rewrite the URLs to an HTTPS version. -This generally breaks the site. However, the Tor Browser doesn't block -mixed content, in order to allow HTTPS Everywhere to try and rewrite the URLs -to an HTTPS version. - -To enable a rule only on platforms that allow mixed content (currently only the -Tor Browser), you can add a `platform="mixedcontent"` attribute to the ruleset -element. +This generally breaks the site. Depending on their configuration and threat +model, some users might however decide to enable these rulesets via a global +option in HTTPS Everywhere. To that effect, such rulesets are idenfied with +the specific `platform="mixedcontent"` attribute to the ruleset element. From eb8b66b95d77050dc9475cf4a9012974e2a67b53 Mon Sep 17 00:00:00 2001 From: Hugo Gruson Date: Tue, 14 May 2019 15:56:44 +0200 Subject: [PATCH 2/5] Update links to HTTPS --- docs/en_US/rulesets.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/en_US/rulesets.md b/docs/en_US/rulesets.md index d27edd4aed06..2e692b40a356 100644 --- a/docs/en_US/rulesets.md +++ b/docs/en_US/rulesets.md @@ -3,14 +3,14 @@ This page describes how to write rulesets for [HTTPS Everywhere](https://eff.org/https-everywhere), a browser extension that switches sites over from HTTP to HTTPS automatically. HTTPS Everywhere comes -with [thousands](http://www.eff.org/https-everywhere/atlas/) of rulesets that +with [thousands](https://www.eff.org/https-everywhere/atlas/) of rulesets that tell HTTPS Everywhere which sites it should switch to HTTPS and how. If there is a site that offers HTTPS and is not handled by the extension, this guide will explain how to add that site. #### [Rulesets](#rulesets) -A `ruleset` is an [XML](http://www.xml.com/pub/a/98/10/guide0.html?page=2) file +A `ruleset` is an [XML](https://www.xml.com/pub/a/98/10/guide0.html?page=2) file describing behavior for a site or group of sites. A ruleset contains one or more `rules`. For example, here is [`RabbitMQ.xml`](https://github.com/efforg/https-everywhere/blob/master/src/chrome/content/rules/RabbitMQ.xml), @@ -37,7 +37,7 @@ match that host name. HTTPS Everywhere then tries each rule in those rulesets against the full URL. If the [Regular -Expression](http://www.regular-expressions.info/quickstart.html), or regexp, in +Expression](https://www.regular-expressions.info/quickstart.html), or regexp, in one of those rules matches, HTTPS Everywhere [rewrites the URL](#rules-and-regular-expressions) according the `to` attribute of the rule. @@ -58,7 +58,7 @@ separate target. #### [Rules and Regular Expressions](#rules-and-regular-expressions) The `rule` tags do the actual rewriting work. The `from` attribute of each rule -is a [regular expression](http://www.regular-expressions.info/quickstart.html) +is a [regular expression](https://www.regular-expressions.info/quickstart.html) matched against a full URL. You can use rules to rewrite URLs in simple or complicated ways. Here's a simplified (and now obsolete) example for Wikipedia: @@ -84,9 +84,9 @@ between rulesets is unspecified. Only the first rule or exception matching a given URL is applied. Rules are evaluated using [Javascript regular -expressions](http://www.regular-expressions.info/javascript.html), which are +expressions](https://www.regular-expressions.info/javascript.html), which are similar but not identical to [Perl-style regular -expressions.](http://www.regular-expressions.info/pcre.html) Note that if your +expressions.](https://www.regular-expressions.info/pcre.html) Note that if your rules include ampersands (&), they need to be appropriately XML-encoded: replace each occurrence of **&** with **&**. @@ -118,7 +118,7 @@ less cumbersome. #### [Secure Cookies](#secure-cookies) Many HTTPS websites fail to correctly set the [secure -flag](https://secure.wikimedia.org/wikipedia/en/wiki/HTTP_cookie#Secure_and_HttpOnly) +flag](https://en.wikipedia.org/wiki/HTTP_cookie#Secure_and_HttpOnly) on authentication and/or tracking cookies. HTTPS Everywhere provides a facility for turning this flag on. For instance: From cdfba3bb7c594df73bdad0f0a37b6f7c35e66eb8 Mon Sep 17 00:00:00 2001 From: Hugo Gruson Date: Tue, 14 May 2019 15:59:17 +0200 Subject: [PATCH 3/5] Update example rulesets style --- docs/en_US/rulesets.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/en_US/rulesets.md b/docs/en_US/rulesets.md index 2e692b40a356..63aef7767154 100644 --- a/docs/en_US/rulesets.md +++ b/docs/en_US/rulesets.md @@ -18,11 +18,11 @@ from the addon distribution: ```xml - - + + - + ``` @@ -64,10 +64,10 @@ complicated ways. Here's a simplified (and now obsolete) example for Wikipedia: ```xml - + - + ``` @@ -97,7 +97,7 @@ the rule should **not** be applied. The Stack Exchange rule contains an exclusion for the OpenID login path, which breaks logins if it is rewritten: ```xml - + ``` Exclusions are always evaluated before rules in a given ruleset. Matching any @@ -189,8 +189,8 @@ element, with a value explaining why the rule is off. ```xml - - + + ``` From 92425c3596f3802a9b14b35f487a8462a14b40ad Mon Sep 17 00:00:00 2001 From: Hugo Gruson Date: Tue, 14 May 2019 17:19:50 +0200 Subject: [PATCH 4/5] Fix typo --- docs/en_US/rulesets.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en_US/rulesets.md b/docs/en_US/rulesets.md index 63aef7767154..9230c28bbe44 100644 --- a/docs/en_US/rulesets.md +++ b/docs/en_US/rulesets.md @@ -204,5 +204,5 @@ instead of HTTPS). This type of mixed content is blocked in most major browsers, before HTTPS Everywhere has a chance to rewrite the URLs to an HTTPS version. This generally breaks the site. Depending on their configuration and threat model, some users might however decide to enable these rulesets via a global -option in HTTPS Everywhere. To that effect, such rulesets are idenfied with +option in HTTPS Everywhere. To that effect, such rulesets are identified with the specific `platform="mixedcontent"` attribute to the ruleset element. From a35776b51295f490755e288845d732e00c8ac137 Mon Sep 17 00:00:00 2001 From: Hugo Gruson Date: Thu, 16 May 2019 11:33:58 +0200 Subject: [PATCH 5/5] Update atlas location --- docs/en_US/rulesets.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en_US/rulesets.md b/docs/en_US/rulesets.md index 9230c28bbe44..f9f71f020f34 100644 --- a/docs/en_US/rulesets.md +++ b/docs/en_US/rulesets.md @@ -3,7 +3,7 @@ This page describes how to write rulesets for [HTTPS Everywhere](https://eff.org/https-everywhere), a browser extension that switches sites over from HTTP to HTTPS automatically. HTTPS Everywhere comes -with [thousands](https://www.eff.org/https-everywhere/atlas/) of rulesets that +with [thousands](https://atlas.eff.org/index.html) of rulesets that tell HTTPS Everywhere which sites it should switch to HTTPS and how. If there is a site that offers HTTPS and is not handled by the extension, this guide will explain how to add that site.