cpe 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.8.3"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Chris Wuest
+
+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/README.rdoc

@@ -0,0 +1,19 @@
+= cpe
+
+Description goes here.
+
+== Contributing to cpe
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Chris Wuest. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "cpe"
+  gem.homepage = "http://github.com/cwuest/ruby-cpe"
+  gem.license = "MIT"
+  gem.summary = %Q{Library for parsing and generating CPEs}
+  gem.description = %Q{Library for parsing and generating Common Platform Enumeration strings (see http://cpe.mitre.org/)}
+  gem.email = "chris@chriswuest.com"
+  gem.authors = ["Chris Wuest"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "cpe #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/cpe.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "cpe"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Chris Wuest"]
+  s.date = "2012-02-24"
+  s.description = "Library for parsing and generating Common Platform Enumeration strings (see http://cpe.mitre.org/)"
+  s.email = "chris@chriswuest.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "cpe.gemspec",
+    "lib/cpe.rb",
+    "test/helper.rb",
+    "test/test_cpe.rb"
+  ]
+  s.homepage = "http://github.com/cwuest/ruby-cpe"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Library for parsing and generating CPEs"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+  end
+end
+

data/lib/cpe.rb

@@ -0,0 +1,94 @@
+# = cpe.rb
+#
+#  Copyright (c) Chris Wuest <chris@chriswuest.com>
+#  Expectr is freely distributable under the terms of an MIT-style license.
+#  See LICENSE.txt or http://www.opensource.org/licenses/mit-license.php.
+
+# == Description
+# Cpe is a small library built to simplify working with the Common Platform
+# Enumeration spec managed by Mitre.  See http://cpe.mitre.org/ for further
+# details.
+#
+# == Examples
+# === Parsing CPE
+#
+#   cpe = Cpe.parse "cpe:/o:microsoft:windows_xp:::pro"
+#   cpe.vendor # => "microsoft"
+#   cpe.to_s # => "cpe:/o:microsoft:windows_xp:::pro:"
+#
+# === Generating CPE string
+#   cpe = Cpe.new :part => Cpe::OS
+#   cpe.vendor = "microsoft"
+#   cpe.product = "windows_xp"
+#   cpe.to_s # => "cpe:/o:microsoft:windows_xp::::"
+class Cpe
+	# Part type.  Can be /o (Cpe::OS), /a (Cpe::Application), /h (Cpe::Hardware)
+	attr_accessor :part
+	# Vendor
+	attr_accessor :vendor
+	# Product
+	attr_accessor :product
+	# Version
+	attr_accessor :version
+	# Update/patch level
+	attr_accessor :update
+	# Edition
+	attr_accessor :edition
+	# Language
+	attr_accessor :language
+
+	# 
+	# Create a new Cpe object, initializing all relevent variables to known
+	# values, or else an empty string.  Part must be one of /o, /a, /h or else
+	# be nil.
+	#
+	def initialize args={}
+		raise ArgumentError unless args.kind_of? Hash
+		raise ArgumentError unless /\/[oah]/.match args[:part].to_s or args[:part].nil?
+		@part = args[:part] || ""
+		@vendor = args[:vendor] || ""
+		@product = args[:product] || ""
+		@version = args[:version] || ""
+		@update = args[:update] || ""
+		@edition = args[:edition] || ""
+		@language = args[:language] || ""
+	end
+
+	# 
+	# Check that at least Part and one other piece of information have been
+	# collected, and generate CPE string.
+	#
+	def to_s
+		raise KeyError unless /\/[oah]/.match @part
+		raise KeyError if @vendor.to_s.empty? and @product.to_s.empty? and @version.to_s.empty? and @update.to_s.empty? and @edition.to_s.empty? and @language.to_s.empty?
+		return ["cpe", @part, @vendor, @product, @version, @update, @edition, @language].join(":").downcase
+	end
+
+	#
+	# Parse pre-existing CPE string and return new Cpe object
+	#
+	# String parsing is permissive regarding the number of trailing colons
+	# provided, filling in empty strings if needed.
+	#
+	# === Bugs
+	#
+	# * Presently unable to pass File object as input
+	#
+	def Cpe.parse cpe
+		raise ArgumentError unless cpe.kind_of? String
+		raise ArgumentError, "CPE malformed" unless /^cpe:\/[hoa]:/.match cpe and !/ /.match cpe
+
+		data = Hash.new
+		discard, data[:part], data[:vendor], data[:product], data[:version],
+		data[:update], data[:edition], data[:language] = cpe.split(/:/, 8)
+
+		return self.new data
+	end
+end
+
+# Variable for readability for "/o"
+Cpe::OS = "/o"
+# Variable for readability for "/a"
+Cpe::Application = "/a"
+# Variable for readability for "/h"
+Cpe::Hardware = "/h"

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'cpe'
+
+class Test::Unit::TestCase
+end

data/test/test_cpe.rb

@@ -0,0 +1,45 @@
+require 'helper'
+
+# CPE examples borrowed from CPE Spec document ver. 2.2
+class TestCpe < Test::Unit::TestCase
+	def setup
+		@valid = "cpe:/o:microsoft:windows_xp:::pro"
+		@invalid = ["cpe::", "cpe://redhat:enterprise_linux:3::as", "cpe:/o:redhat:Enterprise Linux:3::", ":/o:redhat:enterprise_linux:3", 4]
+	end
+
+	def test_parse_valid
+		cpe = Cpe.parse(@valid)
+		assert_equal "/o", cpe.part
+		assert_equal "microsoft", cpe.vendor
+		assert_equal "windows_xp", cpe.product
+		assert_equal "", cpe.version
+		assert_equal "", cpe.update
+		assert_equal "pro", cpe.edition
+		assert_equal "", cpe.language
+	end
+
+	def test_parse_invalid
+		@invalid.each do |cpe|
+			assert_raises(ArgumentError) { Cpe.parse(cpe) }
+		end
+	end
+
+	def test_generation
+		cpe = Cpe.new :part => Cpe::OS, :vendor => "microsoft", :product => "windows_xp", :edition => "pro"
+		assert_equal cpe.to_s, "cpe:/o:microsoft:windows_xp:::pro:"
+
+		cpe = Cpe.new :part => Cpe::Application, :vendor => "ACME", :product => "Product", :version => "1.0", :update => "update2", :edition => "-", :language => "en-us"
+		assert_equal cpe.to_s, "cpe:/a:acme:product:1.0:update2:-:en-us"
+
+		cpe = Cpe.new :part => Cpe::Hardware, :vendor => "cisco", :product => "router", :version => 3825
+		assert_equal cpe.to_s, "cpe:/h:cisco:router:3825:::"
+
+		assert_raises(ArgumentError) { Cpe.new :part => 2 }
+		assert_nothing_raised { Cpe.new }
+
+		assert_raises(KeyError) { Cpe.new.to_s }
+		assert_raises(KeyError) { Cpe.new(:part => Cpe::OS).to_s }
+		assert_raises(KeyError) { Cpe.new(:vendor => "redhat").to_s }
+		assert_nothing_raised { Cpe.new(:vendor => "redhat", :part => Cpe::OS).to_s }
+	end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: cpe
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Chris Wuest
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &11396320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *11396320
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &11413360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *11413360
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &11412000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *11412000
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &11409060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: *11409060
+description: Library for parsing and generating Common Platform Enumeration strings
+  (see http://cpe.mitre.org/)
+email: chris@chriswuest.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- cpe.gemspec
+- lib/cpe.rb
+- test/helper.rb
+- test/test_cpe.rb
+homepage: http://github.com/cwuest/ruby-cpe
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3747455494260107595
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Library for parsing and generating CPEs
+test_files: []