model.lua 13.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 35 36 37 38 39 40
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


41 42 43
M.ConfigObject = M.class()

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

   self.extraobjs = {}
51
   self.uniqueids = {}
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
52 53
end

54 55 56 57 58 59 60 61
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

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

70
   params.label = join(self.label, label)
71

72 73 74
   local obj = cls.morph(params, self.context, self.location)
   if key then self.extraobjs[key] = obj end
   return obj
75 76
end

77
function M.ConfigObject:uniqueid(key)
78
   if not key then key = '' end
79 80 81 82 83
   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

84
   local res = join(key, self.label)
85 86 87 88 89 90 91 92
   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

93
function M.ConfigObject:error(msg) raise(self.location..': '..msg) end
94

95
function M.ConfigObject:warning(msg)
96 97 98
   io.stderr:write(self.location..': '..msg..'\n')
end

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

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

Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
109

110
M.Zone = M.class(M.ConfigObject)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
111

112
function M.Zone:optfrags(dir)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
113 114 115 116 117 118 119
   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
120 121 122
   local aopts = nil
   if self.addr then
      aopts = {}
123 124
      for i, hostdef in listpairs(self.addr) do
	 for i, addr in ipairs(resolve(hostdef, self)) do
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
125 126 127 128 129
	    table.insert(aopts,
			 {family=addr[1],
			  [aprop]=addr[2],
			  opts='-'..aopt..' '..addr[2]})
	 end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
130 131 132
      end
   end

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


143
M.fwzone = M.Zone()
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
144 145


146
local IPSet = M.class(M.ConfigObject)
147 148

function IPSet:init(...)
149
   IPSet.super(self):init(...)
150 151 152

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

153
   if startswith(self.type, 'bitmap:') then
154 155 156 157
      if not self.range then self:error('Range not defined') end
      self.options = {self.type, 'range', self.range}
      self.family = 'inet'

158
   elseif startswith(self.type, 'hash:') then
159 160 161 162 163 164 165 166 167
      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


168
M.Rule = M.class(M.ConfigObject)
169

Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
170

171 172
function M.Rule:init(...)
   M.Rule.super(self):init(...)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
173 174

   for i, prop in ipairs({'in', 'out'}) do
175 176 177 178 179 180 181 182 183
      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
184
   end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
185

Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
186
   if self.service then
187 188 189 190
      if not self.label and type(self.service) == 'string' then
	 self.label = self.service
      end

191 192 193 194 195 196 197
      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
198 199 200 201
   end
end


202
function M.Rule:direction(dir)
203 204 205 206 207 208
   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


209
function M.Rule:zoneoptfrags()
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
210

211
   local function zonepair(zin, zout)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
212

213
      local function zofs(zone, dir)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
214
	 if not zone then return zone end
215
	 return zone:optfrags(dir)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
216 217 218 219
      end

      local chain, ofrags

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

227 228 229 230 231 232 233 234 235 236 237
      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
238 239
      else
	 chain = 'FORWARD'
240 241
	 ofrags = combinations(zofs(zin, 'in'), zofs(zout, 'out'))

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

252 253 254
      return combinations(ofrags,
			  chain and {{chain=chain}} or {{chain='PREROUTING'},
							{chain='OUTPUT'}})
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
255 256 257
   end

   local res = {}
258 259
   local izones = self[self:direction('in')] or {}
   local ozones = self[self:direction('out')] or {}
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
260

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

   return res
end


271
function M.Rule:servoptfrags()
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
272 273 274

   if not self.service then return end

275
   local fports = {inet={}, inet6={}}
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
276 277 278
   local res = {}

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

282
	 if contains({6, 'tcp', 17, 'udp'}, sdef.proto) then
283 284 285 286 287 288 289 290
	    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
291
			extend(
292
			   ports[sdef.proto],
293
			   maplist(
294
			      sdef.port,
295
			      function(p) return tostring(p):gsub('-', ':') end
296 297 298 299 300
			   )
			)
		     else ports[sdef.proto] = {} end
		  end
	       end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
301 302 303 304 305 306 307
	    end

	 else

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

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

320 321 322 323 324 325 326 327 328
	    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

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

339
   local popt = ' --'..(self.reverse and 's' or 'd')..'port'
340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361
   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]
		     
362
		     pc = pc + (port:find(':') and 2 or 1)
363 364 365 366 367 368 369 370 371 372 373 374 375 376
		     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
377

378
      extend(res, combinations(ofrags, {{family=family}}))
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
379 380 381 382 383
   end

   return res
end

384 385
function M.Rule:destoptfrags()
   return self:create(M.Zone, {addr=self.dest}):optfrags(self:direction('out'))
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
386 387
end

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

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

392
function M.Rule:target()
393 394 395 396 397 398 399 400 401 402
   -- 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
403 404 405
end


406
function M.Rule:trules()
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
407

408
   local function tag(ofrags, tag, value)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
409 410 411 412 413 414 415 416
      for i, ofrag in ipairs(ofrags) do
	 assert(not ofrag[tag])
	 ofrag[tag] = value
      end
   end

   local families

417
   local function setfamilies(ofrags)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
418 419 420 421 422 423 424 425 426 427 428 429
      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

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

   local res = self:zoneoptfrags()

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

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

Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
450
	 if not ipset.args then
451
	    self:error('Set direction arguments not defined')
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
452
	 end
453

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

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

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

   setfamilies(res)

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

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

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

   local target
501
   if combined then
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
502
      target = self:target()
503
      res = combined
504
   else target = self:uniqueid('address') end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
505 506 507

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

508
   res = combinations(res, {{target=target}})
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
509

510
   if not combined then
511
      extend(
512 513 514
	 res,
	 combinations(addrofrags, {{chain=target, target=self:target()}})
      )
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
515 516
   end

517
   extend(res, self:extraoptfrags())
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
518

519 520 521 522 523 524 525
   local tbl = self:table()

   local function convertchains(ofrags)
      local res = {}

      for i, ofrag in ipairs(ofrags) do

526
	 if contains(builtin[tbl], ofrag.chain) then table.insert(res, ofrag)
527
	 else
528 529 530
	    local ofs, recursive
	    if ofrag.chain == 'PREROUTING' then
	       ofs = {{chain='FORWARD'}, {chain='INPUT'}}
531
	    elseif ofrag.chain == 'POSTROUTING' then
532 533 534 535 536 537 538 539
	       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'}
	       }
540 541
	    end

542
	    if ofs then
543
	       ofrag.chain = nil
544 545
	       ofs = combinations(ofs, {ofrag})
	       if recursive then ofs = convertchains(ofs) end
546
	       extend(res, ofs)
547

548 549 550 551 552 553 554
	    else table.insert(res, ofrag) end
	 end
      end

      return res
   end

555
   res = convertchains(ffilter(res))
556
   tag(res, 'table', tbl, false)
557 558

   local function checkzof(ofrag, dir, chains)
559
      if ofrag[dir] and contains(chains, ofrag.chain) then
560 561 562 563 564 565 566 567
	 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
568
   
569
   return combinations(res, ffilter({{family='inet'}, {family='inet6'}}))
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
570 571
end

572
function M.Rule:extraoptfrags() return {} end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
573 574


575 576 577
M.export = {zone={class=M.Zone}, ipset={class=IPSet, before='%modules'}}

return M