gpgme-ffi 3.0.0

data/lib/gpgme/ffi/library.rb

@@ -0,0 +1,279 @@
+require 'ffi'
+
+module GPGME::Library
+  extend FFI::Library
+
+  ffi_lib 'libgpgme.so.11'
+
+  class SigNotation < FFI::Struct
+    layout :next,      :pointer,
+           :name,      :string,
+           :value,     :string,
+           :name_len,  :int,
+           :value_len, :int,
+           :flags,     :uint,
+           # packed: human_readable, critical, _unused
+           :bits,      :uint
+  end
+
+  class Signature < FFI::Struct
+    layout :next,            :pointer,
+           :summary,         :int,
+           :fpr,             :string,
+           :status,          :uint,
+           :notations,       :pointer,
+           :timestamp,       :ulong,
+           :exp_timestamp,   :ulong,
+           # packed: wrong_key_usage, pka_trust, chain_model, _unused
+           :flags,           :uint,
+           :validity,        :uint,
+           :validity_reason, :uint,
+           :pubkey_algo,     :uint,
+           :hash_algo,       :uint,
+           :pka_address,     :string
+  end
+
+  class EngineInfo < FFI::Struct
+    layout :next,            :pointer,
+           :protocol,        :uint,
+           :file_name,       :string,
+           :version,         :string,
+           :req_version,     :string,
+           :home_dir,        :string
+  end
+
+  class Callbacks < FFI::Struct
+    layout :read,    :pointer,
+           :write,   :pointer,
+           :seek,    :pointer,
+           :release, :pointer
+  end
+
+  class ImportStatus < FFI::Struct
+    layout :next,   :pointer,
+           :fpr,    :string,
+           :result, :uint,
+           :status, :uint
+  end
+
+  class ImportResult < FFI::Struct
+    layout :considered,       :int,
+           :no_user_id,       :int,
+           :imported,         :int,
+           :imported_rsa,     :int,
+           :unchanged,        :int,
+           :new_user_ids,     :int,
+           :new_sub_keys,     :int,
+           :new_signatures,   :int,
+           :new_revocations,  :int,
+           :secret_read,      :int,
+           :secret_imported,  :int,
+           :secret_unchanged, :int,
+           :skipped_new_keys, :int,
+           :not_imported,     :int,
+           :imports,          :pointer
+  end
+
+  class TrustItem < FFI::Struct
+    layout :_refs,        :uint,
+           :keyid,        :string,
+           :_keyid,       [ :uint8, 16 + 1 ],
+           :type,         :int,
+           :level,        :int,
+           :owner_trust,  :string,
+           :_owner_trust, [ :uint8, 2 ],
+           :validity,     :string,
+           :_validity,    [ :uint8, 2 ],
+           :name,         :string
+  end
+
+  class Key < FFI::Struct
+    layout :_refs,         :uint,
+           # packed: revoked, expired, disabled, invalid, can_encrypt, can_sign, can_certify,
+           # secret, can_authenticate, is_qualified, _unused
+           :flags,         :uint,
+           :protocol,      :uint,
+           :issuer_serial, :string,
+           :issuer_name,   :string,
+           :chain_id,      :string,
+           :owner_trust,   :uint,
+           :subkeys,       :pointer,
+           :uids,          :pointer,
+           :_last_subkey,  :pointer,
+           :_last_uid,     :pointer,
+           :keylist_mode,  :uint
+  end
+
+  class SubKey < FFI::Struct
+    layout :next,        :pointer,
+           # packed, see above + is_cardkey
+           :flags,       :uint,
+           :pubkey_algo, :uint,
+           :length,      :uint,
+           :keyid,       :string,
+           :_keyid,      [ :uint8, 16 + 1],
+           :fpr,         :string,
+           :timestamp,   :long,
+           :expires,     :long,
+           :card_number, :string
+  end
+
+  class UserID < FFI::Struct
+    layout :next,         :pointer,
+           # packed: revoked, invalid
+           :flags,        :uint,
+           :validity,     :uint,
+           :uid,          :string,
+           :name,         :string,
+           :email,        :string,
+           :comment,      :string,
+           :signatures,   :pointer,
+           :_last_keysig, :pointer
+  end
+
+  class KeySig < FFI::Struct
+    layout :next,            :pointer,
+           # packed: revoked, expired, invalid, exportable
+           :flags,           :uint,
+           :pubkey_algo,     :uint,
+           :keyid,           :string,
+           :_keyid,          [ :uint8, 16 + 1 ],
+           :timestamp,       :long,
+           :expires,         :long,
+           :status,          :uint,
+           :_obsolete_class, :uint,
+           :uid,             :string,
+           :name,            :string,
+           :email,           :string,
+           :comment,         :string,
+           :sig_class,       :uint,
+           :notations,       :pointer,
+           :_last_notation,  :pointer
+  end
+
+  class DecryptResult < FFI::Struct
+    layout :unsupported_algorithm, :string,
+           # packed: wrong_key_usage
+           :flags,                 :uint,
+           :recipients,            :pointer,
+           :file_name,             :string
+  end
+
+  class VerifyResult < FFI::Struct
+    layout :signatures, :pointer,
+           :file_name,  :string
+  end
+
+  class SignResult < FFI::Struct
+    layout :invalid_signers, :pointer,
+           :signatures,      :pointer
+  end
+
+  class InvalidKey < FFI::Struct
+    layout :next,   :pointer,
+           :fpr,    :string,
+           :reason, :uint
+  end
+
+  class EncryptResult < FFI::Struct
+    layout :invalid_recipients, :pointer
+  end
+
+  class NewSignature < FFI::Struct
+    layout :next,              :pointer,
+           :type,              :uint,
+           :pubkey_algo,       :uint,
+           :hash_algo,         :uint,
+           :_obsolete_class,   :ulong,
+           :timestamp,         :long,
+           :fpr,               :string,
+           :_obsolete_class_2, :uint,
+           :sig_class,         :uint
+  end
+
+  attach_function :gpgme_check_version_internal,  [ :buffer_in, :size_t ], :string
+  attach_function :gpgme_engine_check_version,    [ :uint ], :uint
+  attach_function :gpgme_get_engine_info,         [ :pointer ], :uint
+  attach_function :gpgme_set_engine_info,         [ :uint, :buffer_in, :buffer_in ], :uint
+  attach_function :gpgme_pubkey_algo_name,        [ :uint ], :string
+  attach_function :gpgme_hash_algo_name,          [ :uint ], :string
+  attach_function :gpgme_strerror,                [ :uint ], :string
+  attach_function :gpgme_data_new,                [ :pointer ], :uint
+  attach_function :gpgme_data_new_from_mem,       [ :pointer, :buffer_in, :size_t, :int ], :uint
+  attach_function :gpgme_data_new_from_fd,        [ :pointer, :int ], :uint
+  attach_function :gpgme_data_new_from_cbs,       [ :pointer, :pointer, :pointer ], :uint
+  attach_function :gpgme_data_release,            [ :pointer ], :void
+  attach_function :gpgme_data_read,               [ :pointer, :buffer_out, :size_t ], :ssize_t
+  attach_function :gpgme_data_write,              [ :pointer, :buffer_in, :size_t ], :ssize_t
+  attach_function :gpgme_data_seek,               [ :pointer, :off_t, :int ], :off_t
+  attach_function :gpgme_data_get_encoding,       [ :pointer ], :uint
+  attach_function :gpgme_data_set_encoding,       [ :pointer, :uint ], :uint
+  attach_function :gpgme_new,                     [ :pointer ], :uint
+  attach_function :gpgme_release,                 [ :pointer ], :void
+  attach_function :gpgme_set_protocol,            [ :pointer, :uint ], :uint
+  attach_function :gpgme_get_protocol,            [ :pointer ], :uint
+  attach_function :gpgme_set_armor,               [ :pointer, :uint ], :void
+  attach_function :gpgme_get_armor,               [ :pointer ], :uint
+  attach_function :gpgme_set_textmode,            [ :pointer, :uint ], :void
+  attach_function :gpgme_get_textmode,            [ :pointer ], :uint
+  attach_function :gpgme_set_include_certs,       [ :pointer, :uint ], :void
+  attach_function :gpgme_get_include_certs,       [ :pointer ], :uint
+  attach_function :gpgme_set_keylist_mode,        [ :pointer, :uint ], :uint
+  attach_function :gpgme_get_keylist_mode,        [ :pointer ], :uint
+  attach_function :gpgme_set_passphrase_cb,       [ :pointer, :pointer, :pointer ], :void
+  attach_function :gpgme_get_passphrase_cb,       [ :pointer, :pointer, :pointer ], :void
+  attach_function :gpgme_set_progress_cb,         [ :pointer, :pointer, :pointer ], :void
+  attach_function :gpgme_get_progress_cb,         [ :pointer, :pointer, :pointer ], :void
+  attach_function :gpgme_set_locale,              [ :pointer, :int, :buffer_in ], :uint
+  attach_function :gpgme_op_keylist_start,        [ :pointer, :buffer_in, :int ], :uint
+  attach_function :gpgme_op_keylist_ext_start,    [ :pointer, :buffer_in, :int, :int ], :uint
+  attach_function :gpgme_op_keylist_next,         [ :pointer, :buffer_out ], :uint
+  attach_function :gpgme_op_keylist_end,          [ :pointer ], :uint
+  attach_function :gpgme_get_key,                 [ :pointer, :buffer_in, :buffer_out, :int ], :uint
+  attach_function :gpgme_key_ref,                 [ :pointer ], :void
+  attach_function :gpgme_key_unref,               [ :pointer ], :void
+  attach_function :gpgme_op_genkey,               [ :pointer, :buffer_in, :pointer, :pointer ], :uint
+  attach_function :gpgme_op_genkey_start,         [ :pointer, :buffer_in, :pointer, :pointer ], :uint
+  attach_function :gpgme_op_export,               [ :pointer, :buffer_in, :int, :pointer ], :uint
+  attach_function :gpgme_op_export_start,         [ :pointer, :buffer_in, :int, :pointer ], :uint
+  attach_function :gpgme_op_export_ext,           [  :pointer, :buffer_in, :int, :pointer ], :uint
+  attach_function :gpgme_op_export_ext_start,     [ :pointer, :buffer_in, :int, :pointer ], :uint
+  attach_function :gpgme_op_export_keys,          [ :pointer, :buffer_in, :int, :pointer ], :uint
+  attach_function :gpgme_op_export_keys_start,    [ :pointer, :buffer_in, :int, :pointer ], :uint
+  attach_function :gpgme_op_import,               [ :pointer, :pointer ], :uint
+  attach_function :gpgme_op_import_start,         [ :pointer, :pointer ], :uint
+  attach_function :gpgme_op_import_keys,          [ :pointer, :buffer_in ], :uint
+  attach_function :gpgme_op_import_keys_start,    [ :pointer, :buffer_in ], :uint
+  attach_function :gpgme_op_import_result,        [ :pointer ], :pointer
+  attach_function :gpgme_op_delete,               [ :pointer, :pointer, :int ], :uint
+  attach_function :gpgme_op_delete_start,         [ :pointer, :pointer, :int ], :uint
+  attach_function :gpgme_op_edit,                 [ :pointer, :pointer, :pointer, :pointer, :pointer ], :uint
+  attach_function :gpgme_op_edit_start,           [ :pointer, :pointer, :pointer, :pointer, :pointer ], :uint
+  attach_function :gpgme_op_card_edit,            [ :pointer, :pointer, :pointer, :pointer, :pointer ], :uint
+  attach_function :gpgme_op_card_edit_start,      [ :pointer, :pointer, :pointer, :pointer, :pointer ], :uint
+  attach_function :gpgme_op_trustlist_start,      [ :pointer, :buffer_in, :int ], :uint
+  attach_function :gpgme_op_trustlist_next,       [ :pointer, :buffer_out ], :uint
+  attach_function :gpgme_op_trustlist_end,        [ :pointer ], :uint
+  attach_function :gpgme_trust_item_ref,          [ :pointer ], :void
+  attach_function :gpgme_trust_item_unref,        [ :pointer ], :void
+  attach_function :gpgme_op_decrypt,              [ :pointer, :pointer, :pointer ], :uint
+  attach_function :gpgme_op_decrypt_start,        [ :pointer, :pointer, :pointer ], :uint
+  attach_function :gpgme_op_decrypt_result,       [ :pointer ], :pointer
+  attach_function :gpgme_op_verify,               [ :pointer, :pointer, :pointer, :pointer ], :uint
+  attach_function :gpgme_op_verify_start,         [ :pointer, :pointer, :pointer, :pointer ], :uint
+  attach_function :gpgme_op_verify_result,        [ :pointer ], :pointer
+  attach_function :gpgme_op_decrypt_verify,       [ :pointer, :pointer, :pointer ], :uint
+  attach_function :gpgme_op_decrypt_verify_start, [ :pointer, :pointer, :pointer ], :uint
+  attach_function :gpgme_signers_clear,           [ :pointer ], :void
+  attach_function :gpgme_signers_add,             [ :pointer, :pointer ], :uint
+  attach_function :gpgme_signers_enum,            [ :pointer, :int ], :pointer
+  attach_function :gpgme_op_sign,                 [ :pointer, :pointer, :pointer, :uint ], :uint
+  attach_function :gpgme_op_sign_start,           [ :pointer, :pointer, :pointer, :uint ], :uint
+  attach_function :gpgme_op_sign_result,          [ :pointer ], :pointer
+  attach_function :gpgme_op_encrypt,              [ :pointer, :buffer_in, :uint, :pointer, :pointer ], :uint
+  attach_function :gpgme_op_encrypt_start,        [ :pointer, :buffer_in, :uint, :pointer, :pointer ], :uint
+  attach_function :gpgme_op_encrypt_sign,         [ :pointer, :buffer_in, :uint, :pointer, :pointer ], :uint
+  attach_function :gpgme_op_encrypt_sign_start,   [ :pointer, :buffer_in, :uint, :pointer, :pointer ], :uint
+  attach_function :gpgme_op_encrypt_result,       [ :pointer ], :pointer
+  attach_function :gpgme_wait,                    [ :pointer, :buffer_out, :int ], :pointer
+end

data/lib/gpgme/ffi/meta.rb

@@ -0,0 +1,57 @@
+module GPGME
+  module Meta
+    def self.ffize_value(arg)
+      if arg.respond_to?(:context_pointer)
+        arg.context_pointer
+
+      elsif arg.kind_of?(String)
+        FFI::MemoryPointer.from_string arg
+
+      elsif arg.kind_of?(Array)
+        buf = FFI::Buffer.new :pointer, arg.length + 1
+
+        pointers = arg.map { |item| ffize_value item }
+        pointers << FFI::Pointer::NULL
+        buf.put_array_of_pointer 0, pointers
+
+        buf
+
+      elsif arg.nil?
+        FFI::Pointer::NULL
+      else
+        arg
+      end
+    end
+
+    def self.define_ffi_forwarder(*functions)
+      functions.each do |id|
+        GPGME.define_singleton_method(id) do |*args|
+          args = args.map! { |arg| Meta.ffize_value arg }
+
+          GPGME::Library.send id, *args
+        end
+      end
+    end
+
+    def self.common_gpgme_edit(context, key, ruby_callback, ruby_handle, data, receiver)
+      callback = FFI::Function.new(:uint, [ :pointer, :uint, :string, :int ]) do |handle, status, args, fd|
+        ruby_callback.call ruby_handle, status, args, fd
+
+        GPGME.gpgme_err_make GPGME::GPG_ERR_SOURCE_USER_1, GPGME::GPG_ERR_NO_ERROR
+      end
+
+      context.edit_callback = callback
+
+      receiver.call context.context_pointer, key.context_pointer, callback, FFI::Pointer::NULL,
+                  data.context_pointer
+    end
+
+    def self.define_op_edit(*functions)
+      functions.each do |function|
+        GPGME.define_singleton_method(function) do |*args|
+          common_gpgme_edit *args, GPGME::Library.method(function)
+        end
+      end
+    end
+  end
+end

data/lib/gpgme/ffi/new_signature.rb

@@ -0,0 +1,18 @@
+module GPGME
+  class NewSignature
+    def self.new_from_struct(struct)
+      instance = allocate
+
+      instance.instance_exec do
+        @type        = struct[:type]
+        @pubkey_algo = struct[:pubkey_algo]
+        @hash_algo   = struct[:hash_algo]
+        @sig_class   = struct[:sig_class]
+        @timestamp   = struct[:timestamp]
+        @fpr         = struct[:fpr]
+      end
+
+      instance
+    end
+  end
+end

data/lib/gpgme/ffi/sig_notation.rb

@@ -0,0 +1,12 @@
+module GPGME
+  class SigNotation
+    def self.new_from_struct(struct)
+      instance = allocate
+
+      instance.instance_exec do
+        @name  = struct[:name]
+        @value = struct[:value]
+      end
+    end
+  end
+end

data/lib/gpgme/ffi/sign_result.rb

@@ -0,0 +1,33 @@
+module GPGME
+  class SignResult
+    def self.new_from_struct(struct)
+      instance = allocate
+
+      instance.instance_exec do
+        @invalid_signers = []
+
+        pointer = struct[:invalid_signers]
+        until pointer.null?
+          key = Library::InvalidKey.new pointer
+
+          @invalid_signers << InvalidKey.new_from_struct(key)
+
+          pointer = key[:next]
+        end
+
+        @signatures = []
+
+        pointer = struct[:signatures]
+        until pointer.null?
+          signature = Library::NewSignature.new pointer
+
+          @signatures << NewSignature.new_from_struct(signature)
+
+          pointer = key[:next]
+        end
+      end
+
+      instance
+    end
+  end
+end

data/lib/gpgme/ffi/signature.rb

@@ -0,0 +1,35 @@
+module GPGME
+  class Signature
+    def self.new_from_struct(struct)
+      instance = allocate
+
+      instance.instance_exec do
+        @summary   = struct[:summary]
+        @fpr       = struct[:fpr]
+        @status    = struct[:status]
+
+        @notations = []
+
+        pointer = struct[:notations]
+        until pointer.null?
+          notation = Library::SigNotation.new pointer
+
+          @notations << SigNotation.new_from_struct(notation)
+
+          pointer = notation[:next]
+        end
+
+        @timestamp       = struct[:timestamp]
+        @exp_timestamp   = struct[:exp_timestamp]
+        @wrong_key_usage = (struct[:flags] >> 0) & 1
+        @pka_trust       = (struct[:flags] >> 1) & 3
+        @chain_model     = (struct[:flags] >> 3) & 1
+        @validity        = struct[:validity]
+        @validity_reason = struct[:validity_reason]
+        @pka_address     = struct[:pka_address]
+      end
+
+      instance
+    end
+  end
+end

data/lib/gpgme/ffi/sub_key.rb

@@ -0,0 +1,27 @@
+module GPGME
+  class SubKey
+    def self.new_from_struct(struct)
+      instance = allocate
+
+      instance.instance_exec do
+        @revoked          = (struct[:flags] >> 0) & 1
+        @expired          = (struct[:flags] >> 1) & 1
+        @disabled         = (struct[:flags] >> 2) & 1
+        @invalid          = (struct[:flags] >> 3) & 1
+        @can_encrypt      = (struct[:flags] >> 4) & 1
+        @can_sign         = (struct[:flags] >> 5) & 1
+        @can_certify      = (struct[:flags] >> 6) & 1
+        @secret           = (struct[:flags] >> 7) & 1
+        @can_authenticate = (struct[:flags] >> 8) & 1
+        @pubkey_algo      = struct[:pubkey_algo]
+        @length           = struct[:length]
+        @keyid            = struct[:keyid]
+        @fpr              = struct[:fpr]
+        @timestamp        = struct[:timestamp]
+        @expires          = struct[:expires]
+      end
+
+      instance
+    end
+  end
+end

data/lib/gpgme/ffi/trust_item.rb

@@ -0,0 +1,31 @@
+module GPGME
+  class TrustItem
+    class Pointer < FFI::AutoPointer
+      def self.release(ptr)
+        GPGME::Library.gpgme_trust_item_unref ptr
+      end
+    end
+
+    def self.new_from_struct(pointer)
+      instance = allocate
+
+      instance.instance_exec do
+        @ptr = Pointer.new pointer
+
+        structure = Library::TrustItem.new @ptr
+        @keyid = structure[:keyid]
+        @type = structure[:type]
+        @level = structure[:level]
+        @owner_trust = structure[:owner_trust]
+        @validity = structure[:validity]
+        @name = structure[:name]
+      end
+
+      instance
+    end
+
+    def context_pointer
+      @ptr
+    end
+  end
+end

data/lib/gpgme/ffi/user_id.rb

@@ -0,0 +1,30 @@
+module GPGME
+  class UserID
+    def self.new_from_struct(struct)
+      instance = allocate
+
+      instance.instance_exec do
+        @revoked  = (struct[:flags] >> 0) & 1
+        @invalid  = (struct[:flags] >> 1) & 1
+        @validity = struct[:validity]
+        @uid      = struct[:uid]
+        @name     = struct[:name]
+        @email    = struct[:email]
+        @comment  = struct[:comment]
+
+        @signatures = []
+        pointer = struct[:signatures]
+
+        until pointer.null?
+          signature = Library::KeySig
+
+          @signatures << KeySig.new_from_struct(signature)
+
+          pointer = signature[:next]
+        end
+      end
+
+      instance
+    end
+  end
+end

data/lib/gpgme/ffi/verify_result.rb

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

data/lib/gpgme/ffi.rb

@@ -0,0 +1,22 @@
+require "gpgme/ffi/enums"
+require "gpgme/ffi/library"
+require "gpgme/ffi/engine_info"
+require "gpgme/ffi/ctx"
+require "gpgme/ffi/data"
+require "gpgme/ffi/key"
+require "gpgme/ffi/sub_key"
+require "gpgme/ffi/user_id"
+require "gpgme/ffi/key_sig"
+require "gpgme/ffi/decrypt_result"
+require "gpgme/ffi/verify_result"
+require "gpgme/ffi/sign_result"
+require "gpgme/ffi/encrypt_result"
+require "gpgme/ffi/signature"
+require "gpgme/ffi/sig_notation"
+require "gpgme/ffi/trust_item"
+require "gpgme/ffi/invalid_key"
+require "gpgme/ffi/new_signature"
+require "gpgme/ffi/import_result"
+require "gpgme/ffi/import_status"
+require "gpgme/ffi/meta"
+require "gpgme/ffi/functions"

data/lib/gpgme/io_callbacks.rb

@@ -0,0 +1,21 @@
+module GPGME
+  class IOCallbacks
+    def initialize(io)
+      @io = io
+    end
+
+    def read(hook, length)
+      @io.read(length)
+    end
+
+    def write(hook, buffer, length)
+      @io.write(buffer[0 .. length])
+    end
+
+    def seek(hook, offset, whence)
+      return @io.pos if offset == 0 && whence == IO::SEEK_CUR
+      @io.seek(offset, whence)
+      @io.pos
+    end
+  end
+end