gpgme-ffi 3.0.0

data/lib/gpgme/ctx.rb

@@ -0,0 +1,462 @@
+module GPGME
+
+  ##
+  # A context within which all cryptographic operations are performed.
+  #
+  # More operations can be done which are not available in the higher level
+  # API. Note how to create a new instance of this class in {GPGME::Ctx.new}.
+  #
+  class Ctx
+
+    ##
+    # Create a new instance from the given +options+. Must be released either
+    # executing the operations inside a block, or executing {GPGME::Ctx#release}
+    # afterwards.
+    #
+    # @param [Hash] options
+    #  The optional parameters are as follows:
+    #  * +:protocol+ Either +PROTOCOL_OpenPGP+ or +PROTOCOL_CMS+.
+    #  * +:armor+ will return ASCII armored outputs if specified true.
+    #  * +:textmode+ if +true+, inform the recipient that the input is text.
+    #  * +:keylist_mode+ One of: +KEYLIST_MODE_LOCAL+, +KEYLIST_MODE_EXTERN+,
+    #    +KEYLIST_MODE_SIGS+ or +KEYLIST_MODE_VALIDATE+.
+    #  * +:password+ password of the passphrased password being used.
+    #  * +:passphrase_callback+ A callback function. See {#set_passphrase_callback}.
+    #  * +:passphrase_callback_value+ An object passed to passphrase_callback.
+    #  * +:progress_callback+  A callback function. See {#set_progress_callback}.
+    #  * +:progress_callback_value+ An object passed to progress_callback.
+    #
+    # @example
+    #   ctx = GPGME::Ctx.new
+    #   # operate on ctx
+    #   ctx.release
+    #
+    # @example
+    #   GPGME::Ctx.new do |ctx|
+    #     # operate on ctx
+    #   end
+    #
+    def self.new(options = {})
+      rctx = []
+      err = GPGME::gpgme_new(rctx)
+      exc = GPGME::error_to_exception(err)
+      raise exc if exc
+      ctx = rctx[0]
+
+      ctx.protocol     = options[:protocol]     if options[:protocol]
+      ctx.armor        = options[:armor]        if options[:armor]
+      ctx.textmode     = options[:textmode]     if options[:textmode]
+      ctx.keylist_mode = options[:keylist_mode] if options[:keylist_mode]
+
+      if options[:password]
+        ctx.set_passphrase_callback GPGME::Ctx.method(:pass_function),
+          options[:password]
+      else
+        if options[:passphrase_callback]
+          ctx.set_passphrase_callback options[:passphrase_callback],
+            options[:passphrase_callback_value]
+        end
+      end
+      if options[:progress_callback]
+        ctx.set_progress_callback options[:progress_callback],
+          options[:progress_callback_value]
+      end
+
+      if block_given?
+        begin
+          yield ctx
+        ensure
+          GPGME::gpgme_release(ctx)
+        end
+      else
+        ctx
+      end
+    end
+
+
+    ##
+    # Releases the Ctx instance. Must be called if it was initialized without
+    # a block.
+    #
+    # @example
+    #   ctx = GPGME::Ctx.new
+    #   # operate on ctx
+    #   ctx.release
+    #
+    def release
+      GPGME::gpgme_release(self)
+    end
+
+    ##
+    # Getters and setters
+    ##
+
+    # Set the +protocol+ used within this context. See {GPGME::Ctx.new} for
+    # possible values.
+    def protocol=(proto)
+      err = GPGME::gpgme_set_protocol(self, proto)
+      exc = GPGME::error_to_exception(err)
+      raise exc if exc
+      proto
+    end
+
+    # Return the +protocol+ used within this context.
+    def protocol
+      GPGME::gpgme_get_protocol(self)
+    end
+
+    # Tell whether the output should be ASCII armored.
+    def armor=(yes)
+      GPGME::gpgme_set_armor(self, yes ? 1 : 0)
+      yes
+    end
+
+    # Return true if the output is ASCII armored.
+    def armor
+      GPGME::gpgme_get_armor(self) == 1 ? true : false
+    end
+
+    # Tell whether canonical text mode should be used.
+    def textmode=(yes)
+      GPGME::gpgme_set_textmode(self, yes ? 1 : 0)
+      yes
+    end
+
+    # Return true if canonical text mode is enabled.
+    def textmode
+      GPGME::gpgme_get_textmode(self) == 1 ? true : false
+    end
+
+    # Change the default behaviour of the key listing functions.
+    def keylist_mode=(mode)
+      GPGME::gpgme_set_keylist_mode(self, mode)
+      mode
+    end
+
+    # Return the current key listing mode.
+    def keylist_mode
+      GPGME::gpgme_get_keylist_mode(self)
+    end
+
+    ##
+    # Passphrase and progress callbacks
+    ##
+
+    # Set the passphrase callback with given hook value.
+    # +passfunc+ should respond to +call+ with 5 arguments.
+    #
+    # * +obj+ the parameter +:passphrase_callback_value+ passed when creating
+    #   the {GPGME::Ctx} object.
+    # * +uid_hint+ hint as to what key are we asking the password for. Ex:
+    #
+    #   +CFB3294A50C2CFD7 Albert Llop <mrsimo@example.com>+
+    #
+    # * +passphrase_info+
+    # * +prev_was_bad+ 0 if it's the first time the password is being asked,
+    #   1 otherwise.
+    # * +fd+ file descriptor where the password must be written too.
+    #
+    # Expects a Method object which can be obtained by the +method+ method
+    # (really..).
+    #
+    #  ctx.set_passphrase_callback(MyModule.method(:passfunc))
+    #
+    # @example this method will simply return +maria+ as password.
+    #  def pass_function(obj, uid_hint, passphrase_info, prev_was_bad, fd)
+    #    io = ::FFI::IO.for_fd(fd, 'w')
+    #    io.puts "maria"
+    #    io.flush
+    #  end
+    #
+    # @example this will interactively ask for the password
+    #  def passfunc(obj, uid_hint, passphrase_info, prev_was_bad, fd)
+    #    $stderr.write("Passphrase for #{uid_hint}: ")
+    #    $stderr.flush
+    #    begin
+    #      system('stty -echo')
+    #      io = ::FFI::IO.for_fd(fd, 'w')
+    #      io.puts(gets)
+    #      io.flush
+    #    ensure
+    #      (0 ... $_.length).each do |i| $_[i] = ?0 end if $_
+    #      system('stty echo')
+    #    end
+    #    $stderr.puts
+    #  end
+    #
+    def set_passphrase_callback(passfunc, hook_value = nil)
+      GPGME::gpgme_set_passphrase_cb(self, passfunc, hook_value)
+    end
+    alias set_passphrase_cb set_passphrase_callback
+
+    # Set the progress callback with given hook value.
+    # <i>progfunc</i> should respond to <code>call</code> with 5 arguments.
+    #
+    #  def progfunc(hook, what, type, current, total)
+    #    $stderr.write("#{what}: #{current}/#{total}\r")
+    #    $stderr.flush
+    #  end
+    #
+    #  ctx.set_progress_callback(method(:progfunc))
+    #
+    def set_progress_callback(progfunc, hook_value = nil)
+      GPGME::gpgme_set_progress_cb(self, progfunc, hook_value)
+    end
+    alias set_progress_cb set_progress_callback
+
+    ##
+    # Searching and iterating through keys. Used by {GPGME::Key.find}
+    ##
+
+    # Initiate a key listing operation for given pattern. If +pattern+ is
+    # +nil+, all available keys are returned. If +secret_only<+ is +true+,
+    # only secret keys are returned.
+    #
+    # Used by {GPGME::Ctx#each_key}
+    def keylist_start(pattern = nil, secret_only = false)
+      err = GPGME::gpgme_op_keylist_start(self, pattern, secret_only ? 1 : 0)
+      exc = GPGME::error_to_exception(err)
+      raise exc if exc
+    end
+
+    # Advance to the next key in the key listing operation.
+    #
+    # Used by {GPGME::Ctx#each_key}
+    def keylist_next
+      rkey = []
+      err = GPGME::gpgme_op_keylist_next(self, rkey)
+      exc = GPGME::error_to_exception(err)
+      raise exc if exc
+      rkey[0]
+    end
+
+    # End a pending key list operation.
+    #
+    # Used by {GPGME::Ctx#each_key}
+    def keylist_end
+      err = GPGME::gpgme_op_keylist_end(self)
+      exc = GPGME::error_to_exception(err)
+      raise exc if exc
+    end
+
+    # Convenient method to iterate over keys.
+    #
+    # If +pattern+ is +nil+, all available keys are returned. If +secret_only+
+    # is +true+, only secret keys are returned.
+    #
+    # See {GPGME::Key.find} for an example of how to use, or for an easier way
+    # to use.
+    def each_key(pattern = nil, secret_only = false, &block)
+      keylist_start(pattern, secret_only)
+      begin
+        loop { yield keylist_next }
+      rescue EOFError
+        # The last key in the list has already been returned.
+      ensure
+        keylist_end
+      end
+    end
+    alias each_keys each_key
+
+    # Returns the keys that match the +pattern+, or all if +pattern+ is nil.
+    # Returns only secret keys if +secret_only+ is true.
+    def keys(pattern = nil, secret_only = nil)
+      keys = []
+      each_key(pattern, secret_only) do |key|
+        keys << key
+      end
+      keys
+    end
+
+    # Get the key with the +fingerprint+.
+    # If +secret+ is +true+, secret key is returned.
+    def get_key(fingerprint, secret = false)
+      rkey = []
+      err = GPGME::gpgme_get_key(self, fingerprint, rkey, secret ? 1 : 0)
+      exc = GPGME::error_to_exception(err)
+      raise exc if exc
+      rkey[0]
+    end
+
+    ##
+    # Import/export and generation/deletion of keys
+    ##
+
+    # Generate a new key pair.
+    # +parms+ is a string which looks like
+    #
+    #  <GnupgKeyParms format="internal">
+    #  Key-Type: DSA
+    #  Key-Length: 1024
+    #  Subkey-Type: ELG-E
+    #  Subkey-Length: 1024
+    #  Name-Real: Joe Tester
+    #  Name-Comment: with stupid passphrase
+    #  Name-Email: joe@foo.bar
+    #  Expire-Date: 0
+    #  Passphrase: abc
+    #  </GnupgKeyParms>
+    #
+    # If +pubkey+ and +seckey+ are both set to +nil+, it stores the generated
+    # key pair into your key ring.
+    def generate_key(parms, pubkey = nil, seckey = nil)
+      err = GPGME::gpgme_op_genkey(self, parms, pubkey, seckey)
+      exc = GPGME::error_to_exception(err)
+      raise exc if exc
+    end
+    alias genkey generate_key
+
+    # Extract the public keys that match the +recipients+. Returns a
+    # {GPGME::Data} object which is not rewinded (should do +seek(0)+
+    # before reading).
+    #
+    # Private keys cannot be exported due to GPGME restrictions.
+    #
+    # If passed, the key will be exported to +keydata+, which must be
+    # a {GPGME::Data} object.
+    def export_keys(recipients, keydata = Data.new)
+      err = GPGME::gpgme_op_export(self, recipients, 0, keydata)
+      exc = GPGME::error_to_exception(err)
+      raise exc if exc
+      keydata
+    end
+    alias export export_keys
+
+    # Add the keys in the data buffer to the key ring.
+    def import_keys(keydata)
+      err = GPGME::gpgme_op_import(self, keydata)
+      exc = GPGME::error_to_exception(err)
+      raise exc if exc
+    end
+    alias import import_keys
+
+    def import_result
+      GPGME::gpgme_op_import_result(self)
+    end
+
+    # Delete the key from the key ring.
+    # If allow_secret is false, only public keys are deleted,
+    # otherwise secret keys are deleted as well.
+    def delete_key(key, allow_secret = false)
+      err = GPGME::gpgme_op_delete(self, key, allow_secret ? 1 : 0)
+      exc = GPGME::error_to_exception(err)
+      raise exc if exc
+    end
+    alias delete delete_key
+
+    # Edit attributes of the key in the local key ring.
+    def edit_key(key, editfunc, hook_value = nil, out = Data.new)
+      err = GPGME::gpgme_op_edit(self, key, editfunc, hook_value, out)
+      exc = GPGME::error_to_exception(err)
+      raise exc if exc
+    end
+    alias edit edit_key
+
+    # Edit attributes of the key on the card.
+    def edit_card_key(key, editfunc, hook_value = nil, out = Data.new)
+      err = GPGME::gpgme_op_card_edit(self, key, editfunc, hook_value, out)
+      exc = GPGME::error_to_exception(err)
+      raise exc if exc
+    end
+    alias edit_card edit_card_key
+    alias card_edit edit_card_key
+
+    ##
+    # Crypto operations
+    ##
+
+    # Decrypt the ciphertext and return the plaintext.
+    def decrypt(cipher, plain = Data.new)
+      err = GPGME::gpgme_op_decrypt(self, cipher, plain)
+      exc = GPGME::error_to_exception(err)
+      raise exc if exc
+      plain
+    end
+
+    def decrypt_verify(cipher, plain = Data.new)
+      err = GPGME::gpgme_op_decrypt_verify(self, cipher, plain)
+      exc = GPGME::error_to_exception(err)
+      raise exc if exc
+      plain
+    end
+
+    def decrypt_result
+      GPGME::gpgme_op_decrypt_result(self)
+    end
+
+    # Verify that the signature in the data object is a valid signature.
+    def verify(sig, signed_text = nil, plain = Data.new)
+      err = GPGME::gpgme_op_verify(self, sig, signed_text, plain)
+      exc = GPGME::error_to_exception(err)
+      raise exc if exc
+      plain
+    end
+
+    def verify_result
+      GPGME::gpgme_op_verify_result(self)
+    end
+
+    # Remove the list of signers from this object.
+    def clear_signers
+      GPGME::gpgme_signers_clear(self)
+    end
+
+    # Add _keys_ to the list of signers.
+    def add_signer(*keys)
+      keys.each do |key|
+        err = GPGME::gpgme_signers_add(self, key)
+        exc = GPGME::error_to_exception(err)
+        raise exc if exc
+      end
+    end
+
+    # Create a signature for the text.
+    # +plain+ is a data object which contains the text.
+    # +sig+ is a data object where the generated signature is stored.
+    def sign(plain, sig = Data.new, mode = GPGME::SIG_MODE_NORMAL)
+      err = GPGME::gpgme_op_sign(self, plain, sig, mode)
+      exc = GPGME::error_to_exception(err)
+      raise exc if exc
+      sig
+    end
+
+    def sign_result
+      GPGME::gpgme_op_sign_result(self)
+    end
+
+    # Encrypt the plaintext in the data object for the recipients and
+    # return the ciphertext.
+    def encrypt(recp, plain, cipher = Data.new, flags = 0)
+      err = GPGME::gpgme_op_encrypt(self, recp, flags, plain, cipher)
+      exc = GPGME::error_to_exception(err)
+      raise exc if exc
+      cipher
+    end
+
+    def encrypt_result
+      GPGME::gpgme_op_encrypt_result(self)
+    end
+
+    def encrypt_sign(recp, plain, cipher = Data.new, flags = 0)
+      err = GPGME::gpgme_op_encrypt_sign(self, recp, flags, plain, cipher)
+      exc = GPGME::error_to_exception(err)
+      raise exc if exc
+      cipher
+    end
+
+    def inspect
+      "#<#{self.class} protocol=#{PROTOCOL_NAMES[protocol] || protocol}, \
+armor=#{armor}, textmode=#{textmode}, \
+keylist_mode=#{KEYLIST_MODE_NAMES[keylist_mode]}>"
+    end
+
+    private
+
+    def self.pass_function(pass, uid_hint, passphrase_info, prev_was_bad, fd)
+      io = ::FFI::IO.for_fd(fd, 'w')
+      io.puts pass
+      io.flush
+    end
+
+  end
+end

data/lib/gpgme/data.rb

@@ -0,0 +1,189 @@
+module GPGME
+
+  ##
+  # A class whose purpose is to unify the way we work with the data (both input
+  # and output). Most of the calls expect instances of this class, or will try
+  # to create one from your parameters.
+  #
+  # Read the {#read}, {#write} and {#seek} methods for the most commonly used
+  # methods.
+  class Data
+
+    BLOCK_SIZE = 4096
+
+    class << self
+
+      ##
+      # We implement +self.new+ instead of initialize because objects are actually
+      # instantiated through the C API with stuff like +gpgme_data_new+.
+      #
+      # We try to create a {GPGME::Data} smartly depending on the object passed, and if
+      # another {GPGME::Data} object is passed, it just returns it, so when in
+      # doubt, you can always pass a {GPGME::Data} object.
+      #
+      # @example empty
+      #   data = GPGME::Data.new
+      #   data.write("stuff")
+      #
+      # @example from a string
+      #   data = GPGME::Data.new("From a string")
+      #
+      # @example from a file
+      #   data = GPGME::Data.new(File.open("secure.pass"))
+      #
+      # @example from a file descriptor
+      #   data = GPGME::Data.new(0) # Standard input
+      #   data = GPGME::Data.new(1) # Standard output
+      #
+      #   file = File.open("secure.pass")
+      #   data = GPGME::Data.new(file.fileno) # file descriptor
+      #
+      def new(object = nil)
+        if object.nil?
+          empty!
+        elsif object.is_a?(Data)
+          object
+        elsif object.is_a?(Integer)
+          from_fd(object)
+        elsif object.respond_to? :to_str
+          from_str(object.to_str)
+        elsif object.respond_to? :to_io
+          from_io(object.to_io)
+        elsif object.respond_to? :open
+          from_io(object.open)
+        end
+      end
+
+      # Create a new instance with an empty buffer.
+      def empty!
+        rdh = []
+        err = GPGME::gpgme_data_new(rdh)
+        exc = GPGME::error_to_exception(err)
+        raise exc if exc
+        rdh.first
+      end
+
+      # Create a new instance with internal buffer.
+      def from_str(string)
+        rdh = []
+        err = GPGME::gpgme_data_new_from_mem(rdh, string, string.length)
+        exc = GPGME::error_to_exception(err)
+        raise exc if exc
+        rdh.first
+      end
+
+      # Create a new instance associated with a given IO.
+      def from_io(io)
+        from_callbacks(IOCallbacks.new(io))
+      end
+
+      # Create a new instance from the specified file descriptor.
+      def from_fd(fd)
+        rdh = []
+        err = GPGME::gpgme_data_new_from_fd(rdh, fd)
+        exc = GPGME::error_to_exception(err)
+        raise exc if exc
+        rdh.first
+      end
+
+      # Create a new instance from the specified callbacks.
+      def from_callbacks(callbacks, hook_value = nil)
+        rdh = []
+        err = GPGME::gpgme_data_new_from_cbs(rdh, callbacks, hook_value)
+        exc = GPGME::error_to_exception(err)
+        raise exc if exc
+        rdh.first
+      end
+    end # class << self
+
+    # Read at most +length+ bytes from the data object, or to the end
+    # of file if +length+ is omitted or is +nil+.
+    #
+    # @example
+    #   data = GPGME::Data.new("From a string")
+    #   data.read # => "From a string"
+    #
+    # @example
+    #   data = GPGME::Data.new("From a string")
+    #   data.read(4) # => "From"
+    #
+    def read(length = nil)
+      if length
+        GPGME::gpgme_data_read(self, length)
+      else
+        buf = String.new
+        loop do
+          s = GPGME::gpgme_data_read(self, BLOCK_SIZE)
+          break unless s
+          buf << s
+        end
+        buf
+      end
+    end
+
+    ##
+    # Seek to a given +offset+ in the data object according to the
+    # value of +whence+.
+    #
+    # @example going to the beginning of the buffer after writing something
+    #  data = GPGME::Data.new("Some data")
+    #  data.read # => "Some data"
+    #  data.read # => ""
+    #  data.seek 0
+    #  data.read # => "Some data"
+    #
+    def seek(offset, whence = IO::SEEK_SET)
+      GPGME::gpgme_data_seek(self, offset, IO::SEEK_SET)
+    end
+
+    ##
+    # Writes +length+ bytes from +buffer+ into the data object.
+    # Writes the full buffer if no length passed.
+    #
+    # @example
+    #   data = GPGME::Data.new
+    #   data.write "hola"
+    #   data.seek 0
+    #   data.read # => "hola"
+    #
+    # @example
+    #   data = GPGME::Data.new
+    #   data.write "hola", 2
+    #   data.seek 0
+    #   data.read # => "ho"
+    #
+    def write(buffer, length = buffer.length)
+      GPGME::gpgme_data_write(self, buffer, length)
+    end
+
+    ##
+    # Return the encoding of the underlying data.
+    def encoding
+      GPGME::gpgme_data_get_encoding(self)
+    end
+
+    ##
+    # Sets the encoding for this buffer. Accepts only values in one of the
+    # DATA_ENCODING_* constants.
+    #
+    # @raise [GPGME::Error::InvalidValue] if the value isn't accepted.
+    def encoding=(encoding)
+      err = GPGME::gpgme_data_set_encoding(self, encoding)
+      exc = GPGME::error_to_exception(err)
+      raise exc if exc
+      encoding
+    end
+
+    ##
+    # Return the entire content of the data object as string.
+    def to_s
+      pos = seek(0, IO::SEEK_CUR)
+      begin
+        seek(0)
+        read
+      ensure
+        seek(pos)
+      end
+    end
+  end
+end