iplist/iplist.go

   1 package iplist
   2
   3 import (
   4         "bytes"
   5         "errors"
   6         "fmt"
   7         "net"
   8         "sort"
   9 )
  10
  11 type IPList struct {
  12         ranges []Range
  13 }
  14
  15 type Range struct {
  16         First, Last net.IP
  17         Description string
  18 }
  19
  20 func (r *Range) String() string {
  21         return fmt.Sprintf("%s-%s (%s)", r.First, r.Last, r.Description)
  22 }
  23
  24 // Create a new IP list. The given ranges must already sorted by the lower
  25 // bound IP in each range. Behaviour is undefined for lists of overlapping
  26 // ranges.
  27 func New(initSorted []Range) *IPList {
  28         return &IPList{
  29                 ranges: initSorted,
  30         }
  31 }
  32
  33 func (me *IPList) NumRanges() int {
  34         if me == nil {
  35                 return 0
  36         }
  37         return len(me.ranges)
  38 }
  39
  40 // Return the range the given IP is in. Returns nil if no range is found.
  41 func (me *IPList) Lookup(ip net.IP) (r *Range) {
  42         if me == nil {
  43                 return nil
  44         }
  45         // TODO: Perhaps all addresses should be converted to IPv6, if the future
  46         // of IP is to always be backwards compatible. But this will cost 4x the
  47         // memory for IPv4 addresses?
  48         if v4 := ip.To4(); v4 != nil {
  49                 r = me.lookup(v4)
  50                 if r != nil {
  51                         return
  52                 }
  53         }
  54         if v6 := ip.To16(); v6 != nil {
  55                 return me.lookup(v6)
  56         }
  57         return nil
  58 }
  59
  60 // Return the range the given IP is in. Returns nil if no range is found.
  61 func (me *IPList) lookup(ip net.IP) (r *Range) {
  62         // Find the index of the first range for which the following range exceeds
  63         // it.
  64         i := sort.Search(len(me.ranges), func(i int) bool {
  65                 if i+1 >= len(me.ranges) {
  66                         return true
  67                 }
  68                 return bytes.Compare(ip, me.ranges[i+1].First) < 0
  69         })
  70         if i == len(me.ranges) {
  71                 return
  72         }
  73         r = &me.ranges[i]
  74         if bytes.Compare(ip, r.First) < 0 || bytes.Compare(ip, r.Last) > 0 {
  75                 r = nil
  76         }
  77         return
  78 }
  79
  80 func minifyIP(ip *net.IP) {
  81         v4 := ip.To4()
  82         if v4 != nil {
  83                 *ip = append(make([]byte, 0, 4), v4...)
  84         }
  85 }
  86
  87 // Parse a line of the PeerGuardian Text Lists (P2P) Format. Returns !ok but
  88 // no error if a line doesn't contain a range but isn't erroneous, such as
  89 // comment and blank lines.
  90 func ParseBlocklistP2PLine(l []byte) (r Range, ok bool, err error) {
  91         l = bytes.TrimSpace(l)
  92         if len(l) == 0 || bytes.HasPrefix(l, []byte("#")) {
  93                 return
  94         }
  95         // TODO: Something tells me this will end badly when IPv6 blocklists are
  96         // added.
  97         colon := bytes.LastIndexAny(l, ":")
  98         if colon == -1 {
  99                 err = errors.New("missing colon")
 100                 return
 101         }
 102         hyphen := bytes.IndexByte(l[colon+1:], '-')
 103         if hyphen == -1 {
 104                 err = errors.New("missing hyphen")
 105                 return
 106         }
 107         hyphen += colon + 1
 108         r.Description = string(l[:colon])
 109         r.First = net.ParseIP(string(l[colon+1 : hyphen]))
 110         minifyIP(&r.First)
 111         r.Last = net.ParseIP(string(l[hyphen+1:]))
 112         minifyIP(&r.Last)
 113         if r.First == nil || r.Last == nil || len(r.First) != len(r.Last) {
 114                 err = errors.New("bad IP range")
 115                 return
 116         }
 117         ok = true
 118         return
 119 }