key_control 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0a43d357aa17e6404d6b196fb576fdf25946bdab
+  data.tar.gz: 126e9d849870e97199913868ab3ec380e6a142ec
+SHA512:
+  metadata.gz: 6bd5cc1776e64ecdee7abc6425d180a1983e2d6428860e5fc7a52f10d6082ea1b64ceeb156aaa857eae8ee48689d01194cbfa40f53292ac2ff8b6c43e3401c07
+  data.tar.gz: 5e3828a75ac5addee2ae31f590290ac1a36c96d38fcabca66cbbafcccde52150fcc1c2af603649d3c8493f0f8a10c2ea948af77a368d2eaa63804adcd2f183f4

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in key_control.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Andrew Horner
+
+MIT License
+
+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.md

@@ -0,0 +1,55 @@
+# KeyControl
+
+KeyControl is a Ruby wrapper for the `keyctl` commands available on most Linux
+systems. It provides a Hash-like API for storing and retrieving data using the
+kernel's built-in key management facilities.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'key_control'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install key_control
+
+## Usage
+
+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),
+which are available for use as constants in the `KeyControl` module.
+
+As an example, we'll create a basic accessor for the session keyring (useful for sharing information among several grouped processes):
+```ruby
+keyring = KeyControl::KeyRing.new(KeyControl::SESSION)
+```
+
+Once you have your keyring instance, just treat it like you would a hash:
+```ruby
+keyring["mykey"] = "my passphrase"
+keyring["mykey"]
+# => "my passphrase"
+```
+
+That's it! The power of this gem comes from the ability to use your kernel's
+built-in key management mechanism to share information between Ruby processes
+without exposing your data to the outside world.
+
+## Future Enhancements
+
+- Improved `libkeyutils` shared object library detection
+- Basic keyring management (creation, specifically)
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/key_control/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/key_control.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'key_control/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "key_control"
+  spec.version       = KeyControl::VERSION
+  spec.authors       = ["Andrew Horner"]
+  spec.email         = ["andrew@tablexi.com"]
+  spec.summary       = "A simple wrapper for the `keyctl` utility."
+  spec.description   = <<-TEXT
+    Provides a Hash-like syntax for storing and retrieving data from the
+    system's keyctl utility.
+  TEXT
+
+  spec.homepage      = "https://github.com/ahorner/key_control"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/lib/key_control/key_ring.rb

@@ -0,0 +1,54 @@
+module KeyControl
+
+  class KeyRing
+
+    # Public: Get a new KeyControl::KeyRing instance with the specified keyring
+    # identifier.
+    #
+    # keyring - A String or Integer identifying the desired keyring.
+    #
+    # Returns a KeyControl::KeyRing instance.
+    def initialize(keyring)
+      @keyring = keyring
+      @system = System.new
+    end
+
+    # Public: Add the requested data to the keychain for the given description.
+    #
+    # name - The description of the data.
+    # data - The data to store in the keychain.
+    #
+    # Returns nothing.
+    def []=(name, data)
+      execute(:add, "user", name, data, data.length, @keyring)
+    end
+
+    # Public: Get the data matching the passed description from the keychain.
+    #
+    # name - The description of the data for which to search.
+    #
+    # Returns the requested data or nil.
+    def [](name)
+      handle = execute(:search, "user", name, nil, @keyring)
+      return nil if handle == -1
+
+      length = execute(:read, handle, "", 0)
+      buffer = "0" * length
+      execute(:read, handle, buffer, length)
+
+      buffer
+    end
+
+    private
+
+    # Private: Execute the requested action in keyctl.
+    #
+    # action - The action to perform.
+    # args   - A list of arguments which should be passed to the action.
+    #
+    # Returns the stdout value returned by the call.
+    def execute(action, *args)
+      @system.send(action).call(*args)
+    end
+  end
+end

data/lib/key_control/system.rb

@@ -0,0 +1,59 @@
+require "fiddle"
+
+module KeyControl
+
+  class System
+
+    # Public: Get a proc representing the add_key system call.
+    #
+    # Returns a Fiddle::Function.
+    def add
+      @add ||= Fiddle::Function.new(
+        keyutils["add_key"],
+        [ Fiddle::ALIGN_CHAR,
+          Fiddle::ALIGN_CHAR,
+          Fiddle::TYPE_VOIDP,
+          Fiddle::TYPE_SIZE_T,
+          Fiddle::TYPE_INT ],
+        Fiddle::TYPE_INT )
+    end
+
+    # Public: Get a proc representing the request_key system call.
+    #
+    # Returns a Fiddle::Function.
+    def search
+      @search ||= Fiddle::Function.new(
+        keyutils["request_key"],
+        [ Fiddle::ALIGN_CHAR,
+          Fiddle::ALIGN_CHAR,
+          Fiddle::ALIGN_CHAR,
+          Fiddle::TYPE_INT ],
+        Fiddle::TYPE_INT )
+    end
+
+    # Public: Get a proc representing the keyctl_read system call.
+    #
+    # Returns a Fiddle::Function.
+    def read
+      @read ||= Fiddle::Function.new(
+        keyutils["keyctl_read"],
+        [ Fiddle::TYPE_INT,
+          Fiddle::ALIGN_CHAR,
+          Fiddle::TYPE_SIZE_T ],
+        Fiddle::TYPE_LONG )
+    end
+
+    private
+
+    # Private: Get a handle representing the system calls available through
+    # libkeyutils.so.
+    # TODO: For now, we assume that the shared object file is in the default
+    # location for CentOS installations. It would be nice to make this more
+    # flexible.
+    #
+    # Returns a Fiddle::Handle.
+    def keyutils
+      @keyutils ||= Fiddle::Handle.new("/lib64/libkeyutils.so.1")
+    end
+  end
+end

data/lib/key_control/version.rb

@@ -0,0 +1,3 @@
+module KeyControl
+  VERSION = "0.0.1"
+end

data/lib/key_control.rb

@@ -0,0 +1,13 @@
+require "key_control/version"
+require "key_control/system"
+require "key_control/key_ring"
+
+module KeyControl
+
+  THREAD  = -1
+  PROCESS = -2
+  SESSION = -3
+  USER    = -4
+  DEFAULT = -5
+  GROUP   = -6
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: key_control
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Horner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      Provides a Hash-like syntax for storing and retrieving data from the
+      system's keyctl utility.
+email:
+- andrew@tablexi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- key_control.gemspec
+- lib/key_control.rb
+- lib/key_control/key_ring.rb
+- lib/key_control/system.rb
+- lib/key_control/version.rb
+homepage: https://github.com/ahorner/key_control
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: A simple wrapper for the `keyctl` utility.
+test_files: []