filter.lua 11.7 KB
Newer Older
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
1 2
--[[
Filter module for Alpine Wall
3
Copyright (C) 2012-2017 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
]]--


Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
8
local loadclass = require('awall').loadclass
9
local resolve = require('awall.host')
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
10

11
local model = require('awall.model')
12 13 14
local class = model.class
local Rule = model.Rule

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

17
local util = require('awall.util')
18
local contains = util.contains
19
local extend = util.extend
20
local listpairs = util.listpairs
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
21 22


23 24 25 26 27 28 29 30 31
local RECENT_MAX_COUNT = 20

local FilterLimit = class(model.Limit)

function FilterLimit:recentofrags(name)
   local count = self.count
   local interval = self.interval

   if count > RECENT_MAX_COUNT then
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
32
      count = self:intrate()
33 34 35 36 37 38 39 40 41 42 43
      interval = 1
   end

   if count > RECENT_MAX_COUNT then return end

   local uofs = {}
   local sofs = {}

   for _, family in ipairs{'inet', 'inet6'} do
      if type(self.mask[family].mode) ~= 'table' then return end
      local mask = ''
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
44
      local attr, len = table.unpack(self.mask[family].mode)
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67

      if family == 'inet' then
	 local octet
	 for i = 0, 3 do
	    if len <= i * 8 then octet = 0
	    elseif len > i * 8 + 7 then octet = 255
	    else octet = 256 - 2^(8 - len % 8) end
	    mask = util.join(mask, '.', octet)
	 end

      elseif family == 'inet6' then
	 while len > 0 do
	    if #mask % 5 == 4 then mask = mask..':' end
	    mask = mask..('%x'):format(16 - 2^math.max(0, 4 - len))
	    len = len - 4
	 end
	 while #mask % 5 < 4 do mask = mask..'0' end
	 if #mask < 39 then mask = mask..'::' end
      end

      local rec = {
	 {
	    family=family,
68
	    match='-m recent --name '..name..' --r'..
69 70 71 72 73 74 75 76
	       ({src='source', dest='dest'})[attr]..' --mask '..mask
	 }
      }

      extend(
	 uofs,
	 combinations(
	    rec,
77
	    {{match='--update --hitcount '..count..' --seconds '..interval}}
78 79
	 )
      )
80
      extend(sofs, combinations(rec, {{match='--set'}}))
81 82 83 84 85 86
   end

   return uofs, sofs
end


87 88
local TranslatingRule = class(Rule)

89 90 91 92 93
function TranslatingRule:init(...)
   TranslatingRule.super(self):init(...)
   if type(self.dnat) == 'string' then self.dnat = {addr=self.dnat} end
end

94 95 96 97 98 99
function TranslatingRule:destoptfrags()
   local ofrags = TranslatingRule.super(self):destoptfrags()
   if not self.dnat then return ofrags end

   ofrags = combinations(ofrags, {{family='inet6'}})
   local natof = self:create(
100
      model.Zone, {addr=self.dnat.addr}
101 102 103 104 105 106
   ):optfrags(self:direction('out'))
   assert(#natof == 1)
   table.insert(ofrags, natof[1])
   return ofrags
end

107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
function TranslatingRule:servoptfrags()
   local ofrags = TranslatingRule.super(self):servoptfrags()
   if not (self.dnat and self.dnat.port) then return ofrags end

   ofrags = combinations(ofrags, {{family='inet6'}})

   local protos = {}
   for _, serv in listpairs(self.service) do
      for _, sdef in listpairs(serv) do
	 if sdef.family ~= 'inet6' then
	    if not contains({'tcp', 'udp'}, sdef.proto) then
	       self:error('Cannot do port translation for '..sdef.proto)
	    end
	    protos[sdef.proto] = true
	 end
      end
   end
   for proto, _ in pairs(protos) do
      extend(
	 ofrags,
	 combinations(
	    self:create(
	       model.Rule, {service={proto=proto, port=self.dnat.port}}
	    ):servoptfrags(),
	    {{family='inet'}}
	 )
      )
   end

   return ofrags
end

139

Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
140 141 142 143
local LoggingRule = class(TranslatingRule)

function LoggingRule:init(...)
   LoggingRule.super(self):init(...)
144
   util.setdefault(self, 'action', 'accept')
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
145 146

   local custom = self:customtarget()
147
   if type(self.log) ~= 'table' then
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
148
      self.log = loadclass('log').get(
149
	 self, self.log, not custom and self:logdefault()
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
150 151 152 153
      )
   end
   if custom and self.log then
      self:error('Logging not allowed with custom action: '..self.action)
154
   end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
155 156
end

157 158
function LoggingRule:logdefault() return false end

159
function LoggingRule:target() return 'ACCEPT' end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
160

161 162 163 164 165
function LoggingRule:actofrags(log, target)
   local res = log and log:optfrags() or {}
   if target ~= nil then table.insert(res, {target=target}) end
   return res
end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
166

167 168 169 170
function LoggingRule:combinelog(ofrags, log, action, target)
   local actions = self:actofrags(log, target)
   return actions[1] and
      self:combine(ofrags, actions, 'log'..action, log) or ofrags
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
171 172
end

173
function LoggingRule:mangleoptfrags(ofrags)
174
   return self:combinelog(ofrags, self.log, self.action, self:target())
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
175 176 177
end


178
local RelatedRule = class(TranslatingRule)
179 180 181 182 183 184 185 186

function RelatedRule:servoptfrags()
   local helpers = {}
   for i, serv in listpairs(self.service) do
      for i, sdef in listpairs(serv) do
	 local helper = sdef['ct-helper']
	 if helper then
	    helpers[helper] = {
187
	       family=sdef.family,
188 189
	       match='-m conntrack --ctstate RELATED -m helper --helper '..
	          helper
190 191 192 193 194 195 196
	    }
	 end
      end
   end
   return util.values(helpers)
end

197 198
function RelatedRule:target() return 'ACCEPT' end

199

Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
200
local Filter = class(LoggingRule)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
201

Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
202
function Filter:init(...)
203
   Filter.super(self):init(...)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
204 205

   -- alpine v2.4 compatibility
206
   if contains({'logdrop', 'logreject'}, self.action) then
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
207
      self:warning('Deprecated action: '..self.action)
208
      self.action = self.action:sub(4, -1)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
209 210 211
   end

   local limit = self:limit()
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
212
   if limit then
213 214 215
      if limit == 'conn-limit' and self['no-track'] then
	 self:error('Tracking required with connection limit')
      end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
216 217 218
      if type(self[limit]) ~= 'table' then
	 self[limit] = {count=self[limit]}
      end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
219
      self[limit].log = loadclass('log').get(self, self[limit].log, true)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
220
   end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
221 222
end

223
function Filter:extratrules()
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
224 225
   local res = {}

226 227
   local function extrarules(label, cls, options)
      options = options or {}
228 229
      options.attrs = 'dnat'
      extend(res, self:extrarules(label, cls, options))
230 231
   end

Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
232
   if self.dnat then
233 234 235
      if self.action ~= 'accept' then
	 self:error('dnat option not allowed with '..self.action..' action')
      end
236 237 238
      if self['no-track'] then
	 self:error('dnat option not allowed with no-track')
      end
239 240
      if self.ipset then
	 self:error('dnat and ipset options cannot be used simultaneously')
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
241 242
      end

243 244 245 246
      if self.dnat.addr:find('/') then
	 self:error('DNAT target cannot be a network address')
      end

Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
247
      local dnataddr
248
      for i, addr in ipairs(resolve(self.dnat.addr, self)) do
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
249 250
	 if addr[1] == 'inet' then
	    if dnataddr then
251 252 253
	       self:error(
		  self.dnat.addr..' resolves to multiple IPv4 addresses'
	       )
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
254 255 256 257 258
	    end
	    dnataddr = addr[2]
	 end
      end
      if not dnataddr then
259
	 self:error(self.dnat.addr..' does not resolve to any IPv4 address')
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
260 261
      end

262 263 264 265 266 267 268 269
      extrarules(
	 'dnat',
	 'dnat',
	 {
	    update={['to-addr']=dnataddr, ['to-port']=self.dnat.port},
	    discard='out'
	 }
      )
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
270 271
   end

272
   if self.action == 'tarpit' or self['no-track'] then
273
      extrarules('no-track', 'no-track')
274
   end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
275

276
   if self.action == 'accept' then
277
      if self:position() == 'prepend' then
278
	 extrarules('final', LoggingRule, {update={log=self.log}})
279 280
      end

281 282 283 284
      local nr = #res

      if self.related then
	 for i, rule in listpairs(self.related) do
285
	    extrarules(
286 287 288
	       'related',
	       RelatedRule,
	       {index=i, src=rule, update={service=self.service}}
289
	    )
290 291 292 293
	 end
      else
	 -- TODO avoid creating unnecessary RELATED rules by introducing
	 -- helper direction attributes to service definitions
294
	 extrarules('related', RelatedRule)
295
	 extrarules('related-reply', RelatedRule, {update={reverse=true}})
296 297 298 299 300 301
      end

      if self['no-track'] then
	 if #res > nr then
	    self:error('Tracking required by service')
	 end
302 303
	 extrarules('no-track-reply', 'no-track', {update={reverse=true}})
	 extrarules('reply', 'filter', {update={reverse=true}})
304
      end
305 306
   end

Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
307 308 309
   return res
end

Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
310 311 312 313 314
function Filter:limit()
   local res
   for i, limit in ipairs({'conn-limit', 'flow-limit'}) do
      if self[limit] then
	 if res then
315
	    self:error('Cannot specify multiple limits for a single filter rule')
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
316 317 318 319 320 321 322 323
	 end
	 res = limit
      end
   end
   return res
end

function Filter:position()
324 325
   return not self['no-track'] and self:limit() == 'flow-limit'
      and 'prepend' or 'append'
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
326 327
end

328 329 330 331
function Filter:logdefault()
   return contains({'drop', 'reject', 'tarpit'}, self.action)
end

332
function Filter:target()
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
333
   if self.action == 'pass' then return end
334 335
   if self.action ~= 'accept' and not self:logdefault() then
      self:error('Invalid filter action: '..self.action)
336
   end
337
   return self.action == 'tarpit' and 'tarpit' or self.action:upper()
338 339
end

340
function Filter:mangleoptfrags(ofrags)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
341
   local limit = self:limit()
342
   if not limit then return Filter.super(self):mangleoptfrags(ofrags) end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
343

344 345 346
   if self.action ~= 'accept' then
      self:error('Cannot specify limit for '..self.action..' filter')
   end
347

348 349 350
   local limitchain = self:uniqueid('limit')
   local limitlog = self[limit].log
   local limitobj = self:create(FilterLimit, self[limit], 'limit')
351

352
   local ofs
353
   local accept = self:position() == 'append'
354

355
   local uofs, sofs = limitobj:recentofrags(limitchain)
356

357
   if uofs then
358 359 360
      ofs = self:combinelog(uofs, limitlog, 'drop', 'DROP')
      if accept then extend(ofs, self:actofrags(self.log)) end
      extend(ofs, combinations(sofs, {{target=accept and 'ACCEPT'}}))
361

362
   else
363 364 365
      local limofs = limitobj:limitofrags(limitchain)
      ofs = accept and Filter.super(self):mangleoptfrags(limofs) or
	 combinations(limofs, {{target='RETURN'}})
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
366

367
      extend(ofs, self:actofrags(limitlog, 'DROP'))
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
368
   end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
369

370
   return self:combine(ofrags, ofs, 'limit', true)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
371 372 373
end


374
local Policy = class(Filter)
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
375 376 377 378

function Policy:servoptfrags() return nil end


379 380
local fchains = {{chain='FORWARD'}, {chain='INPUT'}, {chain='OUTPUT'}}

381
local function stateful(config)
382 383
   local res = {}

384 385 386 387
   for i, family in ipairs{'inet', 'inet6'} do

      local er = combinations(
	 fchains,
388
	 {{match='-m conntrack --ctstate ESTABLISHED'}}
389
      )
390 391
      for i, chain in ipairs({'INPUT', 'OUTPUT'}) do
	 table.insert(
392
	    er, {chain=chain, match='-'..chain:sub(1, 1):lower()..' lo'}
393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
	 )
      end
      extend(
	 res,
	 combinations(er, {{family=family, table='filter', target='ACCEPT'}})
      )

      -- TODO avoid creating unnecessary CT rules by inspecting the
      -- filter rules' target families and chains
      local visited = {}
      local ofrags = {}
      for i, rule in listpairs(config.filter) do
	 for i, serv in listpairs(rule.service) do
	    if not visited[serv] then
	       for i, sdef in listpairs(serv) do
		  if sdef['ct-helper'] then
		     local of = combinations(
410
			Rule.morph{service={sdef}}:servoptfrags(),
411 412 413 414 415 416 417 418
			{{family=family}}
		     )
		     if of[1] then
			assert(#of == 1)
			of[1].target = 'CT --helper '..sdef['ct-helper']
			table.insert(ofrags, of[1])
		     end
		  end
419
	       end
420
	       visited[serv] = true
421 422 423
	    end
	 end
      end
424 425 426 427 428 429 430
      extend(
	 res,
	 combinations(
	    {{table='raw'}},
	    {{chain='PREROUTING'}, {chain='OUTPUT'}},
	    ofrags
	 )
431
      )
432
   end
433 434

   return res
435
end
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
436

437 438
local icmp = {{family='inet', table='filter', match='-p icmp'}}
local icmp6 = {{family='inet6', table='filter', match='-p icmpv6'}}
439 440 441 442 443 444 445
local ir = combinations(
   icmp6,
   {{chain='INPUT'}, {chain='OUTPUT'}},
   {{target='ACCEPT'}}
)
extend(ir, combinations(icmp6, {{chain='FORWARD', target='icmp-routing'}}))
extend(ir, combinations(icmp, fchains, {{target='icmp-routing'}}))
446 447

local function icmprules(ofrag, oname, types)
448 449
   extend(
      ir,
450 451 452 453 454
      combinations(
         ofrag,
	 {{chain='icmp-routing', target='ACCEPT'}},
	 util.map(types, function(t) return {match='--'..oname..' '..t} end)
      )
455
   )
456 457 458
end
icmprules(icmp, 'icmp-type', {3, 11, 12})
icmprules(icmp6, 'icmpv6-type', {1, 2, 3, 4})
Kaarle Ritvanen's avatar
Kaarle Ritvanen committed
459

460 461 462 463 464 465 466 467
return {
   export={
      filter={class=Filter, before={'dnat', 'no-track'}},
      policy={class=Policy, after='%filter-after'},
      ['%filter-before']={rules=stateful, before='filter'},
      ['%filter-after']={rules=ir, after='filter'}
   },
   achains=combinations(
468
      {{chain='tarpit'}}, {{match='-p tcp', target='TARPIT'}, {target='DROP'}}
469
   )
470
}