cookbooks/networking/resources/firewall_rule.rb

   1 #
   2 # Cookbook:: networking
   3 # Resource:: firewall_rule
   4 #
   5 # Copyright:: 2020, OpenStreetMap Foundation
   6 #
   7 # Licensed under the Apache License, Version 2.0 (the "License");
   8 # you may not use this file except in compliance with the License.
   9 # You may obtain a copy of the License at
  10 #
  11 #     https://www.apache.org/licenses/LICENSE-2.0
  12 #
  13 # Unless required by applicable law or agreed to in writing, software
  14 # distributed under the License is distributed on an "AS IS" BASIS,
  15 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16 # See the License for the specific language governing permissions and
  17 # limitations under the License.
  18 #
  19
  20 resource_name :firewall_rule
  21 provides :firewall_rule
  22
  23 unified_mode true
  24
  25 default_action :nothing
  26
  27 property :rule, :kind_of => String, :name_property => true
  28 property :family, :kind_of => [String, Symbol]
  29 property :source, :kind_of => String, :required => true
  30 property :dest, :kind_of => String, :required => true
  31 property :proto, :kind_of => String, :required => true
  32 property :dest_ports, :kind_of => [String, Integer], :default => "-"
  33 property :source_ports, :kind_of => [String, Integer], :default => "-"
  34 property :rate_limit, :kind_of => String, :default => "-"
  35 property :connection_limit, :kind_of => [String, Integer], :default => "-"
  36 property :helper, :kind_of => String, :default => "-"
  37
  38 property :compile_time, TrueClass, :default => true
  39
  40 action :accept do
  41   add_rule :accept
  42 end
  43
  44 action :drop do
  45   add_rule :drop
  46 end
  47
  48 action :reject do
  49   add_rule :reject
  50 end
  51
  52 action_class do
  53   def add_rule(action)
  54     if node[:networking][:firewall][:engine] == "shorewall"
  55       add_shorewall_rule(action)
  56     elsif node[:networking][:firewall][:engine] == "nftables"
  57       if new_resource.family.nil?
  58         add_nftables_rule(action, "inet")
  59         add_nftables_rule(action, "inet6")
  60       elsif new_resource.family.to_s == "inet"
  61         add_nftables_rule(action, "inet")
  62       elsif new_resource.family.to_s == "inet6"
  63         add_nftables_rule(action, "inet6")
  64       end
  65     end
  66   end
  67
  68   def add_shorewall_rule(action)
  69     rule = {
  70       :action => action.to_s.upcase,
  71       :source => new_resource.source,
  72       :dest => new_resource.dest,
  73       :proto => new_resource.proto,
  74       :dest_ports => new_resource.dest_ports.to_s,
  75       :source_ports => new_resource.source_ports.to_s,
  76       :rate_limit => new_resource.rate_limit,
  77       :connection_limit => new_resource.connection_limit.to_s,
  78       :helper => new_resource.helper
  79     }
  80
  81     if new_resource.family.nil?
  82       node.default[:networking][:firewall][:inet] << rule
  83       node.default[:networking][:firewall][:inet6] << rule
  84     elsif new_resource.family.to_s == "inet"
  85       node.default[:networking][:firewall][:inet] << rule
  86     elsif new_resource.family.to_s == "inet6"
  87       node.default[:networking][:firewall][:inet6] << rule
  88     else
  89       log "Unsupported network family" do
  90         level :error
  91       end
  92     end
  93   end
  94
  95   def add_nftables_rule(action, family)
  96     rule = []
  97
  98     ip = case family
  99          when "inet" then "ip"
 100          when "inet6" then "ip6"
 101          end
 102
 103     proto = case new_resource.proto
 104             when "udp" then "udp"
 105             when "tcp", "tcp:syn" then "tcp"
 106             end
 107
 108     if new_resource.source_ports != "-"
 109       rule << "#{proto} sport { #{nftables_source_ports} }"
 110     end
 111
 112     if new_resource.dest_ports != "-"
 113       rule << "#{proto} dport { #{nftables_dest_ports} }"
 114     end
 115
 116     if new_resource.source == "osm"
 117       rule << "#{ip} saddr @#{ip}-osm-addresses"
 118     elsif new_resource.source =~ /^net:(.*)$/
 119       addresses = Regexp.last_match(1).split(",").join(", ")
 120
 121       rule << "#{ip} saddr { #{addresses} }"
 122     end
 123
 124     if new_resource.dest == "osm"
 125       rule << "#{ip} daddr @#{ip}-osm-addresses"
 126     elsif new_resource.dest =~ /^net:(.*)$/
 127       addresses = Regexp.last_match(1).split(",").join(", ")
 128
 129       rule << "#{ip} daddr { #{addresses} }"
 130     end
 131
 132     if new_resource.proto == "tcp:syn"
 133       rule << "ct state new"
 134     end
 135
 136     if new_resource.connection_limit != "-"
 137       rule << "ct count #{new_resource.connection_limit}"
 138     end
 139
 140     if new_resource.rate_limit =~ %r{^s:(\d+)/sec:(\d+)$}
 141       set = "#{new_resource.rule}-#{ip}"
 142       rate = Regexp.last_match(1)
 143       burst = Regexp.last_match(2)
 144
 145       node.default[:networking][:firewall][:sets] << set
 146
 147       rule << "add @#{set} { #{ip} saddr limit rate #{rate}/second burst #{burst} packets }"
 148     end
 149
 150     rule << case action
 151             when :accept then "accept"
 152             when :drop then "jump log-and-drop"
 153             when :reject then "jump log-and-reject"
 154             end
 155
 156     if new_resource.source == "fw"
 157       node.default[:networking][:firewall][:outgoing] << rule.join(" ")
 158     elsif new_resource.dest == "fw"
 159       node.default[:networking][:firewall][:incoming] << rule.join(" ")
 160     end
 161   end
 162
 163   def nftables_source_ports
 164     new_resource.source_ports.to_s.sub(/:$/, "-65535").gsub(":", "-")
 165   end
 166
 167   def nftables_dest_ports
 168     new_resource.dest_ports.to_s.sub(/:$/, "-65535").gsub(":", "-")
 169   end
 170 end