gpgme-ffi 3.0.0

data/lib/gpgme/engine.rb

@@ -0,0 +1,76 @@
+module GPGME
+
+  ##
+  # Convenience methods to check different aspects of the gpg system
+  # installation.
+  module Engine
+    class << self
+
+      ##
+      # Verify that the engine implementing the protocol +proto+ is installed in
+      # the system. Can be one of +PROTOCOL_OpenPGP+ or +PROTOCOL_CMS+.
+      #
+      # @return [Boolean] true if the engine is installed.
+      #
+      # @example
+      #   GPGME::Engine.check_version(GPGME::PROTOCOL_OpenPGP) # => true
+      #
+      def check_version(proto)
+        err = GPGME::gpgme_engine_check_version(proto)
+        exc = GPGME::error_to_exception(err)
+        !exc
+      end
+
+      ##
+      # Return an array of {GPGME::EngineInfo} structures of enabled engines.
+      #
+      # @example
+      #   GPGME::Engine.info.first
+      #   # => #<GPGME::EngineInfo:0x00000100d4fbd8
+      #          @file_name="/usr/local/bin/gpg",
+      #          @protocol=0,
+      #          @req_version="1.3.0",
+      #          @version="1.4.11">
+      #
+      def info
+        rinfo = []
+        GPGME::gpgme_get_engine_info(rinfo)
+        rinfo
+      end
+
+      ##
+      # Change the default configuration of the crypto engine implementing
+      # protocol +proto+.
+      #
+      # @param proto
+      #   Can be one of +PROTOCOL_OpenPGP+ or +PROTOCOL_CMS+.
+      #
+      # @param file_name
+      #   The file name of the executable program implementing the protocol.
+      #
+      # @param home_dir
+      #   The directory name of the configuration directory.
+      #
+      # @example
+      #   GPGME::Engine.set
+      #
+      def set_info(proto, file_name, home_dir)
+        err = GPGME::gpgme_set_engine_info(proto, file_name, home_dir)
+        exc = GPGME::error_to_exception(err)
+        raise exc if exc
+      end
+
+      ##
+      # Sets the home dir for the configuration options. This way one could,
+      # for example, load the keys from a customized keychain.
+      #
+      # @example
+      #   GPGME::Engine.home_dir = '/tmp'
+      #
+      def home_dir=(home_dir)
+        current = info.first
+        set_info current.protocol, current.file_name, home_dir
+      end
+    end # class << self
+  end # class Engine
+end # module GPGME

data/lib/gpgme/error.rb

@@ -0,0 +1,66 @@
+module GPGME
+  class Error < StandardError
+    def initialize(error)
+      @error = error
+    end
+    attr_reader :error
+
+    # Return the error code.
+    #
+    # The error code indicates the type of an error, or the reason why
+    # an operation failed.
+    def code
+      GPGME::gpgme_err_code(@error)
+    end
+
+    # Return the error source.
+    #
+    # The error source has not a precisely defined meaning.  Sometimes
+    # it is the place where the error happened, sometimes it is the
+    # place where an error was encoded into an error value.  Usually
+    # the error source will give an indication to where to look for
+    # the problem.  This is not always true, but it is attempted to
+    # achieve this goal.
+    def source
+      GPGME::gpgme_err_source(@error)
+    end
+
+    # Return a description of the error code.
+    def message
+      GPGME::gpgme_strerror(@error)
+    end
+
+    class General < self; end
+    class InvalidValue < self; end
+    class UnusablePublicKey < self
+      attr_accessor :keys
+    end
+    class UnusableSecretKey < self
+      attr_accessor :keys
+    end
+    class NoData < self; end
+    class Conflict < self; end
+    class NotImplemented < self; end
+    class DecryptFailed < self; end
+    class BadPassphrase < self; end
+    class Canceled < self; end
+    class InvalidEngine < self; end
+    class AmbiguousName < self; end
+    class WrongKeyUsage < self
+      attr_accessor :key_usage
+    end
+    class CertificateRevoked < self; end
+    class CertificateExpired < self; end
+    class NoCRLKnown < self; end
+    class NoPolicyMatch < self; end
+    class NoSecretKey < self; end
+    class MissingCertificate < self; end
+    class BadCertificateChain < self; end
+    class UnsupportedAlgorithm < self
+      attr_accessor :algorithm
+    end
+    class BadSignature < self; end
+    class NoPublicKey < self; end
+    class InvalidVersion < self; end
+  end
+end

data/lib/gpgme/ffi/ctx.rb

@@ -0,0 +1,36 @@
+module GPGME
+  class Ctx
+    attr_accessor :context_passphrase_callback
+    attr_accessor :context_progress_callback
+
+    class Pointer < FFI::AutoPointer
+      def self.release(ptr)
+        GPGME::Library.gpgme_release ptr
+      end
+    end
+
+    def self.new_from_struct(pointer)
+      instance = allocate
+
+      instance.instance_exec do
+        @context_passphrase_callback = [ nil, nil, nil ]
+        @context_progress_callback   = [ nil, nil, nil ]
+
+        @ptr = Pointer.new pointer
+      end
+
+      instance
+    end
+
+    def release_pointer
+      raise ArgumentError, "released ctx" if @ptr.nil?
+      @ptr.free
+      @ptr = nil
+    end
+
+    def context_pointer
+      raise "context is already released" if @ptr.nil?
+      @ptr
+    end
+  end
+end

data/lib/gpgme/ffi/data.rb

@@ -0,0 +1,24 @@
+module GPGME
+  class Data
+    class Pointer < FFI::AutoPointer
+      def self.release(ptr)
+        GPGME::Library.gpgme_data_release ptr
+      end
+    end
+
+    def self.new_from_struct(pointer, cbs = nil)
+      instance = allocate
+
+      instance.instance_exec do
+        @ptr = Pointer.new pointer
+        @cbs = cbs
+      end
+
+      instance
+    end
+
+    def context_pointer
+      @ptr
+    end
+  end
+end

data/lib/gpgme/ffi/decrypt_result.rb

@@ -0,0 +1,14 @@
+module GPGME
+  class DecryptResult
+    def self.new_from_struct(struct)
+      instance = allocate
+
+      instance.instance_exec do
+        @unsupported_algorithm = struct[:unsupported_algorithm]
+        @wrong_key_usage       = (struct[:flags] >> 0) & 1
+      end
+
+      instance
+    end
+  end
+end

data/lib/gpgme/ffi/encrypt_result.rb

@@ -0,0 +1,22 @@
+module GPGME
+  class EncryptResult
+    def self.new_from_struct(struct)
+      instance = allocate
+
+      instance.instance_exec do
+        @invalid_recipients = []
+
+        pointer = struct[:invalid_recipients]
+        until pointer.null?
+          key = Library::InvalidKey.new pointer
+
+          @invalid_recipients << InvalidKey.new_from_struct(key)
+
+          pointer = key[:next]
+        end
+      end
+
+      instance
+    end
+  end
+end

data/lib/gpgme/ffi/engine_info.rb

@@ -0,0 +1,17 @@
+module GPGME
+  class EngineInfo
+    def self.new_from_struct(info)
+      instance = allocate
+
+      instance.instance_exec do
+        @protocol    = info[:protocol]
+        @file_name   = info[:file_name]
+        @version     = info[:version]
+        @req_version = info[:req_version]
+        @home_dir    = info[:home_dir]
+      end
+
+      instance
+    end
+  end
+end