libs/core/luasrc/ip.lua

   1 --[[
   2
   3 LuCI ip calculation libarary
   4 (c) 2008 Jo-Philipp Wich <xm@leipzig.freifunk.net>
   5 (c) 2008 Steven Barth <steven@midlink.org>
   6
   7 Licensed under the Apache License, Version 2.0 (the "License");
   8 you may not use this file except in compliance with the License.
   9 You may obtain a copy of the License at
  10
  11         http://www.apache.org/licenses/LICENSE-2.0
  12
  13 $Id$
  14
  15 ]]--
  16
  17 module( "luci.ip", package.seeall )
  18
  19 require("bit")
  20 require("luci.util")
  21
  22 LITTLE_ENDIAN = not luci.util.bigendian()
  23 BIG_ENDIAN    = not LITTLE_ENDIAN
  24
  25 FAMILY_INET4  = 0x04
  26 FAMILY_INET6  = 0x06
  27
  28
  29 local function __bless(x)
  30         return setmetatable( x, {
  31                 __index = luci.ip.cidr,
  32                 __add   = luci.ip.cidr.add,
  33                 __lt    = luci.ip.cidr.lower,
  34                 __eq    = luci.ip.cidr.equal,
  35                 __le    =
  36                         function(...)
  37                                 return luci.ip.cidr.equal(...) or luci.ip.cidr.lower(...)
  38                         end
  39         } )
  40 end
  41
  42 local function __mask16(bits)
  43         return bit.lshift(
  44                 bit.rshift( 0xFFFF, 16 - bits % 16 ),
  45                 16 - bits % 16
  46         )
  47 end
  48
  49 -- htons(), htonl(), ntohs(), ntohl()
  50
  51 function htons(x)
  52         if LITTLE_ENDIAN then
  53                 return bit.bor(
  54                         bit.rshift( x, 8 ),
  55                         bit.band( bit.lshift( x, 8 ), 0xFF00 )
  56                 )
  57         else
  58                 return x
  59         end
  60 end
  61
  62 function htonl(x)
  63         if LITTLE_ENDIAN then
  64                 return bit.bor(
  65                         bit.lshift( htons( bit.band( x, 0xFFFF ) ), 16 ),
  66                         htons( bit.rshift( x, 16 ) )
  67                 )
  68         else
  69                 return x
  70         end
  71 end
  72
  73 ntohs = htons
  74 ntohl = htonl
  75
  76
  77 function IPv4(address, netmask)
  78         address = address or "0.0.0.0/0"
  79
  80         local data = {}
  81         local prefix = address:match("/(.+)")
  82
  83         if netmask then
  84                 prefix = IPv4():prefix(netmask)
  85         elseif prefix then
  86                 address = address:gsub("/.+","")
  87                 prefix = tonumber(prefix)
  88                 if not prefix or prefix < 0 or prefix > 32 then return nil end
  89         else
  90                 prefix = 32
  91         end
  92
  93         local b1, b2, b3, b4 = address:match("^(%d+)%.(%d+)%.(%d+)%.(%d+)$")
  94
  95         b1 = tonumber(b1)
  96         b2 = tonumber(b2)
  97         b3 = tonumber(b3)
  98         b4 = tonumber(b4)
  99
 100         if b1 and b1 <= 255 and
 101            b2 and b2 <= 255 and
 102            b3 and b3 <= 255 and
 103            b4 and b4 <= 255
 104         then
 105                 return __bless({
 106                         FAMILY_INET4,
 107                         { b1 * 256 + b2, b3 * 256 + b4 },
 108                         prefix
 109                 })
 110         end
 111 end
 112
 113 function IPv6(address, netmask)
 114         address = address or "::/0"
 115
 116         local data = {}
 117         local prefix = address:match("/(.+)")
 118
 119         if netmask then
 120                 prefix = IPv6():prefix(netmask)
 121         elseif prefix then
 122                 address = address:gsub("/.+","")
 123                 prefix = tonumber(prefix)
 124                 if not prefix or prefix < 0 or prefix > 128 then return nil end
 125         else
 126                 prefix = 128
 127         end
 128
 129         local borderl = address:sub(1, 1) == ":" and 2 or 1
 130         local borderh, zeroh, chunk, block
 131
 132         if #address > 45 then return nil end
 133
 134         repeat
 135                 borderh = address:find(":", borderl, true)
 136                 if not borderh then break end
 137
 138                 block = tonumber(address:sub(borderl, borderh - 1), 16)
 139                 if block and block <= 65535 then
 140                         table.insert(data, block)
 141                 else
 142                         if zeroh or borderh - borderl > 1 then return nil end
 143                         zeroh = #data + 1
 144                 end
 145
 146                 borderl = borderh + 1
 147         until #data == 7
 148
 149         chunk = address:sub(borderl)
 150         if #chunk > 0 and #chunk <= 4 then
 151                 block = tonumber(chunk, 16)
 152                 if not block or block > 65535 then return nil end
 153
 154                 table.insert(data, block)
 155         elseif #chunk > 4 then
 156                 if #data == 7 or #chunk > 15 then return nil end
 157                 borderl = 1
 158                 for i=1, 4 do
 159                         borderh = chunk:find(".", borderl, true)
 160                         if not borderh and i < 4 then return nil end
 161                         borderh = borderh and borderh - 1
 162
 163                         block = tonumber(chunk:sub(borderl, borderh))
 164                         if not block or block > 255 then return nil end
 165
 166                         if i == 1 or i == 3 then
 167                                 table.insert(data, block * 256)
 168                         else
 169                                 data[#data] = data[#data] + block
 170                         end
 171
 172                         borderl = borderh and borderh + 2
 173                 end
 174         end
 175
 176         if zeroh then
 177                 if #data == 8 then return nil end
 178                 while #data < 8 do
 179                         table.insert(data, zeroh, 0)
 180                 end
 181         end
 182
 183         if #data == 8 then
 184                 return __bless({ FAMILY_INET6, data, prefix })
 185         end
 186 end
 187
 188
 189 cidr = luci.util.class()
 190
 191 function cidr.is4( self )
 192         return self[1] == FAMILY_INET4
 193 end
 194
 195 function cidr.is6( self )
 196         return self[1] == FAMILY_INET6
 197 end
 198
 199 function cidr.string( self )
 200         local str
 201         if self:is4() then
 202                 str = string.format(
 203                         "%d.%d.%d.%d",
 204                         bit.rshift(self[2][1], 8), bit.band(self[2][1], 0xFF),
 205                         bit.rshift(self[2][2], 8), bit.band(self[2][2], 0xFF)
 206                 )
 207                 if self[3] < 32 then
 208                         str = str .. "/" .. self[3]
 209                 end
 210         elseif self:is6() then
 211                 str = string.format( "%X:%X:%X:%X:%X:%X:%X:%X", unpack(self[2]) )
 212                 if self[3] < 128 then
 213                         str = str .. "/" .. self[3]
 214                 end
 215         end
 216         return str
 217 end
 218
 219 function cidr.lower( self, addr )
 220         assert( self[1] == addr[1], "Can't compare IPv4 and IPv6 addresses" )
 221         for i = 1, #self[2] do
 222                 if self[2][i] ~= addr[2][i] then
 223                         return self[2][i] < addr[2][i]
 224                 end
 225         end
 226         return false
 227 end
 228
 229 function cidr.higher( self, addr )
 230         assert( self[1] == addr[1], "Can't compare IPv4 and IPv6 addresses" )
 231         for i = 1, #self[2] do
 232                 if self[2][i] ~= addr[2][i] then
 233                         return self[2][i] > addr[2][i]
 234                 end
 235         end
 236         return false
 237 end
 238
 239 function cidr.equal( self, addr )
 240         assert( self[1] == addr[1], "Can't compare IPv4 and IPv6 addresses" )
 241         for i = 1, #self[2] do
 242                 if self[2][i] ~= addr[2][i] then
 243                         return false
 244                 end
 245         end
 246         return true
 247 end
 248
 249 function cidr.prefix( self, mask )
 250         local prefix = self[3]
 251
 252         if mask then
 253                 prefix = 0
 254
 255                 local obj = self:is4() and IPv4(mask) or IPv6(mask)
 256                 if not obj then
 257                         return nil
 258                 end
 259
 260                 for i, block in ipairs(obj[2]) do
 261                         local pos = bit.lshift(1, 15)
 262                         for i=15, 0, -1 do
 263                                 if bit.band(block, pos) == pos then
 264                                         prefix = prefix + 1
 265                                 else
 266                                         return prefix
 267                                 end
 268                                 pos = bit.rshift(pos, 1)
 269                         end
 270                 end
 271         end
 272
 273         return prefix
 274 end
 275
 276 function cidr.network( self )
 277         local data = { }
 278
 279         for i = 1, math.floor( self[3] / 16 ) do
 280                 table.insert( data, self[2][i] )
 281         end
 282
 283         table.insert( data, bit.band( self[2][1+#data], __mask16(self[3]) ) )
 284
 285         for i = #data, #self[2] do
 286                 table.insert( data, 0 )
 287         end
 288
 289         return __bless({ self[1], data, self:is4() and 32 or 128 })
 290 end
 291
 292 function cidr.host( self )
 293         return __bless({ self[1], data, self:is4() and 32 or 128 })
 294 end
 295
 296 function cidr.mask( self, bits )
 297         local data = { }
 298         bits = bits or self[3]
 299
 300         for i = 1, math.floor( bits / 16 ) do
 301                 table.insert( data, 0xFFFF )
 302         end
 303
 304         table.insert( data, __mask16(bits) )
 305
 306         for i = #data + 1, #self[2] do
 307                 table.insert( data, 0 )
 308         end
 309
 310         return __bless({ self[1], data, self:is4() and 32 or 128 })
 311 end
 312
 313 function cidr.contains( self, addr )
 314         if self:mask() <= addr:mask() then
 315                 return self:mask(addr:prefix()) == addr:mask()
 316         end
 317
 318         return false
 319 end
 320
 321 function cidr.add( self, amount )
 322         local shorts = { bit.rshift(amount, 16), bit.band(amount, 0xFFFF) }
 323         local data   = { unpack(self[2]) }
 324
 325         for pos = #data, 1, -1 do
 326                 local add = ( #shorts > 0 ) and table.remove( shorts, #shorts ) or 0
 327                 if ( data[pos] + add ) > 0xFFFF then
 328                         data[pos] = ( data[pos] + add ) % 0xFFFF
 329                         if pos > 2 then
 330                                 data[pos-1] = data[pos-1] + ( add - data[pos] )
 331                         end
 332                 else
 333                         data[pos] = data[pos] + add
 334                 end
 335         end
 336
 337         return __bless({ self[1], data, self[3] })
 338 end