inspec-core 2.1.67

data/lib/utils/plugin_registry.rb

@@ -0,0 +1,93 @@
+# encoding: utf-8
+# author: Dominik Richter
+# author: Christoph Hartmann
+
+class PluginRegistry
+  attr_reader :registry
+
+  def initialize
+    @registry = {}
+  end
+
+  # Resolve a target via available plugins.
+  #
+  # @param [String] target to resolve
+  # @return [Plugin] plugin instance if it can be resolved, nil otherwise
+  def resolve(target)
+    modules.each do |m|
+      res = m.resolve(target)
+      return res unless res.nil?
+    end
+    nil
+  end
+
+  private
+
+  # Get all registered plugins sorted by priority, with highest first
+  #
+  # @return [Array[Plugin]] sorted list of plugins
+  def modules
+    @registry.values
+             .sort_by { |x| x.respond_to?(:priority) ? x.priority : 0 }
+             .reverse
+  end
+end
+
+class PluginRegistry
+  class Plugin
+    # Retrieve the plugin registry associated with this plugin
+    #
+    # @return [PluginRegistry] plugin registry for this plugin
+    def self.plugin_registry
+      raise "Plugin #{self} does not implement `self.plugin_registry()`. This method is required"
+    end
+
+    # Register a new plugin by name
+    #
+    # @param [String] the unique name of this plugin
+    # @return [nil] disregard
+    def self.name(name)
+      raise "Trying to register #{self} with name == nil" if name.nil?
+      @name = name
+      plugin_registry.registry[name] = self
+    end
+
+    # This plugin's priority. Set it by providing the priority as an
+    # argument. Higher numbers ensure that the plugin is
+    # called early to check if a target belongs to it. When called without
+    # an argument, it retrieves this plugin's priority. Defaults to 0.
+    #
+    # @param [Numeric] Priority as a number. Will only be set if != nil
+    # @return [Numeric] This plugin's priority
+    def self.priority(x = nil)
+      @priority = x unless x.nil?
+      @priority || 0
+    end
+
+    # Try to resolve the target. If this plugin cannot handle it, the result
+    # will be nil. If, however, the plugin can resolve it, the resulting
+    # object will be an instance of this plugin. This means, that the interface
+    # that this base class provides, is the basis for the returned type.
+    #
+    # @param [String] target to try to resolve
+    # @return [Plugin] instance if it can be resolved, nil otherwise
+    def self.resolve(_target)
+      raise "Plugin #{self} does not implement `self.resolve(target)`. This method is required"
+    end
+
+    # When a plugin's resolve doesn't lead to the final state, it can
+    # use this method to hand it back for another resolver to handle.
+    #
+    # @param [Any] the current target that needs resolving
+    # @param [Plugin] an instance of the calling resolver
+    # @return [Plugin] instance if it can be resolved, nil otherwise
+    def self.resolve_next(target, parent)
+      res = plugin_registry.resolve(target)
+      res.parent = parent
+      res
+    end
+
+    attr_reader :target
+    attr_accessor :parent
+  end
+end

data/lib/utils/simpleconfig.rb

@@ -0,0 +1,120 @@
+# encoding: utf-8
+# copyright: 2015, Dominik Richter
+# author: Dominik Richter
+# author: Christoph Hartmann
+
+require 'utils/parser'
+
+class SimpleConfig
+  include CommentParser
+
+  attr_reader :params, :groups
+  def initialize(raw_data, opts = {})
+    parse(raw_data, opts)
+  end
+
+  # Parse some data
+  # quotes: quoting characters, which are parsed, so everything inside
+  # it will be part of a string
+  # multiline: allow quoted text to span multiple lines
+  # comment_char: char which identifies comments
+  # standalone_comments: comments must appear alone in a line; if set to true,
+  # no comments can be added to the end of an assignment/statement line
+  def parse(raw_data, opts = nil)
+    @params = {}
+    @groups = []
+    @vals = @params
+    options = default_options.merge(opts || {})
+    return if raw_data.nil?
+
+    # prepare raw data if required
+    if !options[:line_separator].nil?
+      raw_data = raw_data.tr(options[:line_separator], "\n")
+    end
+    rest = raw_data
+    rest = parse_rest(rest, options) until rest.empty?
+  end
+
+  private
+
+  def parse_values(match, values)
+    start_idx = 2
+    i = 0
+    count = values - 1
+    return match[start_idx] if values == 1
+
+    # iterate over expected parameters
+    values = []
+    loop do
+      values.push(match[start_idx + i])
+      i += 1
+      break if i > count
+    end
+    values
+  end
+
+  def parse_params_line(line, opts)
+    # now line contains what we are interested in parsing
+    # check if it is an assignment
+    m = opts[:assignment_regex].match(line)
+    return nil if m.nil?
+
+    if opts[:multiple_values]
+      @vals[m[1]] ||= []
+      @vals[m[1]].push(parse_values(m, opts[:key_values]))
+    else
+      @vals[m[1]] = parse_values(m, opts[:key_values])
+    end
+  end
+
+  def parse_group_line(line, opts)
+    return nil if opts[:group_re].nil?
+    m = opts[:group_re].match(line)
+    return nil if m.nil?
+    @groups.push(m[1])
+
+    # We use a Hashie::Mash to provide method syntax for retrieving
+    # values. For configs that have keys whose values may be hashes
+    # (such as a mysql config that has [sections]), providing
+    # a hash whose values are accessible via methods provide
+    # a better user experience with `its` blocks.
+    @vals = @params[m[1]] = Hashie::Mash.new
+  end
+
+  def parse_implicit_assignment_line(line, opts)
+    return nil if is_empty_line(line)
+    if opts[:multiple_values]
+      @vals[line.strip] ||= []
+    else
+      @vals[line.strip] = ''
+    end
+  end
+
+  def parse_rest(rest, opts)
+    line, idx_nl = parse_comment_line(rest, opts)
+    parse_params_line(line, opts) or
+      parse_group_line(line, opts) or
+      parse_implicit_assignment_line(line, opts)
+
+    # return whatever is left
+    rest[(idx_nl + 1)..-1] || ''
+  end
+
+  def is_empty_line(l)
+    l =~ /^\s*$/
+  end
+
+  def default_options
+    {
+      quotes: '',
+      multiline: false,
+      comment_char: '#',
+      line_separator: nil, # uses this char to seperate lines before parsing
+      assignment_regex: /^\s*([^=]*?)\s*=\s*(.*?)\s*$/,
+      group_re: /\[([^\]]+)\]\s*$/,
+      key_values: 1, # default for key=value, may require for 'key val1 val2 val3'
+      standalone_comments: false,
+      multiple_values: false,
+    }
+  end
+end

data/lib/utils/spdx.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+# author: Christoph Hartmann
+# author: Dominik Richter
+class Spdx
+  def self.licenses
+    spdx_file = File.join(File.dirname(__FILE__), 'spdx.txt').freeze
+    File.read(spdx_file).split("\n")
+  end
+
+  def self.valid_license?(license)
+    licenses.include?(license)
+  end
+end

data/lib/utils/spdx.txt

@@ -0,0 +1,344 @@
+Glide
+Abstyles
+AFL-1.1
+AFL-1.2
+AFL-2.0
+AFL-2.1
+AFL-3.0
+AMPAS
+APL-1.0
+Adobe-Glyph
+APAFML
+Adobe-2006
+AGPL-1.0
+Afmparse
+Aladdin
+ADSL
+AMDPLPA
+ANTLR-PD
+Apache-1.0
+Apache-1.1
+Apache-2.0
+AML
+APSL-1.0
+APSL-1.1
+APSL-1.2
+APSL-2.0
+Artistic-1.0
+Artistic-1.0-Perl
+Artistic-1.0-cl8
+Artistic-2.0
+AAL
+Bahyph
+Barr
+Beerware
+BitTorrent-1.0
+BitTorrent-1.1
+BSL-1.0
+Borceux
+BSD-2-Clause
+BSD-2-Clause-FreeBSD
+BSD-2-Clause-NetBSD
+BSD-3-Clause
+BSD-3-Clause-Clear
+BSD-3-Clause-No-Nuclear-License
+BSD-3-Clause-No-Nuclear-License-2014
+BSD-3-Clause-No-Nuclear-Warranty
+BSD-4-Clause
+BSD-Protection
+BSD-Source-Code
+BSD-3-Clause-Attribution
+0BSD
+BSD-4-Clause-UC
+bzip2-1.0.5
+bzip2-1.0.6
+Caldera
+CECILL-1.0
+CECILL-1.1
+CECILL-2.0
+CECILL-2.1
+CECILL-B
+CECILL-C
+ClArtistic
+MIT-CMU
+CNRI-Jython
+CNRI-Python
+CNRI-Python-GPL-Compatible
+CPOL-1.02
+CDDL-1.0
+CDDL-1.1
+CPAL-1.0
+CPL-1.0
+CATOSL-1.1
+Condor-1.1
+CC-BY-1.0
+CC-BY-2.0
+CC-BY-2.5
+CC-BY-3.0
+CC-BY-4.0
+CC-BY-ND-1.0
+CC-BY-ND-2.0
+CC-BY-ND-2.5
+CC-BY-ND-3.0
+CC-BY-ND-4.0
+CC-BY-NC-1.0
+CC-BY-NC-2.0
+CC-BY-NC-2.5
+CC-BY-NC-3.0
+CC-BY-NC-4.0
+CC-BY-NC-ND-1.0
+CC-BY-NC-ND-2.0
+CC-BY-NC-ND-2.5
+CC-BY-NC-ND-3.0
+CC-BY-NC-ND-4.0
+CC-BY-NC-SA-1.0
+CC-BY-NC-SA-2.0
+CC-BY-NC-SA-2.5
+CC-BY-NC-SA-3.0
+CC-BY-NC-SA-4.0
+CC-BY-SA-1.0
+CC-BY-SA-2.0
+CC-BY-SA-2.5
+CC-BY-SA-3.0
+CC-BY-SA-4.0
+CC0-1.0
+Crossword
+CrystalStacker
+CUA-OPL-1.0
+Cube
+curl
+D-FSL-1.0
+diffmark
+WTFPL
+DOC
+Dotseqn
+DSDP
+dvipdfm
+EPL-1.0
+ECL-1.0
+ECL-2.0
+eGenix
+EFL-1.0
+EFL-2.0
+MIT-advertising
+MIT-enna
+Entessa
+ErlPL-1.1
+EUDatagrid
+EUPL-1.0
+EUPL-1.1
+Eurosym
+Fair
+MIT-feh
+Frameworx-1.0
+FreeImage
+FTL
+FSFAP
+FSFUL
+FSFULLR
+Giftware
+GL2PS
+Glulxe
+AGPL-3.0
+GFDL-1.1
+GFDL-1.2
+GFDL-1.3
+GPL-1.0
+GPL-2.0
+GPL-3.0
+LGPL-2.1
+LGPL-3.0
+LGPL-2.0
+gnuplot
+gSOAP-1.3b
+HaskellReport
+HPND
+IBM-pibs
+IPL-1.0
+ICU
+ImageMagick
+iMatix
+Imlib2
+IJG
+Info-ZIP
+Intel-ACPI
+Intel
+Interbase-1.0
+IPA
+ISC
+JasPer-2.0
+JSON
+LPPL-1.0
+LPPL-1.1
+LPPL-1.2
+LPPL-1.3a
+LPPL-1.3c
+Latex2e
+BSD-3-Clause-LBNL
+Leptonica
+LGPLLR
+Libpng
+libtiff
+LAL-1.2
+LAL-1.3
+LiLiQ-P-1.1
+LiLiQ-Rplus-1.1
+LiLiQ-R-1.1
+LPL-1.02
+LPL-1.0
+MakeIndex
+MTLL
+MS-PL
+MS-RL
+MirOS
+MITNFA
+MIT
+Motosoto
+MPL-1.0
+MPL-1.1
+MPL-2.0
+MPL-2.0-no-copyleft-exception
+mpich2
+Multics
+Mup
+NASA-1.3
+Naumen
+NBPL-1.0
+Net-SNMP
+NetCDF
+NGPL
+NOSL
+NPL-1.0
+NPL-1.1
+Newsletr
+NLPL
+Nokia
+NPOSL-3.0
+NLOD-1.0
+Noweb
+NRL
+NTP
+Nunit
+OCLC-2.0
+ODbL-1.0
+PDDL-1.0
+OCCT-PL
+OGTSL
+OLDAP-2.2.2
+OLDAP-1.1
+OLDAP-1.2
+OLDAP-1.3
+OLDAP-1.4
+OLDAP-2.0
+OLDAP-2.0.1
+OLDAP-2.1
+OLDAP-2.2
+OLDAP-2.2.1
+OLDAP-2.3
+OLDAP-2.4
+OLDAP-2.5
+OLDAP-2.6
+OLDAP-2.7
+OLDAP-2.8
+OML
+OPL-1.0
+OSL-1.0
+OSL-1.1
+OSL-2.0
+OSL-2.1
+OSL-3.0
+OpenSSL
+OSET-PL-2.1
+PHP-3.0
+PHP-3.01
+Plexus
+PostgreSQL
+psfrag
+psutils
+Python-2.0
+QPL-1.0
+Qhull
+Rdisc
+RPSL-1.0
+RPL-1.1
+RPL-1.5
+RHeCos-1.1
+RSCPL
+RSA-MD
+Ruby
+SAX-PD
+Saxpath
+SCEA
+SWL
+SMPPL
+Sendmail
+SGI-B-1.0
+SGI-B-1.1
+SGI-B-2.0
+OFL-1.0
+OFL-1.1
+SimPL-2.0
+Sleepycat
+SNIA
+Spencer-86
+Spencer-94
+Spencer-99
+SMLNJ
+SugarCRM-1.1.3
+SISSL
+SISSL-1.2
+SPL-1.0
+Watcom-1.0
+TCL
+TCP-wrappers
+Unlicense
+TMate
+TORQUE-1.1
+TOSL
+Unicode-DFS-2015
+Unicode-DFS-2016
+Unicode-TOU
+UPL-1.0
+NCSA
+Vim
+VOSTROM
+VSL-1.0
+W3C-20150513
+W3C-19980720
+W3C
+Wsuipa
+Xnet
+X11
+Xerox
+XFree86-1.1
+xinetd
+xpp
+XSkat
+YPL-1.0
+YPL-1.1
+Zed
+Zend-2.0
+Zimbra-1.3
+Zimbra-1.4
+Zlib
+zlib-acknowledgement
+ZPL-1.1
+ZPL-2.0
+ZPL-2.1
+eCos-2.0
+GPL-1.0+
+GPL-2.0+
+GPL-2.0-with-autoconf-exception
+GPL-2.0-with-bison-exception
+GPL-2.0-with-classpath-exception
+GPL-2.0-with-font-exception
+GPL-2.0-with-GCC-exception
+GPL-3.0+
+GPL-3.0-with-autoconf-exception
+GPL-3.0-with-GCC-exception
+LGPL-2.1+
+LGPL-3.0+
+LGPL-2.0+
+StandardML-NJ
+WXwindows
+All Rights Reserved