Class: Shutter::CommandLine

Inherits:
Object
  • Object
show all
Defined in:
lib/shutter/command_line.rb

Constant Summary collapse

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 rules to stdout. This is the default behavior.}
DISPLAY_OPTS_RESTORE = 
%q{Restore the firewall rules 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_CHECK = 
%q{Check to see if the generated rules match the current firewall rules.}
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.}

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(path = "/etc/shutter.d") ⇒ CommandLine

Returns a new instance of CommandLine.



19
20
21
22
 
# File 'lib/shutter/command_line.rb', line 19

def initialize( path = "/etc/shutter.d")
  @config_path = path
  @os = Shutter::OS.new
end

Instance Attribute Details

#os ⇒ Object (readonly)

Returns the value of attribute os.



17
18
19
 
# File 'lib/shutter/command_line.rb', line 17

def os
  @os
end

Instance Method Details

#command ⇒ Object 



32
33
34
 
# File 'lib/shutter/command_line.rb', line 32

def command
  @command ||= :save
end

#config_path ⇒ Object 



40
41
42
 
# File 'lib/shutter/command_line.rb', line 40

def config_path
  @config_path ||= "/etc/shutter.d"
end

#debug ⇒ Object 



36
37
38
 
# File 'lib/shutter/command_line.rb', line 36

def debug
  @debug ||= false
end

#execute(args, noop = false) ⇒ Object 



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/shutter/command_line.rb', line 48

def execute(args, noop=false)
  options = {}
  optparse = OptionParser.new do |opts|
    opts.banner = "Usage: shutter [options]"
    # Initialize the configuration files
    opts.on( '--init', DISPLAY_OPTS_INIT ) do
      @command = :init
    end
    # Recreate the configuration files.  Overwrites all changes
    opts.on( '--reinit', DISPLAY_OPTS_REINIT ) do 
      @command = :reinit
    end
    # Upgrade the configuration files that have changes with a new version
    opts.on( '--upgrade', DISPLAY_OPTS_UPGRADE ) do 
      @command = :upgrade
    end
    # Output the firewall to stdout
    opts.on( '-s', '--save', DISPLAY_OPTS_SAVE) do
      @command = :save
    end
    # Restore the firewall through iptables-restore
    opts.on( '-r', '--restore', DISPLAY_OPTS_RESTORE) do
      @command = :restore
    end
    # 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
    # Check the generated rules against the current rules
    opts.on( '-c', "--check", DISPLAY_OPTS_PERSIST) do |file| 
      @command = :check
    end
    # Sets the directory for configuration files
    opts.on( '-d', '--dir DIR', DISPLAY_OPTS_DIR) do |dir| 
      @config_path = dir
    end
    # Turn on debugging
    opts.on_tail( '--debug', DISPLAY_OPTS_DEBUG) do 
      @debug = true
    end
    # Display help and exit
    opts.on_tail( '-h', '--help', DISPLAY_OPTS_HELP ) do 
      puts opts ; exit
    end
    # 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

#firewall ⇒ Object 



44
45
46
 
# File 'lib/shutter/command_line.rb', line 44

def firewall
  @firewall ||= Shutter::Firewall::IPTables.new(@config_path)
end

#persist ⇒ Object 



24
25
26
 
# File 'lib/shutter/command_line.rb', line 24

def persist
  @persist ||= false
end

#persist_file ⇒ Object 



28
29
30
 
# File 'lib/shutter/command_line.rb', line 28

def persist_file
  @persist_file ||= @os.persist_file
end

#run ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/shutter/command_line.rb', line 107

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"])
  when :save
    firewall.save
  when :restore
    firewall.restore
    puts "Writing to #{persist_file}" if persist
    firewall.persist(persist_file) if persist
  when :check
    if firewall.check
      puts "OK"
    else
      puts "MISMATCH"
    end
  end
end