model.lua 9.75 KB
Newer Older
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
1 2 3 4 5 6 7 8 9 10 11 12
--[[
Base data model for Alpine Wall
Copyright (C) 2012 Kaarle Ritvanen
Licensed under the terms of GPL2
]]--


module(..., package.seeall)

require 'awall'
require 'awall.host'
require 'awall.util'
13
require 'awall.object'
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
14 15 16 17 18
require 'awall.optfrag'

local util = awall.util
local combinations = awall.optfrag.combinations

19
class = awall.object.class
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
20 21


22
ConfigObject = class(awall.object.Object)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
23

24
function ConfigObject:init(context, location)
25 26
   if context then
      self.context = context
27
      self.root = context.objects
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
28
   end
29
   self.location = location
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
30 31
end

32 33 34 35 36 37
function ConfigObject:create(cls, params)
   return cls.morph(params, self.context, self.location)
end

function ConfigObject:error(msg) error(self.location..': '..msg) end

38
function ConfigObject:trules() return {} end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
39

40 41 42 43 44 45 46 47 48 49
function ConfigObject:info()
   local res = {}
   for i, trule in ipairs(self:trules()) do
      table.insert(res,
		   {'  '..trule.family..'/'..trule.table..'/'..trule.chain,
		    trule.opts})
   end
   return res
end

Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
50

51
Zone = class(ConfigObject)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
52 53 54 55 56 57 58 59 60

function Zone:optfrags(dir)
   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
61 62 63 64
   local aopts = nil
   if self.addr then
      aopts = {}
      for i, hostdef in util.listpairs(self.addr) do
65
	 for i, addr in ipairs(awall.host.resolve(hostdef, self)) do
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
66 67 68 69 70
	    table.insert(aopts,
			 {family=addr[1],
			  [aprop]=addr[2],
			  opts='-'..aopt..' '..addr[2]})
	 end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
      end
   end

   return combinations(util.maplist(self.iface,
				    function(x)
				       return {[iprop]=x,
					       opts='-'..iopt..' '..x}
				    end),
		       aopts)
end


fwzone = Zone.new()


86 87
Rule = class(ConfigObject)

Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
88

89 90
function Rule:init(...)
   ConfigObject.init(self, unpack(arg))
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
91

92 93
   self.newchains = {}

Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
94 95 96
   for i, prop in ipairs({'in', 'out'}) do
      self[prop] = self[prop] and util.maplist(self[prop],
					       function(z)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
97
						  if type(z) ~= 'string' then return z end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
98
						  return z == '_fw' and fwzone or
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
99
						     self.root.zone[z] or
100
						     self:error('Invalid zone: '..z)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
101 102
					       end) or self:defaultzones()
   end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
103

Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
104
   if self.service then
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
105
      if type(self.service) == 'string' then self.label = self.service end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
106 107
      self.service = util.maplist(self.service,
				  function(s)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
108
				     if type(s) ~= 'string' then return s end
109
				     return self.root.service[s] or self:error('Invalid service: '..s)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
110 111 112 113 114 115 116 117 118
				  end)
   end
end

function Rule:defaultzones() return {nil, fwzone} end


function Rule:zoneoptfrags()

119
   local function zonepair(zin, zout)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
120

121
      local function zofs(zone, dir)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
122
	 if not zone then return zone end
123
	 return zone:optfrags(dir)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
124 125 126 127 128
      end

      local chain, ofrags

      if zin == fwzone or zout == fwzone then
129
	 if zin == zout then return {} end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
130 131 132 133 134 135 136
	 local dir, z = 'in', zin
	 if zin == fwzone then dir, z = 'out', zout end
	 chain = string.upper(dir)..'PUT'
	 ofrags = zofs(z, dir)

      else
	 chain = 'FORWARD'
137 138 139 140 141 142 143 144 145
	 ofrags = combinations(zofs(zin, 'in'), zofs(zout, 'out'))

	 if ofrags then
	    ofrags = util.filter(ofrags,
				 function(of)
				    return not (of['in'] and of.out and
						of['in'] == of.out)
				 end)
	 end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
146 147 148 149 150 151 152 153 154 155 156 157
      end

      if not ofrags then ofrags = {{}} end

      for i, ofrag in ipairs(ofrags) do ofrag.fchain = chain end

      return ofrags
   end

   local res = {}

   for i = 1,math.max(1, table.maxn(self['in'])) do
158 159
      for j = 1,math.max(1, table.maxn(self.out)) do
	 util.extend(res, zonepair(self['in'][i], self.out[j]))
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
160 161 162 163 164 165 166 167 168 169 170
      end
   end

   return res
end


function Rule:servoptfrags()

   if not self.service then return end

171
   local function containskey(tbl, key)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
172 173 174 175 176 177 178 179 180
      for k, v in pairs(tbl) do if k == key then return true end end
      return false
   end

   local ports = {}
   local res = {}

   for i, serv in ipairs(self.service) do
      for i, sdef in util.listpairs(serv) do
181
	 if not sdef.proto then self:error('Protocol not defined') end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
182 183 184 185 186 187 188

	 if util.contains({6, 'tcp', 17, 'udp'}, sdef.proto) then
	    local new = not containskey(ports, sdef.proto)
	    if new then ports[sdef.proto] = {} end

	    if new or ports[sdef.proto][1] then
	       if sdef.port then
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
189
		  util.extend(ports[sdef.proto], sdef.port)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
190 191 192 193 194 195 196 197
	       else ports[sdef.proto] = {} end
	    end

	 else

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

198 199 200 201 202 203 204 205 206
	    -- TODO multiple ICMP types per rule
	    local oname
	    if util.contains({1, 'icmp'}, sdef.proto) then
	       family = 'inet'
	       oname = 'icmp-type'
	    elseif util.contains({58, 'ipv6-icmp', 'icmpv6'}, sdef.proto) then
	       family = 'inet6'
	       oname = 'icmpv6-type'
	    elseif sdef.type then
207
	       self:error('Type specification not valid with '..sdef.proto)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
208
	    end
209
	    if sdef.type then opts = opts..' --'..oname..' '..sdef.type end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235

	    table.insert(res, {family=family, opts=opts})
	 end
      end
   end

   for proto, plist in pairs(ports) do
      local opts = '-p '..proto
      local len = table.maxn(plist)

      if len == 1 then
	 opts = opts..' --dport '..plist[1]
      elseif len > 1 then
	 opts = opts..' -m multiport --dports '
	 for i, port in ipairs(plist) do
	    if i > 1 then opts = opts..',' end
	    opts = opts..port
	 end
      end

      table.insert(res, {opts=opts})
   end

   return res
end

Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
236
function Rule:destoptfrags()
237
   return self:create(Zone, {addr=self.dest}):optfrags('out')
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
238 239
end

Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
240 241 242 243 244 245 246
function Rule:table() return 'filter' end

function Rule:chain() return nil end

function Rule:position() return 'append' end

function Rule:target()
247
   if not self.action then self:error('Action not defined') end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
248 249 250 251 252 253
   return string.upper(self.action)
end


function Rule:trules()

254
   local function tag(ofrags, tag, value)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
255 256 257 258 259 260 261 262
      for i, ofrag in ipairs(ofrags) do
	 assert(not ofrag[tag])
	 ofrag[tag] = value
      end
   end

   local families

263
   local function setfamilies(ofrags)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
264 265 266 267 268 269 270 271 272 273 274 275
      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

276
   local function ffilter(ofrags)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
277
      if not ofrags or not ofrags[1] or not families then return ofrags end
278 279 280 281 282
      return util.filter(ofrags,
			 function(of)
			    return not of.family or util.contains(families,
								  of.family)
			 end)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
283 284
   end

285
   local function appendtarget(ofrag, target)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
286 287 288 289 290
      ofrag.opts = (ofrag.opts and ofrag.opts..' ' or '')..'-j '..target
   end

   local res = self:zoneoptfrags()

291
   if self.ipset then
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
292 293
      local ipsetofrags = {}
      for i, ipset in util.listpairs(self.ipset) do
294
	 if not ipset.name then self:error('Set name not defined') end
295

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

Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
299
	 if not ipset.args then
300
	    self:error('Set direction arguments not defined')
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
301
	 end
302

Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
303 304 305 306 307
	 local setopts = '-m set --match-set '..ipset.name..' '
	 for i, arg in util.listpairs(ipset.args) do
	    if i > 1 then setopts = setopts..',' end
	    if arg == 'in' then setopts = setopts..'src'
	    elseif arg == 'out' then setopts = setopts..'dst'
308
	    else self:error('Invalid set direction argument') end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
309
	 end
310
	 table.insert(ipsetofrags, {family=setdef.family, opts=setopts})
311
      end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
312
      res = combinations(res, ipsetofrags)
313 314
   end

315 316
   if self.ipsec then
      res = combinations(res, {{opts='-m policy --pol ipsec --dir '..self.ipsec}})
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
317 318 319 320 321 322 323
   end

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

   setfamilies(res)
   tag(res, 'chain', self:chain())

324
   local addrofrags = combinations(self:create(Zone, {addr=self.src}):optfrags('in'),
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
325
				   self:destoptfrags())
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340

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

   local addrchain = false
   for i, ofrag in ipairs(res) do
      if not ofrag.chain then ofrag.chain = ofrag.fchain end
      addrchain = addrchain or (self.src and ofrag.src) or (self.dest and ofrag.dest)
   end

   local target
   if addrchain then
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
341
      target = self:newchain('address')
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
342 343
   else
      target = self:target()
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
344
      res = combinations(res, addrofrags)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
345 346 347 348 349 350 351 352 353 354 355 356 357 358
   end

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

   for i, ofrag in ipairs(res) do appendtarget(ofrag, target) end

   if addrchain then
      for i, ofrag in ipairs(addrofrags) do
	 ofrag.chain = target
	 appendtarget(ofrag, self:target())
	 table.insert(res, ofrag)
      end      
   end

Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
359
   util.extend(res, ffilter(self:extraoptfrags()))
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
360 361

   tag(res, 'table', self:table(), false)
362 363 364 365 366 367 368 369 370 371 372

   local function checkzof(ofrag, dir, chains)
      if ofrag[dir] and util.contains(chains, ofrag.chain) then
	 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
373
   
374
   return combinations(res, ffilter({{family='inet'}, {family='inet6'}}))
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
375 376 377 378
end

function Rule:extraoptfrags() return {} end

379 380 381
function Rule:newchain(key)
   if self.newchains[key] then return self.newchains[key] end

Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
382 383 384
   if not self.context.lastid then self.context.lastid = {} end
   local lastid = self.context.lastid

385 386 387 388 389 390 391 392
   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.newchains[key] = res
   return res
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
393 394
end

Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
395

396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
ForwardOnlyRule = class(Rule)

function ForwardOnlyRule:init(...)
   Rule.init(self, unpack(arg))
   for i, dir in ipairs({'in', 'out'}) do
      if util.contains(self[dir], fwzone) then
	 self:error('Not applicable to the firewall zone')
      end
   end
end

function ForwardOnlyRule:defaultzones() return {nil} end

function ForwardOnlyRule:chain() return 'PREROUTING' end


412
classes = {{'zone', Zone}}
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
413
defrules = {}