3 LuCI ip calculation libarary
4 (c) 2008 Jo-Philipp Wich <xm@leipzig.freifunk.net>
5 (c) 2008 Steven Barth <steven@midlink.org>
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
11 http://www.apache.org/licenses/LICENSE-2.0
17 module( "luci.ip", package.seeall )
22 LITTLE_ENDIAN = not luci.util.bigendian()
23 BIG_ENDIAN = not LITTLE_ENDIAN
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,
37 return luci.ip.cidr.equal(...) or luci.ip.cidr.lower(...)
42 local function __mask16(bits)
44 bit.rshift( 0xFFFF, 16 - bits % 16 ),
49 local function __length(family)
50 if family == FAMILY_INET4 then
57 -- htons(), htonl(), ntohs(), ntohl()
63 bit.band( bit.lshift( x, 8 ), 0xFF00 )
73 bit.lshift( htons( bit.band( x, 0xFFFF ) ), 16 ),
74 htons( bit.rshift( x, 16 ) )
85 function IPv4(address, netmask)
86 address = address or "0.0.0.0/0"
88 local obj = __bless({ FAMILY_INET4 })
91 local prefix = address:match("/(.+)")
94 prefix = obj:prefix(netmask)
96 address = address:gsub("/.+","")
97 prefix = tonumber(prefix)
98 if not prefix or prefix < 0 or prefix > 32 then return nil end
103 local b1, b2, b3, b4 = address:match("^(%d+)%.(%d+)%.(%d+)%.(%d+)$")
110 if b1 and b1 <= 255 and
116 table.insert(obj, { b1 * 256 + b2, b3 * 256 + b4 })
117 table.insert(obj, prefix)
122 function IPv6(address, netmask)
123 address = address or "::/0"
125 local obj = __bless({ FAMILY_INET6 })
128 local prefix = address:match("/(.+)")
131 prefix = obj:prefix(netmask)
133 address = address:gsub("/.+","")
134 prefix = tonumber(prefix)
135 if not prefix or prefix < 0 or prefix > 128 then return nil end
140 local borderl = address:sub(1, 1) == ":" and 2 or 1
141 local borderh, zeroh, chunk, block
143 if #address > 45 then return nil end
146 borderh = address:find(":", borderl, true)
147 if not borderh then break end
149 block = tonumber(address:sub(borderl, borderh - 1), 16)
150 if block and block <= 65535 then
151 table.insert(data, block)
153 if zeroh or borderh - borderl > 1 then return nil end
157 borderl = borderh + 1
160 chunk = address:sub(borderl)
161 if #chunk > 0 and #chunk <= 4 then
162 block = tonumber(chunk, 16)
163 if not block or block > 65535 then return nil end
165 table.insert(data, block)
166 elseif #chunk > 4 then
167 if #data == 7 or #chunk > 15 then return nil end
170 borderh = chunk:find(".", borderl, true)
171 if not borderh and i < 4 then return nil end
172 borderh = borderh and borderh - 1
174 block = tonumber(chunk:sub(borderl, borderh))
175 if not block or block > 255 then return nil end
177 if i == 1 or i == 3 then
178 table.insert(data, block * 256)
180 data[#data] = data[#data] + block
183 borderl = borderh and borderh + 2
188 if #data == 8 then return nil end
190 table.insert(data, zeroh, 0)
194 if #data == 8 and prefix then
195 table.insert(obj, data)
196 table.insert(obj, prefix)
201 function Hex( hex, prefix, family, swap )
202 family = ( family ~= nil ) and family or FAMILY_INET4
203 swap = ( swap == nil ) and true or swap
204 prefix = prefix or __length(family)
206 local len = __length(family)
210 for i = 1, (len/4) - #hex do tmp = tmp .. '0' end
212 if swap and LITTLE_ENDIAN then
213 for i = #hex, 1, -2 do tmp = tmp .. hex:sub( i - 1, i ) end
220 for i = 1, ( len / 4 ), 4 do
221 local n = tonumber( hex:sub( i, i+3 ), 16 )
223 table.insert( data, n )
229 return __bless({ family, data, len })
233 cidr = luci.util.class()
235 function cidr.is4( self )
236 return self[1] == FAMILY_INET4
239 function cidr.is6( self )
240 return self[1] == FAMILY_INET6
243 function cidr.string( self )
248 bit.rshift(self[2][1], 8), bit.band(self[2][1], 0xFF),
249 bit.rshift(self[2][2], 8), bit.band(self[2][2], 0xFF)
252 str = str .. "/" .. self[3]
254 elseif self:is6() then
255 str = string.format( "%X:%X:%X:%X:%X:%X:%X:%X", unpack(self[2]) )
256 if self[3] < 128 then
257 str = str .. "/" .. self[3]
263 function cidr.lower( self, addr )
264 assert( self[1] == addr[1], "Can't compare IPv4 and IPv6 addresses" )
265 for i = 1, #self[2] do
266 if self[2][i] ~= addr[2][i] then
267 return self[2][i] < addr[2][i]
273 function cidr.higher( self, addr )
274 assert( self[1] == addr[1], "Can't compare IPv4 and IPv6 addresses" )
275 for i = 1, #self[2] do
276 if self[2][i] ~= addr[2][i] then
277 return self[2][i] > addr[2][i]
283 function cidr.equal( self, addr )
284 assert( self[1] == addr[1], "Can't compare IPv4 and IPv6 addresses" )
285 for i = 1, #self[2] do
286 if self[2][i] ~= addr[2][i] then
293 function cidr.prefix( self, mask )
294 local prefix = self[3]
299 local obj = self:is4() and IPv4(mask) or IPv6(mask)
305 for i, block in ipairs(obj[2]) do
306 local pos = bit.lshift(1, 15)
308 if bit.band(block, pos) == pos then
317 pos = bit.rshift(pos, 1)
325 function cidr.network( self, bits )
327 bits = bits or self[3]
329 for i = 1, math.floor( bits / 16 ) do
330 table.insert( data, self[2][i] )
333 if #data < #self[2] then
334 table.insert( data, bit.band( self[2][1+#data], __mask16(bits) ) )
336 for i = #data + 1, #self[2] do
337 table.insert( data, 0 )
341 return __bless({ self[1], data, __length(self[1]) })
344 function cidr.host( self )
345 return __bless({ self[1], data, __length(self[1]) })
348 function cidr.mask( self, bits )
350 bits = bits or self[3]
352 for i = 1, math.floor( bits / 16 ) do
353 table.insert( data, 0xFFFF )
356 if #data < #self[2] then
357 table.insert( data, __mask16(bits) )
359 for i = #data + 1, #self[2] do
360 table.insert( data, 0 )
364 return __bless({ self[1], data, __length(self[1]) })
367 function cidr.contains( self, addr )
368 assert( self[1] == addr[1], "Can't compare IPv4 and IPv6 addresses" )
370 if self:prefix() <= addr:prefix() then
371 return self:network() == addr:network(self:prefix())
377 function cidr.add( self, amount )
378 local shorts = { bit.rshift(amount, 16), bit.band(amount, 0xFFFF) }
379 local data = { unpack(self[2]) }
381 for pos = #data, 1, -1 do
382 local add = ( #shorts > 0 ) and table.remove( shorts, #shorts ) or 0
383 if ( data[pos] + add ) > 0xFFFF then
384 data[pos] = ( data[pos] + add ) % 0xFFFF
386 data[pos-1] = data[pos-1] + ( add - data[pos] )
389 data[pos] = data[pos] + add
393 return __bless({ self[1], data, self[3] })