Skip to content

Commit 9c8b5a6

Browse files
Remove normative language from proxy configuration and rework references. Fixes #451
This is a general cleanup of the proxy configuration section of the spec.
1 parent ba6b944 commit 9c8b5a6

File tree

1 file changed

+52
-47
lines changed

1 file changed

+52
-47
lines changed

webdriver-spec.html

+52-47
Original file line numberDiff line numberDiff line change
@@ -450,6 +450,11 @@ <h3>Dependencies</h3>
450450
<!-- ScrollIntoViewOptions --> <li><dfn><a href=https://drafts.csswg.org/cssom-view/#dictdef-scrollintoviewoptions><code>ScrollIntoViewOptions</code></a></dfn>
451451
</ul>
452452

453+
<dt>SOCKS Proxy and related specification:
454+
<dd><p>To be <dfn>SOCKS Proxy</dfn> and <dfn>SOCKS authentication</dfn> compliant,
455+
it is supposed that the implementation supports the relevant subsets of
456+
[[!RFC1928]] and [[!RFC1929]].
457+
453458
<dt>Unicode
454459
<dd>The following terms are defined in the standard: [[!Unicode]]
455460
<ul>
@@ -462,8 +467,10 @@ <h3>Dependencies</h3>
462467
<!-- Absolute URL --> <li><dfn><a href=https://url.spec.whatwg.org/#syntax-url-absolute>Absolute URL</a></dfn>
463468
<!-- Absolute URL with fragment --> <li><dfn><a href=https://url.spec.whatwg.org/#syntax-url-absolute-with-fragment>Absolute URL with fragment</a></dfn>
464469
<!-- Domain --><li><dfn><a href="https://url.spec.whatwg.org/#concept-domain">Domain</a></dfn>
470+
<!-- Host --> <li><dfn><a href="https://url.spec.whatwg.org/#concept-host">Host</a></dfn>
465471
<!-- Path-absolute URL --> <li><dfn><a href=https://url.spec.whatwg.org/#syntax-url-path-absolute>Path-absolute URL</a></dfn>
466472
<!-- Path --> <li><dfn><a href=https://url.spec.whatwg.org/#concept-url-path>Path</a></dfn>
473+
<!-- Port --> <li><dfn><a href="https://url.spec.whatwg.org/#concept-url-port">Port</a></dfn>
467474
<!-- URL serialiser --> <li><dfn><a href=https://url.spec.whatwg.org/#concept-url-serializer>URL serialiser</a></dfn>
468475
</ul>
469476

@@ -1702,125 +1709,123 @@ <h3>Proxy</h3>
17021709
<th>Key
17031710
<th>Value Type
17041711
<th>Description
1712+
<th>Valid values
17051713
</tr>
17061714
</thead>
17071715

17081716
<tbody>
17091717
<tr>
1710-
<td>"<code>proxyType</code>"
1718+
<td><dfn>"<code>proxyType</code>"</dfn>
17111719
<td>string
1712-
<td>Indicates the type of proxy configuration. This value <em>SHOULD</em> be one
1713-
of the following: "<code>pac</code>", "<code>noproxy</code>",
1720+
<td>Indicates the type of proxy configuration.
1721+
<td>"<code>pac</code>", "<code>noproxy</code>",
17141722
"<code>autodetect</code>", "<code>system</code>", or "<code>manual</code>".
17151723
</tr>
17161724

17171725
<tr>
17181726
<td>"<code>proxyAutoconfigUrl</code>"
17191727
<td>string
1720-
<td>Defines the URL for a proxy auto-config file. [URL]
1721-
This property <em>SHOULD</em> only be set when the "<code>proxyType</code>" is
1722-
equal to "<code>pac</code>".
1728+
<td>Defines the URL for a proxy auto-config file if <a>"<code>proxyType</code>"</a>
1729+
is equal to "<code>pac</code>". [URL]
1730+
<td>
17231731
</tr>
17241732

17251733
<tr>
17261734
<td>"<code>ftpProxy</code>"
17271735
<td>string
1728-
<td>Defines the proxy <em>hostname</em> for FTP traffic. Alternatively, an
1729-
implementation <em>MAY</em> accept a hostname and port through this property.
1730-
This property <em>SHOULD</em> only be set when the "<code>proxyType</code>" is
1736+
<td>Defines the proxy <a>host</a> for FTP traffic when the <a>"<code>proxyType</code>"</a> is
17311737
equal to "<code>manual</code>".
1738+
<td>
17321739
</tr>
17331740

17341741
<tr>
17351742
<td>"<code>ftpProxyPort</code>"
17361743
<td>number
1737-
<td>Defines the proxy <em>port</em> for FTP traffic.
1738-
This property <em>SHOULD</em> only be set when the "<code>proxyType</code>" is
1744+
<td>Defines the proxy <a>port</a> for FTP traffic when the <a>"<code>proxyType</code>"</a> is
17391745
equal to "<code>manual</code>".
1746+
<td>
17401747
</tr>
17411748

17421749
<tr>
17431750
<td>"<code>httpProxy</code>"
17441751
<td>string
1745-
<td>Defines the proxy <em>hostname</em> for HTTP traffic. If a hostname and port
1746-
is passed through this property, set "<code>httpProxy</code>" to the hostname
1747-
and "<code>httpProxyPort</code>" to the port.
1748-
<p>This property <em>SHOULD</em> only be set when the "<code>proxyType</code>" is
1749-
equal to "<code>manual</code>".
1752+
<td>Defines the proxy <a>host</a> for HTTP traffic. If a <a>URL</a>
1753+
is passed through this property, set "<code>httpProxy</code>" to the <a>host</a>
1754+
and "<code>httpProxyPort</code>" to the <a>port</a> when the <a>"<code>proxyType</code>"</a>
1755+
is equal to "<code>manual</code>".
1756+
<td>
17501757
</tr>
17511758

17521759
<tr>
17531760
<td>"<code>httpProxyPort</code>"
17541761
<td>number
1755-
<td>Defines the proxy <em>port</em> for HTTP traffic. If "<code>httpProxyPort</code>"
1756-
is defined in "<code>httpProxy</code>" and from this property, return <a>error</a> with <a>error code</a> <a>invalid argument</a>.
1757-
This property <em>SHOULD</em> only be set when the "<code>proxyType</code>" is
1758-
equal to "<code>manual</code>".
1762+
<td>Defines the proxy <a>port</a> for HTTP traffic when the "<code>proxyType</code>" is
1763+
equal to "<code>manual</code>". If "<code>httpProxyPort</code>"
1764+
is defined in "<code>httpProxy</code>" and from this property, return <a>error</a>
1765+
with <a>error code</a> <a>invalid argument</a>.
1766+
<td>
17591767
</tr>
17601768

17611769
<tr>
17621770
<td>"<code>sslProxy</code>"
17631771
<td>string
1764-
<td>Defines the proxy <em>hostname</em> for encrypted TLS traffic. If a hostname and port
1765-
is passed through this property, set "<code>sslProxy</code>" to the hostname
1766-
and "<code>sslProxyPort</code>" to the port.
1767-
This property <em>SHOULD</em> only be set when the "<code>proxyType</code>" is
1768-
equal to "<code>manual</code>".
1772+
<td>Defines the proxy <a>host</a> for encrypted TLS traffic when the "<code>proxyType</code>" is
1773+
equal to "<code>manual</code>". If a <a>URL</a> is passed through this property,
1774+
set "<code>sslProxy</code>" to the <a>host</a> and "<code>sslProxyPort</code>" to the <a>port</a>.
1775+
<td>
17691776
</tr>
17701777

17711778
<tr>
17721779
<td>"<code>sslProxyPort</code>"
17731780
<td>number
1774-
<td>Defines the proxy <em>port</em> for ssl traffic. If "<code>sslProxyPort</code>"
1775-
is defined in "<code>sslProxy</code>" and from this property, return <a>error</a> with <a>error code</a> <a>invalid argument</a>.
1776-
This property <em>SHOULD</em> only be set when the "<code>proxyType</code>" is
1777-
equal to "<code>manual</code>".
1781+
<td>Defines the proxy <a>port</a> for ssl traffic when the "<code>proxyType</code>" is
1782+
equal to "<code>manual</code>". If "<code>sslProxyPort</code>" is defined in "<code>sslProxy</code>"
1783+
and from this property, return <a>error</a> with <a>error code</a> <a>invalid argument</a>.
1784+
<td>
17781785
</tr>
17791786

17801787
<tr>
17811788
<td>"<code>socksProxy</code>"
17821789
<td>string
1783-
<td>Defines the proxy <em>hostname</em> for a SOCKS proxy. [[RFC1928]]
1784-
Alternatively, an implementation <em>MAY</em> accept a hostname and port
1785-
through this property.
1786-
This property <em>SHOULD</em> only be set when the "<code>proxyType</code>" is
1787-
equal to "<code>manual</code>".
1790+
<td>Defines the proxy <a>host</a> for a <a>SOCKS proxy</a> when the "<code>proxyType</code>" is
1791+
equal to "<code>manual</code>".
1792+
If a <a>URL</a> is passed through this property,
1793+
set "<code>socksProxy</code>" to the <a>host</a> and "<code>socksProxyPort</code>" to the <a>port</a>.
1794+
<td>
17881795
</tr>
17891796

17901797
<tr>
17911798
<td>"<code>socksProxyPort</code>"
17921799
<td>number
1793-
<td>Defines the proxy <em>port</em> for a SOCKS proxy. [[RFC1928]]
1794-
This property <em>SHOULD</em> only be set when the "<code>proxyType</code>" is
1795-
equal to "<code>manual</code>".
1800+
<td>Defines the proxy <a>port</a> for a <a>SOCKS proxy</a> when the "<code>proxyType</code>" is
1801+
equal to "<code>manual</code>".
1802+
If "<code>socksProxyPort</code>" is defined in "<code>socksProxyPort</code>"
1803+
and from this property, return <a>error</a> with <a>error code</a> <a>invalid argument</a>.
1804+
<td>
17961805
</tr>
17971806

17981807
<tr>
17991808
<td>"<code>socksVersion</code>"
18001809
<td>number
1801-
<td>Defines the SOCKS proxy version.
1802-
This property <em>SHOULD</em> only be set when the "<code>proxyType</code>" is
1810+
<td>Defines the <a>SOCKS proxy</a> version when the "<code>proxyType</code>" is
18031811
equal to "<code>manual</code>".
1812+
<td>
18041813
</tr>
18051814

18061815
<tr>
18071816
<td>"<code>socksUsername</code>"
18081817
<td>string
1809-
<td>
1810-
Defines the username used when authenticating with a SOCKS proxy. [[RFC1928]]
1811-
This property <em>SHOULD</em> only be set when the "<code>proxyType</code>" is
1818+
<td>Defines the username used when <a data-lt='socks authentication'>authenticating</a> with a <a>SOCKS proxy</a> when the "<code>proxyType</code>" is
18121819
equal to "<code>manual</code>".
1820+
<td>
18131821
</tr>
18141822

18151823
<tr>
18161824
<td>"<code>socksPassword</code>"
18171825
<td>string
1826+
<td>Defines the password used when <a data-lt='socks authentication'>authenticating</a> with a <a>SOCKS proxy</a>, when the "<code>proxyType</code>" is
1827+
equal to "<code>manual</code>", and is not returned with <a>capabilties</a> to the <a>local end</a>.
18181828
<td>
1819-
Defines the password used when authenticating with a SOCKS proxy. [[RFC1928]]
1820-
This property <em>SHOULD</em> only be set when the "<code>proxyType</code>" is
1821-
equal to "<code>manual</code>".
1822-
This property <em>MUST NOT</em> be set by a <a>remote end</a> when returning
1823-
<a>capabilities</a> to the <a>local end</a>.
18241829
</tr>
18251830

18261831
</tbody>

0 commit comments

Comments
 (0)