openscap 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c04e6a4f80a1b4543f0fec9f9b3e77dd212754ff
+  data.tar.gz: 63b800808bc11cf29bc1913e9e707c241b30d288
+SHA512:
+  metadata.gz: 93c3b39ef2fe40f07a45e6a6a1c588e7dfb9b7a723df0855216560b1b140b65f8b12c33521586ed6b349237bc54a88a0a0e027ebfee96ad9b46dda44732f07d8
+  data.tar.gz: cf83e53fac11ae9ffcab9aa7a68572c4d3766b13a1418ed57b73eeee595c6904bd061c52a976730e3010e9ab53ecd74626c62b7bee2f45db0057081262e70af3

data/.gitignore

@@ -0,0 +1,4 @@
+.buildpath
+.project
+.settings
+test/output

data/COPYING

@@ -0,0 +1,339 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+                            NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    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 2 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, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.

data/README.md

@@ -0,0 +1,21 @@
+![ruby-openscap icon](http://isimluk.fedorapeople.org/ruby-OpenSCAP-small.png) ruby-OpenSCAP
+=============
+
+Description
+-------------
+A FFI wrapper around the OpenSCAP library.
+
+Features/problems
+-------------
+Current version supports minimal set of functions needed to build own scanner.
+
+Sample Scanner Implementation
+-------------
+
+    require 'openscap'
+    s = OpenSCAP::Xccdf::Session.new("ssg-fedora-ds.xml")
+    s.load
+    s.profile = "xccdf_org.ssgproject.content_profile_common"
+    s.evaluate
+    s.export_results(rds_file:"results.rds.xml")
+

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler'
+
+Bundler::GemHelper.install_tasks
+
+task :test do
+  $LOAD_PATH.unshift('lib')
+  $LOAD_PATH.unshift('test')
+  Dir.glob('./test/**/*_test.rb') { |f| require f }
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/openscap.rb

@@ -0,0 +1,17 @@
+#
+# Copyright (c) 2014 Red Hat Inc.
+#
+# This software is licensed to you under the GNU General Public License,
+# version 2 (GPLv2). 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 GPLv2
+# along with this software; if not, see
+# http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
+#
+
+require 'openscap/openscap'
+require 'openscap/exceptions'
+require 'openscap/xccdf/session'
+
+module OpenSCAP
+end

data/lib/openscap/exceptions.rb

@@ -0,0 +1,15 @@
+#
+# Copyright (c) 2014 Red Hat Inc.
+#
+# This software is licensed to you under the GNU General Public License,
+# version 2 (GPLv2). 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 GPLv2
+# along with this software; if not, see
+# http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
+#
+
+module OpenSCAP
+  class OpenSCAPError < StandardError
+  end
+end

data/lib/openscap/openscap.rb

@@ -0,0 +1,42 @@
+#
+# Copyright (c) 2014 Red Hat Inc.
+#
+# This software is licensed to you under the GNU General Public License,
+# version 2 (GPLv2). 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 GPLv2
+# along with this software; if not, see
+# http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
+#
+
+require 'ffi'
+
+module OpenSCAP
+  extend FFI::Library
+  ffi_lib ['libopenscap.so.8', 'openscap']
+
+  def self.error?
+    return oscap_err()
+  end
+
+  def self.get_full_error
+    err = oscap_err_get_full_error
+    return err.null? ? nil : err.read_string()
+  end
+
+  def self.raise!
+    err = get_full_error
+    if err.nil?
+      err = '(unknown error)'
+    end
+    raise OpenSCAPError, err
+  end
+
+  attach_function :oscap_init, [], :void
+  attach_function :oscap_cleanup, [], :void
+  attach_function :oscap_get_version, [], :string
+
+  attach_function :oscap_err, [], :bool
+  attach_function :oscap_err_get_full_error, [], :pointer
+  private_class_method :oscap_err, :oscap_err_get_full_error
+end

data/lib/openscap/xccdf/session.rb

@@ -0,0 +1,99 @@
+#
+# Copyright (c) 2014 Red Hat Inc.
+#
+# This software is licensed to you under the GNU General Public License,
+# version 2 (GPLv2). 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 GPLv2
+# along with this software; if not, see
+# http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
+#
+
+module OpenSCAP
+  module Xccdf
+
+    class Session
+      def initialize(input_filename)
+        @input_filename = input_filename
+        @s = OpenSCAP.xccdf_session_new(input_filename)
+        if @s.null?
+          OpenSCAP.raise!
+        end
+      end
+
+      def sds?
+        return OpenSCAP.xccdf_session_is_sds(@s)
+      end
+
+      def load(datastream_id:nil, component_id:nil)
+        if sds?
+          OpenSCAP.xccdf_session_set_datastream_id(@s, datastream_id)
+          OpenSCAP.xccdf_session_set_component_id(@s, component_id)
+        end
+        if OpenSCAP.xccdf_session_load(@s) != 0
+          OpenSCAP.raise!
+        end
+        OpenSCAP.raise! unless OpenSCAP.xccdf_session_load_check_engine_plugins(@s) == 0
+      end
+
+      def profile=(p)
+        @profile = p
+        if OpenSCAP.xccdf_session_set_profile_id(@s, p) == false
+          raise OpenSCAPError, "No profile '" + p + "' found"
+        end
+      end
+
+      def evaluate
+        if OpenSCAP.xccdf_session_evaluate(@s) != 0
+          OpenSCAP.raise!
+        end
+      end
+
+      def remediate
+        OpenSCAP.raise! unless OpenSCAP.xccdf_session_remediate(@s) == 0
+      end
+
+      def export_results(rds_file:nil, xccdf_file:nil, report_file:nil,
+        oval_results:false, oval_variables:false, engines_results:false)
+        OpenSCAP.raise! unless OpenSCAP.xccdf_session_set_arf_export(@s, rds_file)
+        OpenSCAP.raise! unless OpenSCAP.xccdf_session_set_xccdf_export(@s, xccdf_file)
+        OpenSCAP.raise! unless OpenSCAP.xccdf_session_set_report_export(@s, report_file)
+        OpenSCAP.xccdf_session_set_oval_results_export(@s, oval_results)
+        OpenSCAP.xccdf_session_set_oval_variables_export(@s, oval_variables)
+        OpenSCAP.xccdf_session_set_check_engine_plugins_results_export(@s, engines_results)
+
+        OpenSCAP.raise! unless OpenSCAP.xccdf_session_export_oval(@s) == 0
+        OpenSCAP.raise! unless OpenSCAP.xccdf_session_export_check_engine_plugins(@s) == 0
+        OpenSCAP.raise! unless OpenSCAP.xccdf_session_export_xccdf(@s) == 0
+        OpenSCAP.raise! unless OpenSCAP.xccdf_session_export_arf(@s) == 0
+      end
+
+      def finalize(s)
+        OpenSCAP.xccdf_session_free(s.s)
+      end
+    end
+  end
+
+  attach_function :xccdf_session_new, [:string], :pointer
+  attach_function :xccdf_session_free, [:pointer], :void
+  attach_function :xccdf_session_load, [:pointer], :int
+  attach_function :xccdf_session_load_check_engine_plugins, [:pointer], :int
+  attach_function :xccdf_session_evaluate, [:pointer], :int
+  attach_function :xccdf_session_remediate, [:pointer], :int
+  attach_function :xccdf_session_export_oval, [:pointer], :int
+  attach_function :xccdf_session_export_check_engine_plugins, [:pointer], :int
+  attach_function :xccdf_session_export_xccdf, [:pointer], :int
+  attach_function :xccdf_session_export_arf, [:pointer], :int
+
+  attach_function :xccdf_session_is_sds, [:pointer], :bool
+
+  attach_function :xccdf_session_set_profile_id, [:pointer, :string], :bool
+  attach_function :xccdf_session_set_datastream_id, [:pointer, :string], :void
+  attach_function :xccdf_session_set_component_id, [:pointer, :string], :void
+  attach_function :xccdf_session_set_arf_export, [:pointer, :string], :bool
+  attach_function :xccdf_session_set_xccdf_export, [:pointer, :string], :bool
+  attach_function :xccdf_session_set_report_export, [:pointer, :string], :bool
+  attach_function :xccdf_session_set_oval_variables_export, [:pointer, :bool], :void
+  attach_function :xccdf_session_set_oval_results_export, [:pointer, :bool], :void
+  attach_function :xccdf_session_set_check_engine_plugins_results_export, [:pointer, :bool], :void
+end

data/openscap.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require 'date'
+
+GEMSPEC = Gem::Specification.new do |gem|
+  gem.name = "openscap"
+  gem.version = File.open('VERSION').readline.chomp
+  gem.date = Date.today.to_s
+  gem.platform = Gem::Platform::RUBY
+
+  gem.author = "Šimon Lukašík"
+  gem.email = "isimluk@fedoraproject.org"
+  gem.homepage = "https://github.com/isimluk/ruby-openscap"
+  gem.license = "GPL-2.0"
+
+  gem.summary = "A FFI wrapper around the OpenSCAP library"
+  gem.description = "A FFI wrapper around the OpenSCAP library.
+  Currently it provides only subset of libopenscap functionality."
+
+  gem.add_development_dependency "bundler", ">=1.0.0"
+  gem.add_runtime_dependency "ffi", ">= 1.4.0"
+
+  gem.files = `git ls-files`.split("\n")
+  gem.require_path = 'lib'
+  gem.required_ruby_version = '>= 2.0.0'
+end

data/test/common/testcase.rb

@@ -0,0 +1,38 @@
+#
+# Copyright (c) 2014 Red Hat Inc.
+#
+# This software is licensed to you under the GNU General Public License,
+# version 2 (GPLv2). 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 GPLv2
+# along with this software; if not, see
+# http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
+#
+
+require 'test/unit'
+
+module OpenSCAP
+  class TestCase < Test::Unit::TestCase
+    class << self
+      def startup
+        OpenSCAP.oscap_init
+      end
+
+      def shutdown
+        OpenSCAP.oscap_cleanup
+      end
+    end
+
+    def setup
+      workdir = "test/output"
+      FileUtils.rm_rf workdir
+      Dir.mkdir workdir
+      Dir.chdir workdir
+    end
+
+    def cleanup
+      Dir.chdir "../.."
+      OpenSCAP.raise! if OpenSCAP.error?
+    end
+  end
+end

data/test/data/sds-complex.xml

@@ -0,0 +1,132 @@
+<?xml version="1.0" encoding="utf-8"?>
+<ds:data-stream-collection xmlns:ds="http://scap.nist.gov/schema/scap/source/1.2" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:cat="urn:oasis:names:tc:entity:xmlns:xml:catalog" id="scap_org.open-scap_collection_from_xccdf_first-xccdf.xml" schematron-version="1.0">
+  <!-- This is bit more complex Datastream. The purpose is to test that scanner is able to find
+        * datastream-id scap_org.open-scap_datastream_tst2
+        * xccdf-id scap_org.open-scap_cref_second-xccdf.xml2
+        * profile xccdf_moc.elpmaxe.www_profile_2
+    -->
+  <ds:data-stream id="scap_org.open-scap_datastream_tst" scap-version="1.2" use-case="OTHER">
+    <ds:checklists>
+      <ds:component-ref id="scap_org.open-scap_cref_first-xccdf.xml" xlink:href="#scap_org.open-scap_comp_first-xccdf.xml">
+        <cat:catalog>
+          <cat:uri name="stub-oval.xml" uri="#scap_org.open-scap_cref_stub-oval.xml"/>
+        </cat:catalog>
+      </ds:component-ref>
+      <ds:component-ref id="scap_org.open-scap_cref_second-xccdf.xml" xlink:href="#scap_org.open-scap_comp_second-xccdf.xml">
+        <cat:catalog>
+          <cat:uri name="stub-oval.xml" uri="#scap_org.open-scap_cref_stub-oval.xml"/>
+        </cat:catalog>
+      </ds:component-ref>
+    </ds:checklists>
+    <ds:checks>
+      <ds:component-ref id="scap_org.open-scap_cref_stub-oval.xml" xlink:href="#scap_org.open-scap_comp_stub-oval.xml"/>
+    </ds:checks>
+  </ds:data-stream>
+  <ds:data-stream id="scap_org.open-scap_datastream_tst2" scap-version="1.2" use-case="OTHER">
+    <ds:checklists>
+      <ds:component-ref id="scap_org.open-scap_cref_first-xccdf.xml2" xlink:href="#scap_org.open-scap_comp_first-xccdf.xml">
+        <cat:catalog>
+          <cat:uri name="stub-oval.xml" uri="#scap_org.open-scap_cref_stub-oval.xml2"/>
+        </cat:catalog>
+      </ds:component-ref>
+      <ds:component-ref id="scap_org.open-scap_cref_second-xccdf.xml2" xlink:href="#scap_org.open-scap_comp_second-xccdf.xml2">
+        <cat:catalog>
+          <cat:uri name="stub-oval.xml" uri="#scap_org.open-scap_cref_stub-oval.xml2"/>
+        </cat:catalog>
+      </ds:component-ref>
+    </ds:checklists>
+    <ds:checks>
+      <ds:component-ref id="scap_org.open-scap_cref_stub-oval.xml2" xlink:href="#scap_org.open-scap_comp_stub-oval.xml"/>
+    </ds:checks>
+  </ds:data-stream>
+  <ds:component id="scap_org.open-scap_comp_stub-oval.xml" timestamp="2012-10-10T13:33:44">
+    <oval_definitions xmlns:oval-def="http://oval.mitre.org/XMLSchema/oval-definitions-5" xmlns:oval="http://oval.mitre.org/XMLSchema/oval-common-5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ind-def="http://oval.mitre.org/XMLSchema/oval-definitions-5#independent" xmlns:unix-def="http://oval.mitre.org/XMLSchema/oval-definitions-5#unix" xmlns:lin-def="http://oval.mitre.org/XMLSchema/oval-definitions-5#linux" xmlns="http://oval.mitre.org/XMLSchema/oval-definitions-5" xsi:schemaLocation="http://oval.mitre.org/XMLSchema/oval-definitions-5#unix unix-definitions-schema.xsd http://oval.mitre.org/XMLSchema/oval-definitions-5#independent independent-definitions-schema.xsd http://oval.mitre.org/XMLSchema/oval-definitions-5#linux linux-definitions-schema.xsd http://oval.mitre.org/XMLSchema/oval-definitions-5 oval-definitions-schema.xsd http://oval.mitre.org/XMLSchema/oval-common-5 oval-common-schema.xsd">
+      <generator>
+        <oval:schema_version>5.10</oval:schema_version>
+        <oval:timestamp>0001-01-01T00:00:00+00:00</oval:timestamp>
+      </generator>
+      <definitions>
+        <definition class="compliance" version="1" id="oval:x:def:1">
+          <metadata>
+            <title>x</title>
+            <description>x</description>
+            <affected family="unix">
+              <platform>x</platform>
+            </affected>
+          </metadata>
+          <criteria comment="x">
+            <criterion test_ref="oval:x:tst:1"/>
+          </criteria>
+        </definition>
+      </definitions>
+      <tests>
+        <variable_test xmlns="http://oval.mitre.org/XMLSchema/oval-definitions-5#independent" id="oval:x:tst:1" check="all" comment="x" version="1">
+          <object object_ref="oval:x:obj:1"/>
+        </variable_test>
+      </tests>
+      <objects>
+        <variable_object xmlns="http://oval.mitre.org/XMLSchema/oval-definitions-5#independent" id="oval:x:obj:1" version="1" comment="x">
+          <var_ref>oval:x:var:1</var_ref>
+        </variable_object>
+      </objects>
+      <variables>
+        <constant_variable id="oval:x:var:1" version="1" comment="x" datatype="string">
+          <value>x</value>
+        </constant_variable>
+      </variables>
+    </oval_definitions>
+  </ds:component>
+  <ds:component id="scap_org.open-scap_comp_first-xccdf.xml" timestamp="2012-10-10T13:34:54">
+    <Benchmark xmlns="http://checklists.nist.gov/xccdf/1.2" id="xccdf_moc.elpmaxe.www_benchmark_first">
+      <status>incomplete</status>
+      <version>1.0</version>
+      <Rule selected="true" id="xccdf_moc.elpmaxe.www_rule_first">
+        <check system="http://oval.mitre.org/XMLSchema/oval-definitions-5" negate="true">
+          <check-content-ref href="stub-oval.xml"/>
+        </check>
+      </Rule>
+    </Benchmark>
+  </ds:component>
+  <ds:component id="scap_org.open-scap_comp_second-xccdf.xml2" timestamp="2012-10-10T13:34:54">
+    <Benchmark xmlns="http://checklists.nist.gov/xccdf/1.2" id="xccdf_moc.elpmaxe.www_benchmark_second">
+      <status>incomplete</status>
+      <version>1.0</version>
+      <Profile id="xccdf_moc.elpmaxe.www_profile_1">
+        <title>is kinda compulsory</title>
+        <select idref="xccdf_moc.elpmaxe.www_rule_second" selected="true"/>
+      </Profile>
+      <Profile id="xccdf_moc.elpmaxe.www_profile_2" extends="xccdf_moc.elpmaxe.www_profile_1">
+        <title>is kinda compulsory</title>
+        <select idref="xccdf_moc.elpmaxe.www_group_one" selected="true"/>
+      </Profile>
+      <Group selected="false" id="xccdf_moc.elpmaxe.www_group_one">
+        <Rule selected="false" id="xccdf_moc.elpmaxe.www_rule_second">
+          <check system="http://oval.mitre.org/XMLSchema/oval-definitions-5">
+            <check-content-ref href="stub-oval.xml"/>
+          </check>
+        </Rule>
+      </Group>
+    </Benchmark>
+  </ds:component>
+  <ds:component id="scap_org.open-scap_comp_second-xccdf.xml" timestamp="2012-10-10T13:34:54">
+    <Benchmark xmlns="http://checklists.nist.gov/xccdf/1.2" id="xccdf_moc.elpmaxe.www_benchmark_second">
+      <status>incomplete</status>
+      <version>1.0</version>
+      <Profile id="xccdf_moc.elpmaxe.www_profile_1">
+        <title>is kinda compulsory</title>
+        <select idref="xccdf_moc.elpmaxe.www_rule_second" selected="true"/>
+      </Profile>
+      <Profile id="xccdf_moc.elpmaxe.www_profile_2" extends="xccdf_moc.elpmaxe.www_profile_1">
+        <title>is kinda compulsory</title>
+        <select idref="xccdf_moc.elpmaxe.www_rule_second" selected="true"/>
+      </Profile>
+      <Group selected="false" id="xccdf_moc.elpmaxe.www_group_one">
+        <Rule selected="false" id="xccdf_moc.elpmaxe.www_rule_second">
+          <check system="http://oval.mitre.org/XMLSchema/oval-definitions-5">
+            <check-content-ref href="stub-oval.xml"/>
+          </check>
+        </Rule>
+      </Group>
+    </Benchmark>
+  </ds:component>
+</ds:data-stream-collection>

data/test/data/xccdf.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Benchmark xmlns="http://checklists.nist.gov/xccdf/1.2" id="xccdf_moc.elpmaxe.www_benchmark_second">
+  <status>incomplete</status>
+  <version>1.0</version>
+  <Profile id="xccdf_moc.elpmaxe.www_profile_1">
+    <title>is kinda compulsory</title>
+    <select idref="xccdf_moc.elpmaxe.www_rule_second" selected="true"/>
+  </Profile>
+  <Profile id="xccdf_moc.elpmaxe.www_profile_2" extends="xccdf_moc.elpmaxe.www_profile_1">
+    <title>is kinda compulsory</title>
+    <select idref="xccdf_moc.elpmaxe.www_group_one" selected="true"/>
+  </Profile>
+  <Group selected="false" id="xccdf_moc.elpmaxe.www_group_one">
+    <Rule selected="false" id="xccdf_moc.elpmaxe.www_rule_second">
+      <check system="http://oval.mitre.org/XMLSchema/oval-definitions-5">
+        <check-content-ref href="stub-oval.xml"/>
+      </check>
+    </Rule>
+  </Group>
+</Benchmark>

data/test/openscap_test.rb

@@ -0,0 +1,30 @@
+#
+# Copyright (c) 2014 Red Hat Inc.
+#
+# This software is licensed to you under the GNU General Public License,
+# version 2 (GPLv2). 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 GPLv2
+# along with this software; if not, see
+# http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
+#
+
+require 'common/testcase'
+require 'openscap'
+
+class TestOscapVersion < OpenSCAP::TestCase
+  def test_oscap_version
+    OpenSCAP.oscap_init
+    version = OpenSCAP.oscap_get_version
+    OpenSCAP.oscap_cleanup
+    assert version.include?(".")
+  end
+
+  def test_double_read_error
+    assert ! OpenSCAP.error?
+    msg = OpenSCAP.get_full_error
+    assert msg.nil?
+    msg = OpenSCAP.get_full_error
+    assert msg.nil?
+  end
+end

data/test/xccdf/session_ds_test.rb

@@ -0,0 +1,125 @@
+#
+# Copyright (c) 2014 Red Hat Inc.
+#
+# This software is licensed to you under the GNU General Public License,
+# version 2 (GPLv2). 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 GPLv2
+# along with this software; if not, see
+# http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
+#
+
+require 'openscap'
+require 'common/testcase'
+
+class TestSessionDS < OpenSCAP::TestCase
+  def test_sds_true
+    s = OpenSCAP::Xccdf::Session.new("../data/sds-complex.xml")
+    assert s.sds?
+  end
+
+  def test_session_load
+    s = OpenSCAP::Xccdf::Session.new("../data/sds-complex.xml")
+    s.load
+    s.evaluate
+  end
+
+  def test_session_load_ds_comp
+    s = OpenSCAP::Xccdf::Session.new("../data/sds-complex.xml")
+    s.load(datastream_id:"scap_org.open-scap_datastream_tst2", component_id:"scap_org.open-scap_cref_second-xccdf.xml2")
+    s.evaluate
+  end
+
+  def test_session_load_bad_datastream
+    s = OpenSCAP::Xccdf::Session.new("../data/sds-complex.xml")
+    msg = nil
+    begin
+      s.load(datastream_id:"nonexistent")
+      assert false
+    rescue OpenSCAP::OpenSCAPError => e
+      msg = e.to_s
+    end
+    assert msg.start_with?("Failed to locate a datastream with ID matching 'nonexistent' ID and checklist inside matching '<any>' ID.")
+  end
+
+  def test_session_load_bad_component
+    s = OpenSCAP::Xccdf::Session.new("../data/sds-complex.xml")
+    msg = nil
+    begin
+      s.load(component_id:"nonexistent")
+      assert false
+    rescue OpenSCAP::OpenSCAPError => e
+      msg = e.to_s
+    end
+    assert msg.start_with?("Failed to locate a datastream with ID matching '<any>' ID and checklist inside matching 'nonexistent' ID.")
+  end
+
+  def test_session_set_profile
+    s = OpenSCAP::Xccdf::Session.new("../data/sds-complex.xml")
+    s.load(component_id:"scap_org.open-scap_cref_second-xccdf.xml")
+    s.profile = "xccdf_moc.elpmaxe.www_profile_1"
+    s.evaluate
+  end
+
+  def test_session_set_profile_bad
+    s = OpenSCAP::Xccdf::Session.new("../data/sds-complex.xml")
+    s.load
+    msg = nil
+    begin
+      s.profile = "xccdf_moc.elpmaxe.www_profile_1"
+      assert false
+    rescue OpenSCAP::OpenSCAPError => e
+      msg = e.to_s
+    end
+    assert msg.start_with?("No profile 'xccdf_moc.elpmaxe.www_profile_1' found")
+  end
+
+  def test_session_export_rds
+    s = OpenSCAP::Xccdf::Session.new("../data/sds-complex.xml")
+    s.load
+    s.evaluate
+    s.export_results(rds_file:"report.rds.xml")
+    assert_exported ["report.rds.xml"]
+  end
+
+  def test_session_export_xccdf_results
+    s = OpenSCAP::Xccdf::Session.new("../data/sds-complex.xml")
+    s.load(component_id:"scap_org.open-scap_cref_second-xccdf.xml")
+    s.profile = "xccdf_moc.elpmaxe.www_profile_1"
+    s.evaluate
+    s.export_results(xccdf_file:"result.xccdf.xml")
+    assert_exported ["result.xccdf.xml"]
+  end
+
+  def test_session_export_html_report
+    s = OpenSCAP::Xccdf::Session.new("../data/sds-complex.xml")
+    s.load(component_id:"scap_org.open-scap_cref_second-xccdf.xml")
+    s.profile = "xccdf_moc.elpmaxe.www_profile_1"
+    s.evaluate
+    s.export_results(report_file:"report.html", xccdf_file:"result.xccdf.xml")
+    assert_exported ["report.html", "result.xccdf.xml"]
+  end
+
+  def test_session_export_oval_variables
+    s = OpenSCAP::Xccdf::Session.new("../data/sds-complex.xml")
+    s.load(component_id:"scap_org.open-scap_cref_second-xccdf.xml")
+    s.profile = "xccdf_moc.elpmaxe.www_profile_1"
+    s.evaluate
+    s.export_results(oval_variables:true)
+    assert_exported []
+  end
+
+  def test_remediate
+    s = OpenSCAP::Xccdf::Session.new("../data/sds-complex.xml")
+    s.load(component_id:"scap_org.open-scap_cref_second-xccdf.xml")
+    s.profile = "xccdf_moc.elpmaxe.www_profile_1"
+    s.evaluate
+    s.remediate
+  end
+
+  def assert_exported(files)
+    # libopenscap compiled with --enable-debug creates debug files
+    FileUtils.rm_rf(Dir.glob "oscap_debug.log.*")
+    assert files.sort == Dir.glob("*").sort
+  end
+end

data/test/xccdf/session_test.rb

@@ -0,0 +1,31 @@
+#
+# Copyright (c) 2014 Red Hat Inc.
+#
+# This software is licensed to you under the GNU General Public License,
+# version 2 (GPLv2). 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 GPLv2
+# along with this software; if not, see
+# http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
+#
+
+require 'openscap'
+require 'common/testcase'
+
+class TestSession < OpenSCAP::TestCase
+  def test_session_new_bad
+    msg = nil
+    begin
+      s = OpenSCAP::Xccdf::Session.new("")
+      assert false
+    rescue OpenSCAP::OpenSCAPError => e
+      msg = e.to_s
+    end
+    assert msg.start_with?("Unable to open file: ''"), "Message was: " + msg
+  end
+
+  def test_sds_false
+    s = OpenSCAP::Xccdf::Session.new("../data/xccdf.xml")
+    assert ! s.sds?
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: openscap
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Šimon Lukašík
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+description: |-
+  A FFI wrapper around the OpenSCAP library.
+    Currently it provides only subset of libopenscap functionality.
+email: isimluk@fedoraproject.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- COPYING
+- README.md
+- Rakefile
+- VERSION
+- lib/openscap.rb
+- lib/openscap/exceptions.rb
+- lib/openscap/openscap.rb
+- lib/openscap/xccdf/session.rb
+- openscap.gemspec
+- test/common/testcase.rb
+- test/data/sds-complex.xml
+- test/data/xccdf.xml
+- test/openscap_test.rb
+- test/xccdf/session_ds_test.rb
+- test/xccdf/session_test.rb
+homepage: https://github.com/isimluk/ruby-openscap
+licenses:
+- GPL-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: A FFI wrapper around the OpenSCAP library
+test_files: []