Convert firewall_rule to a resource

diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml
index 2f7e6ded4d4b0542ab2e562b33211e169741203f..bdb397acf8f7df5de238b01ad83ab44b41d4f91c 100644 (file)
--- a/.rubocop_todo.yml
+++ b/.rubocop_todo.yml
@@ -6,13 +6,6 @@
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 

-# Offense count: 1
-# Configuration parameters: Include.
-# Include: **/definitions/*.rb
-ChefModernize/Definitions:
-  Exclude:
-    - 'cookbooks/networking/definitions/firewall_rule.rb'
-

 # Offense count: 1038
 # Cop supports --auto-correct.
 # Configuration parameters: .
 # Offense count: 1038
 # Cop supports --auto-correct.
 # Configuration parameters: .

diff --git a/cookbooks/networking/definitions/firewall_rule.rb b/cookbooks/networking/definitions/firewall_rule.rb
deleted file mode 100644 (file)
index 0196c41..0000000
--- a/cookbooks/networking/definitions/firewall_rule.rb
+++ /dev/null
@@ -1,45 +0,0 @@
-#
-# Cookbook:: networking
-# Definition:: firewall_rule
-#
-# Copyright:: 2011, OpenStreetMap Foundation
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     https://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
-define :firewall_rule, :action => :accept do
-  rule = Hash[
-    :action => params[:action].to_s.upcase,
-    :source => params[:source],
-    :dest => params[:dest],
-    :proto => params[:proto],
-    :dest_ports => params[:dest_ports] || "-",
-    :source_ports => params[:source_ports] || "-",
-    :rate_limit => params[:rate_limit] || "-",
-    :connection_limit => params[:connection_limit] || "-",
-    :helper => params[:helper] || "-"
-  ]
-
-  if params[:family].nil?
-    node.default[:networking][:firewall][:inet] << rule
-    node.default[:networking][:firewall][:inet6] << rule
-  elsif params[:family].to_s == "inet"
-    node.default[:networking][:firewall][:inet] << rule
-  elsif params[:family].to_s == "inet6"
-    node.default[:networking][:firewall][:inet6] << rule
-  else
-    log "Unsupported network family" do
-      level :error
-    end
-  end
-end

diff --git a/cookbooks/networking/recipes/default.rb b/cookbooks/networking/recipes/default.rb
index d85f2ebbda8bcd30291ac3a109869fee5881f65a..c195251e6803b7fdf3ff65492ada07020759ace8 100644 (file)
--- a/cookbooks/networking/recipes/default.rb
+++ b/cookbooks/networking/recipes/default.rb
@@ -343,6 +343,7 @@ template "/etc/shorewall/policy" do
 end
 
 template "/etc/shorewall/rules" do
 end
 
 template "/etc/shorewall/rules" do

+  action :nothing

   source "shorewall-rules.erb"
   owner "root"
   group "root"
   source "shorewall-rules.erb"
   owner "root"
   group "root"


@@ -351,6 +352,11 @@ template "/etc/shorewall/rules" do
   notifies :restart, "service[shorewall]"
 end
 
   notifies :restart, "service[shorewall]"
 end
 

+notify_group "shorewall-rules" do
+  action :run
+  notifies :create, "template[/etc/shorewall/rules]"
+end
+

 service "shorewall" do
   action [:enable, :start]
   supports :restart => true
 service "shorewall" do
   action [:enable, :start]
   supports :restart => true


@@ -464,6 +470,7 @@ unless node.interfaces(:family => :inet6).empty?
   end
 
   template "/etc/shorewall6/rules" do
   end
 
   template "/etc/shorewall6/rules" do

+    action :nothing

     source "shorewall-rules.erb"
     owner "root"
     group "root"
     source "shorewall-rules.erb"
     owner "root"
     group "root"


@@ -472,6 +479,11 @@ unless node.interfaces(:family => :inet6).empty?
     notifies :restart, "service[shorewall6]"
   end
 
     notifies :restart, "service[shorewall6]"
   end
 

+  notify_group "shorewall6-rules" do
+    action :run
+    notifies :create, "template[/etc/shorewall6/rules]"
+  end
+

   service "shorewall6" do
     action [:enable, :start]
     supports :restart => true
   service "shorewall6" do
     action [:enable, :start]
     supports :restart => true

diff --git a/cookbooks/networking/resources/firewall_rule.rb b/cookbooks/networking/resources/firewall_rule.rb
new file mode 100644 (file)
index 0000000..348272a
--- /dev/null
+++ b/cookbooks/networking/resources/firewall_rule.rb
@@ -0,0 +1,75 @@
+#
+# Cookbook:: networking
+# Resource:: firewall_rule
+#
+# Copyright:: 2020, OpenStreetMap Foundation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+resource_name :firewall_rule
+provides :firewall_rule
+
+default_action :nothing
+
+property :rule, :kind_of => String, :name_property => true
+property :family, :kind_of => [String, Symbol]
+property :source, :kind_of => String, :required => true
+property :dest, :kind_of => String, :required => true
+property :proto, :kind_of => String, :required => true
+property :dest_ports, :kind_of => [String, Integer], :default => "-"
+property :source_ports, :kind_of => [String, Integer], :default => "-"
+property :rate_limit, :kind_of => String, :default => "-"
+property :connection_limit, :kind_of => String, :default => "-"
+property :helper, :kind_of => String, :default => "-"
+
+action :accept do
+  add_rule :accept
+end
+
+action :drop do
+  add_rule :drop
+end
+
+action :reject do
+  add_rule :reject
+end
+
+action_class do
+  def add_rule(action)
+    rule = {
+      :action => action.to_s.upcase,
+      :source => new_resource.source,
+      :dest => new_resource.dest,
+      :proto => new_resource.proto,
+      :dest_ports => new_resource.dest_ports.to_s,
+      :source_ports => new_resource.source_ports.to_s,
+      :rate_limit => new_resource.rate_limit,
+      :connection_limit => new_resource.connection_limit,
+      :helper => new_resource.helper
+    }
+
+    if new_resource.family.nil?
+      node.default[:networking][:firewall][:inet] << rule
+      node.default[:networking][:firewall][:inet6] << rule
+    elsif new_resource.family.to_s == "inet"
+      node.default[:networking][:firewall][:inet] << rule
+    elsif new_resource.family.to_s == "inet6"
+      node.default[:networking][:firewall][:inet6] << rule
+    else
+      log "Unsupported network family" do
+        level :error
+      end
+    end
+  end
+end