itamae-plugin-resource-iptables 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f317f0705017d3ee086290e31d0d3783da45a1c2
+  data.tar.gz: 5a47520726d648ef2c2b068c80be2aeff9b8ea07
+SHA512:
+  metadata.gz: 4e3a0bb59121a2d19b1c5211c7687cf3f80ecc8ab50b1af8531e92d95cfde391c998139956b6dbf0fa010e7b564cf8cc5a65cf998fe70fb206fcf1c2a5bc37aa
+  data.tar.gz: 3deda76ba4a82ad8669c8ed20ac19ba71728f52eaad5b56de10d34903d43989de7d980a9e0d25f7748c0b1833d211e812e85bcb0f055b9b4bb0e83e4e0442139

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in itamae-plugin-resource-iptables.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Kohei Suzuki
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,32 @@
+# Itamae::Plugin::Resource::Iptables
+
+[itamae](https://github.com/ryotarai/itamae) resource plugin to manage iptables.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'itamae-plugin-resource-iptables'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install itamae-plugin-resource-iptables
+
+## Usage
+
+- [examples/firewall.rb](examples/firewall.rb)
+- [examples/rtmpsuck.rb](examples/rtmpsuck.rb)
+
+## Contributing
+
+1. Fork it ( https://github.com/eagletmt/itamae-plugin-resource-iptables/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/examples/firewall.rb

@@ -0,0 +1,71 @@
+require 'itamae/plugin/resource/iptables'
+
+iptables_flush 'flush' do
+end
+
+iptables_policy 'INPUT' do
+  action :drop
+end
+
+iptables_policy 'OUTPUT' do
+  action :accept
+end
+
+iptables_policy 'FORWARD' do
+  action :drop
+end
+
+iptables_rule 'accept loopback' do
+  action :accept
+  chain 'INPUT'
+  in_interface 'lo'
+end
+
+iptables_rule 'accept ping' do
+  action :accept
+  chain 'INPUT'
+  protocol 'icmp'
+end
+
+iptables_rule 'accept related,established' do
+  action :accept
+  chain 'INPUT'
+  state %w[RELATED ESTABLISHED]
+end
+
+iptables_rule 'accept from local' do
+  action :accept
+  chain 'INPUT'
+  source '192.168.10.0/24'
+end
+
+iptables_chain 'SSH_LOGGING' do
+end
+
+iptables_rule 'chain ssh' do
+  action :create
+  chain 'INPUT'
+  protocol 'tcp'
+  dport 22
+  state %w[NEW]
+  jump 'SSH_LOGGING'
+end
+
+iptables_rule 'log ssh' do
+  action :log
+  chain 'SSH_LOGGING'
+  log_prefix '[ssh] '
+  log_level 'info'
+end
+
+iptables_rule 'accept ssh' do
+  action :accept
+  chain 'SSH_LOGGING'
+end
+
+iptables_save '/etc/iptables/iptables.rules' do
+end
+
+service 'iptables.service' do
+  action [:enable, :start]
+end

data/examples/rtmpsuck.rb

@@ -0,0 +1,32 @@
+require 'itamae/plugin/resource/iptables'
+
+iptables_flush 'flush' do
+end
+
+iptables_policy 'INPUT' do
+  action :accept
+end
+
+iptables_policy 'OUTPUT' do
+  action :accept
+end
+
+iptables_policy 'FORWARD' do
+  action :accept
+end
+
+iptables_rule 'redirect to rtmpsuck' do
+  action :redirect
+  table 'nat'
+  chain 'OUTPUT'
+  protocol 'tcp'
+  dport 1935
+  not_uid_owner 'rtmpsuck'
+end
+
+iptables_save '/etc/iptables/iptables.rules' do
+end
+
+service 'iptables.service' do
+  action [:enable, :start]
+end

data/itamae-plugin-resource-iptables.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'itamae/plugin/resource/iptables/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "itamae-plugin-resource-iptables"
+  spec.version       = Itamae::Plugin::Resource::Iptables::VERSION
+  spec.authors       = ["Kohei Suzuki"]
+  spec.email         = ["eagletmt@gmail.com"]
+  spec.summary       = %q{itamae resource plugin to manage iptables.}
+  spec.description   = %q{itamae resource plugin to manage iptables.}
+  spec.homepage      = "https://github.com/eagletmt/itamae-plugin-resource-iptables"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_dependency "itamae"
+end

data/lib/itamae/plugin/resource/iptables.rb

@@ -0,0 +1,17 @@
+require 'itamae/plugin/resource/iptables/version'
+
+require 'itamae/plugin/resource/iptables_chain'
+require 'itamae/plugin/resource/iptables_flush'
+require 'itamae/plugin/resource/iptables_policy'
+require 'itamae/plugin/resource/iptables_rule'
+require 'itamae/plugin/resource/iptables_save'
+
+module Itamae
+  module Plugin
+    module Resource
+      module Iptables
+        # Your code goes here...
+      end
+    end
+  end
+end

data/lib/itamae/plugin/resource/iptables/basic_rule.rb

@@ -0,0 +1,38 @@
+module Itamae
+  module Plugin
+    module Resource
+      module Iptables
+        module BasicRule
+          RULES = {
+            protocol: { type: String },
+            source: { type: String },
+            destination: { type: String },
+            in_interface: { type: String },
+            out_interface: { type: String },
+          }
+
+          def self.prepended(base)
+            base.class_eval do
+              RULES.each do |key, opts|
+                define_attribute key, opts
+                define_attribute :"not_#{key}", opts
+              end
+            end
+          end
+
+          def build_rule(attrs)
+            rule = []
+            RULES.each_key.map(&:to_s).each do |key|
+              if attrs.has_key?(key)
+                rule << "--#{key.gsub('_', '-')}" << attrs[key]
+              elsif attrs.has_key?("not_#{key}")
+                rule << "--#{key.gsub('_', '-')}" << '!' << attrs[key]
+              end
+            end
+            super + rule
+          end
+        end
+      end
+    end
+  end
+end

data/lib/itamae/plugin/resource/iptables/log_rule.rb

@@ -0,0 +1,26 @@
+module Itamae
+  module Plugin
+    module Resource
+      module Iptables
+        module LogRule
+          def self.prepended(base)
+            base.class_eval do
+              define_attribute :log_level, type: String
+              define_attribute :log_prefix, type: String
+            end
+          end
+
+          def build_rule(attrs)
+            rule = []
+            %w[log_level log_prefix].each do |key|
+              if attrs.has_key?(key)
+                rule << "--#{key.gsub('_', '-')}" << attrs[key]
+              end
+            end
+            super + rule
+          end
+        end
+      end
+    end
+  end
+end

data/lib/itamae/plugin/resource/iptables/multiport_rule.rb

@@ -0,0 +1,79 @@
+module Itamae
+  module Plugin
+    module Resource
+      module Iptables
+        module MultiportRule
+          def self.prepended(base)
+            base.class_eval do
+              [:sport, :dport].each do |key|
+                define_attribute key, type: [Fixnum, Range, Array]
+                define_attribute :"not_#{key}", type: [Fixnum, Range, Array]
+              end
+            end
+          end
+
+          def build_rule(attrs)
+            rule = super
+            spec = PortSpecifier.new
+            %w[dport sport].each do |key|
+              if port = attrs[key]
+                spec.and(key, port)
+              elsif not_port = attrs["not_#{key}"]
+                spec.not(key, not_port)
+              end
+            end
+            super + spec.to_rule
+          end
+
+          class PortSpecifier
+            def initialize
+              @multiport = false
+              @rule = []
+            end
+
+            def and(key, port)
+              add_port_spec(key, port)
+              self
+            end
+
+            def not(key, port)
+              @rule << '!'
+              add_port_spec(key, port)
+              self
+            end
+
+            def to_rule
+              if @multiport
+                %w[--match multiport] + @rule
+              else
+                @rule
+              end
+            end
+
+            private
+
+            def add_port_spec(key, port)
+              case port
+              when Array
+                @multiport = true
+                @rule << "--#{key}s" << port.join(',')
+              when Range
+                @multiport = true
+                start = port.begin
+                finish = port.end
+                if port.exclude_end?
+                  finish -= 1
+                end
+                @rule << "--#{key}s" << "#{start}:#{finish}"
+              when Fixnum
+                @rule << "--#{key}" << port.to_s
+              else
+                raise "Wrong port specifier: #{port.inspect}"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/itamae/plugin/resource/iptables/owner_rule.rb

@@ -0,0 +1,34 @@
+module Itamae
+  module Plugin
+    module Resource
+      module Iptables
+        module OwnerRule
+          def self.prepended(base)
+            base.class_eval do
+              [:uid_owner, :gid_owner].each do |key|
+                define_attribute key, type: String
+                define_attribute :"not_#{key}", type: String
+              end
+            end
+          end
+
+          def build_rule(attrs)
+            rule = %w[uid_owner gid_owner].flat_map do |key|
+              if id = attrs[key]
+                ["--#{key.gsub('_', '-')}", id]
+              elsif not_id = attrs["not_#{key}"]
+                ['!', "--#{key.gsub('_', '-')}", not_id]
+              else
+                []
+              end
+            end
+            unless rule.empty?
+              rule.unshift('--match', 'owner')
+            end
+            super + rule
+          end
+        end
+      end
+    end
+  end
+end

data/lib/itamae/plugin/resource/iptables/state_rule.rb

@@ -0,0 +1,27 @@
+module Itamae
+  module Plugin
+    module Resource
+      module Iptables
+        module StateRule
+          def self.prepended(base)
+            base.class_eval do
+              define_attribute :state, type: Array
+            end
+          end
+
+          def build_rule(attrs)
+            rule =
+              if state = attrs['state']
+                ['--match', 'state', '--state', state.join(',')]
+              elsif not_state = attrs['not_state']
+                ['--match', 'state', '!', '--state', not_state.join(',')]
+              else
+                []
+              end
+            super + rule
+          end
+        end
+      end
+    end
+  end
+end

data/lib/itamae/plugin/resource/iptables/version.rb

@@ -0,0 +1,9 @@
+module Itamae
+  module Plugin
+    module Resource
+      module Iptables
+        VERSION = "0.0.1"
+      end
+    end
+  end
+end

data/lib/itamae/plugin/resource/iptables_chain.rb

@@ -0,0 +1,26 @@
+require 'itamae/resource/base'
+
+module Itamae
+  module Plugin
+    module Resource
+      class IptablesChain < Itamae::Resource::Base
+        define_attribute :action, default: :create
+        define_attribute :chain, type: String, default_name: true
+        define_attribute :table, type: String, default: 'filter'
+
+        def set_current_attributes
+          current.exist = run_command(['iptables', '--table', attributes.table, '--list-rules', attributes.chain], error: false).exit_status == 0
+          unless current.exist
+            Logger.info "Create chain #{attributes.chain}"
+          end
+        end
+
+        def action_create(options)
+          unless current.exist
+            run_command(['iptables', '--table', attributes.table, '--new-chain', attributes.chain])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/itamae/plugin/resource/iptables_flush.rb

@@ -0,0 +1,24 @@
+require 'itamae/resource/base'
+
+module Itamae
+  module Plugin
+    module Resource
+      class IptablesFlush < Itamae::Resource::Base
+        define_attribute :action, default: :run
+
+        def action_run(options)
+          get_tables.each do |table|
+            run_command(['iptables', '--table', table, '--flush'])
+            run_command(['iptables', '--table', table, '--delete-chain'])
+          end
+        end
+
+        private
+
+        def get_tables
+          run_command(['cat', '/proc/net/ip_tables_names']).stdout.each_line.map(&:chomp)
+        end
+      end
+    end
+  end
+end

data/lib/itamae/plugin/resource/iptables_policy.rb

@@ -0,0 +1,33 @@
+require 'itamae/resource/base'
+
+module Itamae
+  module Plugin
+    module Resource
+      class IptablesPolicy < Itamae::Resource::Base
+        define_attribute :action, required: true
+        define_attribute :chain, default_name: true
+        define_attribute :table, type: String, default: 'filter'
+
+        def set_current_attributes
+          super
+          current.action = get_policy(attributes.table, attributes.chain)
+        end
+
+        def action_drop(options)
+          run_command(['iptables', '--table', attributes.table, '--policy', attributes.chain, 'DROP'])
+        end
+
+        def action_accept(options)
+          run_command(['iptables', '--table', attributes.table, '--policy', attributes.chain, 'ACCEPT'])
+        end
+
+        private
+
+        def get_policy(table, chain)
+          line = run_command(['iptables', '--table', table, '--list-rules', chain]).stdout.each_line.first.chomp
+          line[/\A-P #{Regexp.escape(chain)} (.+)\z/, 1].downcase.to_sym
+        end
+      end
+    end
+  end
+end

data/lib/itamae/plugin/resource/iptables_rule.rb

@@ -0,0 +1,63 @@
+require 'itamae/resource/base'
+
+require 'itamae/plugin/resource/iptables/basic_rule'
+require 'itamae/plugin/resource/iptables/multiport_rule'
+require 'itamae/plugin/resource/iptables/log_rule'
+require 'itamae/plugin/resource/iptables/owner_rule'
+require 'itamae/plugin/resource/iptables/state_rule'
+
+module Itamae
+  module Plugin
+    module Resource
+      class IptablesRule < Itamae::Resource::Base
+        define_attribute :chain, type: String, required: true
+        define_attribute :table, type: String, default: 'filter'
+        define_attribute :jump, type: String
+        define_attribute :comment, type: String, default_name: true
+
+        prepend Iptables::BasicRule
+        prepend Iptables::LogRule
+        prepend Iptables::MultiportRule
+        prepend Iptables::OwnerRule
+        prepend Iptables::StateRule
+
+        def pre_action
+          super
+          if attributes.action != :create
+            attributes.jump = attributes.action.to_s.upcase
+          end
+        end
+
+        def set_current_attributes
+          super
+          rule = build_rule(attributes)
+          current.exist = run_command(['iptables', '--table', attributes.table, '--check', attributes.chain] + rule, error: false).exit_status == 0
+          unless current.exist
+            Logger.info "Create rule for #{attributes.chain}: #{rule.join(' ')}"
+          end
+        end
+
+        def action_create(options)
+          unless current.exist
+            rule = build_rule(attributes)
+            run_command(['iptables', '--table', attributes.table, '--append', attributes.chain] + rule)
+          end
+        end
+
+        alias_method :action_accept, :action_create
+        alias_method :action_drop, :action_create
+        alias_method :action_log, :action_create
+        alias_method :action_redirect, :action_create
+
+        private
+
+        def build_rule(attrs)
+          rule = []
+          rule << "--jump" << attrs.jump
+          rule << '--match' << 'comment' << '--comment' << attrs.comment
+          rule
+        end
+      end
+    end
+  end
+end

data/lib/itamae/plugin/resource/iptables_save.rb

@@ -0,0 +1,21 @@
+require 'itamae/resource/file'
+
+module Itamae
+  module Plugin
+    module Resource
+      class IptablesSave < Itamae::Resource::File
+        def pre_action
+          attributes.content = run_command(['iptables-save']).stdout
+          attributes.owner ||= 'root'
+          attributes.group ||= 'root'
+          attributes.mode ||= '644'
+          super
+        end
+
+        def show_differences
+          # suppress differences
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: itamae-plugin-resource-iptables
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kohei Suzuki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: itamae
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: itamae resource plugin to manage iptables.
+email:
+- eagletmt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/firewall.rb
+- examples/rtmpsuck.rb
+- itamae-plugin-resource-iptables.gemspec
+- lib/itamae/plugin/resource/iptables.rb
+- lib/itamae/plugin/resource/iptables/basic_rule.rb
+- lib/itamae/plugin/resource/iptables/log_rule.rb
+- lib/itamae/plugin/resource/iptables/multiport_rule.rb
+- lib/itamae/plugin/resource/iptables/owner_rule.rb
+- lib/itamae/plugin/resource/iptables/state_rule.rb
+- lib/itamae/plugin/resource/iptables/version.rb
+- lib/itamae/plugin/resource/iptables_chain.rb
+- lib/itamae/plugin/resource/iptables_flush.rb
+- lib/itamae/plugin/resource/iptables_policy.rb
+- lib/itamae/plugin/resource/iptables_rule.rb
+- lib/itamae/plugin/resource/iptables_save.rb
+homepage: https://github.com/eagletmt/itamae-plugin-resource-iptables
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: itamae resource plugin to manage iptables.
+test_files: []
+has_rdoc: