model.lua 14.3 KB
Newer Older
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
1 2
--[[
Base data model for Alpine Wall
3
Copyright (C) 2012-2014 Kaarle Ritvanen
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
4
See LICENSE file for license details
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
5 6 7
]]--


8
local M = {}
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
9 10


11 12 13 14
local loadclass = require('awall').loadclass
M.class = require('awall.class')
local resolve = require('awall.host')
local builtin = require('awall.iptables').builtin
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
15

16 17
local optfrag = require('awall.optfrag')
local combinations = optfrag.combinations
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
18

19
local raise = require('awall.uerror').raise
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
20

21 22 23 24 25 26
local util = require('awall.util')
local contains = util.contains
local extend = util.extend
local filter = util.filter
local listpairs = util.listpairs
local maplist = util.maplist
27

Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
28

29 30 31
local startswith = require('stringy').startswith


32 33 34
local RECENT_MAX_COUNT = 20


35 36 37 38 39 40 41 42 43
local function join(a, b)
   local comps = {}
   local function add(s) if s and s > '' then table.insert(comps, s) end end
   add(a)
   add(b)
   if comps[1] then return table.concat(comps, '-') end
end


44 45 46
M.ConfigObject = M.class()

function M.ConfigObject:init(context, location)
47 48
   if context then
      self.context = context
49
      self.root = context.objects
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
50
   end
51
   self.location = location
52 53

   self.extraobjs = {}
54
   self.uniqueids = {}
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
55 56
end

57 58 59 60 61 62 63 64
function M.ConfigObject:create(cls, params, label, index)
   local key
   if label then
      key = label..(index or '')
      local obj = self.extraobjs[key]
      if obj then return obj end
   end

65 66
   if type(cls) == 'string' then
      local name = cls
67
      cls = loadclass(cls)
68 69 70 71
      if not cls then
	 self:error('Support for '..name..' objects not installed')
      end
   end
72

73
   if type(params) ~= 'table' then params = {params} end
74
   params.label = join(self.label, label)
75

76 77 78
   local obj = cls.morph(params, self.context, self.location)
   if key then self.extraobjs[key] = obj end
   return obj
79 80
end

81
function M.ConfigObject:uniqueid(key)
82
   if not key then key = '' end
83 84 85 86 87
   if self.uniqueids[key] then return self.uniqueids[key] end

   if not self.context.lastid then self.context.lastid = {} end
   local lastid = self.context.lastid

88
   local res = join(key, self.label)
89 90 91 92 93 94 95 96
   if not lastid[res] then lastid[res] = -1 end
   lastid[res] = lastid[res] + 1
   res = res..'-'..lastid[res]

   self.uniqueids[key] = res
   return res
end

97
function M.ConfigObject:error(msg) raise(self.location..': '..msg) end
98

99
function M.ConfigObject:warning(msg)
100 101 102
   io.stderr:write(self.location..': '..msg..'\n')
end

103
function M.ConfigObject:trules() return {} end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
104

105
function M.ConfigObject:info()
106 107
   local res = {}
   for i, trule in ipairs(self:trules()) do
108
      table.insert(res, {'  '..optfrag.location(trule), optfrag.command(trule)})
109 110 111 112
   end
   return res
end

Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
113

114
M.Zone = M.class(M.ConfigObject)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
115

116
function M.Zone:optfrags(dir)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
117 118 119 120 121 122 123
   local iopt, aopt, iprop, aprop
   if dir == 'in' then
      iopt, aopt, iprop, aprop = 'i', 's', 'in', 'src'
   elseif dir == 'out' then
      iopt, aopt, iprop, aprop = 'o', 'd', 'out', 'dest'
   else assert(false) end

Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
124 125 126
   local aopts = nil
   if self.addr then
      aopts = {}
127 128
      for i, hostdef in listpairs(self.addr) do
	 for i, addr in ipairs(resolve(hostdef, self)) do
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
129 130 131 132 133
	    table.insert(aopts,
			 {family=addr[1],
			  [aprop]=addr[2],
			  opts='-'..aopt..' '..addr[2]})
	 end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
134 135 136
      end
   end

137 138 139 140 141 142 143
   return combinations(
      maplist(
	 self.iface,
	 function(x) return {[iprop]=x, opts='-'..iopt..' '..x} end
      ),
      aopts
   )
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
144 145 146
end


147
M.fwzone = M.Zone()
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
148 149


150
local IPSet = M.class(M.ConfigObject)
151 152

function IPSet:init(...)
153
   IPSet.super(self):init(...)
154 155 156

   if not self.type then self:error('Type not defined') end

157
   if startswith(self.type, 'bitmap:') then
158 159 160 161
      if not self.range then self:error('Range not defined') end
      self.options = {self.type, 'range', self.range}
      self.family = 'inet'

162
   elseif startswith(self.type, 'hash:') then
163 164 165 166 167 168 169 170 171
      if not self.family then self:error('Family not defined') end
      self.options = {self.type, 'family', self.family}

   elseif self.type == 'list:set' then self.options = {self.type}

   else self:error('Invalid type: '..self.type) end
end


172
M.Rule = M.class(M.ConfigObject)
173

Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
174

175 176
function M.Rule:init(...)
   M.Rule.super(self):init(...)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
177 178

   for i, prop in ipairs({'in', 'out'}) do
179 180 181 182 183 184 185 186 187
      self[prop] = self[prop] and maplist(
	 self[prop],
	 function(z)
	    if type(z) ~= 'string' then return z end
	    return z == '_fw' and M.fwzone or
	       self.root.zone[z] or
	       self:error('Invalid zone: '..z)
	 end
      )
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
188
   end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
189

Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
190
   if self.service then
191 192 193 194
      if not self.label and type(self.service) == 'string' then
	 self.label = self.service
      end

195 196 197 198 199 200 201
      self.service = maplist(
	 self.service,
	 function(s)
	    if type(s) ~= 'string' then return s end
	    return self.root.service[s] or self:error('Invalid service: '..s)
	 end
      )
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
202 203 204 205
   end
end


206
function M.Rule:direction(dir)
207 208 209 210 211 212
   if dir == 'in' then return self.reverse and 'out' or 'in' end
   if dir == 'out' then return self.reverse and 'in' or 'out' end
   self:error('Invalid direction: '..dir)
end


213
function M.Rule:zoneoptfrags()
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
214

215
   local function zonepair(zin, zout)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
216

217
      local function zofs(zone, dir)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
218
	 if not zone then return zone end
219
	 return zone:optfrags(dir)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
220 221 222 223
      end

      local chain, ofrags

224
      if zin == M.fwzone or zout == M.fwzone then
225
	 if zin == zout then return {} end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
226
	 local dir, z = 'in', zin
227
	 if zin == M.fwzone then dir, z = 'out', zout end
228
	 chain = dir:upper()..'PUT'
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
229 230
	 ofrags = zofs(z, dir)

231 232 233 234 235 236 237 238 239 240 241
      elseif not zin or not zout then

	 if zin then
	    chain = 'PREROUTING'
	    ofrags = zofs(zin, 'in')

	 elseif zout then
	    chain = 'POSTROUTING'
	    ofrags = zofs(zout, 'out')
	 end

Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
242 243
      else
	 chain = 'FORWARD'
244 245
	 ofrags = combinations(zofs(zin, 'in'), zofs(zout, 'out'))

246
	 if ofrags and not zout['route-back'] then
247 248 249 250 251 252
	    ofrags = filter(
	       ofrags,
	       function(of)
		  return not (of['in'] and of.out and of['in'] == of.out)
	       end
	    )
253
	 end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
254 255
      end

256 257 258
      return combinations(ofrags,
			  chain and {{chain=chain}} or {{chain='PREROUTING'},
							{chain='OUTPUT'}})
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
259 260 261
   end

   local res = {}
262 263
   local izones = self[self:direction('in')] or {}
   local ozones = self[self:direction('out')] or {}
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
264

265 266
   for i = 1,math.max(1, table.maxn(izones)) do
      for j = 1,math.max(1, table.maxn(ozones)) do
267
	 extend(res, zonepair(izones[i], ozones[j]))
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
268 269 270 271 272 273 274
      end
   end

   return res
end


275
function M.Rule:servoptfrags()
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
276 277 278

   if not self.service then return end

279
   local fports = {inet={}, inet6={}}
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
280 281 282
   local res = {}

   for i, serv in ipairs(self.service) do
283
      for i, sdef in listpairs(serv) do
284
	 if not sdef.proto then self:error('Protocol not defined') end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
285

286
	 if contains({6, 'tcp', 17, 'udp'}, sdef.proto) then
287 288 289 290 291 292 293 294
	    for family, ports in pairs(fports) do
	       if not sdef.family or family == sdef.family then

		  local new = not ports[sdef.proto]
		  if new then ports[sdef.proto] = {} end

		  if new or ports[sdef.proto][1] then
		     if sdef.port then
295
			extend(
296
			   ports[sdef.proto],
297
			   maplist(
298
			      sdef.port,
299
			      function(p) return tostring(p):gsub('-', ':') end
300 301 302 303 304
			   )
			)
		     else ports[sdef.proto] = {} end
		  end
	       end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
305 306 307 308 309 310 311
	    end

	 else

	    local opts = '-p '..sdef.proto
	    local family = nil

312 313
	    -- TODO multiple ICMP types per rule
	    local oname
314
	    if contains({1, 'icmp'}, sdef.proto) then
315 316
	       family = 'inet'
	       oname = 'icmp-type'
317
	    elseif contains({58, 'ipv6-icmp', 'icmpv6'}, sdef.proto) then
318 319
	       family = 'inet6'
	       oname = 'icmpv6-type'
320
	    elseif sdef.type or sdef['reply-type'] then
321
	       self:error('Type specification not valid with '..sdef.proto)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
322 323
	    end

324 325 326 327 328 329 330 331 332
	    if sdef.family then
	       if not family then family = sdef.family
	       elseif family ~= sdef.family then
		  self:error(
		     'Protocol '..sdef.proto..' is incompatible with '..sdef.family
		  )
	       end
	    end

333 334
	    if sdef.type then
	       opts = opts..' --'..oname..' '..(
335
		  self.reverse and sdef['reply-type'] or sdef.type
336 337
	       )
	    end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
338 339 340 341 342
	    table.insert(res, {family=family, opts=opts})
	 end
      end
   end

343
   local popt = ' --'..(self.reverse and 's' or 'd')..'port'
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365
   for family, pports in pairs(fports) do
      local ofrags = {}

      for proto, ports in pairs(pports) do
	 local propt = '-p '..proto

	 if ports[1] then
	    local len = #ports
	    repeat
	       local opts

	       if len == 1 then
		  opts = propt..popt..' '..ports[1]
		  len = 0

	       else
		  opts = propt..' -m multiport'..popt..'s '
		  local pc = 0
		  repeat
		     local sep = pc == 0 and '' or ','
		     local port = ports[1]
		     
366
		     pc = pc + (port:find(':') and 2 or 1)
367 368 369 370 371 372 373 374 375 376 377 378 379 380
		     if pc > 15 then break end
		     
		     opts = opts..sep..port
		     
		     table.remove(ports, 1)
		     len = len - 1
		  until len == 0
	       end

	       table.insert(ofrags, {opts=opts})
	    until len == 0

	 else table.insert(ofrags, {opts=propt}) end
      end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
381

382
      extend(res, combinations(ofrags, {{family=family}}))
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
383 384 385 386 387
   end

   return res
end

388 389
function M.Rule:destoptfrags()
   return self:create(M.Zone, {addr=self.dest}):optfrags(self:direction('out'))
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
390 391
end

392
function M.Rule:table() return 'filter' end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
393

394
function M.Rule:position() return 'append' end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
395

396
function M.Rule:target()
397 398 399 400 401 402 403 404 405 406
   -- alpine v2.7 compatibility
   if self.action == 'accept' then
      self:warning("'accept' action deprecated in favor of 'exclude'")
      self.action = 'exclude'
   end

   if self.action == 'exclude' then return 'ACCEPT' end
   if self.action and self.action ~= 'include' then
      self:error('Invalid action: '..self.action)
   end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
407 408 409
end


410
function M.Rule:trules()
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
411

412
   local function tag(ofrags, tag, value)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
413 414 415 416 417 418 419 420
      for i, ofrag in ipairs(ofrags) do
	 assert(not ofrag[tag])
	 ofrag[tag] = value
      end
   end

   local families

421
   local function setfamilies(ofrags)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
422 423 424 425 426 427 428 429 430 431 432 433
      if ofrags then
	 families = {}
	 for i, ofrag in ipairs(ofrags) do
	    if not ofrag.family then
	       families = nil
	       return
	    end
	    table.insert(families, ofrag.family)
	 end
      else families = nil end
   end

434
   local function ffilter(ofrags)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
435
      if not ofrags or not ofrags[1] or not families then return ofrags end
436 437 438 439 440 441
      return filter(
	 ofrags,
	 function(of)
	    return not of.family or contains(families, of.family)
	 end
      )
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
442 443 444 445
   end

   local res = self:zoneoptfrags()

446
   if self.ipset then
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
447
      local ipsetofrags = {}
448
      for i, ipset in listpairs(self.ipset) do
449
	 if not ipset.name then self:error('Set name not defined') end
450

Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
451
	 local setdef = self.root.ipset and self.root.ipset[ipset.name]
452
	 if not setdef then self:error('Invalid set name') end
453

Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
454
	 if not ipset.args then
455
	    self:error('Set direction arguments not defined')
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
456
	 end
457

Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
458
	 local setopts = '-m set --match-set '..ipset.name..' '
459 460
	 setopts = setopts..table.concat(util.map(util.list(ipset.args),
						  function(a)
461 462 463 464
						     if self:direction(a) == 'in' then
							return 'src'
						     end
						     return 'dst'
465 466
						  end),
					 ',')
467
	 table.insert(ipsetofrags, {family=setdef.family, opts=setopts})
468
      end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
469
      res = combinations(res, ipsetofrags)
470 471
   end

472
   if self.ipsec then
473 474
      res = combinations(res,
			 {{opts='-m policy --pol ipsec --dir '..self:direction(self.ipsec)}})
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
475 476 477 478 479 480
   end

   res = combinations(res, self:servoptfrags())

   setfamilies(res)

481 482 483 484
   local addrofrags = combinations(
      self:create(M.Zone, {addr=self.src}):optfrags(self:direction('in')),
      self:destoptfrags()
   )
485
   local combined = res
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
486 487 488 489 490 491

   if addrofrags then
      addrofrags = ffilter(addrofrags)
      setfamilies(addrofrags)
      res = ffilter(res)

492 493
      combined = {}
      for i, ofrag in ipairs(res) do
494 495 496
	 local aofs = combinations(addrofrags, {{family=ofrag.family}})
	 local cc = combinations({ofrag}, aofs)
	 if #cc < #aofs then
497 498 499
	    combined = nil
	    break
	 end
500
	 extend(combined, cc)
501
      end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
502 503 504
   end

   local target
505
   if combined then
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
506
      target = self:target()
507
      res = combined
508
   else target = self:uniqueid('address') end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
509 510 511

   tag(res, 'position', self:position())

512
   res = combinations(res, {{target=target}})
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
513

514
   if not combined then
515
      extend(
516 517 518
	 res,
	 combinations(addrofrags, {{chain=target, target=self:target()}})
      )
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
519 520
   end

521
   extend(res, self:extraoptfrags())
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
522

523 524 525 526 527 528 529
   local tbl = self:table()

   local function convertchains(ofrags)
      local res = {}

      for i, ofrag in ipairs(ofrags) do

530
	 if contains(builtin[tbl], ofrag.chain) then table.insert(res, ofrag)
531
	 else
532 533 534
	    local ofs, recursive
	    if ofrag.chain == 'PREROUTING' then
	       ofs = {{chain='FORWARD'}, {chain='INPUT'}}
535
	    elseif ofrag.chain == 'POSTROUTING' then
536 537 538 539 540 541 542 543
	       ofs = {{chain='FORWARD'}, {chain='OUTPUT'}}
	       recursive = true
	    elseif ofrag.chain == 'INPUT' then
	       ofs = {{opts='-m addrtype --dst-type LOCAL', chain='PREROUTING'}}
	    elseif ofrag.chain == 'FORWARD' then
	       ofs = {
		  {opts='-m addrtype ! --dst-type LOCAL', chain='PREROUTING'}
	       }
544 545
	    end

546
	    if ofs then
547
	       ofrag.chain = nil
548 549
	       ofs = combinations(ofs, {ofrag})
	       if recursive then ofs = convertchains(ofs) end
550
	       extend(res, ofs)
551

552 553 554 555 556 557 558
	    else table.insert(res, ofrag) end
	 end
      end

      return res
   end

559
   res = convertchains(ffilter(res))
560
   tag(res, 'table', tbl, false)
561 562

   local function checkzof(ofrag, dir, chains)
563
      if ofrag[dir] and contains(chains, ofrag.chain) then
564 565 566 567 568 569 570 571
	 self:error('Cannot specify '..dir..'bound interface ('..ofrag[dir]..')')
      end
   end

   for i, ofrag in ipairs(res) do
      checkzof(ofrag, 'in', {'OUTPUT', 'POSTROUTING'})
      checkzof(ofrag, 'out', {'INPUT', 'PREROUTING'})
   end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
572
   
573
   return combinations(res, ffilter({{family='inet'}, {family='inet6'}}))
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
574 575
end

576
function M.Rule:extraoptfrags() return {} end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
577 578


579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617
M.Limit = M.class(M.ConfigObject)

function M.Limit:init(...)
   M.Limit.super(self):init(...)

   if not self.count then
      if not self[1] then
	 self:error('Packet count not defined for limit')
      end
      self.count = self[1]
   end

   if not self.interval then self.interval = 1 end
end

function M.Limit:rate() return math.ceil(self.count / self.interval) end

function M.Limit:recentopts()
   local count = self.count
   local interval = self.interval

   if count > RECENT_MAX_COUNT then
      count = self:rate()
      interval = 1
   end

   if count <= RECENT_MAX_COUNT then
      return '--update --hitcount '..count..' --seconds '..interval
   end
end

function M.Limit:limitopts(name)
   local rate = self:rate()
   return '-m hashlimit --hashlimit-upto '..rate..
      '/second --hashlimit-burst '..rate..
      ' --hashlimit-mode srcip --hashlimit-name '..(name or self:uniqueid())
end


618 619 620
M.export = {zone={class=M.Zone}, ipset={class=IPSet, before='%modules'}}

return M