WhiteCloth 0.0.2

data/lib/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Denis Defreyne and contributors
+
+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/lib/WhiteCloth.rb

@@ -0,0 +1,24 @@
+### Copyright (c) 2010, David Love
+###
+### Permission to use, copy, modify, and/or distribute this software for 
+### any purpose with or without fee is hereby granted, provided that the 
+### above copyright notice and this permission notice appear in all copies.
+###
+### THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 
+### WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 
+### MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 
+### ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 
+### WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 
+### ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 
+### OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+###
+
+module WhiteCloth
+
+  ## Define Application Global constants
+
+  # The current WhiteCloth client version.
+  VERSION = '0.1'
+
+end
+

data/lib/whitecloth/cli.rb

@@ -0,0 +1,29 @@
+### Copyright (c) 2009 Denis Defreyne, 2010-2011 David Love
+###
+### Permission to use, copy, modify, and/or distribute this software for 
+### any purpose with or without fee is hereby granted, provided that the 
+### above copyright notice and this permission notice appear in all copies.
+###
+### THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 
+### WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 
+### MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 
+### ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 
+### WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 
+### ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 
+### OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+###
+
+require 'rubygems'
+
+# Load command line handling library
+require 'cri'
+
+# Install module for command line
+# interface
+module WhiteCloth:CLI
+end
+
+# Load the command line handling modules
+require 'whitecloth/cli/logger'
+require 'whitecloth/cli/commands'
+require 'whitecloth/cli/base'

data/lib/whitecloth/cli/base.rb

@@ -0,0 +1,102 @@
+# Copyright (c) 2009 Denis Defreyne, 2010-2011 David Love
+#
+# Permission to use, copy, modify, and/or distribute this software for 
+# any purpose with or without fee is hereby granted, provided that the 
+# above copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#
+
+# @author Denis Defreyne
+# @author David Love
+#
+# The +CLI+ module acts as the gathering place for all the gloabl options
+# and the sub-commands which the +whitecloth+ command can deal with. 
+# Sub-commands are themselves defined in the {WhiteCloth::CLI::Commands} 
+# module 
+module WhiteCloth::CLI
+
+  # @author Denis Defreyne
+  # @author David Love
+  #
+  # Details the global options applicable to all commands, and the code necessary
+  # to process those options. Each sub-command also needs to be registered with 
+  # this class for it to work: strange things will happen if the sub-command is
+  # not set-up here!
+  #
+  # When creating a new sub-command, the constructor for that sub-command needs
+  # to be added to the {Base#initialize} function of *this* class as well. Be sure to 
+  # also add the path to the file where the sub-command is defined to the file 
+  # +lib/whitecloth/cli/commands.rb+, otherwise you will get warnings of unknown
+  # classes.
+  class Base < Cri::Base
+
+    # Instantiates the sub-commands by creating a single reference to each
+    # known sub-command.
+    # 
+    # @note This means that if your sub-command is not in this constructor
+    #   it *will not* be found, and *will not* appear as a valid sub-command.
+    #   If something is missing from the 'help' command, check this method! 
+    def initialize
+      super('whitecloth')
+
+      # Add help command
+      self.help_command = WhiteCloth::CLI::Commands::Help.new
+      add_command(self.help_command)
+
+      # Add other commands
+      add_command(WhiteCloth::CLI::Commands::Bootstrap.new)
+      add_command(WhiteCloth::CLI::Commands::Show.new)
+    end
+
+    # Returns the list of global option definitionss.
+    def global_option_definitions
+      [
+        {
+          :long => 'help', :short => 'h', :argument => :forbidden,
+          :desc => 'show this help message and quit'
+        },
+        {
+          :long => 'no-color', :short => 'C', :argument => :forbidden,
+          :desc => 'disable color'
+        },
+        {
+          :long => 'version', :short => 'v', :argument => :forbidden,
+          :desc => 'show version information and quit'
+        },
+        {
+          :long => 'verbose', :short => 'V', :argument => :forbidden,
+          :desc => 'make whitecloth output more detailed'
+        }
+      ]
+    end
+
+    # Process the global options, and set/change the application state from them
+    def handle_option(option)
+      # Handle version option
+      if option == :version
+        puts "WhiteCloth Bootstrap Client #{WhiteCloth::VERSION} (c) 2011 David Love."
+        puts "Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) running on #{RUBY_PLATFORM}"
+        exit 0
+      # Handle verbose option
+      elsif option == :verbose
+        WhiteCloth::CLI::Logger.instance.level = :low
+      # Handle no-color option
+      elsif option == :'no-color'
+        WhiteCloth::CLI::Logger.instance.color = false
+      # Handle help option
+      elsif option == :help
+        show_help
+        exit 0
+      end
+    end
+
+  end
+
+end

data/lib/whitecloth/cli/commands.rb

@@ -0,0 +1,29 @@
+# Copyright (c) 2009 Denis Defreyne, 2010-2011 David Love
+#
+# Permission to use, copy, modify, and/or distribute this software for 
+# any purpose with or without fee is hereby granted, provided that the 
+# above copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+# @author David Love
+#
+# The +Commands+ module acts as the gathering place for all the sub-commands 
+# which the +whitecloth+ command can deal with. Each sub-command defines both 
+# the command action, options, and associated help text.
+#
+# All commands should live under +lib/whitecloth/cli/commands+, with the 
+# file-name named after the sub-command defined within it. 
+module WhiteCloth::CLI::Commands
+end
+
+require 'whitecloth/cli/commands/help'
+
+require 'whitecloth/cli/commands/bootstrap'
+require 'whitecloth/cli/commands/show'

data/lib/whitecloth/cli/commands/bootstrap.rb

@@ -0,0 +1,103 @@
+# Copyright (c) 2009 Denis Defreyne, 2010-2011 David Love
+#
+# Permission to use, copy, modify, and/or distribute this software for 
+# any purpose with or without fee is hereby granted, provided that the 
+# above copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+
+module WhiteCloth::CLI::Commands
+
+  # @author David Love
+  #
+  # The +bootstrap+ command prepared the basic WhiteCloth realms (if 
+  # needed), and then links the current host to those realms. The basic
+  # realms consists of
+  #
+  # +Realm 0+: *Namespace*. All the named realms stored in this domain.
+  # 
+  # +Realm 1+: *Realm Handlers*. The basic gateways needed to create/store/update
+  # other realms.
+  # 
+  # +Realm 5+: *Realm Code*. Libraries and other code which the realm handlers
+  # should use by preference when conducting operations on the realms.
+  #
+  # If the IP address of a server (or a server name) is given to as an argument
+  # to this command, then we will use that IP address (name) for as the WhiteCloth
+  # realm server to contact. Otherwise we will look for the same data from the file
+  # +/etc/whitecloth.conf+: aborting if the file cannot be found.
+  #
+  # Once we have made contact with the server, we look at the basic realms listed
+  # above, and attempt to ensure they can be found. If not, an attempt is made to
+  # create the basic realms: aborting if this attempt fails.
+  #
+  # Finally, once everything has been set-up, we upload the core realm code (or 
+  # update the existing code)
+  class Bootstrap < Cri::Command
+
+    # The name of the sub-command (as it appears in the command line app)
+    def name
+      'bootstrap'
+    end
+
+    # The aliases this sub-command is known by
+    def aliases
+      []
+    end
+
+    # A short help text describing the purpose of this command
+    def short_desc
+      'Create a link between this host and the whitecloth servers.'
+    end
+
+    # A longer description, detailing both the purpose and the
+    # use of this command
+    def long_desc
+      'Look for the specified server, adding the data required to link the ' +
+      'current host to that server. If the found server has not been set-up ' +
+      'then this command also performs the setup of the base realms as well. '
+    end
+
+    # Show the user the basic syntax of this command
+    def usage
+      "whitecloth bootstrap [-s server]"
+    end
+    
+    # Define the options for this command
+    def option_definitions
+      [
+        { :short => 's', :long => 'server', :argument => :optional }
+      ]
+    end
+
+    # Execute the command
+    def run(options, arguments)
+      
+      # The first thing we need to do is to find the relevant server. So we 
+      # check the options and see if they can help
+      unless options[:server].nil? or options[:server].empty? then
+        #
+      else
+      
+        # The user has not specified a server, so we will attempt to get one
+        # from the system configuration
+        if File.exists?("/etc/whitecloth.conf") then
+          #
+        
+        # Everything has failed, so we abort        
+        else
+          WhiteCloth::CLI::Logger.instance.log_level(:high, :error, "Cannot locate a WhiteCloth server. Either specify the server to connect to using the 'server' option, or create an appropriate configuration file.")
+        end
+      end  
+    end
+
+  end
+
+end

data/lib/whitecloth/cli/commands/help.rb

@@ -0,0 +1,106 @@
+### Copyright (c) 2009 Denis Defreyne, 2010-2011 David Love
+###
+### Permission to use, copy, modify, and/or distribute this software for 
+### any purpose with or without fee is hereby granted, provided that the 
+### above copyright notice and this permission notice appear in all copies.
+###
+### THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 
+### WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 
+### MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 
+### ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 
+### WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 
+### ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 
+### OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+###
+
+module WhiteCloth::CLI::Commands
+
+  # @author Denis Defreyne
+  # @author David Love
+  #
+  # The +help+ command show the user a brief summary of the available
+  # sub-commands, and the short description of each of those commands.
+  #
+  # Further help is available to the user, if one of the sub-commands
+  # is named as an argument to this command. In that case, the longer
+  # help for the command is displayed.
+  #
+  # @note This class is merely a helper class: the actual text, options
+  #   and other details are drawn directly from the source code of those
+  #   commands. In the execution of this command, we rely on the +cri+
+  #   and +cli+ libraries to do the hard work of actually processing the
+  #   sub-commands.
+  class Help < Cri::Command
+
+    # The name of the sub-command (as it appears in the command line app)
+    def name
+      'help'
+    end
+
+    # The aliases this sub-command is known by
+    def aliases
+      []
+    end
+
+    # A short help text describing the purpose of this command
+    def short_desc
+      'Show help for a command'
+    end
+
+    # A longer description, detailing both the purpose and the
+    # use of this command
+    def long_desc
+      'Show help for the given command, or show general help. When no ' +
+      'command is given, a list of available commands is displayed, as ' +
+      'well as a list of global command-line options. When a command is ' +
+      'given, a command description as well as command-specific ' +
+      'command-line options are shown.'
+    end
+
+    # Show the user the basic syntax of this command
+    def usage
+      "whitecloth help [command]"
+    end
+
+    # Execute the command
+    def run(options, arguments)
+      # Check arguments
+      if arguments.size > 1
+        $stderr.puts "usage: #{usage}"
+        exit 1
+      end
+
+      if arguments.length == 0
+        # Build help text
+        text = ''
+
+        # Add title
+        text << "A command-line tool for managing WhiteCloth realms.\n"
+
+        # Add available commands
+        text << "\n"
+        text << "Available commands:\n"
+        text << "\n"
+        @base.commands.sort.each do |command|
+          text << sprintf("    %-20s %s\n", command.name, command.short_desc)
+        end
+
+        # Add global options
+        text << "\n"
+        text << "Global options:\n"
+        text << "\n"
+        @base.global_option_definitions.sort { |x,y| x[:long] <=> y[:long] }.each do |opt_def|
+          text << sprintf("    -%1s --%-15s %s\n", opt_def[:short], opt_def[:long], opt_def[:desc])
+        end
+
+        # Display text
+        puts text
+      elsif arguments.length == 1
+        command = @base.command_named(arguments[0])
+        puts command.help
+      end
+    end
+
+  end
+
+end

data/lib/whitecloth/cli/commands/show.rb

@@ -0,0 +1,87 @@
+# Copyright (c) 2011 David Love
+#
+# Permission to use, copy, modify, and/or distribute this software for 
+# any purpose with or without fee is hereby granted, provided that the 
+# above copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#
+#
+# @author David Love
+#
+
+module WhiteCloth::CLI::Commands
+
+  # @author David Love
+  #
+  # Displays a summary of the realm data found in the configured WhiteCloth
+  # server.
+  class Show < Cri::Command
+    
+    # The name of the sub-command (as it appears in the command line app)
+    def name
+      'show-status'
+    end
+
+    # The aliases this sub-command is known by
+    def aliases
+      []
+    end
+
+    # A short help text describing the purpose of this command
+    def short_desc
+      'Create or update information from the network'
+    end
+
+    # A longer description, detailing both the purpose and the
+    # use of this command
+    def long_desc
+      "Displays the current state of the evironemnt " +
+      "to update the host files (held in the 'hosts' directory). Existing " +
+      "information will be updated, and missing information inserted.\n"
+    end
+    
+    # Show the user the basic syntax of this command
+    def usage
+      "bootstrap show-status"
+    end
+
+    # Define the options for this command
+    def option_definitions
+      []
+    end
+
+    # Execute the command
+    def run(options, arguments)
+
+      # Load the list of groups
+      group_list = YAML::load( File.open("config/groups.yaml"))
+      
+      # Load the list of networks
+      network_list = YAML::load( File.open("config/networks.yaml"))
+
+      # Update the information in each group-network directory
+      gn_name_list = Array.new
+
+      network_list.each{|network|
+        puts network[1]
+        
+        net_block = network[1]['ip4-address-block'].to_s
+
+        # Scan this network
+        # parser = Nmap::Parser.parsescan("nmap", "-sVC " + net_block)
+
+        puts parser
+      }
+
+    end
+  
+  end
+
+end