diff options
| author | Damien Neil <dneil@google.com> | 2023-07-11 15:34:09 -0700 |
|---|---|---|
| committer | Damien Neil <dneil@google.com> | 2023-07-20 16:58:55 +0000 |
| commit | 89699847bf29c9891c95c8c55f8b6bff82c8f4e2 (patch) | |
| tree | 6da04943253738966ef9ec12aa930abdf05a5a53 /src/net | |
| parent | 89265f98948718c0d4d3d4763decf02914188ae6 (diff) | |
| download | go-89699847bf29c9891c95c8c55f8b6bff82c8f4e2.tar.xz | |
net/url: document requirements for IPv6 addresses in URL.Host
When the host subcomponent of a URL is an IPv6 address, it must be
surrounded by square brackets to prevent colons in the address
from being interpreted as the port: "[fe80::1]:80".
Document this requirement.
Fixes #61093
Fixes #61276
Change-Id: Iaf411b9dc211fd876468d6e2e94ff672ba0d329d
Reviewed-on: https://go-review.googlesource.com/c/go/+/508976
Run-TryBot: Damien Neil <dneil@google.com>
TryBot-Result: Gopher Robot <gobot@golang.org>
Reviewed-by: Joseph Tsai <joetsai@digital-static.net>
Reviewed-by: Cherry Mui <cherryyz@google.com>
Diffstat (limited to 'src/net')
| -rw-r--r-- | src/net/url/url.go | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/src/net/url/url.go b/src/net/url/url.go index 501b263e87..2d40a58673 100644 --- a/src/net/url/url.go +++ b/src/net/url/url.go @@ -348,6 +348,13 @@ func escape(s string, mode encoding) string { // // scheme:opaque[?query][#fragment] // +// The Host field contains the host and port subcomponents of the URL. +// When the port is present, it is separated from the host with a colon. +// When the host is an IPv6 address, it must be enclosed in square brackets: +// "[fe80::1]:80". The [net.JoinHostPort] function combines a host and port +// into a string suitable for the Host field, adding square brackets to +// the host when necessary. +// // Note that the Path field is stored in decoded form: /%47%6f%2f becomes /Go/. // A consequence is that it is impossible to tell which slashes in the Path were // slashes in the raw URL and which were %2f. This distinction is rarely important, @@ -363,7 +370,7 @@ type URL struct { Scheme string Opaque string // encoded opaque data User *Userinfo // username and password information - Host string // host or host:port + Host string // host or host:port (see Hostname and Port methods) Path string // path (relative paths may omit leading slash) RawPath string // encoded path hint (see EscapedPath method) OmitHost bool // do not emit empty host (authority) |