Skip to content

Commit 8a9d144

Browse files
author
reffy-bot
committed
Update of TR report from new reffy run
Using reffy commit 18.4.6.
1 parent 1387917 commit 8a9d144

File tree

299 files changed

+12232
-214
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

299 files changed

+12232
-214
lines changed

‎tr/algorithms/epub-34.json

+151
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
{
2+
"spec": {
3+
"title": "EPUB 3.4",
4+
"url": "https://www.w3.org/TR/epub-34/"
5+
},
6+
"algorithms": [
7+
{
8+
"name": "manifest plane",
9+
"href": "https://www.w3.org/TR/epub-34/#dfn-manifest-plane",
10+
"html": "To <dfn class=\"export\" data-lt-no-plural=\"\" data-export=\"\" id=\"dfn-manifest-plane\" tabindex=\"0\" aria-haspopup=\"dialog\" data-dfn-type=\"dfn\">manifest plane</dfn> defines all the resources of an\n\t\t\t\t\t\t<a data-link-type=\"dfn|abstract-op\" href=\"https://www.w3.org/TR/epub-34/#dfn-epub-publication\" class=\"internalDFN\" id=\"ref-for-dfn-epub-publication-21\">EPUB publication</a>. It is analogous to the <a data-link-type=\"dfn|abstract-op\" href=\"https://www.w3.org/TR/epub-34/#dfn-package-document\" class=\"internalDFN\" id=\"ref-for-dfn-package-document-11\">package document</a> <a data-link-type=\"dfn|abstract-op\" data-lt=\"EPUB manifest\" href=\"https://www.w3.org/TR/epub-34/#dfn-epub-manifest\" class=\"internalDFN\" id=\"ref-for-dfn-epub-manifest-2\">manifest</a>,\n\t\t\t\t\t\tbut includes resources not present in that list.",
11+
"rationale": "To <dfn>"
12+
},
13+
{
14+
"html": "To <strong>derive the file path</strong>, given a file or directory <var>file</var> in the <a href=\"https://www.w3.org/TR/epub-34/#sec-container-abstract\">OCF abstract container</a>, apply the following steps\n\t\t\t\t\t\t(expressed using the terminology of [<cite><a class=\"bibref\" data-link-type=\"biblio\" href=\"https://www.w3.org/TR/epub-34/#bib-infra\" title=\"Infra Standard\">infra</a></cite>]):",
15+
"rationale": ".algorithm",
16+
"steps": [
17+
{
18+
"html": "Let <var>path</var> be an empty <a data-link-type=\"dfn\" href=\"https://infra.spec.whatwg.org/#list\" id=\"ref-for-index-term-list-0-1\">list</a>."
19+
},
20+
{
21+
"html": "Let <var>current</var> be <var>file</var>."
22+
},
23+
{
24+
"html": "While <var>current</var> is not the <a data-link-type=\"dfn|abstract-op\" href=\"https://www.w3.org/TR/epub-34/#dfn-root-directory\" class=\"internalDFN\" id=\"ref-for-dfn-root-directory-5\">root directory</a>:",
25+
"rationale": "prepend",
26+
"steps": [
27+
{
28+
"html": "<a data-link-type=\"dfn\" href=\"https://infra.spec.whatwg.org/#list-prepend\" id=\"ref-for-index-term-prepend-for-list-1\">prepend</a> the <a data-link-type=\"dfn|abstract-op\" href=\"https://www.w3.org/TR/epub-34/#dfn-file-name\" class=\"internalDFN\" id=\"ref-for-dfn-file-name-2\">file name</a> of <var>current</var> to <var>path</var>;"
29+
},
30+
{
31+
"html": "set <var>current</var> to the parent directory of <var>current</var>."
32+
}
33+
]
34+
},
35+
{
36+
"html": "Return the <a href=\"https://infra.spec.whatwg.org/#string-concatenate\" id=\"ref-for-index-term-concatenation-1\">concatenation</a> of <var>path</var>\n\t\t\t\t\t\t\tusing the <code>U+002F&nbsp;(/)</code> character."
37+
}
38+
]
39+
},
40+
{
41+
"name": "valid-relative-ocf-URL-with-fragment string",
42+
"href": "https://www.w3.org/TR/epub-34/#dfn-valid-relative-container-url-with-fragment-string",
43+
"html": "A string <var>url</var> is a <dfn class=\"export\" id=\"dfn-valid-relative-container-url-with-fragment-string\" data-export=\"\" tabindex=\"0\" aria-haspopup=\"dialog\" data-dfn-type=\"dfn\">valid-relative-ocf-URL-with-fragment string</dfn> if it is a\n\t\t\t\t\t\t<a data-link-type=\"dfn\" href=\"https://url.spec.whatwg.org/#path-relative-scheme-less-url-string\" id=\"ref-for-index-term-path-relative-scheme-less-url-string-1\">path-relative-scheme-less-url string</a>, optionally followed by <code>U+0023&nbsp;(#)</code>\n\t\t\t\t\t\tand a <a data-link-type=\"dfn\" href=\"https://url.spec.whatwg.org/#url-fragment-string\" id=\"ref-for-index-term-url-fragment-string-1\">url-fragment string</a>, and if the following steps return <var>true</var>:",
44+
"rationale": ".algorithm",
45+
"steps": [
46+
{
47+
"html": "<p>Set the <a data-link-type=\"dfn|abstract-op\" href=\"https://www.w3.org/TR/epub-34/#dfn-container-root-url\" class=\"internalDFN\" id=\"ref-for-dfn-container-root-url-6\">container root URL</a> to <code>https://a.example.org/A/</code>.</p>\n\t\t\t\t\t\t\t<details class=\"explanation\">\n\t\t\t\t\t\t\t\t<summary>Explanation</summary>\n\t\t\t\t\t\t\t\t<p>The goal of the algorithm is to detect whether <var>url</var> could be seen as\n\t\t\t\t\t\t\t\t\t\"leaking\" outside the container. To do that, the standard <a data-link-type=\"dfn\" data-lt=\"url parser\" href=\"https://url.spec.whatwg.org/#concept-url-parser\" id=\"ref-for-index-term-url-parser-4\">URL parsing algorithm</a> is used with an artificial root URL; the detection of the \"leak\" is done\n\t\t\t\t\t\t\t\t\tby comparing the result of the parsing with the presence of the first test path\n\t\t\t\t\t\t\t\t\tsegment (<code>A</code>). (Note that the artificial container root URL wilfully\n\t\t\t\t\t\t\t\t\tviolates, for the purpose of this algorithm, the <a href=\"https://www.w3.org/TR/epub-34/#sec-root-url-properties\">required properties</a> by using that first test path segment.)</p>\n\t\t\t\t\t\t\t</details>"
48+
},
49+
{
50+
"html": "<p>Let <var>base</var> be the <a href=\"https://url.spec.whatwg.org/#concept-base-url\" id=\"ref-for-index-term-base-4\">base URL</a> that must be\n\t\t\t\t\t\t\t\tused to parse <var>url</var> as defined by the context (document or environment) where\n\t\t\t\t\t\t\t\t\t<var>url</var> is used, and according to the content URL of the <a data-link-type=\"dfn|abstract-op\" href=\"https://www.w3.org/TR/epub-34/#dfn-package-document\" class=\"internalDFN\" id=\"ref-for-dfn-package-document-16\">package document</a>\n\t\t\t\t\t\t\t\t(see <a href=\"https://www.w3.org/TR/epub-34/#sec-parse-package-urls\" class=\"sec-ref\"><bdi class=\"secno\">5.2 </bdi>Parsing URLs in the package document</a>).</p>\n\t\t\t\t\t\t\t<details class=\"explanation\">\n\t\t\t\t\t\t\t\t<summary>Explanation</summary>\n\t\t\t\t\t\t\t\t<p>In the case of a URL in the package document the <var>base</var> variable is set to\n\t\t\t\t\t\t\t\t\tthe content URL of the package document. In the case of a document within the\n\t\t\t\t\t\t\t\t\t\t<code>META-INF</code> directory, the <var>base</var> variable is set to the\n\t\t\t\t\t\t\t\t\tcontainer root URL (see <a href=\"https://www.w3.org/TR/epub-34/#sec-parsing-urls-metainf\" class=\"sec-ref\"><bdi class=\"secno\">4.2.6.2 </bdi>Parsing URLs in the <code>META-INF</code> directory</a>). In the case of a\n\t\t\t\t\t\t\t\t\tURL in an <a data-link-type=\"dfn|abstract-op\" href=\"https://www.w3.org/TR/epub-34/#dfn-xhtml-content-document\" class=\"internalDFN\" id=\"ref-for-dfn-xhtml-content-document-10\">XHTML content document</a>, the base URL used for parsing is defined by\n\t\t\t\t\t\t\t\t\tthe <a href=\"https://html.spec.whatwg.org/multipage/#resolving-urls\" id=\"ref-for-index-term-html-standard-1\">HTML standard</a>. Typically, it will be the\n\t\t\t\t\t\t\t\t\tcontent URL of the content document (unless the <a href=\"https://www.w3.org/TR/epub-34/#sec-xhtml-deviations-base\">discouraged</a>\n\t\t\t\t\t\t\t\t\t<code>base</code> element is used).</p>\n\t\t\t\t\t\t\t</details>"
51+
},
52+
{
53+
"html": "Let <var>testURLRecord</var> be the result of applying the <a data-link-type=\"dfn\" href=\"https://url.spec.whatwg.org/#concept-url-parser\" id=\"ref-for-index-term-url-parser-5\">URL parser</a> to <var>url</var>,\n\t\t\t\t\t\t\twith <var>base</var>."
54+
},
55+
{
56+
"html": "Let <var>testURLStringA</var> be the result of applying the <a data-link-type=\"dfn\" href=\"https://url.spec.whatwg.org/#concept-url-serializer\" id=\"ref-for-index-term-url-serializer-1\">URL Serializer</a> to\n\t\t\t\t\t\t\t\t<var>testURLRecord</var>."
57+
},
58+
{
59+
"html": "<p>Set the <a data-link-type=\"dfn|abstract-op\" href=\"https://www.w3.org/TR/epub-34/#dfn-container-root-url\" class=\"internalDFN\" id=\"ref-for-dfn-container-root-url-7\">container root URL</a> to <code>https://b.example.org/B/</code>.</p>\n\t\t\t\t\t\t\t<details class=\"explanation\">\n\t\t\t\t\t\t\t\t<summary>Explanation</summary>\n\t\t\t\t\t\t\t\t<p>The reasons to repeat the same steps twice with different, and artificial, settings\n\t\t\t\t\t\t\t\t\tof the container root URL is to avoid collision which may occur if the\n\t\t\t\t\t\t\t\t\t\t<var>url</var> string also includes <code>/A/</code>. Consider, for example, the\n\t\t\t\t\t\t\t\t\tcase where <var>url</var> is <code>../../A/doc.xhtml</code>.</p>\n\t\t\t\t\t\t\t</details>"
60+
},
61+
{
62+
"html": "Set <var>base</var> to be the <a href=\"https://url.spec.whatwg.org/#concept-base-url\" id=\"ref-for-index-term-base-5\">base URL</a> that must be\n\t\t\t\t\t\t\tused to parse <var>url</var> as defined by the context (document or environment) where\n\t\t\t\t\t\t\t\t<var>url</var> is used, and according to the content URL of the package document (see <a href=\"https://www.w3.org/TR/epub-34/#sec-parse-package-urls\" class=\"sec-ref\"><bdi class=\"secno\">5.2 </bdi>Parsing URLs in the package document</a>)."
63+
},
64+
{
65+
"html": "Set <var>testURLRecord</var> to be the result of applying the <a data-link-type=\"dfn\" href=\"https://url.spec.whatwg.org/#concept-url-parser\" id=\"ref-for-index-term-url-parser-6\">URL parser</a> to\n\t\t\t\t\t\t\t\t<var>url</var>, with <var>base</var>."
66+
},
67+
{
68+
"html": "Let <var>testURLStringB</var> be the result of applying the <a data-link-type=\"dfn\" href=\"https://url.spec.whatwg.org/#concept-url-serializer\" id=\"ref-for-index-term-url-serializer-2\">URL Serializer</a> to\n\t\t\t\t\t\t\t\t<var>testURLRecord</var>."
69+
},
70+
{
71+
"html": "<p>If <var>testURLStringA</var> does not start with <code>https://a.example.org/</code> or\n\t\t\t\t\t\t\t\t\t<var>testURLStringB</var> does not start with <code>https://b.example.org/</code>,\n\t\t\t\t\t\t\t\treturn <var>true</var>.</p>\n\t\t\t\t\t\t\t<details class=\"explanation\">\n\t\t\t\t\t\t\t\t<summary>Explanation</summary>\n\t\t\t\t\t\t\t\t<p>If any of the result does not share the test URL host, it means that <var>url</var>,\n\t\t\t\t\t\t\t\t\tor its base URL (for example, in HTML, if it is explicitly set with the\n\t\t\t\t\t\t\t\t\t\t<code>base</code> element), was <em>absolute</em> and points outside the\n\t\t\t\t\t\t\t\t\tcontainer. This is acceptable.</p>\n\t\t\t\t\t\t\t</details>"
72+
},
73+
{
74+
"html": "<p>If <var>testURLStringA</var> starts with <code>https://a.example.org/A/</code> and\n\t\t\t\t\t\t\t\t\t<var>testURLStringB</var> starts with <code>https://b.example.org/B/</code>, return\n\t\t\t\t\t\t\t\t\t<var>true</var>.</p>\n\t\t\t\t\t\t\t<details class=\"explanation\">\n\t\t\t\t\t\t\t\t<summary>Explanation</summary>\n\t\t\t\t\t\t\t\t<p>The presence of the first test path segments (<code>A</code>, respectively\n\t\t\t\t\t\t\t\t\t\t<code>B</code>) indicate that the URL doesn't leak outside the container.</p>\n\t\t\t\t\t\t\t</details>"
75+
},
76+
{
77+
"html": "Return <var>false</var>."
78+
}
79+
]
80+
},
81+
{
82+
"html": "The following pseudo-code exemplifies the obfuscation algorithm.",
83+
"rationale": ".algorithm",
84+
"steps": [
85+
{
86+
"html": "set <var>ocf</var> to OCF ZIP container file"
87+
},
88+
{
89+
"html": "set <var>source</var> to font file"
90+
},
91+
{
92+
"html": "set <var>destination</var> to obfuscated font file"
93+
},
94+
{
95+
"html": "set <var>keyData</var> to key for file"
96+
},
97+
{
98+
"html": "set <var>outer</var> to 0"
99+
},
100+
{
101+
"html": "<span>while <var>outer</var> &lt; 52 and not (<var>source</var> at EOF)</span>",
102+
"rationale": "set",
103+
"steps": [
104+
{
105+
"html": "set <var>inner</var> to 0"
106+
},
107+
{
108+
"html": "<span>while <var>inner</var> &lt; 20 and not (<var>source</var> at EOF)</span>",
109+
"rationale": "set",
110+
"steps": [
111+
{
112+
"html": "read 1 byte from <var>source</var> (Assumes read advances file\n\t\t\t\t\t\t\t\t\t\t\tposition)"
113+
},
114+
{
115+
"html": "set <var>sourceByte</var> to result of read"
116+
},
117+
{
118+
"html": "set <var>keyByte</var> to byte <var>inner</var> of <var>keyData</var>"
119+
},
120+
{
121+
"html": "set <var>obfuscatedByte</var> to (<var>sourceByte</var> XOR\n\t\t\t\t\t\t\t\t\t\t\t\t<var>keyByte</var>)"
122+
},
123+
{
124+
"html": "write <var>obfuscatedByte</var> to <var>destination</var>"
125+
},
126+
{
127+
"html": "increment <var>inner</var>"
128+
}
129+
]
130+
},
131+
{
132+
"html": "increment <var>outer</var>"
133+
}
134+
]
135+
},
136+
{
137+
"html": "<span>if not (<var>source</var> at EOF) then</span>\n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t<span>end if</span>",
138+
"ignored": [
139+
"read source to EOF write result of read to destination"
140+
]
141+
},
142+
{
143+
"html": "Deflate <var>destination</var>"
144+
},
145+
{
146+
"html": "store <var>destination</var> as <var>source</var> in <var>ocf</var>"
147+
}
148+
]
149+
}
150+
]
151+
}

0 commit comments

Comments
 (0)