shutter 0.0.6 → 0.0.7

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .yardoc
+.rvmrc
 Gemfile.lock
 InstalledFiles
 _yardoc

data/README.md

@@ -1,9 +1,12 @@
 # Shutter
 
-Shutter is a tool that enables system administrators the ability to manage 
-iptables firewall settings through simple lists instead of complex iptables commands.  Please note:
-This application currently only works with Red Hat based distributions, as the need arrises more 
-distributions will be added.
+Shutter is a tool that gives system administrators the ability to manage 
+iptables firewall settings through simple lists instead of complex iptables commands, making it
+easier to define host and service firewall setting with configuration management tools.  Please note:
+This application currently only works with Red Hat based distributions, as the need arises more 
+distributions will be added.  
+
+**Note: Shutter server is not yet complete**
 
 ## Installation
 
@@ -11,6 +14,12 @@ Instalation is through the gem package management program.
 
     $ gem install shutter
 
+## Upgrading from 0.0.6 to 0.0.7
+
+Version 0.0.7 adds forwarding capabilities to shutter.  To upgrade the base template and add the new configuration files, use the following command:
+
+    $ shutter --upgrade
+
 ## Usage
 
 #### Install the gem.
@@ -36,19 +45,60 @@ placeholders.  By default the files are will be found in the */etc/shutter.d* di
 * **ports.public:**  A list of ports and protocols that are available publically to everyone except the 'Bastards' listed in ip.deny
 
 Shutter was designed to work with the Fail2ban access monitoring/management tool.  It includes a 
-special chain called 'Jail' which is used to insert the jump rules that fail2ban uses to deny access 'on-the-fly'.
-To work correctly, you configure fail2ban to use the Jail chain instead of INPUT.
+special chain called 'Jail' which is used to insert the jump rules that fail2ban uses to deny 
+access 'on-the-fly'.  To work correctly, you configure fail2ban to use the Jail chain instead of 
+INPUT.  The dynamic rules that fail2ban has created in the jail chain remain persistant when 
+shutter is 'restored' or reloaded.
+
+Shutter can also run as a server to recieve requests from clients to populate the ip.allow and ip.deny files from a central location.  To use this feature, you will need to generate an encryption key on the system you plan on using as the server by running the command:
+    
+    server $ shutter --keygen
+
+This will create the file validation.pem in the /etc/shutter.d (or the user defined) folder.  The validation key can then be distributed to the shutter clients to pull in lists.  On the shutter server, you will need to define the available lists in the server.json configuration file.  It could look like this:
+    
+    {
+      'allow_lists': [
+        'default.allow',
+        'private.allow',
+        'public.allow'
+      ],
+      'deny_lists': [
+        'default.deny',
+        'bastards.deny'
+      ]
+    }
+
+To start the server run:
+
+    server $ shutter --server start
+
+To stop the server run:
+
+    server $ shutter --server stop
+
+To restart the server run:
+
+    server $ shutter --server restart
+
+The first time you run shutter-server, empty files will be created in /etc/shutter.d/lists.  Edit the files just like you would the ip.allow and ip.deny files.  Make sure you copy the validation.pem file to your client and then on the client run:
+
+    client $ shutter --allow private --remote shutter.example.com
+
+If the '--allow' is not specified it will grab default.allow file and if the file does not exist on the server it will return an error.  In this case, shutter will grab the private.allow file from the remote site and replace ip.allow with the contents if the contents have changed.
+
+Under the hood:  A request is sent out to retrieve the MD5 sum of the file that lives on the server, if the md5sum of the file on the remote server is different than the one that is on the local server, the file is retrieved and updated on the client.
+
 
 #### To check your firewall you can run:
 
-    $ shutter --save
+    client $ shutter --save
 
 This command mimics the 'iptables-save' command which prints the rules out to the screen.  
 This does not modify the firewall settings.
 
 #### To implement the changes, use:
 
-    $ shutter --restore
+    client $ shutter --restore
 
 This command uses 'iptables-restore' under the hood to update the firewall.  You can use the '--persist' option
 to make the changes permanent and survive reboots.

data/SERVER.md

@@ -0,0 +1,5 @@
+The server runs as a daemon on port 4041 and accepts connetctions from clients.  
+
+Traffic is encrypted using a validation SSL key.
+
+Shutter server uses rack, openssl

data/bin/shutter

@@ -6,6 +6,6 @@ rescue LoadError
 end
 
 require 'shutter'
-config_path = ENV['SHUTTER_CONFIG'] ? ENV['SHUTTER_CONFIG'] : "/etc/shutter.d"
-ENV['SHUTTER_MODE'] = "production"
+config_path = ENV['SHUTTER_CONFIG'] || "/etc/shutter.d"
+ENV['SHUTTER_MODE'] = ENV['SHUTTER_MODE'] || "production"
 Shutter::CommandLine.new(config_path).execute

data/lib/shutter.rb

@@ -6,6 +6,7 @@ module Shutter
   CONFIG_FILES = %w[
         base.ipt
         iface.dmz
+        iface.forward
         ip.allow
         ip.deny
         ports.private

data/lib/shutter/command_line.rb

@@ -14,7 +14,6 @@ module Shutter
           exit
         end
       end
-
       @config_path = path
     end
 
@@ -33,6 +32,9 @@ module Shutter
         opts.on( '--reinit', 'Rereate the initial configuration files' ) do
           options[:command] = :reinit
         end
+        opts.on( '--upgrade', 'Rereate the base template to add new features' ) do
+          options[:command] = :upgrade
+        end
         opts.on( '-s', '--save', 'Output the firewall to stdout. (DEFAULT)') do
           options[:command] = :save
         end
@@ -85,6 +87,16 @@ module Shutter
       end
     end
 
+    def upgrade
+      create_config_dir
+      ["base.ipt", "iface.forward"].each do |name|
+        file = "#{@config_path}/#{name}"
+        File.open(file, 'w') do |f| 
+          f.write(Shutter.const_get(name.upcase.gsub(/\./, "_")))
+        end
+      end
+    end
+
     def save
       init
       @ipt = iptables.generate

data/lib/shutter/content.rb

@@ -139,12 +139,27 @@ BASE_IPT = %q{# Generated by Shutter
 -A DropDDOS ! -d 0.0.0.255/0.0.0.255 -m limit --limit 3/min -j LOG --log-prefix "iptables: DDOS detected:"  
 -A DropDDOS -j DROP
 
+##################################################################
+# NATing
+##################################################################
+# [RULES:FORWARD]
+-A FORWARD ! -d 0.0.0.255/0.0.0.255 -m limit --limit 3/min -j LOG --log-prefix "iptables: Unauthorized Forward:"
+-A FORWARD -j DROP
+
 ##################################################################
 # Add any additional rules that fail2ban has added
 ##################################################################
 # [RULES:FAIL2BAN]
 
 COMMIT
+
+*nat
+:PREROUTING ACCEPT [0:0]
+:POSTROUTING ACCEPT [0:0]
+:OUTPUT ACCEPT [0:0]
+# [RULES:POSTROUTING]
+COMMIT
+
 }
 
 IFACE_DMZ = %q{# Generated by Shutter
@@ -175,4 +190,9 @@ PORTS_PRIVATE = %q{
 # proto port
 22    tcp
 }
+
+IFACE_FORWARD = %q{
+# src iface | dst iface
+# eth0 eth1
+}
 end

data/lib/shutter/iptables.rb

@@ -3,6 +3,7 @@ require 'shutter/iptables/eyepee'
 require 'shutter/iptables/iface'
 require 'shutter/iptables/jail'
 require 'shutter/iptables/port'
+require 'shutter/iptables/forward'
 require 'shutter/os'
 
 module Shutter

data/lib/shutter/iptables/base.rb

@@ -23,20 +23,30 @@ module Shutter
       def generate_filter
         @dmz = Iface.new("#{@path}", :dmz).to_ipt
         @content = @content.gsub(/#\ \[RULES:DMZ\]/, @dmz)
+
+        @forward = Forward.new("#{@path}")
+        @content = @content.gsub(/#\ \[RULES:FORWARD\]/, @forward.to_forward_ipt)
+        @content = @content.gsub(/#\ \[RULES:POSTROUTING\]/, @forward.to_masq_ipt)
+
         @bastards = EyePee.new("#{@path}", :deny).to_ipt
         @content = @content.gsub(/#\ \[RULES:BASTARDS\]/, @bastards)
+        
         @public = Port.new("#{@path}", :public).to_ipt
         @content = @content.gsub(/#\ \[RULES:PUBLIC\]/, @public)
+        
         @allow = EyePee.new("#{@path}", :allow).to_ipt
         @content = @content.gsub(/#\ \[RULES:ALLOWIP\]/, @allow)
+        
         @private = Port.new("#{@path}", :private).to_ipt
         @content = @content.gsub(/#\ \[RULES:PRIVATE\]/, @private)
 
         # Make sure we are restoring what fail2ban has added
         @f2b_chains = Jail.new.fail2ban_chains
         @content = @content.gsub(/#\ \[CHAIN:FAIL2BAN\]/, @f2b_chains)
+        
         @f2b_rules = Jail.new.fail2ban_rules
         @content = @content.gsub(/#\ \[RULES:FAIL2BAN\]/, @f2b_rules)
+        
         @jail = Jail.new.jail_rules
         @content = @content.gsub(/#\ \[RULES:JAIL\]/, @jail)
 

data/lib/shutter/iptables/forward.rb

@@ -0,0 +1,47 @@
+module Shutter
+  module IPTables
+    class Forward
+      def initialize( path )
+        file = File.open("#{path}/iface.forward", "r")
+        @content = file.read
+        @forward = ""
+        @masq = ""
+        @masq_ifaces = []
+        @content.each_line do |line|
+          line = line.strip
+          if line =~ /^[a-z].+$/
+            src, dst = line.split(' ')
+            @forward += forward_ipt(src,dst)
+            @masq_ifaces << dst unless @masq_ifaces.include?(dst)
+          end
+        end
+        @masq_ifaces.each do |iface|
+          @masq += masq_ipt(iface)
+        end
+
+      end
+
+      def to_s
+        @content
+      end
+
+      def to_forward_ipt
+        @forward
+      end
+
+      def to_masq_ipt
+        @masq
+      end
+
+      def forward_ipt( src, dst )
+        rule = "-A FORWARD -i #{src} -o #{dst} -m state --state NEW,RELATED,ESTABLISHED -j ACCEPT\n"
+        rule += "-A FORWARD -i #{dst} -o #{src} -m state --state RELATED,ESTABLISHED -j ACCEPT\n"
+        rule
+      end
+
+      def masq_ipt( iface )
+        "-A POSTROUTING -o #{iface} -j MASQUERADE\n"
+      end
+    end
+  end
+end

data/lib/shutter/version.rb

@@ -1,3 +1,3 @@
 module Shutter
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shutter
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-13 00:00:00.000000000 Z
+date: 2012-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -61,6 +61,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- SERVER.md
 - bin/shutter
 - lib/shutter.rb
 - lib/shutter/command_line.rb
@@ -68,6 +69,7 @@ files:
 - lib/shutter/iptables.rb
 - lib/shutter/iptables/base.rb
 - lib/shutter/iptables/eyepee.rb
+- lib/shutter/iptables/forward.rb
 - lib/shutter/iptables/iface.rb
 - lib/shutter/iptables/jail.rb
 - lib/shutter/iptables/port.rb