key_control 0.0.5 → 0.0.6

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MmI3Yjk3YjQwODc1ZDcxZjVmYzBhZDgzYmY0MmE3NDAwZWZkNjBiNg==
-  data.tar.gz: !binary |-
-    ZDcxNmJmYWFiMjE0MThjZTFkY2ViZTk1Y2Q5YjA0N2NhYjEyNDVkMA==
+SHA1:
+  metadata.gz: ff77033d493fe7d5c4d3efce964e1a01500cc24e
+  data.tar.gz: c6d31ad1d873ac69378ffb75c5033373904e5286
 SHA512:
-  metadata.gz: !binary |-
-    NzNlMjRhOGNlOTdjODRkYjE1ZTQ4NjhmZTM2Y2RjYTc2ZGQzNDMzYThhMzcx
-    Y2RkNmI2Y2ZkMzhjNGNlYTllNWE2NGNkNTYwYmE0ZmY3NGEwMGUyZjI1OWEz
-    ZWQyOWVlYTAxYTJjMjIwM2VjNWE5NGMwMjBiYjlkNThmNGZkYmM=
-  data.tar.gz: !binary |-
-    MjA2ZWYyMTgyM2Q1NDMwMGZiNWNhYzgwNjQxYTJhZWQ4ODQxOWU4MWE0NjFm
-    ZjAxNTM4NmM4ZWE1OTAyNWMxYjBhNTg4N2E1MThkNTU4MjdlNTg1MWRjZjIx
-    MWJiM2RlZjRhOTBjYTAyNTg2Y2IwMDAyMzNhYzNlMzRkMmNkMTA=
+  metadata.gz: 9b4d8dcd0de20f4ab26b6b333cd88ed8ba3fb0f6e7a00377fc58a8946d3fde3336af9578eac512fa9f32e03ce01b1c08b9ccd4b722890843f8d778f2ade51188
+  data.tar.gz: 5bd6485baefafc81a7f2224df367afb1c3247ed71fa5783f3fb5f485634bf742648b5db3adb0bd253dfe90621d09a3ae6572cd3026c1aa52a24f17af9943ed4f

data/README.md

@@ -33,30 +33,56 @@ 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):
+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:
+Once you have your keyring instance, just add and fetch values like you would
+with any regular 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
+That's it! The power of this gem is 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
+### Key Deletion/Expiration
 
-- Non-default keyring management (creation, specifically)
+There are two options to remove values from the current keyring. You can
+remove a piece of data immediately with `KeyRing#delete`:
+```ruby
+keyring.delete("mykey")
+keyring["mykey"]
+# => nil
+```
+
+Alternately, if you need temporary access to the key, but want to ensure that
+it will be removed from the keyring at some point in the future,
+`KeyRing#set_timeout` is available:
+```ruby
+keyring.set_timeout("mykey", 3)
+keyring["mykey"]
+# => "my passphrase"
+sleep 4
+keyring["mykey"]
+# => nil
+```
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/key_control/fork )
+1. Fork it ( http://github.com/ahorner/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
+
+### Thanks
+
+- @gabrielg: For refactoring the library detection, and setting up a slick
+  vagrant test suite.
+- @qfire: For contributing the handy `unlink` and `set_timeout` operations.

data/lib/key_control/key_ring.rb

@@ -36,5 +36,26 @@ module KeyControl
 
       system.get(:read, handle)
     end
+
+    # Public: Remove the data matching the passed description from the keychain.
+    #
+    # name - The description of the data to remove.
+    #
+    # Returns nothing.
+    def delete(name)
+      handle = system.run!(:search, "user", name, nil, @keyring)
+      system.run!(:unlink, handle, @keyring)
+    end
+
+    # Public: Set a timeout for the data matching the passed description.
+    #
+    # name    - The description of the data for which to set a timeout.
+    # timeout - The timeout to set in seconds.
+    #
+    # Returns nothing.
+    def set_timeout(name, timeout)
+      handle = system.run!(:search, "user", name, nil, @keyring)
+      system.run!(:set_timeout, handle, timeout)
+    end
   end
 end

data/lib/key_control/system.rb

@@ -14,6 +14,21 @@ module KeyControl
       send(action).call(*args)
     end
 
+    # Public: Execute the requested action in keyctl, raising an error on
+    # failure.
+    #
+    # 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.
+    # Raises a SystemCallError if the requested system call fails.
+    def run!(action, *args)
+      result = run(action, *args)
+      raise SystemCallError.new(action.to_s, Fiddle.last_error) if result == -1
+
+      result
+    end
+
     # Public: Execute the requested keyctl action, buffering the output into a
     # string in multiple passes.
     #
@@ -70,6 +85,18 @@ module KeyControl
         Fiddle::TYPE_INT )
     end
 
+    # Private: 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: Get a proc representing the request_key system call.
     #
     # Returns a Fiddle::Function.
@@ -83,15 +110,25 @@ module KeyControl
         Fiddle::TYPE_INT )
     end
 
-    # Private: Get a proc representing the keyctl_read system call.
+    # Private: Get a proc representing the keyctl_set_timeout system call.
     #
     # Returns a Fiddle::Function.
-    def read
-      @read ||= Fiddle::Function.new(
-        keyutils["keyctl_read"],
+    def set_timeout
+      @set_timeout ||= Fiddle::Function.new(
+        keyutils["keyctl_set_timeout"],
         [ Fiddle::TYPE_INT,
-          Fiddle::ALIGN_CHAR,
-          Fiddle::TYPE_SIZE_T ],
+          Fiddle::TYPE_INT ],
+        Fiddle::TYPE_LONG )
+    end
+
+    # Private: Get a proc representing the keyctl_unlink system call.
+    #
+    # Returns a Fiddle::Function.
+    def unlink
+      @unlink ||= Fiddle::Function.new(
+        keyutils["keyctl_unlink"],
+        [ Fiddle::ALIGN_INT,
+          Fiddle::ALIGN_INT ],
         Fiddle::TYPE_LONG )
     end
   end

data/lib/key_control/version.rb

@@ -1,3 +1,3 @@
 module KeyControl
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/test/key_control/key_ring_test.rb

@@ -2,6 +2,19 @@ require "test_helper"
 
 describe KeyControl::KeyRing do
   let(:secret) { "the secret time forgot" }
+  let(:key) { "my-key" }
+
+  before do
+    ring[key].must_equal nil
+  end
+
+  after do
+    begin
+      ring.delete(key)
+    rescue SystemCallError
+      # Ignore keys which aren't set
+    end
+  end
 
   describe "thread keyring" do
     let(:ring) do
@@ -9,19 +22,27 @@ describe KeyControl::KeyRing do
     end
 
     it "allows read/write for values in the same thread" do
-      key = "single-thread-test"
-      ring[key].must_equal nil
-
       ring[key] = secret
       ring[key].must_equal secret
     end
 
     it "uses a new keyring for new threads" do
-      key = "multi-thread-test"
+      Thread.new { ring[key] = secret }.join
+
       ring[key].must_equal nil
+    end
 
-      Thread.new { ring[key] = secret }.join
+    it "raises an exception when deleting a key which has not been set" do
+      -> { ring.delete key }.must_raise Errno::ENOKEY
+    end
+
+    it "allows an expiration timeout to be set on a key" do
+      timeout = 1
+      ring[key] = secret
+      ring.set_timeout(key, timeout)
 
+      ring[key].must_equal secret
+      sleep timeout + 0.1
       ring[key].must_equal nil
     end
   end
@@ -32,26 +53,17 @@ describe KeyControl::KeyRing do
     end
 
     it "allows read/write of values in the same process" do
-      key = "single-process-test"
-      ring[key].must_equal nil
-
       ring[key] = secret
       ring[key].must_equal secret
     end
 
     it "allows read/write of values across threads in the same process" do
-      key = "process-thread-test"
-      ring[key].must_equal nil
-
       Thread.new { ring[key] = secret }.join
 
       ring[key].must_equal secret
     end
 
     it "uses a new keyring for new processes" do
-      key = "multi-process-test"
-      ring[key].must_equal nil
-
       pid = fork { ring[key] = secret and exit }
       Process.waitpid(pid)
 
@@ -65,30 +77,24 @@ describe KeyControl::KeyRing do
     end
 
     it "allows read/write of values in the same thread/process" do
-      key = "session-test"
-      ring[key].must_equal nil
-
       ring[key] = secret
       ring[key].must_equal secret
+      ring.delete key
     end
 
     it "allows read/write of values across threads in the same process" do
-      key = "session-thread-test"
-      ring[key].must_equal nil
-
       Thread.new { ring[key] = secret }.join
 
       ring[key].must_equal secret
+      ring.delete key
     end
 
     it "allows read/write of values across processes in the same session" do
-      key = "session-process-test"
-      ring[key].must_equal nil
-
       pid = fork { ring[key] = secret and exit }
       Process.waitpid(pid)
 
       ring[key].must_equal secret
+      ring.delete key
     end
   end
 end

metadata

@@ -1,52 +1,53 @@
 --- !ruby/object:Gem::Specification
 name: key_control
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Andrew Horner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-14 00:00:00.000000000 Z
+date: 2014-10-16 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: ! "    Provides a Hash-like syntax for storing and retrieving data from
-  the\n    system's keyctl utility.\n"
+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
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -70,12 +71,12 @@ 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: []