scaptimony 0.1.0

data/README.md

@@ -0,0 +1,59 @@
+# SCAPtimony
+
+SCAPtimony is SCAP storage and database server build on top of OpenSCAP library.
+SCAPtimony can be deployed as a part of your Rails application (i.e. Foreman) or
+as a stand-alone sealed server.
+
++ Current features:
+  + Collect & achieve OpenSCAP audit results from your infrastructure
++ Future features:
+  + Rails artefacts to display audit results within your application
+  + API to set-up organization defined targeting (connect set of system, a policy and time schedule)
+  + Comparison of audit results
+  + Waive known issues (one-time waivers, re-occurring, waivers)
+
+## Installation
+
+- Get SCAPtimony sources
+
+  ```
+  $ git clone https://github.com/OpenSCAP/scaptimony.git
+  ```
+
+- Build SCAPtimony RPM (instructions for Red Hat Enterprise Linux 6)
+
+  ```
+  $ cd scaptimony
+  $ gem build scaptimony.gemspec
+  # yum install yum-utils rpm-build scl-utils scl-utils-build ruby193-rubygems-devel
+  # yum-builddep extra/rubygem-scaptimony.spec
+  $ rpmbuild  --define "_sourcedir `pwd`" --define "scl ruby193" -ba extra/rubygem-scaptimony.spec
+  ```
+
+- Install SCAPtimony RPM
+
+  ```
+  # yum local install ~/rpmbuild/RPMS/noarch/ruby193-rubygem-scaptimony-*.noarch.rpm
+  ```
+
+## Usage
+
+Users are currently adviced to use SCAPtimony only through
+[foreman_openscap](https://github.com/OpenSCAP/foreman_openscap).
+
+## Copyright
+
+Copyright (c) 2014 Red Hat, Inc.
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SCAPtimony'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/scaptimony/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/scaptimony/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/scaptimony/application_controller.rb

@@ -0,0 +1,4 @@
+module Scaptimony
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/scaptimony/application_helper.rb

@@ -0,0 +1,4 @@
+module Scaptimony
+  module ApplicationHelper
+  end
+end

data/app/models/scaptimony/arf_report.rb

@@ -0,0 +1,38 @@
+require 'fileutils'
+require 'openscap'
+require 'openscap/ds/arf'
+
+module Scaptimony
+  class ArfReport < ActiveRecord::Base
+    belongs_to :asset
+    belongs_to :policy
+
+    def store!(data)
+      begin
+        FileUtils.mkdir_p dir
+        File.open(path, 'wb') { |f| f.write(data) }
+      rescue StandardError => e
+        logger.error "Could not store ARF to '#{path}': #{e.message}"
+        raise e
+      end
+    end
+
+    def each
+      OpenSCAP.oscap_init
+      arf = OpenSCAP::DS::Arf.new path
+      yield arf.html
+      arf.destroy
+      OpenSCAP.oscap_cleanup
+    end
+
+    private
+    def path
+      "#{dir}/#{digest}.xml.bz2"
+    end
+
+    def dir
+      # TODO this should be configurable
+      "/var/lib/foreman/scaptimony/arf/#{asset.name}/#{policy.name}/#{date}"
+    end
+  end
+end

data/app/models/scaptimony/asset.rb

@@ -0,0 +1,4 @@
+module Scaptimony
+  class Asset < ActiveRecord::Base
+  end
+end

data/app/models/scaptimony/policy.rb

@@ -0,0 +1,4 @@
+module Scaptimony
+  class Policy < ActiveRecord::Base
+  end
+end

data/app/views/layouts/scaptimony/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>SCAPtimony</title>
+  <%= stylesheet_link_tag    "scaptimony/application", :media => "all" %>
+  <%= javascript_include_tag "scaptimony/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+Scaptimony::Engine.routes.draw do
+end

data/db/migrate/20141013172051_create_scaptimony_policies.rb

@@ -0,0 +1,9 @@
+class CreateScaptimonyPolicies < ActiveRecord::Migration
+  def change
+    create_table :scaptimony_policies do |t|
+      t.string :name, limit: 80
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20141014105333_create_scaptimony_assets.rb

@@ -0,0 +1,10 @@
+class CreateScaptimonyAssets < ActiveRecord::Migration
+  def change
+    create_table :scaptimony_assets do |t|
+      t.string :name, limit: 255
+
+      t.timestamps
+    end
+    add_index :scaptimony_assets, :name, unique: true
+  end
+end

data/db/migrate/20141015092642_create_scaptimony_arf_reports.rb

@@ -0,0 +1,13 @@
+class CreateScaptimonyArfReports < ActiveRecord::Migration
+  def change
+    create_table :scaptimony_arf_reports do |t|
+      t.references :asset, index: true
+      t.references :policy, index: true
+      t.datetime :date
+      t.string :digest, limit: 128
+
+      t.timestamps
+    end
+    add_index :scaptimony_arf_reports, :digest, unique: true
+  end
+end

data/db/migrate/20141015115511_add_arf_report_unique_constraint.rb

@@ -0,0 +1,6 @@
+class AddArfReportUniqueConstraint < ActiveRecord::Migration
+  def change
+    add_index :scaptimony_arf_reports, [:asset_id, :policy_id, :date, :digest],
+	:unique => true, :name => :index_scaptimony_arf_reports_unique_set
+  end
+end

data/lib/scaptimony.rb

@@ -0,0 +1,4 @@
+require "scaptimony/engine"
+
+module Scaptimony
+end

data/lib/scaptimony/arf_reports_helper.rb

@@ -0,0 +1,24 @@
+#
+# Copyright (c) 2014 Red Hat Inc.
+#
+# This software is licensed to you under the GNU General Public License,
+# version 3 (GPLv3). There is NO WARRANTY for this software, express or
+# implied, including the implied warranties of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. You should have received a copy of GPLv3
+# along with this software; if not, see http://www.gnu.org/licenses/gpl.txt
+#
+
+require 'digest'
+
+module Scaptimony
+  module ArfReportsHelper
+    def self.create_arf(asset, params, arf_bzip)
+      # TODO:RAILS-4.0: This should become policy = Policy.find_or_create_by!(name: params[:policy])
+      policy = Policy.first_or_create!(:name => params[:policy])
+      digest = Digest::SHA256.hexdigest arf_bzip
+      # TODO:RAILS-4.0: This should become arf_report = ArfReport.find_or_create_by! ...
+      arf_report = ArfReport.where(:asset_id => asset.id, :policy_id => policy.id, :date => params[:date], :digest => digest).first_or_create!
+      arf_report.store!(arf_bzip)
+    end
+  end
+end

data/lib/scaptimony/engine.rb

@@ -0,0 +1,5 @@
+module Scaptimony
+  class Engine < ::Rails::Engine
+    isolate_namespace Scaptimony
+  end
+end

data/lib/scaptimony/version.rb

@@ -0,0 +1,3 @@
+module Scaptimony
+  VERSION = "0.1.0"
+end

data/lib/tasks/scaptimony_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :scaptimony do
+#   # Task goes here
+# end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.