shutter 0.0.3 → 0.0.4

data/README.md

@@ -1,24 +1,67 @@
 # Shutter
 
-TODO: Write a gem description
+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.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Instalation is through the gem package management program. 
 
-    gem 'shutter'
+    $ gem install shutter
 
-And then execute:
+## Usage
 
-    $ bundle
+#### Install the gem.
+    
+    $ gem install shutter
 
-Or install it yourself as:
+#### Create the initial configuration files.
 
-    $ gem install shutter
+    $ shutter --init
 
-## Usage
+#### Modify the files to meet your required settings.  
+
+There are several files that you can modify:
+* **base.ipt:**  The one file to rule them all.  Modifying this file is optional as
+it is the template that is used to build the firewall. If you do modify the file,
+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.
+* **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
+* **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.
+
+#### To check your firewall you can run:
+
+    $ 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
+
+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
+
+More documentation to come...
 
-TODO: Write usage instructions here
 
 ## Contributing
 

data/Rakefile

@@ -1,2 +1,11 @@
 #!/usr/bin/env rake
+require 'rspec/core/rake_task'
 require "bundler/gem_tasks"
+
+task :default => :spec
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = %w{--colour --format progress}
+  t.pattern = 'spec/*_spec.rb'
+end

data/bin/shutter

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

data/lib/shutter/command_line.rb

@@ -5,20 +5,21 @@ require 'shutter/os'
 module Shutter
   class CommandLine
     def initialize( path = "/etc/shutter.d")
-      # Currently only available to RedHat variants
-      @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
+      # 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
-      @iptables = Shutter::IPTables::Base.new(@config_path)
-      
     end
 
     def execute
+      @iptables = Shutter::IPTables::Base.new(@config_path)
       options = {}
       optparse = OptionParser.new do |opts|
         opts.banner = "Usage: shutter [options]"
@@ -59,6 +60,7 @@ module Shutter
     end
 
     def init
+      create_config_dir
       Shutter::CONFIG_FILES.each do |name|
         file = "#{@config_path}/#{name}"
         unless File.exists?(file)
@@ -71,6 +73,7 @@ module Shutter
     end
 
     def reinit
+      create_config_dir
       Shutter::CONFIG_FILES.each do |name|
         file = "#{@config_path}/#{name}"
         File.open(file, 'w') do |f| 
@@ -101,5 +104,17 @@ module Shutter
       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
+      end
+    end
+
   end
 end

data/lib/shutter/version.rb

@@ -1,3 +1,3 @@
 module Shutter
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/shutter.gemspec

@@ -14,4 +14,6 @@ Gem::Specification.new do |gem|
   gem.name          = "shutter"
   gem.require_paths = ["lib"]
   gem.version       = Shutter::VERSION
+  gem.add_development_dependency('rspec')
+  gem.add_development_dependency('mocha')
 end

data/spec/content_spec.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "Shutter" do
+  it "should have templates for all files" do
+    Shutter::CONFIG_FILES.each do |name|
+      Shutter.constants.include?(:"#{name.upcase.gsub(/\./, "_")}").should == true
+    end
+  end
+end

data/spec/env_spec.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "Environment Sanity Check" do
+  it "should have the SHUTTER_CONFIG variable set to ./tmp" do
+    ENV['SHUTTER_CONFIG'].should == "./tmp"
+  end
+
+  it "should have the SHUTTER_PERSIST_FILE variable set to ./tmp/iptables" do
+    ENV['SHUTTER_PERSIST_FILE'].should == "./tmp/iptables"
+  end
+
+  it "should be able to write to ./tmp" do
+    File.open("./tmp/test", "w") { |f| f.write("Foo") }
+    IO.read("./tmp/test").should == "Foo"
+    File.unlink("./tmp/test")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'shutter'
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+end
+
+ENV['SHUTTER_CONFIG'] = "./tmp"
+ENV['SHUTTER_PERSIST_FILE'] = "./tmp/iptables"
+ENV['SHUTTER_MODE'] = "testing"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shutter
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,40 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-22 00:00:00.000000000 Z
-dependencies: []
+date: 2012-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Shutter helps maintain firewalls
 email:
 - nosignsoflifehere@gmail.com
@@ -37,6 +69,9 @@ files:
 - lib/shutter/os.rb
 - lib/shutter/version.rb
 - shutter.gemspec
+- spec/content_spec.rb
+- spec/env_spec.rb
+- spec/spec_helper.rb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -57,8 +92,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.20
 signing_key: 
 specification_version: 3
 summary: Shutter helps maintain firewalls
-test_files: []
+test_files:
+- spec/content_spec.rb
+- spec/env_spec.rb
+- spec/spec_helper.rb