key_control 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a784b53837348d3fcba7ffc9f84e65c6a9d040b
-  data.tar.gz: 229ba84f2e41c534c7097295c94d7bf6b97e2ddf
+  metadata.gz: e1ae894b32a61b12e85b7ba01c280974f6bcca55
+  data.tar.gz: 687ea1f4369b0753b879e61dfe875742a121fbf5
 SHA512:
-  metadata.gz: eb8c382abdfaf975048c30b55067a7d0ab08ff920545eb900ef180b4ffd9b8044284d7d1d4349a1802d4fd7639ed2a759864832c106f457cff640ec3ec72b7ee
-  data.tar.gz: 88eac2321abe8781fda47e4e04d05f83875d241a2bc11294288ce0dffb77199705402c871cfa4b0a5a125d634c44ab3adddd2cd42005d6156f41de2a4aaf9235
+  metadata.gz: e8608272a5c149c1b536fb888645508236c14ea1f546302dbf8b26c262e01cc6cf738f8f2e05df45948934a42f92305fd84b73af5f67c5c694ce6364fa9b24e3
+  data.tar.gz: 83d071c944ecdecd8ded2653bd268ef002344d151706b501fe03dc29bf1529da9488679b2c32cfb09f71ce36839aa2779847ce50408392ede965e1c55aaaf320

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.vagrant

data/README.md

@@ -20,6 +20,14 @@ Or install it yourself as:
 
 ## Usage
 
+### Availability
+
+You can check if `KeyControl` is supported on your system with
+`KeyControl.available?`. This will attempt to locate a libkeyutils shared
+library on the system, and return a boolean based on detection.
+
+### Key Storage/Retrieval
+
 The basic API consists of a single class, `KeyControl::KeyRing`. The `KeyRing`
 initializer takes a single argument, the ID of the keyring you wish to store
 your data in. There are several (very useful) [special keyrings](http://manpages.ubuntu.com/manpages/oneiric/man1/keyctl.1.html),
@@ -43,8 +51,7 @@ without exposing your data to the outside world.
 
 ## Future Enhancements
 
-- Improved `libkeyutils` shared object library detection
-- Basic keyring management (creation, specifically)
+- Non-default keyring management (creation, specifically)
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,25 @@
 require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+desc "Bring up Vagrant VM for testing"
+task "vagrant:up" do
+  # `unset` call due to https://github.com/mitchellh/vagrant/issues/3193
+  system("unset RUBYLIB RUBYOPT; vagrant up")
+end
+
+
+task :default do
+  if RUBY_PLATFORM =~ /linux/
+    Rake::Task['test'].invoke
+  else
+    Rake::Task['vagrant:up'].invoke
+    # `unset` call due to https://github.com/mitchellh/vagrant/issues/3193
+    system("unset RUBYLIB RUBYOPT; vagrant ssh -c 'cd /vagrant && bundle && rake test'")
+  end
+end

data/Vagrantfile

@@ -0,0 +1,27 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# Vagrantfile API/syntax version. Don't touch unless you know what you're doing!
+VAGRANTFILE_API_VERSION = "2"
+DEFAULT_RUBY = "2.0.0-p451"
+
+Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
+  config.vm.box = "chef/centos-6.5"
+  config.vm.box_url = "https://vagrantcloud.com/chef/centos-6.5/version/1/provider/virtualbox.box"
+
+  config.vm.provision "shell", inline: <<-PROVISIONER
+    yum update -y
+    wget http://dl.fedoraproject.org/pub/epel/6/x86_64/epel-release-6-8.noarch.rpm
+    wget http://rpms.famillecollet.com/enterprise/remi-release-6.rpm
+    rpm -Uvh remi-release-6*.rpm epel-release-6*.rpm
+    yum install git libffi-devel openssl-devel readline-devel -y
+    yum groupinstall "Development Tools" -y
+    sudo -u vagrant git clone https://github.com/sstephenson/rbenv.git ~vagrant/.rbenv
+    sudo -u vagrant echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~vagrant/.bash_profile
+    sudo -u vagrant echo 'eval "$(rbenv init -)"' >> ~vagrant/.bash_profile
+    sudo -u vagrant git clone https://github.com/sstephenson/ruby-build.git ~vagrant/.rbenv/plugins/ruby-build
+    sudo -u vagrant -i rbenv install #{DEFAULT_RUBY}
+    sudo -u vagrant -i rbenv global #{DEFAULT_RUBY}
+    sudo -u vagrant -i gem install bundler
+  PROVISIONER
+end

data/lib/key_control/key_ring.rb

@@ -33,7 +33,7 @@ module KeyControl
       return nil if handle == -1
 
       length = execute(:read, handle, "", 0)
-      buffer = "0" * length
+      buffer = "\x00" * length
       execute(:read, handle, buffer, length)
 
       buffer

data/lib/key_control/system.rb

@@ -50,13 +50,13 @@ module KeyControl
     #
     # Returns a Fiddle::Handle.
     def keyutils
-      @keyutils ||= KeyControl::LIBRARIES.map do |library|
+      @keyutils ||= KeyControl::LIBRARIES.detect do |library|
         begin
-          Fiddle::Handle.new(library)
+          break Fiddle::Handle.new(library)
         rescue Fiddle::DLError
           nil
         end
-      end.compact.first
+      end
     end
   end
 end

data/lib/key_control/version.rb

@@ -1,3 +1,3 @@
 module KeyControl
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/key_control.rb

@@ -13,16 +13,29 @@ module KeyControl
   DEFAULT = -5
   GROUP   = -6
 
-  # A list of potential library paths. Currently points to the default path for
-  # CentOS installations.
-  # TODO: Track down and add the default library paths for more distros.
+  # A list of potential library paths. Currently looks for the default shared
+  # libraries on CentOS installations.
   LIBRARIES = %w(
-    /lib64/libkeyutils.so.1 )
+    libkeyutils.so
+    libkeyutils.so.1 )
 
-  # Public: Does KeyControl detect any known keyutils libraries?
+  # Public: Shared library names.
+  #
+  # Returns an Array.
+  def self.library_names
+    LIBRARIES
+  end
+
+  # Public: Is a libkeyutils shared library detected on this system?
   #
   # Returns a boolean.
   def self.available?
-    LIBRARIES.any? { |library| File.exists?(library) }
+    library_names.any? do |library_name|
+      begin
+        Fiddle::Handle.new(library_name)
+      rescue Fiddle::DLError
+        false
+      end
+    end
   end
 end

data/test/key_control/key_ring_test.rb

@@ -0,0 +1,92 @@
+require "test_helper"
+
+describe KeyControl::KeyRing do
+
+  describe "thread keyring" do
+    let(:ring) do
+      KeyControl::KeyRing.new(KeyControl::THREAD)
+    end
+
+    it "allows read/write for values in the same thread" do
+      ring["testing"] = "testdata"
+      ring["testing"].must_equal "testdata"
+    end
+
+    it "uses a new keyring for new threads" do
+      ring["thread_test"].must_equal nil
+      thr = Thread.new do
+        ring["thread-test"] = "testdata"
+      end
+      thr.join
+
+      ring["thread-test"].must_equal nil
+    end
+  end
+
+  describe "process keyring" do
+    let(:ring) do
+      KeyControl::KeyRing.new(KeyControl::PROCESS)
+    end
+
+    it "allows read/write of values in the same process" do
+      ring["process-test-1"] = "foobar"
+      ring["process-test-1"].must_equal "foobar"
+    end
+
+    it "allows read/write of values across threads in the same process" do
+      ring["process-thread-test"].must_equal nil
+
+      thr = Thread.new do
+        ring["process-thread-test"] = "baz"
+      end
+      thr.join
+
+      ring["process-thread-test"].must_equal "baz"
+    end
+
+    it "uses a new keyring for new processes" do
+      ring["child-process-test"].must_equal nil
+
+      pid = fork do
+        ring["child-process-test"] = "too many secrets"
+        exit
+      end
+
+      Process.waitpid(pid)
+      ring["child-process-test"].must_equal nil
+    end
+  end
+
+  describe "session keyring" do
+    let(:ring) do
+      KeyControl::KeyRing.new(KeyControl::SESSION)
+    end
+
+    it "allows read/write of values in the same process" do
+      ring["session-test"] = "foobar"
+      ring["session-test"].must_equal "foobar"
+    end
+
+    it "allows read/write of values across threads in the same process" do
+      ring["session-thread-test"].must_equal nil
+      thr = Thread.new do
+        ring["session-thread-test"] = "baz"
+      end
+      thr.join
+
+      ring["session-thread-test"].must_equal "baz"
+    end
+
+    it "allows read/write of values across processes in the same session" do
+      ring["session-process-test"].must_equal nil
+
+      pid = fork do
+        ring["session-process-test"] = "too many secrets"
+        exit
+      end
+
+      Process.waitpid(pid)
+      ring["session-process-test"].must_equal "too many secrets"
+    end
+  end
+end

data/test/key_control_test.rb

@@ -0,0 +1,16 @@
+require "test_helper"
+
+describe KeyControl do
+
+  describe ".available?" do
+    it "returns false if the keyctl library can not be found" do
+      KeyControl.stub(:library_names, %w[badlib]) do
+        KeyControl.available?.must_equal false
+      end
+    end
+
+    it "returns true if the keyctl library is available" do
+      KeyControl.available?.must_equal true
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+require "minitest/unit"
+require "minitest/autorun"
+require "minitest/mock"
+require "key_control"
+
+if RUBY_PLATFORM !~ /linux/
+  raise "The test suite must be run on Linux"
+elsif
+  system("/sbin/ldconfig -p | grep -i libkeyutils.so > /dev/null 2>&1") ||
+    raise("libkeyutils is not available")
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: key_control
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Andrew Horner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-28 00:00:00.000000000 Z
+date: 2014-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,11 +52,15 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- Vagrantfile
 - key_control.gemspec
 - lib/key_control.rb
 - lib/key_control/key_ring.rb
 - lib/key_control/system.rb
 - lib/key_control/version.rb
+- test/key_control/key_ring_test.rb
+- test/key_control_test.rb
+- test/test_helper.rb
 homepage: https://github.com/ahorner/key_control
 licenses:
 - MIT
@@ -81,4 +85,7 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A simple wrapper for the `keyctl` utility.
-test_files: []
+test_files:
+- test/key_control/key_ring_test.rb
+- test/key_control_test.rb
+- test/test_helper.rb