keyutils 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6213f48145ec2d4753b4aee0d9548ba589695058
+  data.tar.gz: 58ab32a041df3267482516366d46dacfbc982d06
+SHA512:
+  metadata.gz: b64b8ead7edc387485ba92318ec6c278e692c0189254a6f00fd4d0981471c21e13a8a0eceebceba553a07c0ae9726361510e327a69766eb159348c03ff93ca7d
+  data.tar.gz: 495c16a4226d589208cbd1e285330ee27efb4d5ae35833575489c77eb9493de59afff10730def7984701f681cca3697866e7cc8775edba12674910e50829165d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.7
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Rafał Rzepecki
+
+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,41 @@
+# Keyutils
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/keyutils`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'keyutils'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install keyutils
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/keyutils.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "keyutils"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/keyutils.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'keyutils/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "keyutils"
+  spec.version       = Keyutils::VERSION
+  spec.authors       = ["Rafał Rzepecki"]
+  spec.email         = ["divided.mind@gmail.com"]
+
+  spec.summary       = %q{Wrapper for Linux keyutils library}
+  spec.description   = %q{FFI-based wrapper for Linux keyutils library, providing idiomatic Ruby access to the kernel keyring.}
+  spec.homepage      = "https://github.com/dividedmind/ruby-keyutils"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "ffi", "~> 1.9"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+end

data/lib/keyutils.rb

@@ -0,0 +1,11 @@
+require "keyutils/version"
+require "keyutils/lib"
+require "keyutils/key"
+require "keyutils/keyring"
+require "keyutils/key_perm"
+
+module Keyutils
+  LIBRARY_VERSION = Lib.keyutils_version_string[/[\d.]+/].freeze
+
+  include KeyPerm
+end

data/lib/keyutils/key.rb

@@ -0,0 +1,572 @@
+require 'keyutils/key_perm'
+
+module Keyutils
+  class Key
+    # Numeric identifier of the key this object points to.
+    #
+    # @return [Fixnum] key serial number or one of {Lib::KEY_SPEC}
+    # @see #serial
+    attr_accessor :id
+    alias to_i id
+    alias hash id
+
+    # Get the serial number of this key.
+    #
+    # For ordinary keys, {#serial} == {#id}, and this method always succeeds.
+    #
+    # For special key handles (such as {Keyring::Session}), this method
+    # will resolve the actual serial number of the key it points to.
+    #
+    # Note if this is a special key handle and the key(ring) is not already
+    # instantiated, calling this method will attempt to create it. For this
+    # reason it can fail if memory or quota is exhausted.
+    #
+    # @return [Fixnum] serial number of this key
+    # @raise [Errno::ENOKEY] no matching key was found
+    # @raise [Errno::ENOMEM] insufficient memory to create a key
+    # @raise [Errno::EDQUOT] the key quota for this user would be exceeded by
+    #   creating this key or linking it to the keyring
+    # @see #exists?
+    # @see #id
+    def serial
+      return id unless id < 0
+      Lib.keyctl_get_keyring_ID id, true
+    end
+
+    # Check if this key exists in the kernel.
+    #
+    # The key may not exist eg. if it has been removed by another process, or if
+    # this is a special keyring handle (such as {Keyring::Thread}) and the
+    # keyring has not been instantiated yet.
+    #
+    # @return [Boolean] true if the key exists
+    def exists?
+      Lib.keyctl_get_keyring_ID(id, false) && true
+    rescue Errno::EACCES
+      true
+    rescue Errno::ENOKEY
+      false
+    end
+
+    # Update the payload of the key if the key type permits it.
+    #
+    # The caller must have write permission on the key to be able to update it.
+    #
+    # +payload+ specifies the data for the new payload; it may be nil
+    # if the key type permits that. The key type may reject the data if it's
+    # in the wrong format or in some other way invalid.
+    #
+    # @param payload [#to_s, nil] data for the new key payload
+    # @return [Key] self
+    # @raise [Errno::ENOKEY] the key is invalid
+    # @raise [Errno::EKEYEXPIRED] the key has expired
+    # @raise [Errno::EKEYREVOKED] the key had been revoked
+    # @raise [Errno::EINVAL] the payload data was invalid
+    # @raise [Errno::ENOMEM] insufficient memory to store the new payload
+    # @raise [Errno::EDQUOT] the key quota for this user would be exceeded by
+    #   increasing the size of the key to accommodate the new payload
+    # @raise [Errno::EACCES] the key exists, but is not writable by the
+    #   calling process
+    # @raise [Errno::EOPNOTSUPP] the key type does not support the update
+    #   operation on its keys
+    def update payload
+      Lib.keyctl_update \
+          id,
+          payload && payload.to_s,
+          payload && payload.to_s.length || 0
+      self
+    end
+
+    # Mark the key as being revoked.
+    #
+    # After this operation has been performed on a key, attempts to access it
+    # will meet with error EKEYREVOKED.
+    #
+    # The caller must have write permission on a key to be able revoke it.
+    #
+    # @return [Key] self
+    # @raise [Errno::ENOKEY] the key does not exist
+    # @raise [Errno::EKEYREVOKED] the key has already been revoked
+    # @raise [Errno::EACCES] the key exists, but is not writable by the
+    #   calling process
+    # @see #invalidate
+    def revoke
+      Lib.keyctl_revoke id
+      self
+    end
+
+    # Change the user and group ownership details of the key.
+    #
+    # A setting of -1 or nil on either +uid+ or +gid+ will cause that setting
+    # to be ignored.
+    #
+    # A process that does not have the _SysAdmin_ capability may not change a
+    # key's UID or set the key's GID to a value that does not match the
+    # process's GID or one of its group list.
+    #
+    # The caller must have _setattr_ permission on a key to be able change its
+    # ownership.
+    #
+    # @param uid [Fixnum, nil] numeric UID of the new owner
+    # @param gid [Fixnum, nil] numeric GID of the new owning group
+    # @return [Key] self
+    # @raise [Errno::ENOKEY] the key does not exist
+    # @raise [Errno::EKEYEXPIRED] the key has expired
+    # @raise [Errno::EKEYREVOKED] the key has been revoked
+    # @raise [Errno::EDQUOT] changing the UID to the one specified would run
+    #   that UID out of quota
+    # @raise [Errno::EACCES] the key exists, but does not grant setattr
+    #   permission to the calling process; or insufficient process permissions
+    # @see #setperm
+    # @see #uid
+    # @see #gid
+    def chown uid = nil, gid = nil
+      Lib.keyctl_chown id, uid || -1, gid || -1
+      self
+    end
+
+    # Change the permissions mask on the key.
+    #
+    # A process that does not have the _SysAdmin_ capability may not change the
+    # permissions mask on a key that doesn't have the same UID as the caller.
+    #
+    # The caller must have _setattr_ permission on a key to be able change its
+    # permissions mask.
+    #
+    # The permissions mask is a bitwise-OR of the following flags:
+    # - +KEY_xxx_VIEW+
+    #   Grant permission to view the attributes of a key.
+    #
+    # - +KEY_xxx_READ+
+    #   Grant permission to read the payload of a key or to list a keyring.
+    # - +KEY_xxx_WRITE+
+    #   Grant permission to modify the payload of a key or to add or remove
+    #   links to/from a keyring.
+    # - +KEY_xxx_SEARCH+
+    #   Grant permission to find a key or to search a keyring.
+    # - +KEY_xxx_LINK+
+    #   Grant permission to make links to a key.
+    # - +KEY_xxx_SETATTR+
+    #   Grant permission to change the ownership and permissions attributes of
+    #   a key.
+    # - +KEY_xxx_ALL+
+    #   Grant all the above.
+    #
+    # The 'xxx' in the above should be replaced by one of:
+    # - +POS+ Grant the permission to a process that possesses the key (has it
+    #   attached searchably to one of the process's keyrings).
+    # - +USR+ Grant the permission to a process with the same UID as the key.
+    # - +GRP+ Grant the permission to a process with the same GID as the key,
+    #   or with a match for the key's GID amongst that process's Groups list.
+    # - +OTH+ Grant the permission to any other process.
+    #
+    # Examples include: {KEY_POS_VIEW}, {KEY_USR_READ}, {KEY_GRP_SEARCH} and
+    # {KEY_OTH_ALL}.
+    #
+    # User, group and other grants are exclusive: if a process qualifies in
+    # the 'user' category, it will not qualify in the 'groups' category; and
+    # if a process qualifies in either 'user' or 'groups' then it will not
+    # qualify in the 'other' category.
+    #
+    # Possessor grants are cumulative with the grants from the 'user',
+    # 'groups' and 'other' categories.
+    #
+    # @param permissions [Fixnum] permission mask; bitwise OR-ed constants from
+    #   {KeyPerm}
+    # @return [Key] self
+    # @raise [Errno::ENOKEY] the key does not exist
+    # @raise [Errno::EKEYEXPIRED] the key has expired
+    # @raise [Errno::EKEYREVOKED] the key has been revoked
+    # @raise [Errno::EACCES] the key exists, but does not grant setattr
+    #   permission to the calling process
+    # @see #perm
+    def setperm permissions
+      Lib.keyctl_setperm id, permissions
+      self
+    end
+
+    # @return [Symbol] the key type name
+    def type
+      @type ||= describe[:type]
+    end
+
+    # @return [String] the key description
+    def description
+      @description ||= describe[:desc]
+    end
+
+    # @return [Fixnum] the key UID
+    # @see #gid
+    # @see #describe
+    # @see #chown
+    def uid
+      describe[:uid]
+    end
+
+    # @return [Fixnum] the key GID
+    # @see #uid
+    # @see #describe
+    # @see #chown
+    def gid
+      describe[:gid]
+    end
+
+    # @return [Fixnum] the key permission mask
+    # @see #setperm
+    # @see #describe
+    def perm
+      describe[:perm]
+    end
+
+    # Describe the attributes of the key.
+    #
+    # The caller must have view permission on a key to be able to get
+    # attributes of it.
+    #
+    # Attributes are returned as a hash of the following keys:
+    # - +:type+ [Symbol],
+    # - +:uid+ [Fixnum],
+    # - +:gid+ [Fixnum],
+    # - +:perm+ [Fixnum],
+    # - +:desc+ [String].
+    #
+    # @return [Hash] key attributes
+    # @see #type
+    # @see #uid
+    # @see #gid
+    # @see #perm
+    # @see #description
+    # @raise [Errno::ENOKEY] the key is invalid
+    # @raise [Errno::EKEYEXPIRED] the key has expired
+    # @raise [Errno::EKEYREVOKED] the key had been revoked
+    # @raise [Errno::EACCES] the key is not viewable by the calling process
+    def describe
+      buf = FFI::MemoryPointer.new :char, 64
+      len = Lib.keyctl_describe id, buf, buf.size
+      while len > buf.size
+        buf = FFI::MemoryPointer.new :char, len
+        len = Lib.keyctl_describe id, buf, buf.size
+      end
+      Key.send :parse_describe, buf.read_string(len - 1)
+    end
+
+    # Read the key.
+    #
+    # Reads the payload of a key if the key type supports it.
+    #
+    # The caller must have read permission on a key to be able to read it.
+    #
+    # @return [String] the key payload
+    # @raise [Errno::ENOKEY] the key is invalid
+    # @raise [Errno::EKEYEXPIRED] the key has expired
+    # @raise [Errno::EKEYREVOKED] the key had been revoked
+    # @raise [Errno::EACCES] the key exists, but is not readable by the
+    #   calling process
+    # @raise [Errno::EOPNOTSUPP] the key type does not support reading of the
+    #   payload data
+    def read
+      buf = FFI::MemoryPointer.new :char, 64
+      len = Lib.keyctl_read id, buf, buf.size
+      while len > buf.size
+        buf = FFI::MemoryPointer.new :char, len
+        len = Lib.keyctl_read id, buf, buf.size
+      end
+      buf.read_string len
+    end
+
+    alias to_s read
+
+    # Instantiate a key
+    #
+    # Instantiate the payload of an uninstantiated key from the data specified.
+    # +payload+ specifies the data for the new payload. +payload+ may be nil
+    # if the key type permits that. The key type may reject the data if it's
+    # in the wrong format or in some other way invalid.
+    #
+    # Only a key for which authority has been assumed may be instantiated or
+    # negatively instantiated, and once instantiated, the authorisation key
+    # will be revoked and the requesting process will be able to resume.
+    #
+    # The +destination+ keyring, if given, is assumed to belong to the initial
+    # requester, and not the instantiating process. Therefore, the special
+    # keyring objects (such as {Keyring::Session}) refer to the requesting
+    # process's keyrings, not the caller's, and the requester's UID, etc. will
+    # be used to access them.
+    #
+    # The +destination+ keyring can be nil if no extra link is desired.
+    #
+    # The requester, not the caller, must have write permission on the
+    # +destination+ for a link to be made there.
+    # @param payload [String, nil] the payload to instantiate the key with
+    # @param destination [Keyring, nil] keyring to link the key to
+    # @return [Key] self
+    # @raise [Errno::ENOKEY] the key or specified keyring is invalid
+    # @raise [Errno::EKEYEXPIRED] the keyring specified has expired
+    # @raise [Errno::EKEYREVOKED] the key or keyring specified had been
+    #   revoked, or the authorisation has been revoked
+    # @raise [Errno::EINVAL] the payload data was invalid
+    # @raise [Errno::ENOMEM] insufficient memory to store the new payload or
+    #   to expand the destination keyring
+    # @raise [Errno::EDQUOT] the key quota for the key's user would be
+    #   exceeded by increasing the size of the key to accommodate the new
+    #   payload or the key quota for the keyring's user would be exceeded by
+    #   expanding the destination keyring
+    # @raise [Errno::EACCES] the key exists, but is not writable by the
+    #   requester
+    # @see #reject
+    # @see #assume_authority
+    def instantiate payload, destination = nil
+      Lib.keyctl_instantiate id,
+          payload && payload.to_s,
+          payload && payload.to_s.length || 0,
+          destination.to_i
+      self
+    end
+
+    # Set the expiration timer on a key
+    #
+    # Sets the expiration timer on a key to +timeout_s+ seconds into the
+    # future. Setting timeout to zero cancels the expiration, assuming the key
+    # hasn't already expired.
+    #
+    # When the key expires, further attempts to access it will be met with
+    # error EKEYEXPIRED.
+    #
+    # The caller must have _setattr_ permission on a key to be able change its
+    # timeout.
+    #
+    # @param timeout_s [Fixnum] expiration timer, in seconds
+    # @return [Key] self
+    # @raise [Errno::ENOKEY] the key does not exist.
+    # @raise [Errno::EKEYEXPIRED] the key has already expired.
+    # @raise [Errno::EKEYREVOKED] the key has been revoked.
+    # @raise [Errno::EACCES] the key does not grant _setattr_ permission to
+    #   the calling process.
+    def set_timeout timeout_s
+      Lib.keyctl_set_timeout id, timeout_s
+      self
+    end
+
+    # Assume the authority to instantiate the key.
+    #
+    # Assumes the authority for the calling thread to deal with and
+    # instantiate this uninstantiated key.
+    #
+    # The calling thread must have the appropriate authorisation key resident
+    # in one of its keyrings for this to succeed, and that authority must not
+    # have been revoked.
+    #
+    # The authorising key is allocated by
+    # {http://man7.org/linux/man-pages/man2/request_key.2.html request_key(2)}
+    # when it needs to invoke userspace to generate a key for the requesting
+    # process. This is then attached to one of the keyrings of the userspace
+    # process to which the task of instantiating the key is given:
+    #
+    # requester ⟶ request_key() ⟶ instantiator
+    #
+    # Calling this function modifies the way {.request} works when called
+    # thereafter by the calling (instantiator) thread; once the authority is
+    # assumed, the keyrings of the initial process are added to the search
+    # path, using the initial process's UID, GID, groups and security context.
+    #
+    # If a thread has multiple instantiations to deal with, it may call this
+    # function to change the authorisation key currently in effect.
+    #
+    # @note This is a per-thread setting and not a per-process setting so that
+    #   a multithreaded process can be used to instantiate several keys at
+    #   once.
+    #
+    # @return (Key) self
+    # @see #instantiate
+    # @see .request
+    # @raise [Errno::ENOKEY] the key is invalid.
+    # @raise [Errno::EKEYREVOKED] the key had been revoked, or the
+    #   authorisation has been revoked.
+    # @see .renounce_authority
+    def assume_authority
+      Lib.keyctl_assume_authority id
+      self
+    end
+
+    # Retrieve the key's security context.
+    #
+    # This will be rendered in a form appropriate to the LSM in force---for
+    # instance, with SELinux, it may look like
+    #
+    #   unconfined_u:unconfined_r:unconfined_t:s0-s0:c0.c1023
+    #
+    # The caller must have view permission on a key to be able to get its
+    # security context.
+    #
+    # @return [String] key security context
+    # @raise [Errno::ENOKEY] the key is invalid.
+    # @raise [Errno::EKEYEXPIRED] the key has expired.
+    # @raise [Errno::EKEYREVOKED] the key had been revoked.
+    # @raise [Errno::EACCES] the key is not viewable by the calling process.
+    def security
+      return @security if @security
+
+      buf = FFI::MemoryPointer.new :char, 64
+      len = Lib.keyctl_get_security id, buf, buf.size
+      while len > buf.size
+        buf = FFI::MemoryPointer.new :char, len
+        len = Lib.keyctl_get_security id, buf, buf.size
+      end
+      @security = buf.read_string (len - 1)
+    end
+
+    # Negatively instantiate a key
+    #
+    # Marks a key as negatively instantiated and sets the expiration timer on
+    # it. Attempts to access the key will raise the given +error+.
+    #
+    # @note On some kernel versions +error+ setting is not supported. In this
+    #   case it will fall back to always raising {Errno::ENOKEY}.
+    #
+    # Only a key for which authority has been assumed may be negatively
+    # instantiated, and once instantiated, the authorisation key
+    # will be revoked and the requesting process will be able to resume.
+    #
+    # The +destination+ keyring, if given, is assumed to belong to the initial
+    # requester, and not the instantiating process. Therefore, the special
+    # keyring objects (such as {Keyring::Session}) refer to the requesting
+    # process's keyrings, not the caller's, and the requester's UID, etc. will
+    # be used to access them.
+    #
+    # The +destination+ keyring can be nil if no extra link is desired.
+    #
+    # The requester, not the caller, must have write permission on the
+    # +destination+ for a link to be made there.
+    #
+    # @param timeout_s [Fixnum] the lifetime of the key in seconds
+    # @param error [::Errno] error to be raised when attempting to
+    #   access the key, typically one of {Errno::ENOKEY},
+    #   {Errno::EKEYREJECTED}, {Errno::EKEYREVOKED} or {Errno::EKEYEXPIRED}
+    # @param destination [Keyring, nil] keyring to link the key to
+    # @return [Key] self
+    # @raise [Errno::ENOKEY] the key or specified keyring is invalid
+    # @raise [Errno::EKEYEXPIRED] the keyring specified has expired
+    # @raise [Errno::EKEYREVOKED] the key or keyring specified had been
+    #   revoked, or the authorisation has been revoked
+    # @raise [Errno::ENOMEM] insufficient memory to expand the destination
+    #   keyring
+    # @raise [Errno::EDQUOT] the key quota for the keyring's user would be
+    #   exceeded by expanding the destination keyring
+    # @raise [Errno::EACCES] the keyring exists, but is not writable by the
+    #   requester
+    # @see #instantiate
+    def reject timeout_s, error = Errno::ENOKEY, destination = nil
+      Lib.keyctl_reject id, timeout_s, error::Errno, keyring.to_i
+      self
+    end
+
+    # Invalidate the key.
+    #
+    # The key is scheduled for immediate removal from all the keyrings that
+    # point to it, after which it will be deleted. The key will be ignored by
+    # all searches once this function is called even if it is not yet fully
+    # dealt with.
+    #
+    # The caller must have _search_ permission on a key to be able to
+    # invalidate it.
+    # @raise [Errno::ENOKEY] the key is invalid.
+    # @raise [Errno::EKEYEXPIRED] the key specified has expired.
+    # @raise [Errno::EKEYREVOKED] the key specified had been revoked.
+    # @raise [Errno::EACCES] the key is not searchable by the calling process.
+    # @return [Key] self
+    # @see #revoke
+    def invalidate
+      Lib.keyctl_invalidate id
+      self
+    end
+
+    # Key equality
+    #
+    # @return [Boolean] whether the objects point to the same key
+    # @see #eql?
+    def == other
+      serial == other.serial
+    end
+
+    # Key handle equality
+    #
+    # Same as {#==}, except it doesn't dereference the special handles such
+    # as {Keyring::Session}. This means {#eql?} can be false even if the
+    # argument points to the same keyring, as long as only one of them is a
+    # special handle.
+    # @see #==
+    # @see #serial
+    # @return [Boolean] whether the key handles are equal
+    def eql? other
+      to_i == other.to_i
+    end
+
+    class << self
+      # Find a key by type and description
+      #
+      # Searches for a key with the given type and exact description, firstly
+      # in the thread, process and session keyrings to which a process is
+      # subscribed and secondly in +/proc/keys+.
+      #
+      # If a key is found, and +destination+ is not nil and specifies a
+      # keyring, then the found key will be linked into it.
+      #
+      # @param type [Symbol] key type
+      # @param description [String] key description
+      # @param destination [Keyring, nil] destination keyring
+      # @return [Key, nil] the key, if found
+      #
+      # @raise [Errno::EKEYEXPIRED] key or keyring have expired.
+      # @raise [Errno::EKEYREVOKED] the key or keyring have been revoked.
+      # @raise [Errno::EACCES] the key is not accessible or keyring exists,
+      #   but is not writable by the calling process.
+      # @see Keyring#request
+      # @see Keyring#search
+      def find type, description, destination = nil
+        serial = Lib.find_key_by_type_and_desc \
+            type.to_s,
+            description,
+            destination.to_i
+        new_dispatch serial, type.intern, description
+      rescue Errno::ENOKEY
+        nil
+      end
+
+      # De-assume the currently assumed authority.
+      # @see #assume_authority
+      # @return [void]
+      def renounce_authority
+        Lib.keyctl_assume_authority 0
+      end
+
+      protected
+      protected :new
+
+      def new_dispatch id, type, description
+        if klass = KeyTypes[type]
+          klass.send :new, id, description
+        else
+          new id, type, description
+        end
+      end
+
+      def parse_describe description
+        type, uid, gid, perm, desc = description.split ';', 5
+        {
+          type: @type = type.intern,
+          uid: uid.to_i,
+          gid: gid.to_i,
+          perm: perm.to_i(16),
+          desc: @description = desc
+        }
+      end
+    end
+
+    private
+    def initialize id, type, description
+      @id = id
+      @type = type
+      @description = description
+    end
+  end
+end