Skip to content

Commit 245c10b

Browse files
mikewestmikewest
committed
CLEAR: Addressing ABNF nits.
1 parent 065b30d commit 245c10b

File tree

2 files changed

+42
-36
lines changed

2 files changed

+42
-36
lines changed

‎specs/clear-site-data/index.html

Lines changed: 37 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@
7171
<h1 class="p-name no-ref" id="title">Clear Site Data</h1>
7272

7373
<h2 class="no-num no-toc no-ref heading settled" id="subtitle"><span class="content">Editor’s Draft,
74-
<time class="dt-updated" datetime="2015-08-10">10 August 2015</time></span></h2>
74+
<time class="dt-updated" datetime="2015-08-12">12 August 2015</time></span></h2>
7575

7676
<div data-fill-with="spec-metadata">
7777
<dl>
@@ -352,14 +352,14 @@ <h4 class="heading settled" data-level="1.1.1" id="example-signout"><span class=
352352
<h4 class="heading settled" data-level="1.1.2" id="example-targeted"><span class="secno">1.1.2. </span><span class="content">Targeted Clearing</span><a class="self-link" href="#example-targeted"></a></h4>
353353

354354

355-
<div class="example" id="example-0b8e3ea5"><a class="self-link" href="#example-0b8e3ea5"></a>
355+
<div class="example" id="example-5c8dc63b"><a class="self-link" href="#example-5c8dc63b"></a>
356356
A user signs out of Megacorp Inc.'s site via a CSRF-protected POST to
357357
<code>https://megacorp.example.com/logout</code>. Megacorp has a large
358358
number of services available as subdomains, so many that it’s not entirely
359359
clear which of them would be safe to clear as a response to a logout action.
360360
One option would be to simply clear everything, and deal with the fallout.
361361
Megacorp’s CEO, however, once lost hours and hours of progress in "Irate
362-
Ibexes" due to inadvertant site-data clearing, and so refuses to allow such
362+
Ibexes" due to inadvertent site-data clearing, and so refuses to allow such
363363
a sweeping impact to the site’s users.
364364

365365

@@ -420,7 +420,7 @@ <h4 class="heading settled" data-level="1.1.3" id="example-keepcookies"><span cl
420420
<h4 class="heading settled" data-level="1.1.4" id="example-killswitch"><span class="secno">1.1.4. </span><span class="content">Kill Switch</span><a class="self-link" href="#example-killswitch"></a></h4>
421421

422422

423-
<div class="example" id="example-346b1576"><a class="self-link" href="#example-346b1576"></a>
423+
<div class="example" id="example-464d0d26"><a class="self-link" href="#example-464d0d26"></a>
424424
Super Secret Social Network’s developers learn that the site was vulnerable
425425
to cross-site scripting attacks which allowed malicious parties to inject
426426
arbitrary code into its origin. They fixed the site, and added a strong
@@ -441,7 +441,7 @@ <h4 class="heading settled" data-level="1.1.4" id="example-killswitch"><span cla
441441

442442
<p class="note" role="note">Note: Installing a Service Worker guarantees that a request will go out to
443443
a server every ~24 hours. That update ping would be a wonderful time to send
444-
a header like this one in case of catastophe. <a data-link-type="biblio" href="#biblio-service-workers">[SERVICE-WORKERS]</a></p>
444+
a header like this one in case of catastrophe. <a data-link-type="biblio" href="#biblio-service-workers">[SERVICE-WORKERS]</a></p>
445445

446446

447447
</div>
@@ -508,7 +508,8 @@ <h3 class="heading settled" data-level="2.1" id="header"><span class="secno">2.1
508508

509509
<p>The <dfn data-dfn-type="dfn" data-noexport="" id="clear_site_data"><code>Clear-Site-Data</code><a class="self-link" href="#clear_site_data"></a></dfn> HTTP response header field
510510
sends a signal to the user agent that it ought to remove all data
511-
of a certain set of types. The header is represented by the following ABNF:</p>
511+
of a certain set of types. The header is represented by the following ABNF
512+
<a data-link-type="biblio" href="#biblio-rfc5234">[RFC5234]</a>:</p>
512513

513514

514515
<pre>Clear-Site-Data = 1#option
@@ -520,7 +521,7 @@ <h3 class="heading settled" data-level="2.1" id="header"><span class="secno">2.1
520521

521522

522523
<p class="note" role="note">Note: The <a data-link-type="dfn" href="https://tools.ietf.org/html/rfc7230#section-3.2.3">BWS</a>, <a data-link-type="dfn" href="https://tools.ietf.org/html/rfc7230#section-3.2.3">OWS</a>, <a data-link-type="dfn" href="https://tools.ietf.org/html/rfc7230#section-3.2.6">token</a>, and <a data-link-type="dfn" href="https://tools.ietf.org/html/rfc7230#section-3.2.6">quoted-string</a> rules
523-
are defined in <a data-link-type="biblio" href="#biblio-rfc7230">[RFC7230]</a>.</p>
524+
as well as the <a data-link-type="dfn" href="https://tools.ietf.org/html/rfc7230#section-7">#rule</a> list extension are defined in <a data-link-type="biblio" href="#biblio-rfc7230">[RFC7230]</a>.</p>
524525

525526

526527
<p>The <a data-link-type="dfn" href="#clear_site_data">Clear-Site-Data</a> header’s value is essentially a semicolon-delimited
@@ -1753,35 +1754,35 @@ <h3 class="no-ref no-num heading settled" id="conformance-classes"><span class="
17531754
<h2 class="no-num heading settled" id="index"><span class="content">Index</span><a class="self-link" href="#index"></a></h2>
17541755
<h3 class="no-num heading settled" id="index-defined-here"><span class="content">Terms defined by this specification</span><a class="self-link" href="#index-defined-here"></a></h3>
17551756
<ul class="indexlist">
1756-
<li><a href="#">*</a><span>, in §2.1.6</span>
1757-
<li><a href="#cache">cache</a><span>, in §2.1.1</span>
1758-
<li><a href="#dom-storagemanager-clear">clear(options)</a><span>, in §2.2</span>
1759-
<li><a href="#clear_site_data">Clear-Site-Data</a><span>, in §2.1</span>
1760-
<li><a href="#conformant-server">conformant server</a><span>, in §Unnumbered section</span>
1761-
<li><a href="#conformant-user-agent">conformant user agent</a><span>, in §Unnumbered section</span>
1762-
<li><a href="#cookies">cookies</a><span>, in §2.1.2</span>
1763-
<li><a href="#does-not-match">Does Not
1764-
Match</a><span>, in §3.1.3</span>
1765-
<li><a href="#domstorage">domStorage</a><span>, in §2.1.3</span>
1766-
<li><a href="#exclude-subdomains">Exclude
1767-
Subdomains</a><span>, in §3.1.2</span>
1768-
<li><a href="#executioncontexts">executionContexts</a><span>, in §2.1.4</span>
1757+
<li>*, <a href="#">2.1.6</a>
1758+
<li>cache, <a href="#cache">2.1.1</a>
1759+
<li>clear(options), <a href="#dom-storagemanager-clear">2.2</a>
1760+
<li>Clear-Site-Data, <a href="#clear_site_data">2.1</a>
1761+
<li>conformant server, <a href="#conformant-server">Unnumbered section</a>
1762+
<li>conformant user agent, <a href="#conformant-user-agent">Unnumbered section</a>
1763+
<li>cookies, <a href="#cookies">2.1.2</a>
1764+
<li>Does Not
1765+
Match, <a href="#does-not-match">3.1.3</a>
1766+
<li>domStorage, <a href="#domstorage">2.1.3</a>
1767+
<li>Exclude
1768+
Subdomains, <a href="#exclude-subdomains">3.1.2</a>
1769+
<li>executionContexts, <a href="#executioncontexts">2.1.4</a>
17691770
<li>includeSubdomains
17701771
<ul>
1771-
<li><a href="#includesubdomains">definition of</a><span>, in §2.1.5</span>
1772-
<li><a href="#dom-storageclearoptions-includesubdomains">dict-member for StorageClearOptions</a><span>, in §2.2</span>
1772+
<li>definition of, <a href="#includesubdomains">2.1.5</a>
1773+
<li>dict-member for StorageClearOptions, <a href="#dom-storageclearoptions-includesubdomains">2.2</a>
17731774
</ul>
1774-
<li><a href="#include-subdomains">Include
1775-
Subdomains</a><span>, in §3.1.2</span>
1776-
<li><a href="#key">key</a><span>, in §2.1</span>
1777-
<li><a href="#matches">Matches</a><span>, in §3.1.3</span>
1778-
<li><a href="#option">option</a><span>, in §2.1</span>
1779-
<li><a href="#dom-storagemanager-clear-options-options">options</a><span>, in §2.2</span>
1780-
<li><a href="#parameter">parameter</a><span>, in §2.1</span>
1781-
<li><a href="#dictdef-storageclearoptions">StorageClearOptions</a><span>, in §2.2</span>
1782-
<li><a href="#enumdef-storagecleartype">StorageClearType</a><span>, in §2.2</span>
1783-
<li><a href="#dom-storageclearoptions-types">types</a><span>, in §2.2</span>
1784-
<li><a href="#value">value</a><span>, in §2.1</span></ul>
1775+
<li>Include
1776+
Subdomains, <a href="#include-subdomains">3.1.2</a>
1777+
<li>key, <a href="#key">2.1</a>
1778+
<li>Matches, <a href="#matches">3.1.3</a>
1779+
<li>option, <a href="#option">2.1</a>
1780+
<li>options, <a href="#dom-storagemanager-clear-options-options">2.2</a>
1781+
<li>parameter, <a href="#parameter">2.1</a>
1782+
<li>StorageClearOptions, <a href="#dictdef-storageclearoptions">2.2</a>
1783+
<li>StorageClearType, <a href="#enumdef-storagecleartype">2.2</a>
1784+
<li>types, <a href="#dom-storageclearoptions-types">2.2</a>
1785+
<li>value, <a href="#value">2.1</a></ul>
17851786
<h3 class="no-num heading settled" id="index-defined-elsewhere"><span class="content">Terms defined by reference</span><a class="self-link" href="#index-defined-elsewhere"></a></h3>
17861787
<ul class="indexlist">
17871788
<li><a data-link-type="biblio" href="#biblio-fetch">[FETCH]</a> defines the following terms:
@@ -1842,6 +1843,7 @@ <h3 class="no-num heading settled" id="index-defined-elsewhere"><span class="con
18421843
</ul>
18431844
<li><a data-link-type="biblio" href="#biblio-rfc7230">[RFC7230]</a> defines the following terms:
18441845
<ul>
1846+
<li><a href="https://tools.ietf.org/html/rfc7230#section-7">#rule</a>
18451847
<li><a href="https://tools.ietf.org/html/rfc7230#section-3.2.3">bws</a>
18461848
<li><a href="https://tools.ietf.org/html/rfc7230#section-3.2.3">ows</a>
18471849
<li><a href="https://tools.ietf.org/html/rfc7230#section-3.2.6">quoted-string</a>
@@ -1901,6 +1903,8 @@ <h3 class="no-num heading settled" id="normative"><span class="content">Normativ
19011903
<dd>Ian Hickson; et al. <a href="http://www.w3.org/TR/html5/">HTML5</a>. 28 October 2014. REC. URL: <a href="http://www.w3.org/TR/html5/">http://www.w3.org/TR/html5/</a>
19021904
<dt id="biblio-rfc2119"><a class="self-link" href="#biblio-rfc2119"></a>[RFC2119]
19031905
<dd>S. Bradner. <a href="https://tools.ietf.org/html/rfc2119">Key words for use in RFCs to Indicate Requirement Levels</a>. March 1997. Best Current Practice. URL: <a href="https://tools.ietf.org/html/rfc2119">https://tools.ietf.org/html/rfc2119</a>
1906+
<dt id="biblio-rfc5234"><a class="self-link" href="#biblio-rfc5234"></a>[RFC5234]
1907+
<dd>D. Crocker, Ed.; P. Overell. <a href="https://tools.ietf.org/html/rfc5234">Augmented BNF for Syntax Specifications: ABNF</a>. January 2008. Internet Standard. URL: <a href="https://tools.ietf.org/html/rfc5234">https://tools.ietf.org/html/rfc5234</a>
19041908
<dt id="biblio-rfc5890"><a class="self-link" href="#biblio-rfc5890"></a>[RFC5890]
19051909
<dd>J. Klensin. <a href="https://tools.ietf.org/html/rfc5890">Internationalized Domain Names for Applications (IDNA): Definitions and Document Framework</a>. August 2010. Proposed Standard. URL: <a href="https://tools.ietf.org/html/rfc5890">https://tools.ietf.org/html/rfc5890</a>
19061910
<dt id="biblio-rfc6265"><a class="self-link" href="#biblio-rfc6265"></a>[RFC6265]

‎specs/clear-site-data/index.src.html

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ <h1>Clear Site Data</h1>
3737
text: database closing steps
3838
text: delete pending; url: dfn-delete-pending
3939
type: interface
40-
text: IDBDatabase; url: idl-def-IDBDatabase
40+
text: IDBDatabase; url: idl-def-IDBDatabase
4141
spec: HTML5; urlPrefix: http://www.w3.org/TR/html5/
4242
type: dfn
4343
urlPrefix: embedded-content-0.html
@@ -147,6 +147,7 @@ <h1>Clear Site Data</h1>
147147
text: BWS; url: section-3.2.3
148148
text: token; url: section-3.2.6
149149
text: quoted-string; url: section-3.2.6
150+
text: #rule; url: section-7
150151
</pre>
151152

152153
<!--
@@ -310,7 +311,8 @@ <h3 id="header">
310311

311312
The <dfn><code>Clear-Site-Data</code></dfn> HTTP response header field
312313
sends a signal to the user agent that it ought to remove all data
313-
of a certain set of types. The header is represented by the following ABNF:
314+
of a certain set of types. The header is represented by the following ABNF
315+
[[!RFC5234]]:
314316

315317
<pre>
316318
Clear-Site-Data = 1#option
@@ -321,7 +323,7 @@ <h3 id="header">
321323
</pre>
322324

323325
Note: The <a>BWS</a>, <a>OWS</a>, <a>token</a>, and <a>quoted-string</a> rules
324-
are defined in [[RFC7230]].
326+
as well as the <a>#rule</a> list extension are defined in [[RFC7230]].
325327

326328
The <a>Clear-Site-Data</a> header's value is essentially a semicolon-delimited
327329
list of "<code>[key]=[value]</code>" pairs which define the kinds of data to

0 commit comments

Comments
 (0)