Run Format

Source file src/pkg/net/ip.go

     1	// Copyright 2009 The Go Authors. All rights reserved.
     2	// Use of this source code is governed by a BSD-style
     3	// license that can be found in the LICENSE file.
     4	
     5	// IP address manipulations
     6	//
     7	// IPv4 addresses are 4 bytes; IPv6 addresses are 16 bytes.
     8	// An IPv4 address can be converted to an IPv6 address by
     9	// adding a canonical prefix (10 zeros, 2 0xFFs).
    10	// This library accepts either size of byte slice but always
    11	// returns 16-byte addresses.
    12	
    13	package net
    14	
    15	import "errors"
    16	
    17	// IP address lengths (bytes).
    18	const (
    19		IPv4len = 4
    20		IPv6len = 16
    21	)
    22	
    23	// An IP is a single IP address, a slice of bytes.
    24	// Functions in this package accept either 4-byte (IPv4)
    25	// or 16-byte (IPv6) slices as input.
    26	//
    27	// Note that in this documentation, referring to an
    28	// IP address as an IPv4 address or an IPv6 address
    29	// is a semantic property of the address, not just the
    30	// length of the byte slice: a 16-byte slice can still
    31	// be an IPv4 address.
    32	type IP []byte
    33	
    34	// An IP mask is an IP address.
    35	type IPMask []byte
    36	
    37	// An IPNet represents an IP network.
    38	type IPNet struct {
    39		IP   IP     // network number
    40		Mask IPMask // network mask
    41	}
    42	
    43	// IPv4 returns the IP address (in 16-byte form) of the
    44	// IPv4 address a.b.c.d.
    45	func IPv4(a, b, c, d byte) IP {
    46		p := make(IP, IPv6len)
    47		copy(p, v4InV6Prefix)
    48		p[12] = a
    49		p[13] = b
    50		p[14] = c
    51		p[15] = d
    52		return p
    53	}
    54	
    55	var v4InV6Prefix = []byte{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0xff, 0xff}
    56	
    57	// IPv4Mask returns the IP mask (in 4-byte form) of the
    58	// IPv4 mask a.b.c.d.
    59	func IPv4Mask(a, b, c, d byte) IPMask {
    60		p := make(IPMask, IPv4len)
    61		p[0] = a
    62		p[1] = b
    63		p[2] = c
    64		p[3] = d
    65		return p
    66	}
    67	
    68	// CIDRMask returns an IPMask consisting of `ones' 1 bits
    69	// followed by 0s up to a total length of `bits' bits.
    70	// For a mask of this form, CIDRMask is the inverse of IPMask.Size.
    71	func CIDRMask(ones, bits int) IPMask {
    72		if bits != 8*IPv4len && bits != 8*IPv6len {
    73			return nil
    74		}
    75		if ones < 0 || ones > bits {
    76			return nil
    77		}
    78		l := bits / 8
    79		m := make(IPMask, l)
    80		n := uint(ones)
    81		for i := 0; i < l; i++ {
    82			if n >= 8 {
    83				m[i] = 0xff
    84				n -= 8
    85				continue
    86			}
    87			m[i] = ^byte(0xff >> n)
    88			n = 0
    89		}
    90		return m
    91	}
    92	
    93	// Well-known IPv4 addresses
    94	var (
    95		IPv4bcast     = IPv4(255, 255, 255, 255) // broadcast
    96		IPv4allsys    = IPv4(224, 0, 0, 1)       // all systems
    97		IPv4allrouter = IPv4(224, 0, 0, 2)       // all routers
    98		IPv4zero      = IPv4(0, 0, 0, 0)         // all zeros
    99	)
   100	
   101	// Well-known IPv6 addresses
   102	var (
   103		IPv6zero                   = IP{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}
   104		IPv6unspecified            = IP{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}
   105		IPv6loopback               = IP{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1}
   106		IPv6interfacelocalallnodes = IP{0xff, 0x01, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0x01}
   107		IPv6linklocalallnodes      = IP{0xff, 0x02, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0x01}
   108		IPv6linklocalallrouters    = IP{0xff, 0x02, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0x02}
   109	)
   110	
   111	// IsUnspecified returns true if ip is an unspecified address.
   112	func (ip IP) IsUnspecified() bool {
   113		if ip.Equal(IPv4zero) || ip.Equal(IPv6unspecified) {
   114			return true
   115		}
   116		return false
   117	}
   118	
   119	// IsLoopback returns true if ip is a loopback address.
   120	func (ip IP) IsLoopback() bool {
   121		if ip4 := ip.To4(); ip4 != nil && ip4[0] == 127 {
   122			return true
   123		}
   124		return ip.Equal(IPv6loopback)
   125	}
   126	
   127	// IsMulticast returns true if ip is a multicast address.
   128	func (ip IP) IsMulticast() bool {
   129		if ip4 := ip.To4(); ip4 != nil && ip4[0]&0xf0 == 0xe0 {
   130			return true
   131		}
   132		return ip[0] == 0xff
   133	}
   134	
   135	// IsInterfaceLinkLocalMulticast returns true if ip is
   136	// an interface-local multicast address.
   137	func (ip IP) IsInterfaceLocalMulticast() bool {
   138		return len(ip) == IPv6len && ip[0] == 0xff && ip[1]&0x0f == 0x01
   139	}
   140	
   141	// IsLinkLocalMulticast returns true if ip is a link-local
   142	// multicast address.
   143	func (ip IP) IsLinkLocalMulticast() bool {
   144		if ip4 := ip.To4(); ip4 != nil && ip4[0] == 224 && ip4[1] == 0 && ip4[2] == 0 {
   145			return true
   146		}
   147		return ip[0] == 0xff && ip[1]&0x0f == 0x02
   148	}
   149	
   150	// IsLinkLocalUnicast returns true if ip is a link-local
   151	// unicast address.
   152	func (ip IP) IsLinkLocalUnicast() bool {
   153		if ip4 := ip.To4(); ip4 != nil && ip4[0] == 169 && ip4[1] == 254 {
   154			return true
   155		}
   156		return ip[0] == 0xfe && ip[1]&0xc0 == 0x80
   157	}
   158	
   159	// IsGlobalUnicast returns true if ip is a global unicast
   160	// address.
   161	func (ip IP) IsGlobalUnicast() bool {
   162		return !ip.IsUnspecified() &&
   163			!ip.IsLoopback() &&
   164			!ip.IsMulticast() &&
   165			!ip.IsLinkLocalUnicast()
   166	}
   167	
   168	// Is p all zeros?
   169	func isZeros(p IP) bool {
   170		for i := 0; i < len(p); i++ {
   171			if p[i] != 0 {
   172				return false
   173			}
   174		}
   175		return true
   176	}
   177	
   178	// To4 converts the IPv4 address ip to a 4-byte representation.
   179	// If ip is not an IPv4 address, To4 returns nil.
   180	func (ip IP) To4() IP {
   181		if len(ip) == IPv4len {
   182			return ip
   183		}
   184		if len(ip) == IPv6len &&
   185			isZeros(ip[0:10]) &&
   186			ip[10] == 0xff &&
   187			ip[11] == 0xff {
   188			return ip[12:16]
   189		}
   190		return nil
   191	}
   192	
   193	// To16 converts the IP address ip to a 16-byte representation.
   194	// If ip is not an IP address (it is the wrong length), To16 returns nil.
   195	func (ip IP) To16() IP {
   196		if len(ip) == IPv4len {
   197			return IPv4(ip[0], ip[1], ip[2], ip[3])
   198		}
   199		if len(ip) == IPv6len {
   200			return ip
   201		}
   202		return nil
   203	}
   204	
   205	// Default route masks for IPv4.
   206	var (
   207		classAMask = IPv4Mask(0xff, 0, 0, 0)
   208		classBMask = IPv4Mask(0xff, 0xff, 0, 0)
   209		classCMask = IPv4Mask(0xff, 0xff, 0xff, 0)
   210	)
   211	
   212	// DefaultMask returns the default IP mask for the IP address ip.
   213	// Only IPv4 addresses have default masks; DefaultMask returns
   214	// nil if ip is not a valid IPv4 address.
   215	func (ip IP) DefaultMask() IPMask {
   216		if ip = ip.To4(); ip == nil {
   217			return nil
   218		}
   219		switch true {
   220		case ip[0] < 0x80:
   221			return classAMask
   222		case ip[0] < 0xC0:
   223			return classBMask
   224		default:
   225			return classCMask
   226		}
   227	}
   228	
   229	func allFF(b []byte) bool {
   230		for _, c := range b {
   231			if c != 0xff {
   232				return false
   233			}
   234		}
   235		return true
   236	}
   237	
   238	// Mask returns the result of masking the IP address ip with mask.
   239	func (ip IP) Mask(mask IPMask) IP {
   240		if len(mask) == IPv6len && len(ip) == IPv4len && allFF(mask[:12]) {
   241			mask = mask[12:]
   242		}
   243		if len(mask) == IPv4len && len(ip) == IPv6len && bytesEqual(ip[:12], v4InV6Prefix) {
   244			ip = ip[12:]
   245		}
   246		n := len(ip)
   247		if n != len(mask) {
   248			return nil
   249		}
   250		out := make(IP, n)
   251		for i := 0; i < n; i++ {
   252			out[i] = ip[i] & mask[i]
   253		}
   254		return out
   255	}
   256	
   257	// String returns the string form of the IP address ip.
   258	// If the address is an IPv4 address, the string representation
   259	// is dotted decimal ("74.125.19.99").  Otherwise the representation
   260	// is IPv6 ("2001:4860:0:2001::68").
   261	func (ip IP) String() string {
   262		p := ip
   263	
   264		if len(ip) == 0 {
   265			return "<nil>"
   266		}
   267	
   268		// If IPv4, use dotted notation.
   269		if p4 := p.To4(); len(p4) == IPv4len {
   270			return itod(uint(p4[0])) + "." +
   271				itod(uint(p4[1])) + "." +
   272				itod(uint(p4[2])) + "." +
   273				itod(uint(p4[3]))
   274		}
   275		if len(p) != IPv6len {
   276			return "?"
   277		}
   278	
   279		// Find longest run of zeros.
   280		e0 := -1
   281		e1 := -1
   282		for i := 0; i < IPv6len; i += 2 {
   283			j := i
   284			for j < IPv6len && p[j] == 0 && p[j+1] == 0 {
   285				j += 2
   286			}
   287			if j > i && j-i > e1-e0 {
   288				e0 = i
   289				e1 = j
   290			}
   291		}
   292		// The symbol "::" MUST NOT be used to shorten just one 16 bit 0 field.
   293		if e1-e0 <= 2 {
   294			e0 = -1
   295			e1 = -1
   296		}
   297	
   298		// Print with possible :: in place of run of zeros
   299		var s string
   300		for i := 0; i < IPv6len; i += 2 {
   301			if i == e0 {
   302				s += "::"
   303				i = e1
   304				if i >= IPv6len {
   305					break
   306				}
   307			} else if i > 0 {
   308				s += ":"
   309			}
   310			s += itox((uint(p[i])<<8)|uint(p[i+1]), 1)
   311		}
   312		return s
   313	}
   314	
   315	// ipEmptyString is like ip.String except that it returns
   316	// an empty string when ip is unset.
   317	func ipEmptyString(ip IP) string {
   318		if len(ip) == 0 {
   319			return ""
   320		}
   321		return ip.String()
   322	}
   323	
   324	// MarshalText implements the encoding.TextMarshaler interface.
   325	// The encoding is the same as returned by String.
   326	func (ip IP) MarshalText() ([]byte, error) {
   327		if len(ip) == 0 {
   328			return []byte(""), nil
   329		}
   330		if len(ip) != IPv4len && len(ip) != IPv6len {
   331			return nil, errors.New("invalid IP address")
   332		}
   333		return []byte(ip.String()), nil
   334	}
   335	
   336	// UnmarshalText implements the encoding.TextUnmarshaler interface.
   337	// The IP address is expected in a form accepted by ParseIP.
   338	func (ip *IP) UnmarshalText(text []byte) error {
   339		if len(text) == 0 {
   340			*ip = nil
   341			return nil
   342		}
   343		s := string(text)
   344		x := ParseIP(s)
   345		if x == nil {
   346			return &ParseError{"IP address", s}
   347		}
   348		*ip = x
   349		return nil
   350	}
   351	
   352	// Equal returns true if ip and x are the same IP address.
   353	// An IPv4 address and that same address in IPv6 form are
   354	// considered to be equal.
   355	func (ip IP) Equal(x IP) bool {
   356		if len(ip) == len(x) {
   357			return bytesEqual(ip, x)
   358		}
   359		if len(ip) == IPv4len && len(x) == IPv6len {
   360			return bytesEqual(x[0:12], v4InV6Prefix) && bytesEqual(ip, x[12:])
   361		}
   362		if len(ip) == IPv6len && len(x) == IPv4len {
   363			return bytesEqual(ip[0:12], v4InV6Prefix) && bytesEqual(ip[12:], x)
   364		}
   365		return false
   366	}
   367	
   368	func bytesEqual(x, y []byte) bool {
   369		if len(x) != len(y) {
   370			return false
   371		}
   372		for i, b := range x {
   373			if y[i] != b {
   374				return false
   375			}
   376		}
   377		return true
   378	}
   379	
   380	// If mask is a sequence of 1 bits followed by 0 bits,
   381	// return the number of 1 bits.
   382	func simpleMaskLength(mask IPMask) int {
   383		var n int
   384		for i, v := range mask {
   385			if v == 0xff {
   386				n += 8
   387				continue
   388			}
   389			// found non-ff byte
   390			// count 1 bits
   391			for v&0x80 != 0 {
   392				n++
   393				v <<= 1
   394			}
   395			// rest must be 0 bits
   396			if v != 0 {
   397				return -1
   398			}
   399			for i++; i < len(mask); i++ {
   400				if mask[i] != 0 {
   401					return -1
   402				}
   403			}
   404			break
   405		}
   406		return n
   407	}
   408	
   409	// Size returns the number of leading ones and total bits in the mask.
   410	// If the mask is not in the canonical form--ones followed by zeros--then
   411	// Size returns 0, 0.
   412	func (m IPMask) Size() (ones, bits int) {
   413		ones, bits = simpleMaskLength(m), len(m)*8
   414		if ones == -1 {
   415			return 0, 0
   416		}
   417		return
   418	}
   419	
   420	// String returns the hexadecimal form of m, with no punctuation.
   421	func (m IPMask) String() string {
   422		s := ""
   423		for _, b := range m {
   424			s += itox(uint(b), 2)
   425		}
   426		if len(s) == 0 {
   427			return "<nil>"
   428		}
   429		return s
   430	}
   431	
   432	func networkNumberAndMask(n *IPNet) (ip IP, m IPMask) {
   433		if ip = n.IP.To4(); ip == nil {
   434			ip = n.IP
   435			if len(ip) != IPv6len {
   436				return nil, nil
   437			}
   438		}
   439		m = n.Mask
   440		switch len(m) {
   441		case IPv4len:
   442			if len(ip) != IPv4len {
   443				return nil, nil
   444			}
   445		case IPv6len:
   446			if len(ip) == IPv4len {
   447				m = m[12:]
   448			}
   449		default:
   450			return nil, nil
   451		}
   452		return
   453	}
   454	
   455	// Contains reports whether the network includes ip.
   456	func (n *IPNet) Contains(ip IP) bool {
   457		nn, m := networkNumberAndMask(n)
   458		if x := ip.To4(); x != nil {
   459			ip = x
   460		}
   461		l := len(ip)
   462		if l != len(nn) {
   463			return false
   464		}
   465		for i := 0; i < l; i++ {
   466			if nn[i]&m[i] != ip[i]&m[i] {
   467				return false
   468			}
   469		}
   470		return true
   471	}
   472	
   473	// Network returns the address's network name, "ip+net".
   474	func (n *IPNet) Network() string { return "ip+net" }
   475	
   476	// String returns the CIDR notation of n like "192.168.100.1/24"
   477	// or "2001:DB8::/48" as defined in RFC 4632 and RFC 4291.
   478	// If the mask is not in the canonical form, it returns the
   479	// string which consists of an IP address, followed by a slash
   480	// character and a mask expressed as hexadecimal form with no
   481	// punctuation like "192.168.100.1/c000ff00".
   482	func (n *IPNet) String() string {
   483		nn, m := networkNumberAndMask(n)
   484		if nn == nil || m == nil {
   485			return "<nil>"
   486		}
   487		l := simpleMaskLength(m)
   488		if l == -1 {
   489			return nn.String() + "/" + m.String()
   490		}
   491		return nn.String() + "/" + itod(uint(l))
   492	}
   493	
   494	// Parse IPv4 address (d.d.d.d).
   495	func parseIPv4(s string) IP {
   496		var p [IPv4len]byte
   497		i := 0
   498		for j := 0; j < IPv4len; j++ {
   499			if i >= len(s) {
   500				// Missing octets.
   501				return nil
   502			}
   503			if j > 0 {
   504				if s[i] != '.' {
   505					return nil
   506				}
   507				i++
   508			}
   509			var (
   510				n  int
   511				ok bool
   512			)
   513			n, i, ok = dtoi(s, i)
   514			if !ok || n > 0xFF {
   515				return nil
   516			}
   517			p[j] = byte(n)
   518		}
   519		if i != len(s) {
   520			return nil
   521		}
   522		return IPv4(p[0], p[1], p[2], p[3])
   523	}
   524	
   525	// parseIPv6 parses s as a literal IPv6 address described in RFC 4291
   526	// and RFC 5952.  It can also parse a literal scoped IPv6 address with
   527	// zone identifier which is described in RFC 4007 when zoneAllowed is
   528	// true.
   529	func parseIPv6(s string, zoneAllowed bool) (ip IP, zone string) {
   530		ip = make(IP, IPv6len)
   531		ellipsis := -1 // position of ellipsis in p
   532		i := 0         // index in string s
   533	
   534		if zoneAllowed {
   535			s, zone = splitHostZone(s)
   536		}
   537	
   538		// Might have leading ellipsis
   539		if len(s) >= 2 && s[0] == ':' && s[1] == ':' {
   540			ellipsis = 0
   541			i = 2
   542			// Might be only ellipsis
   543			if i == len(s) {
   544				return ip, zone
   545			}
   546		}
   547	
   548		// Loop, parsing hex numbers followed by colon.
   549		j := 0
   550		for j < IPv6len {
   551			// Hex number.
   552			n, i1, ok := xtoi(s, i)
   553			if !ok || n > 0xFFFF {
   554				return nil, zone
   555			}
   556	
   557			// If followed by dot, might be in trailing IPv4.
   558			if i1 < len(s) && s[i1] == '.' {
   559				if ellipsis < 0 && j != IPv6len-IPv4len {
   560					// Not the right place.
   561					return nil, zone
   562				}
   563				if j+IPv4len > IPv6len {
   564					// Not enough room.
   565					return nil, zone
   566				}
   567				ip4 := parseIPv4(s[i:])
   568				if ip4 == nil {
   569					return nil, zone
   570				}
   571				ip[j] = ip4[12]
   572				ip[j+1] = ip4[13]
   573				ip[j+2] = ip4[14]
   574				ip[j+3] = ip4[15]
   575				i = len(s)
   576				j += IPv4len
   577				break
   578			}
   579	
   580			// Save this 16-bit chunk.
   581			ip[j] = byte(n >> 8)
   582			ip[j+1] = byte(n)
   583			j += 2
   584	
   585			// Stop at end of string.
   586			i = i1
   587			if i == len(s) {
   588				break
   589			}
   590	
   591			// Otherwise must be followed by colon and more.
   592			if s[i] != ':' || i+1 == len(s) {
   593				return nil, zone
   594			}
   595			i++
   596	
   597			// Look for ellipsis.
   598			if s[i] == ':' {
   599				if ellipsis >= 0 { // already have one
   600					return nil, zone
   601				}
   602				ellipsis = j
   603				if i++; i == len(s) { // can be at end
   604					break
   605				}
   606			}
   607		}
   608	
   609		// Must have used entire string.
   610		if i != len(s) {
   611			return nil, zone
   612		}
   613	
   614		// If didn't parse enough, expand ellipsis.
   615		if j < IPv6len {
   616			if ellipsis < 0 {
   617				return nil, zone
   618			}
   619			n := IPv6len - j
   620			for k := j - 1; k >= ellipsis; k-- {
   621				ip[k+n] = ip[k]
   622			}
   623			for k := ellipsis + n - 1; k >= ellipsis; k-- {
   624				ip[k] = 0
   625			}
   626		}
   627		return ip, zone
   628	}
   629	
   630	// A ParseError represents a malformed text string and the type of string that was expected.
   631	type ParseError struct {
   632		Type string
   633		Text string
   634	}
   635	
   636	func (e *ParseError) Error() string {
   637		return "invalid " + e.Type + ": " + e.Text
   638	}
   639	
   640	// ParseIP parses s as an IP address, returning the result.
   641	// The string s can be in dotted decimal ("74.125.19.99")
   642	// or IPv6 ("2001:4860:0:2001::68") form.
   643	// If s is not a valid textual representation of an IP address,
   644	// ParseIP returns nil.
   645	func ParseIP(s string) IP {
   646		if ip := parseIPv4(s); ip != nil {
   647			return ip
   648		}
   649		ip, _ := parseIPv6(s, false)
   650		return ip
   651	}
   652	
   653	// ParseCIDR parses s as a CIDR notation IP address and mask,
   654	// like "192.168.100.1/24" or "2001:DB8::/48", as defined in
   655	// RFC 4632 and RFC 4291.
   656	//
   657	// It returns the IP address and the network implied by the IP
   658	// and mask.  For example, ParseCIDR("192.168.100.1/16") returns
   659	// the IP address 192.168.100.1 and the network 192.168.0.0/16.
   660	func ParseCIDR(s string) (IP, *IPNet, error) {
   661		i := byteIndex(s, '/')
   662		if i < 0 {
   663			return nil, nil, &ParseError{"CIDR address", s}
   664		}
   665		addr, mask := s[:i], s[i+1:]
   666		iplen := IPv4len
   667		ip := parseIPv4(addr)
   668		if ip == nil {
   669			iplen = IPv6len
   670			ip, _ = parseIPv6(addr, false)
   671		}
   672		n, i, ok := dtoi(mask, 0)
   673		if ip == nil || !ok || i != len(mask) || n < 0 || n > 8*iplen {
   674			return nil, nil, &ParseError{"CIDR address", s}
   675		}
   676		m := CIDRMask(n, 8*iplen)
   677		return ip, &IPNet{IP: ip.Mask(m), Mask: m}, nil
   678	}

View as plain text