cose 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0eb0523fe9b7196988a95f1055ad305d36f6cad45337c344d9b2a55d2f42465e
-  data.tar.gz: 181105f066d6797199b8c495dfc3e4552248692e95c360a77fafad4c0a501046
+  metadata.gz: 05132ebf44cbd8025419363e4f7225a55e28896b9db9c61e490866bdf7ca7d1d
+  data.tar.gz: 5656845e945fa562609f59c05a417a433c2d92f771395727634d7ea1ebc71838
 SHA512:
-  metadata.gz: 423c129d28fca26cdf359deff30dc9cb9a45dce499df15d2607010dc1cbdd4e3aacfb79609d90b6b4e0dff758cf0b375b93cc871a42e4871e89812e04088d0ad
-  data.tar.gz: 13add48d5e31fad84eb20d42805163de9a993ccec0b02bc0d6da0b4b19390db55064f58a1446421a227307e62b231d412e73bb7f0bb8919091316911d7a8cc10
+  metadata.gz: d8c048d5f991c86a246d2ab7384717be17f86edaddbcd4c1f4ce2dbd3b8b25d66b85831ce3b9c5d02f0ce033abeac84b457397d5bb1df540aebd3693b659ee60
+  data.tar.gz: '01953ba4ed4d5734ad0044b3e8735dad85f95407663ad52c04a1d306094c8cdf6b01943c55813eb87ae56688098a6d8cef364c096e9d393b4f1ff2a7873bafd4'

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [v0.4.0] - 2019-03-12
+
+### Added
+
+- RSA public key deserialization
+- Key type-agnostic deserialization
+
+### Changed
+
+- Keys `.from_cbor` methods changed to `.deserialize`
+
 ## [v0.3.0] - 2019-03-09
 
 ### Added
@@ -28,6 +39,7 @@
 - EC2 key object
 - Works with ruby 2.5
 
+[v0.4.0]: https://github.com/cedarcode/cose-ruby/compare/v0.3.0...v0.4.0/
 [v0.3.0]: https://github.com/cedarcode/cose-ruby/compare/v0.2.0...v0.3.0/
 [v0.2.0]: https://github.com/cedarcode/cose-ruby/compare/v0.1.0...v0.2.0/
 [v0.1.0]: https://github.com/cedarcode/cose-ruby/compare/5725d9b5db978f19a21bd59182f092d31a118eff...v0.1.0/

data/README.md

@@ -25,12 +25,31 @@ Or install it yourself as:
 
 ### Key Objects
 
+```ruby
+cbor_data = "..."
+
+key = COSE::Key.deserialize(cbor_data)
+
+case key.class
+when COSE::Key::EC2
+  key.curve
+  key.x_coordinate
+  key.y_coordinate
+  key.d_coordinate
+when COSE::Key::RSA
+  key.modulus_n
+  key.public_exponent_e
+when COSE::Key::Symmetric
+  key.key_value
+end
+```
+
 #### EC2
 
 ```ruby
 cbor_data = "..."
 
-key = COSE::Key::EC2.from_cbor(cbor_data)
+key = COSE::Key::EC2.deserialize(cbor_data)
 
 key.curve
 key.x_coordinate
@@ -43,11 +62,22 @@ key.d_coordinate
 ```ruby
 cbor_data = "..."
 
-key = COSE::Key::Symmetric.from_cbor(cbor_data)
+key = COSE::Key::Symmetric.deserialize(cbor_data)
 
 key.key_value
 ```
 
+#### RSA
+
+```ruby
+cbor_data = "..."
+
+key = COSE::Key::RSA.deserialize(cbor_data)
+
+key.modulus_n
+key.public_exponent_e
+```
+
 ### Signing Objects
 
 #### COSE_Sign

data/lib/cose/key.rb

@@ -0,0 +1,27 @@
+require "cbor"
+require "cose/key/ec2"
+require "cose/key/rsa"
+require "cose/key/symmetric"
+
+module COSE
+  class UnknownKeyType < StandardError; end
+
+  module Key
+    LABEL_KTY = 1
+
+    def self.deserialize(data)
+      map = CBOR.decode(data)
+
+      case map[LABEL_KTY]
+      when COSE::Key::EC2::KTY_EC2
+        COSE::Key::EC2.from_map(map)
+      when COSE::Key::RSA::KTY_RSA
+        COSE::Key::RSA.from_map(map)
+      when COSE::Key::Symmetric::KTY_SYMMETRIC
+        COSE::Key::Symmetric.from_map(map)
+      else
+        raise UnknownKeyType, "Unsupported or unknown key type #{map[LABEL_KTY]}"
+      end
+    end
+  end
+end

data/lib/cose/key/base.rb

@@ -5,14 +5,12 @@ require "cbor"
 module COSE
   module Key
     class Base
-      KTY_LABEL = 1
-
-      def self.from_cbor(cbor)
+      def self.deserialize(cbor)
         from_map(CBOR.decode(cbor))
       end
 
       def self.enforce_type(map, kty, error_message)
-        if map[KTY_LABEL] != kty
+        if map[LABEL_KTY] != kty
           raise error_message
         end
       end

data/lib/cose/key/rsa.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "cose/key/base"
+
+module COSE
+  module Key
+    class RSA < Base
+      LABEL_N = -1
+      LABEL_E = -2
+
+      KTY_RSA = 3
+
+      attr_reader :modulus_n, :public_exponent_e
+
+      def initialize(modulus_n:, public_exponent_e:)
+        if !modulus_n
+          raise ArgumentError, "Required modulus_n is missing"
+        elsif !public_exponent_e
+          raise ArgumentError, "Required public_exponent_e is missing"
+        else
+          @modulus_n = modulus_n
+          @public_exponent_e = public_exponent_e
+        end
+      end
+
+      def self.from_map(map)
+        enforce_type(map, KTY_RSA, "Not an RSA key")
+
+        new(modulus_n: map[LABEL_N], public_exponent_e: map[LABEL_E])
+      end
+    end
+  end
+end

data/lib/cose/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module COSE
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cose
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Gonzalo Rodriguez
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-09 00:00:00.000000000 Z
+date: 2019-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cbor
@@ -124,8 +124,10 @@ files:
 - lib/cose.rb
 - lib/cose/encrypt.rb
 - lib/cose/encrypt0.rb
+- lib/cose/key.rb
 - lib/cose/key/base.rb
 - lib/cose/key/ec2.rb
+- lib/cose/key/rsa.rb
 - lib/cose/key/symmetric.rb
 - lib/cose/mac.rb
 - lib/cose/mac0.rb