keigan 0.0.0 → 0.0.1

data/NEWS.markdown

@@ -0,0 +1,10 @@
+# News
+
+#0.0.1 (August 1, 2012)
+- Initial **alpha** release of a web gui for viewing data
+	- This version is feature incomplete and will probably not even work in most cases!
+  - Enabled via % keigan
+	- Browse to http://localhost:8969 to view it, this is static for now
+
+#0.0.0 (July 09, 2012)
+- Initial gem push to save the gem name, unusable

data/README.markdown

@@ -2,14 +2,61 @@
 
 Keigan is web interface for viewing a risu database
 
-The name comes from the Japanese word for keen insight.
+The name comes from the Japanese word for 'keen insight'.
+
+# Requirements
+
+##Ruby
+Keigan has been tested with ruby-1.9.2-p320, ruby-1.9.3-p125. Please try to use one of these versions if possible. I recommend using RVM to setup your ruby environment you can get it [here](https://rvm.beginrescueend.com/).
+
+### RubyGems
+Keigan relies heavily on [RubyGems](http://rubygems.org/) to install other dependencies I highly recommend using it. RubyGems is included by default in the 1.9.x versions of [Ruby](http://ruby-lang.org/).
+
+- rails
+- yaml
+- logger
+- risu
+- sinatra
+- haml
+
+# Installation
+Installation is really easy just gem install!
+
+	% gem install keigan
+
+# Usage
+It is assumed that you already have a working [risu](http://www.arxopia.com/projects/risu) installation, a configuration file and a parsed database.
+
+## Step 1: Starting the service
+Simply type in a console; by default Keigan will read a configuration file for database settings from the current directory. This means you should run it from the same directory as your risu database(sqlite) and configuration file.
+
+	% keigan
+
+Once the service boots up open a web browser and navigate to http://localhost:8869. Alternatively if you want the service to run in the background you can do the following.
+
+	% keigan &
+
+## Step 2: Navigating the website
+Keigan displays everything in the database in a easy view manner.
+
+### Pages
+- dashboard
+- scans
+- hosts
+- items
+- plugins
 
 # Contributing
-If you would like to contribute templates/bug fixes/etc to Keigan. The easiest way is to fork the project on [github](http://github.com/arxopia/keigan) and make the changes in your fork and the submit a pull request to the project.
+If you would like to contribute to Keigan. The easiest way is to fork the project on [github](http://github.com/arxopia/keigan) and make the changes in your fork and the submit a pull request to the project.
 
 # Issues
 If you have any problems, bugs or feature requests please use the [github issue tracker](http://github.com/arxopia/keigan/issues).
 
+# Copyrights
+- keigan - (BSD) Copyright (C) 2012 Arxopia LLC.
+- risu   - (BSD) Copyright (C) 2010-2012 Arxopia LLC.
+- Bluff  - (MIT) Copyright (C) 2008-2010 James Coglan
+
 # Contact
 You can reach me at keigan[at]arxopia[dot]com.
 

data/Rakefile

@@ -37,6 +37,7 @@ end
 
 task :release => :build do
   system "gem push #{Keigan::APP_NAME}-#{Keigan::VERSION}.gem"
+  puts "Just released #{Keigan::APP_NAME} v#{Keigan::VERSION}. #{Keigan::APP_NAME} is always available in RubyGems! More information at http://arxopia.com/projects/keigan/"
 end
 
 task :clean do
@@ -47,9 +48,9 @@ task :clean do
 	system "rm -rf coverage"
 end
 
-task :default => [:test_unit]
+task :default => [:test]
 
-Rake::TestTask.new("test_unit") { |t|
+Rake::TestTask.new("test") { |t|
 	t.libs << "test"
   t.pattern = 'test/*/*_test.rb'
   t.verbose = true

data/TODO.markdown

@@ -0,0 +1,9 @@
+# TODO
+
+**Release dates and road map are estimates, and features can be changed at any time.**
+
+- Create a custom style for the application
+	- Move to http://twitter.github.com/bootstrap/index.html for the web gui
+- Better layout all the pages and properly display everything
+- Allow editing
+- 100% code coverage for unit and integration tests

data/bin/keigan

@@ -33,4 +33,5 @@ $stderr.sync = true
 require 'rubygems'
 require 'keigan'
 
-puts "Soon."
+app = Keigan::Cli::Application.new
+app.run

data/keigan.gemspec

@@ -51,9 +51,7 @@ Gem::Specification.new do |s|
 	s.required_rubygems_version = ">= 1.8.24"
 	s.rubyforge_project	= "#{Keigan::APP_NAME}"
 
-	#s.add_development_dependency("simplecov", [">= 0.9.9"])
-	#s.add_development_dependency("yard", [">= 0.6.4"])
-
-	#s.add_dependency('rails', ['>= 3.0.7'])
-	#s.add_dependency('libxml-ruby', ['>= 1.1.4'])
+	s.add_dependency('risu', ['>= 1.5.1'])
+	s.add_dependency('sinatra', [">= 1.3.2"])
+	s.add_dependency('haml', [">= 3.1.4"])
 end

data/lib/keigan/cli/application.rb

@@ -0,0 +1,215 @@
+# Copyright (c) 2012 Arxopia LLC.
+# All rights reserved.
+
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+
+#     * Redistributions of source code must retain the above copyright
+#       notice, this list of conditions and the following disclaimer.
+#     * Redistributions in binary form must reproduce the above copyright
+#       notice, this list of conditions and the following disclaimer in the
+#       documentation and/or other materials provided with the distribution.
+#     * Neither the name of the Arxopia LLC nor the names of its contributors
+#     	may be used to endorse or promote products derived from this software
+#     	without specific prior written permission.
+
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL ARXOPIA LLC BE LIABLE FOR ANY DIRECT, INDIRECT,
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+#OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+#OF THE POSSIBILITY OF SUCH DAMAGE.
+
+module Keigan
+	module Cli
+
+		# Application class for Keigan
+		#
+		class Application
+			attr_accessor :database
+
+			# Initializes a CLI Application
+			#
+			def initialize
+				@options = {}
+				@database = {}
+
+				@options[:debug] = false
+			end
+
+			# Loads the configuration file
+			#
+			# @param file Path to configuration file
+			# @param in_memory_config [Boolean] If the configuration is in memory
+			#
+			def load_config(file=CONFIG_FILE, in_memory_config=false)
+				if File.exists?(file) == true or in_memory_config == true
+					begin
+						if in_memory_config
+							yaml = YAML::load(file)
+						else
+							yaml = YAML::load(File.open(file))
+						end
+
+						@database = yaml["database"]
+						@report = yaml["report"]
+
+						puts @database.inspect if @options[:debug]
+
+						#If no values were entered put a default value in
+						@report.each do |k, v|
+							if v == nil
+								@report[k] = "No #{k}"
+							end
+						end
+					rescue => e
+						puts "[!] Error loading configuration! - #{e.message}"
+						exit
+					end
+				else
+					puts "[!] Configuration file does not exist!"
+					exit
+				end
+			end
+
+			# Establishes an [ActiveRecord::Base] database connection
+			#
+			def db_connect
+				begin
+					if @database["adapter"] == nil
+						puts "[!] #{@database['adapter']}" if @options[:debug]
+
+						return false, "[!] Invalid database adapter, please check your configuration file"
+					end
+
+					ActiveRecord::Base.establish_connection(@database)
+					ActiveRecord::Base.connection
+
+				rescue ActiveRecord::AdapterNotSpecified => ans
+					puts "[!] Database adapter not found, please check your configuration file"
+					puts "#{ans.message}\n #{ans.backtrace}" if @options[:debug]
+
+					exit
+				rescue ActiveRecord::AdapterNotFound => anf
+					puts "[!] Database adapter not found, please check your configuration file"
+					puts "#{anf.message}\n #{anf.backtrace}" if @options[:debug]
+
+					exit
+				rescue => e
+					puts "[!] Exception! #{e.message}\n #{e.backtrace}"
+				end
+			end
+
+			# Tests the database connection
+			#
+			# @return [Boolean] True on successful, False on failure
+			def test_connection?
+				begin
+
+					db_connect
+
+					if ActiveRecord::Base.connected? == true
+						return true, "[*] Connection Test Successful"
+					else
+						return false, "[!] Connection Test Failed"
+					end
+				rescue => e
+					puts "[!] Exception! #{e.message}\n #{e.backtrace}"
+				end
+			end
+
+			# Parses all the command line
+			#
+			def parse_options
+				begin
+					opts = OptionParser.new do |opt|
+						opt.banner =	"#{APP_NAME} v#{VERSION}\n#{AUTHOR}\n#{SITE}\n\n"
+						opt.banner << "Usage: #{APP_NAME} [options]"
+						opt.separator('')
+						opt.separator('Configuration Options')
+
+						opt.on('--config-file FILE', "Loads configuration settings for the specified file. By default #{APP_NAME} loads #{CONFIG_FILE}") do |option|
+							if File.exists?(option) == true
+								@options[:config_file] = option
+							else
+								puts "[!] Specified configuration file does not exist. Please specify a file that exists."
+								exit
+							end
+						end
+
+						opt.separator('')
+						opt.separator('Database Options')
+
+						opt.on('--test-connection','Tests the database connection settings') do |option|
+							@options[:test_connection] = option
+						end
+
+						opt.separator ''
+						opt.separator 'Other Options'
+
+						opt.on_tail('-v', '--version', "Shows application version information") do
+							puts "#{APP_NAME}: #{VERSION}\nRuby Version: #{RUBY_VERSION}\nRubygems Version: #{Gem::VERSION}"
+							exit
+						end
+
+						opt.on('-d','--debug','Enable Debug Mode (More verbose output)') do |option|
+							@options[:debug] = true
+						end
+
+						opt.on_tail("-?", "--help", "Show this message") do
+							puts opt.to_s + "\n"
+							exit
+						end
+					end
+
+					if ARGV.length != 0
+						opts.parse!
+					else
+					#	puts opts.to_s + "\n"
+					#	exit
+					end
+				rescue OptionParser::MissingArgument => m
+					puts opts.to_s + "\n"
+					exit
+				rescue OptionParser::InvalidOption => i
+					puts opts.to_s + "\n"
+					exit
+				end
+			end
+
+			# Main Application loop, handles all of the command line arguments and
+			#parsing of files on the command line
+			#
+			def run
+				parse_options
+
+				if @options[:debug] == true
+					puts "[*] Enabling Debug Mode"
+				end
+
+				if @options[:config_file] != nil
+					load_config @options[:config_file]
+				else
+					load_config
+				end
+
+				if @options[:test_connection] != nil
+					result = test_connection?
+
+					puts "#{result[1]}"
+					exit
+				end
+
+				db_connect
+
+				puts "Keigan Web Interface at http://localhost:8969/"
+				Keigan::Web::Application.run!
+
+			end
+		end
+	end
+end

data/lib/keigan/cli.rb

@@ -0,0 +1,32 @@
+# Copyright (c) 2012 Arxopia LLC.
+# All rights reserved.
+
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+
+#     * Redistributions of source code must retain the above copyright
+#       notice, this list of conditions and the following disclaimer.
+#     * Redistributions in binary form must reproduce the above copyright
+#       notice, this list of conditions and the following disclaimer in the
+#       documentation and/or other materials provided with the distribution.
+#     * Neither the name of the Arxopia LLC nor the names of its contributors
+#     	may be used to endorse or promote products derived from this software
+#     	without specific prior written permission.
+
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL ARXOPIA LLC BE LIABLE FOR ANY DIRECT, INDIRECT,
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+#OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+#OF THE POSSIBILITY OF SUCH DAMAGE.
+
+module Keigan
+	module Cli
+	end
+end
+
+require 'keigan/cli/application'

data/lib/keigan/web/application.rb

@@ -0,0 +1,66 @@
+# Copyright (c) 2012 Arxopia LLC.
+# All rights reserved.
+
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+
+#     * Redistributions of source code must retain the above copyright
+#       notice, this list of conditions and the following disclaimer.
+#     * Redistributions in binary form must reproduce the above copyright
+#       notice, this list of conditions and the following disclaimer in the
+#       documentation and/or other materials provided with the distribution.
+#     * Neither the name of the Arxopia LLC nor the names of its contributors
+#     	may be used to endorse or promote products derived from this software
+#     	without specific prior written permission.
+
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL ARXOPIA LLC BE LIABLE FOR ANY DIRECT, INDIRECT,
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+#OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+#OF THE POSSIBILITY OF SUCH DAMAGE.
+
+module Keigan
+	module Web
+		class Application < Sinatra::Base
+			set :bind, 'localhost'
+			set :port, 8969
+			set :haml, :format => :html5
+			set :environment, :production
+
+			get '/' do
+				haml :index
+			end
+
+			get '/hosts' do
+				haml :hosts
+			end
+
+			get '/host/:id' do
+				@host = Host.find(params[:id])
+				haml :host, :layout => :layout
+			end
+
+			get '/reports' do
+				haml :reports
+			end
+
+			get '/report/:id' do
+				@report = Host.find(params[:id])
+				haml :report
+			end
+
+			get '/items' do
+				haml :not_implemented
+			end
+
+			get '/plugins' do
+				haml :not_implemented
+			end
+		end
+	end
+end