rnp 1.0.3 → 1.0.5

data/lib/rnp/rnp.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# (c) 2018 Ribose Inc.
+# (c) 2018,2019 Ribose Inc.
 
 require 'English'
 require 'json'
@@ -14,6 +14,7 @@ require 'rnp/key'
 require 'rnp/op/sign'
 require 'rnp/op/verify'
 require 'rnp/op/encrypt'
+require "rnp/op/generate"
 
 # Class used for interacting with RNP.
 class Rnp
@@ -128,6 +129,89 @@ class Rnp
     end
   end
 
+  # Generate an RSA key (w/optional subkey).
+  #
+  # @param userid [String] the userid for the key
+  # @param bits [Integer] the bit length for the primary key
+  # @param subbits [Integer] the bit length for the subkey
+  #   (0 if no subkey should be generated)
+  # @param password [String] the password to protect the key(s)
+  #   (nil for no protection)
+  def generate_rsa(userid:, bits:, subbits: 0, password:)
+    pptr = FFI::MemoryPointer.new(:pointer)
+    Rnp.call_ffi(:rnp_generate_key_rsa, @ptr, bits, subbits, userid, password,
+                 pptr)
+    pkey = pptr.read_pointer
+    Key.new(pkey) unless pkey.null?
+  end
+
+  # Generate a DSA (w/optional ElGamal subkey) key.
+  #
+  # @param userid [String] the userid for the key
+  # @param bits [Integer] the bit length for the primary key
+  # @param subbits [Integer] the bit length for the subkey
+  #   (0 if no subkey should be generated)
+  # @param password [String] the password to protect the key(s)
+  #   (nil for no protection)
+  def generate_dsa_elgamal(userid:, bits:, subbits: 0, password:)
+    pptr = FFI::MemoryPointer.new(:pointer)
+    Rnp.call_ffi(:rnp_generate_key_dsa_eg, @ptr, bits, subbits, userid,
+                 password, pptr)
+    pkey = pptr.read_pointer
+    Key.new(pkey) unless pkey.null?
+  end
+
+  # Generate an ECDSA+ECDH key pair.
+  #
+  # @param userid [String] the userid for the key
+  # @param curve [String] the name of the curve
+  # @param password [String] the password to protect the key(s)
+  #   (nil for no protection)
+  def generate_ecdsa_ecdh(userid:, curve:, password:)
+    pptr = FFI::MemoryPointer.new(:pointer)
+    Rnp.call_ffi(:rnp_generate_key_ec, @ptr, curve, userid, password, pptr)
+    pkey = pptr.read_pointer
+    Key.new(pkey) unless pkey.null?
+  end
+
+  # Generate an EdDSA+x25519 key pair.
+  #
+  # @param userid [String] the userid for the key
+  # @param password [String] the password to protect the key(s)
+  #   (nil for no protection)
+  def generate_eddsa_25519(userid:, password:)
+    pptr = FFI::MemoryPointer.new(:pointer)
+    Rnp.call_ffi(:rnp_generate_key_25519, @ptr, userid, password, pptr)
+    pkey = pptr.read_pointer
+    Key.new(pkey) unless pkey.null?
+  end
+
+  # Generate an SM2 key pair.
+  #
+  # @param userid [String] the userid for the key
+  # @param password [String] the password to protect the key(s)
+  #   (nil for no protection)
+  def generate_sm2(userid:, password:)
+    pptr = FFI::MemoryPointer.new(:pointer)
+    Rnp.call_ffi(:rnp_generate_key_sm2, @ptr, userid, password, pptr)
+    pkey = pptr.read_pointer
+    Key.new(pkey) unless pkey.null?
+  end
+
+  # Generate a key and optional subkey.
+  #
+  # @param userid [String] the userid for the key
+  # @param password [String] the password to protect the key(s)
+  #   (nil for no protection)
+  def generate(type:, userid:, bits:, curve: nil, password:,
+               subtype: nil, subbits: 0, subcurve: nil)
+    pptr = FFI::MemoryPointer.new(:pointer)
+    Rnp.call_ffi(:rnp_generate_key_ex, @ptr, type, subtype, bits, subbits,
+                 curve, subcurve, userid, password, pptr)
+    pkey = pptr.read_pointer
+    Key.new(pkey) unless pkey.null?
+  end
+
   # Load keys.
   #
   # @param format [String] the format of the keys to load (GPG, KBX, G10).
@@ -141,6 +225,13 @@ class Rnp
     Rnp.call_ffi(:rnp_load_keys, @ptr, format, input.ptr, flags)
   end
 
+  def unload_keys(public_keys: true, secret_keys: true)
+    raise ArgumentError, "At least one of public_keys or secret_keys must be true" \
+      if !public_keys && !secret_keys
+    flags = unload_keys_flags(public_keys: public_keys, secret_keys: secret_keys)
+    Rnp.call_ffi(:rnp_unload_keys, @ptr, flags)
+  end
+
   # Save keys.
   #
   # @param format [String] the format to save the keys in (GPG, KBX, G10).
@@ -349,16 +440,19 @@ class Rnp
   # @param armored (see Encrypt#armored=)
   # @param compression (see Encrypt#compression=)
   # @param cipher (see Encrypt#cipher=)
+  # @param aead (see Encrypt#aead=)
   def encrypt(input:, output: nil, recipients:,
               armored: nil,
               compression: nil,
-              cipher: nil)
+              cipher: nil,
+              aead: nil)
     Output.default(output) do |output_|
       enc = start_encrypt(input: input, output: output_)
       enc.options = {
         armored: armored,
         compression: compression,
-        cipher: cipher
+        cipher: cipher,
+        aead: aead,
       }
       simple_encrypt(enc, recipients: recipients)
     end
@@ -373,6 +467,7 @@ class Rnp
   # @param armored (see Encrypt#armored=)
   # @param compression (see Encrypt#compression=)
   # @param cipher (see Encrypt#cipher=)
+  # @param aead (see Encrypt#aead=)
   # @param hash (see Encrypt#hash=)
   # @param creation_time (see Encrypt#creation_time=)
   # @param expiration_time (see Encrypt#expiration_time=)
@@ -380,6 +475,7 @@ class Rnp
                        armored: nil,
                        compression: nil,
                        cipher: nil,
+                       aead: nil,
                        hash: nil,
                        creation_time: nil,
                        expiration_time: nil)
@@ -389,6 +485,7 @@ class Rnp
         armored: armored,
         compression: compression,
         cipher: cipher,
+        aead: aead,
         hash: hash,
         creation_time: creation_time,
         expiration_time: expiration_time
@@ -406,6 +503,7 @@ class Rnp
   # @param armored (see Encrypt#armored=)
   # @param compression (see Encrypt#compression=)
   # @param cipher (see Encrypt#cipher=)
+  # @param aead (see Encrypt#aead=)
   # @param s2k_hash (see Encrypt#add_password)
   # @param s2k_iterations (see Encrypt#add_password)
   # @param s2k_cipher (see Encrypt#add_password)
@@ -414,6 +512,7 @@ class Rnp
                         armored: nil,
                         compression: nil,
                         cipher: nil,
+                        aead: nil,
                         s2k_hash: nil,
                         s2k_iterations: 0,
                         s2k_cipher: nil)
@@ -422,7 +521,8 @@ class Rnp
       enc.options = {
         armored: armored,
         compression: compression,
-        cipher: cipher
+        cipher: cipher,
+        aead: aead,
       }
       passwords = [passwords] if passwords.is_a?(String)
       passwords.each do |password|
@@ -447,6 +547,30 @@ class Rnp
     end
   end
 
+  # Start a {Generate} operation.
+  #
+  # @param type [String, Symbol] the key type to generate (RSA, DSA, etc)
+  # @return [Generate]
+  def start_generate(type:)
+    pptr = FFI::MemoryPointer.new(:pointer)
+    Rnp.call_ffi(:rnp_op_generate_create, pptr, @ptr, type.to_s)
+    pgen = pptr.read_pointer
+    Generate.new(pgen) unless pgen.null?
+  end
+
+  # Start a {Generate} operation.
+  #
+  # @param primary [Key] the primary key for which to generate a subkey
+  # @param type [String, Symbol] the key type to generate (RSA, DSA, etc)
+  # @return [Generate]
+  def start_generate_subkey(primary:, type:)
+    pptr = FFI::MemoryPointer.new(:pointer)
+    Rnp.call_ffi(:rnp_op_generate_subkey_create, pptr, @ptr, primary.ptr,
+                 type.to_s)
+    pgen = pptr.read_pointer
+    Generate.new(pgen) unless pgen.null?
+  end
+
   # Create a {Sign} operation.
   #
   # @param input [Input] the input to read the data to be signed
@@ -499,6 +623,41 @@ class Rnp
     Encrypt.new(pencrypt) unless pencrypt.null?
   end
 
+  # Import keys
+  #
+  # @param input [Input] the input to read the (OpenPGP-format) keys from
+  # @param public_keys [Boolean] whether to load public keys
+  # @param secret_keys [Boolean] whether to load secret keys
+  # @return [Hash] information on the imported keys
+  def import_keys(input:, public_keys: true, secret_keys: true)
+    flags = 0
+    flags |= LibRnp::RNP_LOAD_SAVE_PUBLIC_KEYS if public_keys
+    flags |= LibRnp::RNP_LOAD_SAVE_SECRET_KEYS if secret_keys
+    pptr = FFI::MemoryPointer.new(:pointer)
+    Rnp.call_ffi(:rnp_import_keys, @ptr, input.ptr, flags, pptr)
+    begin
+      presults = pptr.read_pointer
+      JSON.parse(presults.read_string) unless pptr.null?
+    ensure
+      LibRnp.rnp_buffer_destroy(presults)
+    end
+  end
+
+  # Import signatures
+  #
+  # @param input [Input] the input to read the (OpenPGP-format) keys from
+  # @return [Hash] information on the imported keys
+  def import_signatures(input:)
+    pptr = FFI::MemoryPointer.new(:pointer)
+    Rnp.call_ffi(:rnp_import_signatures, @ptr, input.ptr, 0, pptr)
+    begin
+      presults = pptr.read_pointer
+      JSON.parse(presults.read_string) unless pptr.null?
+    ensure
+      LibRnp.rnp_buffer_destroy(presults)
+    end
+  end
+
   private
 
   KEY_PROVIDER = lambda do |provider, _rnp, _ctx, identifier_type, identifier, secret|
@@ -584,5 +743,12 @@ class Rnp
     flags |= LibRnp::RNP_LOAD_SAVE_SECRET_KEYS if secret_keys
     flags
   end
+
+  def unload_keys_flags(public_keys:, secret_keys:)
+    flags = 0
+    flags |= LibRnp::RNP_KEY_UNLOAD_PUBLIC if public_keys
+    flags |= LibRnp::RNP_KEY_UNLOAD_SECRET if secret_keys
+    flags
+  end
 end # class
 

data/lib/rnp/signature.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+# (c) 2020 Ribose Inc.
+
+require 'ffi'
+
+require 'rnp/error'
+require 'rnp/ffi/librnp'
+require 'rnp/utils'
+
+class Rnp
+  # Class that represents a signature.
+  class Signature
+    # @api private
+    attr_reader :ptr
+
+    # @api private
+    def initialize(ptr)
+      raise Rnp::Error, 'NULL pointer' if ptr.null?
+      @ptr = FFI::AutoPointer.new(ptr, self.class.method(:destroy))
+    end
+
+    # @api private
+    def self.destroy(ptr)
+      LibRnp.rnp_signature_handle_destroy(ptr)
+    end
+
+    def inspect
+      Rnp.inspect_ptr(self)
+    end
+
+    # The type of the signing key (RSA, etc).
+    #
+    # @return [String]
+    def type
+      string_property(:rnp_signature_get_alg)
+    end
+
+    # The hash algorithm used in the signature.
+    #
+    # @return [String]
+    def hash
+      string_property(:rnp_signature_get_hash_alg)
+    end
+
+    # The signer's key id.
+    #
+    # @return [String]
+    def keyid
+      string_property(:rnp_signature_get_keyid)
+    end
+
+    # The time this signature was created at.
+    #
+    # @return [Time]
+    def creation_time
+      pcreation = FFI::MemoryPointer.new(:uint32)
+      Rnp.call_ffi(:rnp_signature_get_creation, @ptr, pcreation)
+      Time.at(pcreation.read(:uint32))
+    end
+
+    # The signer's key.
+    #
+    # @return [Key]
+    def signer
+      pptr = FFI::MemoryPointer.new(:pointer)
+      Rnp.call_ffi(:rnp_signature_get_signer, @ptr, pptr)
+      pkey = pptr.read_pointer
+      Key.new(pkey) unless pkey.null?
+    end
+
+    # JSON representation of this signature (as a Hash).
+    #
+    # @param mpi [Boolean] if true then MPIs will be included
+    # @param raw [Boolean] if true then raw data will be included
+    # @param grip [Boolean] if true then grips will be included
+    # @return [Hash]
+    def json(mpi: false, raw: false, grip: false)
+      flags = 0
+      flags |= LibRnp::RNP_JSON_DUMP_MPI if mpi
+      flags |= LibRnp::RNP_JSON_DUMP_RAW if raw
+      flags |= LibRnp::RNP_JSON_DUMP_GRIP if grip
+      pptr = FFI::MemoryPointer.new(:pointer)
+      Rnp.call_ffi(:rnp_signature_packet_to_json, @ptr, flags, pptr)
+      begin
+        pvalue = pptr.read_pointer
+        JSON.parse(pvalue.read_string) unless pvalue.null?
+      ensure
+        LibRnp.rnp_buffer_destroy(pvalue)
+      end
+    end
+
+    private
+
+    def string_property(func)
+      pptr = FFI::MemoryPointer.new(:pointer)
+      Rnp.call_ffi(func, @ptr, pptr)
+      begin
+        pvalue = pptr.read_pointer
+        pvalue.read_string unless pvalue.null?
+      ensure
+        LibRnp.rnp_buffer_destroy(pvalue)
+      end
+    end
+  end
+end

data/lib/rnp/userid.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+# (c) 2020 Ribose Inc.
+
+require 'ffi'
+
+require 'rnp/error'
+require 'rnp/ffi/librnp'
+require 'rnp/utils'
+require 'rnp/signature'
+
+class Rnp
+  # Class that represents a UserID
+  class UserID
+    # @api private
+    attr_reader :ptr
+
+    # @api private
+    def initialize(ptr, userid)
+      raise Rnp::Error, 'NULL pointer' if ptr.null?
+      @ptr = FFI::AutoPointer.new(ptr, self.class.method(:destroy))
+      @userid = userid
+    end
+
+    # @api private
+    def self.destroy(ptr)
+      LibRnp.rnp_uid_handle_destroy(ptr)
+    end
+
+    def inspect
+      Rnp.inspect_ptr(self)
+    end
+
+    def to_s
+      @userid
+    end
+
+    # Enumerate each {Signature} for this key.
+    #
+    # @return [self, Enumerator]
+    def each_signature(&block)
+      block or return enum_for(:signature_iterator)
+      signature_iterator(&block)
+      self
+    end
+
+    # Get a list of all {Signature}s for this key.
+    #
+    # @return [Array<Signature>]
+    def signatures
+      each_signature.to_a
+    end
+
+    # Check if this key is revoked.
+    #
+    # @return [Boolean]
+    def revoked?
+      presult = FFI::MemoryPointer.new(:bool)
+      Rnp.call_ffi(:rnp_uid_is_revoked, @ptr, presult)
+      presult.read(:bool)
+    end
+
+    private
+
+    def signature_iterator
+      pcount = FFI::MemoryPointer.new(:size_t)
+      Rnp.call_ffi(:rnp_uid_get_signature_count, @ptr, pcount)
+      count = pcount.read(:size_t)
+      (0...count).each do |i|
+        pptr = FFI::MemoryPointer.new(:pointer)
+        Rnp.call_ffi(:rnp_uid_get_signature_at, @ptr, i, pptr)
+        psig = pptr.read_pointer
+        yield Signature.new(psig) unless psig.null?
+      end
+    end
+  end
+end

data/lib/rnp/version.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
-# (c) 2018 Ribose Inc.
+# (c) 2018-2023 Ribose Inc.
 
 class Rnp
-  VERSION = '1.0.3'
+  VERSION = "1.0.5"
 end # class
-

data/lib/rnp.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# (c) 2018 Ribose Inc.
+# (c) 2018-2020 Ribose Inc.
 
 require 'rnp/error'
 require 'rnp/input'
@@ -10,5 +10,7 @@ require 'rnp/op/sign'
 require 'rnp/op/verify'
 require 'rnp/output'
 require 'rnp/rnp'
+require 'rnp/signature'
+require 'rnp/userid'
 require 'rnp/version'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rnp
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.5
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-21 00:00:00.000000000 Z
+date: 2023-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -16,28 +16,34 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.14'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.14'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
@@ -56,16 +62,22 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '14'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +112,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.55.0
+        version: 0.75.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.55.0
+        version: 0.75.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -170,10 +182,13 @@ files:
 - lib/rnp/key.rb
 - lib/rnp/misc.rb
 - lib/rnp/op/encrypt.rb
+- lib/rnp/op/generate.rb
 - lib/rnp/op/sign.rb
 - lib/rnp/op/verify.rb
 - lib/rnp/output.rb
 - lib/rnp/rnp.rb
+- lib/rnp/signature.rb
+- lib/rnp/userid.rb
 - lib/rnp/utils.rb
 - lib/rnp/version.rb
 homepage: https://www.ribose.com
@@ -189,15 +204,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.4.6
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for the rnp OpenPGP library