shutter 0.0.7 → 0.1.0

data/README.md

@@ -3,10 +3,8 @@
 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**
+This application is currently only tested with Red Hat based distributions.  Ubuntu and Debian should 
+work but are not supported.
 
 ## Installation
 
@@ -14,9 +12,11 @@ Instalation is through the gem package management program.
 
     $ gem install shutter
 
-## Upgrading from 0.0.6 to 0.0.7
+## Upgrading from <= 0.0.7 to 0.1.0
 
-Version 0.0.7 adds forwarding capabilities to shutter.  To upgrade the base template and add the new configuration files, use the following command:
+Version 0.0.7 added forwarding capabilities to shutter so the base.ipt changed and needs to be upgraded.  Version 0.1.0 was a complete rewrite which fixed multiple
+bugs as well as the problem with the maximum prefix length for iptables logging in base.ipt.  Support for ubuntu and debian was added but not tested well and 
+requires the iptables-persistant package.  To upgrade the base template and add the new configuration files, use the following command:
 
     $ shutter --upgrade
 
@@ -26,7 +26,8 @@ Version 0.0.7 adds forwarding capabilities to shutter.  To upgrade the base temp
     
     $ gem install shutter
 
-#### Create the initial configuration files.
+#### OPTIONAL: Create the initial configuration files.
+Shutter automatically creates any missing configuration files anytime it is run, but you can create them prior to 
 
     $ shutter --init
 
@@ -39,6 +40,7 @@ just make sure you include the appropriate placeholder directives to allow
 shutter to dynamically fill in the rules.  It is possible to leave out any unwanted
 placeholders.  By default the files are will be found in the */etc/shutter.d* directory
 * **iface.dmz:**  Enter any private interfaces that will be unprotected by the firewall.  One per line.
+* **iface.forward:**  Enter any source and destination interfaces that forwarding will occur.
 * **ip.allow:**  A list of IP addresses and ranges that are allowed to access the 'private' ports
 * **ip.deny:**  A list of IP addresses and ranges that are denied access to both public and private ports. 
 * **ports.private:**  A list of ports and protocols that are available to traffic that passes through the AllowIP chain
@@ -50,65 +52,33 @@ access 'on-the-fly'.  To work correctly, you configure fail2ban to use the Jail
 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:
 
-    client $ shutter --save
+    $ 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:
 
-    client $ shutter --restore
+    $ 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.
-
-#### Useful environment variables:
-**SHUTTER_CONFIG:** Use this variable to set the location to the configuration files.
-
-**SHUTTER_PERSIST_FILE:** Use this variable to set the location of the 'persist' file.  i.e. /etc/sysconfig/iptables (default for Redhat)
-
-**SHUTTER_MODE:** Sets the mode of operation.  Currently only used for testing, but in the future it will include a development mode for increased log output for automated runs
+to make the changes permanent and survive reboots.  Persist can optionally take an argument which defines the location of the
+persist file if it is in a non-standard location.
+
+#### Command line options
+    Usage: shutter [options]
+            --init                       Create the initial configuration files.
+            --reinit                     Rereate the initial configuration files.
+            --upgrade                    Upgrade the configuration files that have changes with a new version.
+        -s, --save                       Output the firewall to stdout. This is the default behavior.
+        -r, --restore                    Restore the firewall through iptables-restore.
+        -p, --persist [FILE]             Write the firewall to the persistance file.  If an argument is given, it will be used as the persistance file
+        -d, --dir DIR                    Set the directory for configuration files.  Default is /etc/shutter.d.
+            --debug                      Turn on debugging for extra output.
+        -h, --help                       Display help and exit.
+            --version                    Display version and exit.
 
 More documentation to come...
 

data/bin/shutter

@@ -4,8 +4,14 @@ begin
 	require 'rubygems'
 rescue LoadError
 end
-
 require 'shutter'
-config_path = ENV['SHUTTER_CONFIG'] || "/etc/shutter.d"
-ENV['SHUTTER_MODE'] = ENV['SHUTTER_MODE'] || "production"
-Shutter::CommandLine.new(config_path).execute
+
+os = Shutter::OS.new
+os.validate!
+SHUTTER_PERSIST_FILE = os.persist_file
+
+#TODO: Should make these not constant
+#IPTABLES_RESTORE="/sbin/iptables-restore"
+#IPTABLES_SAVE="/sbin/iptables-save"
+
+Shutter::CommandLine.new.execute(ARGV)

data/lib/shutter.rb

@@ -1,15 +1,9 @@
 require "shutter/version"
 require "shutter/content"
 require "shutter/command_line"
+require "shutter/iptables"
+require "shutter/os"
+require "shutter/files"
 
 module Shutter
-  CONFIG_FILES = %w[
-        base.ipt
-        iface.dmz
-        iface.forward
-        ip.allow
-        ip.deny
-        ports.private
-        ports.public
-  ]
 end

data/lib/shutter/command_line.rb

@@ -1,135 +1,117 @@
 require 'optparse'
-require 'shutter/iptables'
-require 'shutter/os'
 
 module Shutter
   class CommandLine
+    DISPLAY_OPTS_INIT     = %q{Create the initial configuration files.}
+    DISPLAY_OPTS_REINIT   = %q{Rereate the initial configuration files.}
+    DISPLAY_OPTS_UPGRADE  = %q{Upgrade the configuration files that have changes with a new version.}
+    DISPLAY_OPTS_DIR      = %q{Set the directory for configuration files.  Default is /etc/shutter.d.}
+    DISPLAY_OPTS_SAVE     = %q{Output the firewall to stdout. This is the default behavior.}
+    DISPLAY_OPTS_RESTORE  = %q{Restore the firewall through iptables-restore.}
+    DISPLAY_OPTS_PERSIST  = %q{Write the firewall to the persistance file.  If an argument is given, it will be used as the persistance file}
+    DISPLAY_OPTS_DEBUG    = %q{Turn on debugging for extra output.}
+    DISPLAY_OPTS_HELP     = %q{Display help and exit.}
+    DISPLAY_OPTS_VERSION  = %q{Display version and exit.}
+
     def initialize( path = "/etc/shutter.d")
-      # Currently only available to RedHat variants uless testing
-      unless ENV['SHUTTER_MODE'] == "testing"
-        @os = Shutter::OS.new
-        unless @os.redhat?
-          puts "Shutter is currently only compatible with RedHat and its variants."
-          puts "Help make it compatible with others (github.com/rlyon/shutter)"
-          exit
-        end
-      end
       @config_path = path
+      @os = Shutter::OS.new
+    end
+
+    def persist
+      @persist ||= false
+    end
+
+    def persist_file
+      @persist_file ||= @os.persist_file
+    end
+
+    def command
+      @command ||= :save
     end
 
-    def iptables
-      @iptables ||= Shutter::IPTables::Base.new(@config_path)
+    def debug
+      @debug ||= false
     end
 
-    def execute
+    def config_path
+      @config_path ||= "/etc/shutter.d"
+    end
+
+    def firewall
+      @firewall ||= Shutter::Firewall::IPTables.new(@config_path)
+    end
+
+    def execute(args, noop=false)
       options = {}
       optparse = OptionParser.new do |opts|
         opts.banner = "Usage: shutter [options]"
-        options[:command] = :save
-        opts.on( '--init', 'Create the initial configuration files' ) do
-          options[:command] = :init
+        # Initialize the configuration files
+        opts.on( '--init', DISPLAY_OPTS_INIT ) do
+          @command = :init
         end
-        opts.on( '--reinit', 'Rereate the initial configuration files' ) do
-          options[:command] = :reinit
+        # Recreate the configuration files.  Overwrites all changes
+        opts.on( '--reinit', DISPLAY_OPTS_REINIT ) do 
+          @command = :reinit
         end
-        opts.on( '--upgrade', 'Rereate the base template to add new features' ) do
-          options[:command] = :upgrade
+        # Upgrade the configuration files that have changes with a new version
+        opts.on( '--upgrade', DISPLAY_OPTS_UPGRADE ) do 
+          @command = :upgrade
         end
-        opts.on( '-s', '--save', 'Output the firewall to stdout. (DEFAULT)') do
-          options[:command] = :save
+        # Output the firewall to stdout
+        opts.on( '-s', '--save', DISPLAY_OPTS_SAVE) do
+          @command = :save
         end
-        opts.on( '-r', '--restore', 'Load the firewall through iptables-restore.') do
-          options[:command] = :restore
+        # Restore the firewall through iptables-restore
+        opts.on( '-r', '--restore', DISPLAY_OPTS_RESTORE) do
+          @command = :restore
         end
-        @persist = false
-        opts.on( '-p', '--persist', 'Make the changes persistant. (with --restore)') do
+        # Write the firewall to the persistance file
+        opts.on( '-p', "--persist [FILE]", DISPLAY_OPTS_PERSIST) do |file| 
           @persist = true
+          @persist_file = file || persist_file
         end
-        options[:debug] = false
-        opts.on( '-d', '--debug', 'Be a bit more chatty') do
-          options[:debug] = true
-        end
-        opts.on_tail( '-h', '--help', 'Display this screen' ) do
-          puts opts
-          exit
+        # Sets the directory for configuration files
+        opts.on( '-d', '--dir DIR', DISPLAY_OPTS_DIR) do |dir| 
+          @config_path = dir
         end
-        opts.on_tail( '--version', "Show the version") do
-          puts Shutter::VERSION
-          exit
-        end
-      end
-      optparse.parse!
-      puts "* Using config path: #{@config_path}" if @debug
-      puts "* Running command: #{options[:command].to_s}" if @debug
-      send(options[:command])
-    end
-
-    def init
-      create_config_dir
-      Shutter::CONFIG_FILES.each do |name|
-        file = "#{@config_path}/#{name}"
-        unless File.exists?(file)
-          # puts "Creating: #{file}"
-          File.open(file, 'w') do |f| 
-            f.write(Shutter.const_get(name.upcase.gsub(/\./, "_")))
-          end
+        # Turn on debugging
+        opts.on_tail( '--debug', DISPLAY_OPTS_DEBUG) do 
+          @debug = true
         end
-      end
-    end
-
-    def reinit
-      create_config_dir
-      Shutter::CONFIG_FILES.each do |name|
-        file = "#{@config_path}/#{name}"
-        File.open(file, 'w') do |f| 
-          f.write(Shutter.const_get(name.upcase.gsub(/\./, "_")))
+        # Display help and exit
+        opts.on_tail( '-h', '--help', DISPLAY_OPTS_HELP ) do 
+          puts opts ; exit
         end
-      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(/\./, "_")))
+        # Display version and exit
+        opts.on_tail( '--version', DISPLAY_OPTS_VERSION) do
+          puts Shutter::VERSION ; exit
         end
       end
+      optparse.parse!(args)
+      puts "* Using config path: #{@config_path}" if @debug
+      puts "* Running command: #{@command}" if @debug
+      puts "* Using persistance file: #{persist_file}" if @debug && persist
+      Shutter::Files.create_config_dir(config_path) unless noop
+      Shutter::Files.create(config_path)
+      run unless noop
     end
 
-    def save
-      init
-      @ipt = iptables.generate
-      puts @ipt
-    end
-
-    def restore
-      init
-      @ipt = iptables.generate
-      IO.popen("#{Shutter::IPTables::IPTABLES_RESTORE}", "r+") do |iptr|
-        iptr.puts @ipt ; iptr.close_write
-      end
-      persist if @persist
-    end
-
-    def persist
-      pfile = ENV['SHUTTER_PERSIST_FILE'] ? ENV['SHUTTER_PERSIST_FILE'] : iptables.persist_file(@os)
-      File.open(pfile, "w") do |f|
-        f.write(@ipt)
-      end
-    end
-
-    private
-    def create_config_dir
-      # Check to see if the path to the config files exist
-      unless File.directory?(@config_path)
-        begin
-          Dir.mkdir(@config_path)
-        rescue Errno::ENOENT
-          raise "Could not create the configuration directory.  Check to see if the parent directory exists."
-        end
+    def run
+      case @command
+      when :init
+        Shutter::Files.create(config_path)
+      when :reinit
+        Shutter::Files.create(config_path,true)
+      when :upgrade
+        Shutter::Files.create(config_path,false,["base.ipt", "iface.forward"])
+      when :save
+        firewall.save
+      when :restore
+        firewall.restore
+        puts "Writing to #{persist_file}" if persist
+        firewall.persist(persist_file) if persist
       end
     end
-
   end
 end

data/lib/shutter/content.rb

@@ -1,4 +1,14 @@
 module Shutter
+  module Content
+CONFIG_FILES = %w[
+  base.ipt
+  iface.dmz
+  iface.forward
+  ip.allow
+  ip.deny
+  ports.private
+  ports.public
+]
 
 BASE_IPT = %q{# Generated by Shutter
 *filter
@@ -143,7 +153,7 @@ BASE_IPT = %q{# Generated by Shutter
 # 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 ! -d 0.0.0.255/0.0.0.255 -m limit --limit 3/min -j LOG --log-prefix "iptables: Bad NAT:"
 -A FORWARD -j DROP
 
 ##################################################################
@@ -163,7 +173,7 @@ COMMIT
 }
 
 IFACE_DMZ = %q{# Generated by Shutter
-# iface
+# device
 # eth0
 # eth1
 }
@@ -195,4 +205,41 @@ IFACE_FORWARD = %q{
 # src iface | dst iface
 # eth0 eth1
 }
+
+IFACE_DMZ_MOCK = %q{# Generated by Shutter
+# device
+eth0
+eth1
+}
+
+IP_ALLOW_MOCK = %q{# Generated by Shutter
+# ipaddr
+# ipaddr/subnet
+192.168.0.0/16
+10.0.0.1
+}
+
+IP_DENY_MOCK = %q{# Generated by Shutter
+# ipaddr
+# ipaddr/subnet
+172.31.0.0/24
+8.9.9.9
+}
+
+PORTS_PUBLIC_MOCK = %q{
+# proto port
+80    tcp
+443   tcp
+}
+
+PORTS_PRIVATE_MOCK = %q{
+# proto port
+22    tcp
+}
+
+IFACE_FORWARD_MOCK = %q{
+# src iface | dst iface
+eth0 eth1
+}
+  end
 end