rnp 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ef8ee2f2315bedb5e82708df1ac8773af28ca3e5ac27101fc5c8e77e2f8ffc5
-  data.tar.gz: '0893d5dec0c0e0c29729422d3cc5980998ef3960be5be6627e357e6bff549401'
+  metadata.gz: 3334282a18758db4c39bec6a7b3e3096fe4dadf85d3a8382ec780bd2a816371e
+  data.tar.gz: 0a1b13c36fdc0c5479e2a4531355291867481e7d1ec40bf1ec251eeb49a27cef
 SHA512:
-  metadata.gz: 64974dec05daf601cbfbe8909b8dad87d5b5b9eb209b42d7070a98b5964c8d3e1f0fcd70a79aaae84a2db897254a2a069487d05e4011d4e178477eac0c2e6bf9
-  data.tar.gz: 5d037d98989aaaa28b03587d1e7fe0cba204186570442810cb78a0e4332f4872920230e9cca1902f2ba88ec727c3ee91589e24d7c74e4695f310d6ff4dc7a5cf
+  metadata.gz: e41f0d9936b9b39c0646d80c6ef385aa658afe247a035a72b7005ec706fafcdfb1ffd9cf3c0f9cdad616ec12e97c0a4417460f693e71c5f56ac9942321ef5d6b
+  data.tar.gz: c19e9f0d2775572ac817da0f1754c057ee9281f6bb209404c1a91505532fac0a1474786dd29e73a4c9454afa8bb534b61dab80b0645127f42d7b22e23fa65594

data/CHANGELOG.adoc

@@ -1,5 +1,10 @@
 == Changelog
 
+=== 1.0.3 [08-21-2018]
+* Added support for key exporting.
+* Added support for enarmoring/dearmoring arbitrary data.
+* Added support to retreive the rnp version.
+
 === 1.0.2 [08-14-2018]
 * Support for newer rnp library naming (librnp-0).
 

data/lib/rnp/error.rb

@@ -18,6 +18,12 @@ class Rnp
     end
   end
 
+  class FeatureNotAvailableError < Error
+    def initialize(feature)
+      super("#{feature} is not available in your version of rnp.")
+    end
+  end
+
   class BadPasswordError < Error; end
   class InvalidSignatureError < Error; end
   class BadFormatError < Error; end

data/lib/rnp/ffi/librnp.rb

@@ -4,6 +4,8 @@
 
 require 'ffi'
 
+require 'rnp/error'
+
 # @api private
 module LibRnp
   extend FFI::Library
@@ -287,6 +289,41 @@ module LibRnp
                   %i[pointer],
                   :uint32
 
+  # some newer APIs that may not be present
+  {
+    # key export
+    rnp_key_export: [%i[pointer pointer uint32], :uint32],
+    # enarmor/dearmor
+    rnp_enarmor: [%i[pointer pointer pointer], :uint32],
+    rnp_dearmor: [%i[pointer pointer], :uint32],
+    # versioning
+    rnp_version_string: [%i[], :string],
+    rnp_version_string_full: [%i[], :string],
+    rnp_version: [%i[], :uint32],
+    rnp_version_for: [%i[uint32 uint32 uint32], :uint32],
+    rnp_version_major: [%i[uint32], :uint32],
+    rnp_version_minor: [%i[uint32], :uint32],
+    rnp_version_patch: [%i[uint32], :uint32]
+  }.each do |name, signature|
+    present = ffi_libraries[0].find_function(name.to_s)
+    if !present
+      class_eval do
+        define_singleton_method(name) do |*|
+          raise Rnp::FeatureNotAvailableError, name
+        end
+      end
+    else
+      attach_function name, signature[0], signature[1]
+    end
+    class_eval do
+      const_set("HAVE_#{name.upcase}", present)
+    end
+  end
+
+  RNP_KEY_EXPORT_ARMORED = (1 << 0)
+  RNP_KEY_EXPORT_PUBLIC =  (1 << 1)
+  RNP_KEY_EXPORT_SECRET =  (1 << 2)
+  RNP_KEY_EXPORT_SUBKEYS = (1 << 3)
 
   RNP_LOAD_SAVE_PUBLIC_KEYS = (1 << 0)
   RNP_LOAD_SAVE_SECRET_KEYS = (1 << 1)

data/lib/rnp/key.rb

@@ -182,6 +182,48 @@ class Rnp
       bool_property(:rnp_key_have_secret)
     end
 
+    # Export a public key.
+    #
+    # By default, when exporting a primary key, only the primary key
+    # will be exported. When exporting a subkey, the primary key and
+    # subkey will both be exported.
+    #
+    # @param output [Output] the output to write the exported key.
+    #   If nil, the result will be returned directly as a String.
+    # @param armored (see Sign#armored=)
+    # @param with_subkeys [Boolean] when exporting a primary key,
+    #   this controls whether all subkeys should also be exported.
+    #   When true, the primary key and all subkeys will be exported.
+    #   When false, only the primary key will be exported.
+    #   This parameter is not valid when the key is a subkey.
+    # @return [nil, String]
+    def export_public(armored: true, with_subkeys: false, output: nil)
+      Output.default(output) do |output_|
+        export(public_key: true, with_subkeys: with_subkeys, armored: armored, output: output_)
+      end
+    end
+
+    # Export a secret key.
+    #
+    # By default, when exporting a primary key, only the primary key
+    # will be exported. When exporting a subkey, the primary key and
+    # subkey will both be exported.
+    #
+    # @param output [Output] the output to write the exported key.
+    #   If nil, the result will be returned directly as a String.
+    # @param armored (see Sign#armored=)
+    # @param with_subkeys [Boolean] when exporting a primary key,
+    #   this controls whether all subkeys should also be exported.
+    #   When true, the primary key and all subkeys will be exported.
+    #   When false, only the primary key will be exported.
+    #   This parameter is not valid when the key is a subkey.
+    # @return [nil, String]
+    def export_secret(armored: true, with_subkeys: false, output: nil)
+      Output.default(output) do |output_|
+        export(secret_key: true, with_subkeys: with_subkeys, armored: armored, output: output_)
+      end
+    end
+
     # Returns the raw public key data as PGP packets.
     #
     # @return [String]
@@ -270,6 +312,15 @@ class Rnp
         end
       end
     end
+
+    def export(public_key: false, secret_key: false, with_subkeys: false, armored: true, output: nil)
+      flags = 0
+      flags |= LibRnp::RNP_KEY_EXPORT_ARMORED if armored
+      flags |= LibRnp::RNP_KEY_EXPORT_PUBLIC if public_key
+      flags |= LibRnp::RNP_KEY_EXPORT_SECRET if secret_key
+      flags |= LibRnp::RNP_KEY_EXPORT_SUBKEYS if with_subkeys
+      Rnp.call_ffi(:rnp_key_export, @ptr, output.ptr, flags)
+    end
   end # class
 end # class
 

data/lib/rnp/misc.rb

@@ -67,5 +67,82 @@ class Rnp
       LibRnp.rnp_buffer_destroy(pformat)
     end
   end
+
+  # Add ASCII Armor to data.
+  #
+  # @param input [Input] the input to read data from
+  # @param output [Output] the output to write the armored
+  #   data to. If nil, the result will be returned directly
+  #   as a String.
+  # @return [nil, String]
+  def self.enarmor(input:, output: nil, type: nil)
+    Output.default(output) do |output_|
+      Rnp.call_ffi(:rnp_enarmor, input.ptr, output_.ptr, type)
+    end
+  end
+
+  # Remove ASCII Armor from data.
+  #
+  # @param input [Input] the input to read the ASCII-Armored data from
+  # @param output [Output] the output to write the dearmored data to. If
+  #   nil, the result will be returned directly as a String.
+  # @return [nil, String]
+  def self.dearmor(input:, output: nil)
+    Output.default(output) do |output_|
+      Rnp.call_ffi(:rnp_dearmor, input.ptr, output_.ptr)
+    end
+  end
+
+  # Get the version of the rnp library as a string.
+  #
+  # @return [String]
+  def self.version_string
+    LibRnp.rnp_version_string
+  end
+
+  # Get the detailed version of the rnp library as a string.
+  #
+  # @return [String]
+  def self.version_string_full
+    LibRnp.rnp_version_string_full
+  end
+
+  # Get the version stamp of the rnp library as an unsigned
+  # 32-bit integer. This number can be compared against other
+  # stamps generated with {version_for}.
+  #
+  # @return [Integer]
+  def self.version
+    LibRnp.rnp_version
+  end
+
+  # Encode the given major, minor, and patch numbers into a version
+  # stamp.
+  #
+  # @return [Integer]
+  def self.version_for(major, minor, patch)
+    LibRnp.rnp_version_for(major, minor, patch)
+  end
+
+  # Extract the major version component from the given version stamp.
+  #
+  # @return [Integer]
+  def self.version_major(version)
+    LibRnp.rnp_version_major(version)
+  end
+
+  # Extract the minor version component from the given version stamp.
+  #
+  # @return [Integer]
+  def self.version_minor(version)
+    LibRnp.rnp_version_minor(version)
+  end
+
+  # Extract the patch version component from the given version stamp.
+  #
+  # @return [Integer]
+  def self.version_patch(version)
+    LibRnp.rnp_version_patch(version)
+  end
 end # class
 

data/lib/rnp/output.rb

@@ -116,6 +116,14 @@ class Rnp
       Rnp.call_ffi(:rnp_output_to_callback, pptr, writercb, nil, nil)
       Output.new(pptr.read_pointer, writercb)
     end
+
+    # @api private
+    def self.default(output)
+      to_str = output.nil?
+      output = Output.to_string if to_str
+      yield output
+      output.string if to_str
+    end
   end # class
 end # class
 

data/lib/rnp/rnp.rb

@@ -252,7 +252,7 @@ class Rnp
            creation_time: nil,
            expiration_time: nil,
            hash: nil)
-    default_output(output) do |output_|
+    Output.default(output) do |output_|
       sign = start_sign(input: input, output: output_)
       sign.options = {
         armored: armored,
@@ -280,7 +280,7 @@ class Rnp
                      creation_time: nil,
                      expiration_time: nil,
                      hash: nil)
-    default_output(output) do |output_|
+    Output.default(output) do |output_|
       sign = start_cleartext_sign(input: input, output: output_)
       sign.options = {
         compression: compression,
@@ -309,7 +309,7 @@ class Rnp
                     creation_time: nil,
                     expiration_time: nil,
                     hash: nil)
-    default_output(output) do |output_|
+    Output.default(output) do |output_|
       sign = start_detached_sign(input: input, output: output_)
       sign.options = {
         armored: armored,
@@ -353,7 +353,7 @@ class Rnp
               armored: nil,
               compression: nil,
               cipher: nil)
-    default_output(output) do |output_|
+    Output.default(output) do |output_|
       enc = start_encrypt(input: input, output: output_)
       enc.options = {
         armored: armored,
@@ -383,7 +383,7 @@ class Rnp
                        hash: nil,
                        creation_time: nil,
                        expiration_time: nil)
-    default_output(output) do |output_|
+    Output.default(output) do |output_|
       enc = start_encrypt(input: input, output: output_)
       enc.options = {
         armored: armored,
@@ -417,7 +417,7 @@ class Rnp
                         s2k_hash: nil,
                         s2k_iterations: 0,
                         s2k_cipher: nil)
-    default_output(output) do |output_|
+    Output.default(output) do |output_|
       enc = start_encrypt(input: input, output: output_)
       enc.options = {
         armored: armored,
@@ -442,7 +442,7 @@ class Rnp
   #   If nil, the result will be returned directly as a String.
   # @return [nil, String]
   def decrypt(input:, output: nil)
-    default_output(output) do |output_|
+    Output.default(output) do |output_|
       Rnp.call_ffi(:rnp_decrypt, @ptr, input.ptr, output_.ptr)
     end
   end
@@ -584,12 +584,5 @@ class Rnp
     flags |= LibRnp::RNP_LOAD_SAVE_SECRET_KEYS if secret_keys
     flags
   end
-
-  def default_output(output)
-    to_str = output.nil?
-    output = Output.to_string if to_str
-    yield output
-    output.string if to_str
-  end
 end # class
 

data/lib/rnp/version.rb

@@ -3,6 +3,6 @@
 # (c) 2018 Ribose Inc.
 
 class Rnp
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end # class
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rnp
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-14 00:00:00.000000000 Z
+date: 2018-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor