model.lua 12.9 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 32 33 34
local startswith = require('stringy').startswith


M.ConfigObject = M.class()

function M.ConfigObject:init(context, location)
35 36
   if context then
      self.context = context
37
      self.root = context.objects
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
38
   end
39
   self.location = location
40
   self.uniqueids = {}
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
41 42
end

43
function M.ConfigObject:create(cls, params)
44 45
   if type(cls) == 'string' then
      local name = cls
46
      cls = loadclass(cls)
47 48 49 50
      if not cls then
	 self:error('Support for '..name..' objects not installed')
      end
   end
51 52 53 54 55

   if self.label then
      params.label = self.label..(params.label and '-'..params.label or '')
   end

56 57 58
   return cls.morph(params, self.context, self.location)
end

59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
function M.ConfigObject:uniqueid(key)
   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

   local res = key
   if self.label then res = res..'-'..self.label end
   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

75
function M.ConfigObject:error(msg) raise(self.location..': '..msg) end
76

77
function M.ConfigObject:warning(msg)
78 79 80
   io.stderr:write(self.location..': '..msg..'\n')
end

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

83
function M.ConfigObject:info()
84 85
   local res = {}
   for i, trule in ipairs(self:trules()) do
86
      table.insert(res, {'  '..optfrag.location(trule), optfrag.command(trule)})
87 88 89 90
   end
   return res
end

Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
91

92
M.Zone = M.class(M.ConfigObject)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
93

94
function M.Zone:optfrags(dir)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
95 96 97 98 99 100 101
   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
102 103 104
   local aopts = nil
   if self.addr then
      aopts = {}
105 106
      for i, hostdef in listpairs(self.addr) do
	 for i, addr in ipairs(resolve(hostdef, self)) do
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
107 108 109 110 111
	    table.insert(aopts,
			 {family=addr[1],
			  [aprop]=addr[2],
			  opts='-'..aopt..' '..addr[2]})
	 end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
112 113 114
      end
   end

115 116 117 118 119 120 121
   return combinations(
      maplist(
	 self.iface,
	 function(x) return {[iprop]=x, opts='-'..iopt..' '..x} end
      ),
      aopts
   )
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
122 123 124
end


125
M.fwzone = M.Zone()
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
126 127


128
local IPSet = M.class(M.ConfigObject)
129 130

function IPSet:init(...)
131
   IPSet.super(self):init(...)
132 133 134

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

135
   if startswith(self.type, 'bitmap:') then
136 137 138 139
      if not self.range then self:error('Range not defined') end
      self.options = {self.type, 'range', self.range}
      self.family = 'inet'

140
   elseif startswith(self.type, 'hash:') then
141 142 143 144 145 146 147 148 149
      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


150
M.Rule = M.class(M.ConfigObject)
151

Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
152

153 154
function M.Rule:init(...)
   M.Rule.super(self):init(...)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
155 156

   for i, prop in ipairs({'in', 'out'}) do
157 158 159 160 161 162 163 164 165
      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
166
   end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
167

Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
168
   if self.service then
169 170 171 172
      if not self.label and type(self.service) == 'string' then
	 self.label = self.service
      end

173 174 175 176 177 178 179
      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
180 181 182 183
   end
end


184
function M.Rule:direction(dir)
185 186 187 188 189 190
   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


191
function M.Rule:zoneoptfrags()
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
192

193
   local function zonepair(zin, zout)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
194

195
      local function zofs(zone, dir)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
196
	 if not zone then return zone end
197
	 return zone:optfrags(dir)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
198 199 200 201
      end

      local chain, ofrags

202
      if zin == M.fwzone or zout == M.fwzone then
203
	 if zin == zout then return {} end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
204
	 local dir, z = 'in', zin
205
	 if zin == M.fwzone then dir, z = 'out', zout end
206
	 chain = dir:upper()..'PUT'
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
207 208
	 ofrags = zofs(z, dir)

209 210 211 212 213 214 215 216 217 218 219
      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
220 221
      else
	 chain = 'FORWARD'
222 223
	 ofrags = combinations(zofs(zin, 'in'), zofs(zout, 'out'))

224
	 if ofrags and not zout['route-back'] then
225 226 227 228 229 230
	    ofrags = filter(
	       ofrags,
	       function(of)
		  return not (of['in'] and of.out and of['in'] == of.out)
	       end
	    )
231
	 end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
232 233
      end

234 235 236
      return combinations(ofrags,
			  chain and {{chain=chain}} or {{chain='PREROUTING'},
							{chain='OUTPUT'}})
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
237 238 239
   end

   local res = {}
240 241
   local izones = self[self:direction('in')] or {}
   local ozones = self[self:direction('out')] or {}
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
242

243 244
   for i = 1,math.max(1, table.maxn(izones)) do
      for j = 1,math.max(1, table.maxn(ozones)) do
245
	 extend(res, zonepair(izones[i], ozones[j]))
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
246 247 248 249 250 251 252
      end
   end

   return res
end


253
function M.Rule:servoptfrags()
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
254 255 256

   if not self.service then return end

257
   local fports = {inet={}, inet6={}}
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
258 259 260
   local res = {}

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

264
	 if contains({6, 'tcp', 17, 'udp'}, sdef.proto) then
265 266 267 268 269 270 271 272
	    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
273
			extend(
274
			   ports[sdef.proto],
275
			   maplist(
276
			      sdef.port,
277
			      function(p) return tostring(p):gsub('-', ':') end
278 279 280 281 282
			   )
			)
		     else ports[sdef.proto] = {} end
		  end
	       end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
283 284 285 286 287 288 289
	    end

	 else

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

290 291
	    -- TODO multiple ICMP types per rule
	    local oname
292
	    if contains({1, 'icmp'}, sdef.proto) then
293 294
	       family = 'inet'
	       oname = 'icmp-type'
295
	    elseif contains({58, 'ipv6-icmp', 'icmpv6'}, sdef.proto) then
296 297
	       family = 'inet6'
	       oname = 'icmpv6-type'
298
	    elseif sdef.type or sdef['reply-type'] then
299
	       self:error('Type specification not valid with '..sdef.proto)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
300 301
	    end

302 303 304 305 306 307 308 309 310
	    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

311 312
	    if sdef.type then
	       opts = opts..' --'..oname..' '..(
313
		  self.reverse and sdef['reply-type'] or sdef.type
314 315
	       )
	    end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
316 317 318 319 320
	    table.insert(res, {family=family, opts=opts})
	 end
      end
   end

321
   local popt = ' --'..(self.reverse and 's' or 'd')..'port'
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
   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]
		     
344
		     pc = pc + (port:find(':') and 2 or 1)
345 346 347 348 349 350 351 352 353 354 355 356 357 358
		     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
359

360
      extend(res, combinations(ofrags, {{family=family}}))
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
361 362 363 364 365
   end

   return res
end

366 367
function M.Rule:destoptfrags()
   return self:create(M.Zone, {addr=self.dest}):optfrags(self:direction('out'))
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
368 369
end

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

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

374
function M.Rule:target()
375 376 377 378 379 380 381 382 383 384
   -- 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
385 386 387
end


388
function M.Rule:trules()
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
389

390
   local function tag(ofrags, tag, value)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
391 392 393 394 395 396 397 398
      for i, ofrag in ipairs(ofrags) do
	 assert(not ofrag[tag])
	 ofrag[tag] = value
      end
   end

   local families

399
   local function setfamilies(ofrags)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
400 401 402 403 404 405 406 407 408 409 410 411
      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

412
   local function ffilter(ofrags)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
413
      if not ofrags or not ofrags[1] or not families then return ofrags end
414 415 416 417 418 419
      return filter(
	 ofrags,
	 function(of)
	    return not of.family or contains(families, of.family)
	 end
      )
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
420 421 422 423
   end

   local res = self:zoneoptfrags()

424
   if self.ipset then
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
425
      local ipsetofrags = {}
426
      for i, ipset in listpairs(self.ipset) do
427
	 if not ipset.name then self:error('Set name not defined') end
428

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

Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
432
	 if not ipset.args then
433
	    self:error('Set direction arguments not defined')
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
434
	 end
435

Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
436
	 local setopts = '-m set --match-set '..ipset.name..' '
437 438
	 setopts = setopts..table.concat(util.map(util.list(ipset.args),
						  function(a)
439 440 441 442
						     if self:direction(a) == 'in' then
							return 'src'
						     end
						     return 'dst'
443 444
						  end),
					 ',')
445
	 table.insert(ipsetofrags, {family=setdef.family, opts=setopts})
446
      end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
447
      res = combinations(res, ipsetofrags)
448 449
   end

450
   if self.ipsec then
451 452
      res = combinations(res,
			 {{opts='-m policy --pol ipsec --dir '..self:direction(self.ipsec)}})
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
453 454 455 456 457 458
   end

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

   setfamilies(res)

459 460 461 462
   local addrofrags = combinations(
      self:create(M.Zone, {addr=self.src}):optfrags(self:direction('in')),
      self:destoptfrags()
   )
463
   local combined = res
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
464 465 466 467 468 469

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

470 471
      combined = {}
      for i, ofrag in ipairs(res) do
472 473 474
	 local aofs = combinations(addrofrags, {{family=ofrag.family}})
	 local cc = combinations({ofrag}, aofs)
	 if #cc < #aofs then
475 476 477
	    combined = nil
	    break
	 end
478
	 extend(combined, cc)
479
      end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
480 481 482
   end

   local target
483
   if combined then
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
484
      target = self:target()
485
      res = combined
486
   else target = self:uniqueid('address') end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
487 488 489

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

490
   res = combinations(res, {{target=target}})
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
491

492
   if not combined then
493
      extend(
494 495 496
	 res,
	 combinations(addrofrags, {{chain=target, target=self:target()}})
      )
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
497 498
   end

499
   extend(res, self:extraoptfrags())
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
500

501 502 503 504 505 506 507
   local tbl = self:table()

   local function convertchains(ofrags)
      local res = {}

      for i, ofrag in ipairs(ofrags) do

508
	 if contains(builtin[tbl], ofrag.chain) then table.insert(res, ofrag)
509
	 else
510 511 512
	    local ofs, recursive
	    if ofrag.chain == 'PREROUTING' then
	       ofs = {{chain='FORWARD'}, {chain='INPUT'}}
513
	    elseif ofrag.chain == 'POSTROUTING' then
514 515 516 517 518 519 520 521
	       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'}
	       }
522 523
	    end

524
	    if ofs then
525
	       ofrag.chain = nil
526 527
	       ofs = combinations(ofs, {ofrag})
	       if recursive then ofs = convertchains(ofs) end
528
	       extend(res, ofs)
529

530 531 532 533 534 535 536
	    else table.insert(res, ofrag) end
	 end
      end

      return res
   end

537
   res = convertchains(ffilter(res))
538
   tag(res, 'table', tbl, false)
539 540

   local function checkzof(ofrag, dir, chains)
541
      if ofrag[dir] and contains(chains, ofrag.chain) then
542 543 544 545 546 547 548 549
	 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
550
   
551
   return combinations(res, ffilter({{family='inet'}, {family='inet6'}}))
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
552 553
end

554
function M.Rule:extraoptfrags() return {} end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
555 556


557 558 559
M.export = {zone={class=M.Zone}, ipset={class=IPSet, before='%modules'}}

return M