cose 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 942297236ed3db166f3ca2c214cbb75d796d0540b283eeea274e24670a3046d0
-  data.tar.gz: 4e4806b02f14c40ef7e7ecd0ce866f0bf153103169eb772b99c37c3145e275b5
+  metadata.gz: 110dd14d01e9d95f2204f1f822e79193f0bfe058eaac32550e8db378acb53d56
+  data.tar.gz: 446fd8dc498be1145266c8582d9b1fe4ad6d416b4a4f8f43dd7fd226fc52f17a
 SHA512:
-  metadata.gz: 75e5802ffb297f37e1157c625a1fa7f22132eb1ba7591d11d226431b755e2777ae432767fa29acc56b61b4963de9307ea937e2f3af644bda1a1bd1b48bf07897
-  data.tar.gz: ca258ea27541fc9f06df83f5c76593e74491c1190d9e2da0aab3f1658bb90dbd9f3d62a486c96c8d97c5500cede385836888fc4326b0b70bf428bea192f807a3
+  metadata.gz: 32a204e8b5675c70900f6b255bf877d6951467b8e9508be9f133d4c5abe3aaad9e91a1e29535c25bded3777feb0a44a1c161a2544809ab0b1ce73a8b151921e5
+  data.tar.gz: a80dba546e7fdaadddfb1e3fb05a0e8ce3066928d9e415d24268678cd2fd3fd39d03f6dc67b4243911fbdb2a3b7ab7d396f54510e7e72fa77fa79d8ecb797872

data/.gitignore

@@ -9,3 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+/Gemfile.lock

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.2
   DisabledByDefault: true
 
 Bundler:

data/.travis.yml

@@ -1,5 +1,13 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.5.1
-before_install: gem install bundler -v 1.16.2
+  - ruby-head
+  - 2.6.1
+  - 2.5.3
+  - 2.4.5
+before_install: gem install bundler -v 2.0.1
+
+matrix:
+  fast_finish: true
+  allow_failures:
+    - rvm: ruby-head

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+## [0.2.0] - 2019-03-04
+
+### Added
+
+- Symmetric key object
+- EC2 key suppors D coordinate
+- Works with ruby 2.4
+
+## [v0.1.0] - 2018-06-08
+
+### Added
+
+- EC2 key object
+- Works with ruby 2.5
+
+[v0.2.0]: https://github.com/cedarcode/cose-ruby/compare/v0.1.0...v.0.2.0/
+[v0.1.0]: https://github.com/cedarcode/cose-ruby/compare/5725d9b5db978f19a21bd59182f092d31a118eff...v0.1.0/

data/README.md

@@ -1,8 +1,9 @@
-# Cose
+# cose
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/cose`. To experiment with that code, run `bin/console` for an interactive prompt.
+COSE ([RFC 8152](https://tools.ietf.org/html/rfc8152)) in ruby
 
-TODO: Delete this and the text above, and describe your gem
+[![Gem](https://img.shields.io/gem/v/cose.svg?style=flat-square)](https://rubygems.org/gems/cose)
+[![Travis](https://img.shields.io/travis/cedarcode/cose-ruby.svg?style=flat-square)](https://travis-ci.org/cedarcode/cose-ruby)
 
 ## Installation
 
@@ -22,7 +23,42 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Key Objects
+
+#### EC2
+
+```ruby
+cbor_data = "..."
+
+key = COSE::Key::EC2.from_cbor(cbor_data)
+
+key.curve
+key.x_coordinate
+key.y_coordinate
+key.d_coordinate
+```
+
+#### Symmetric
+
+```ruby
+cbor_data = "..."
+
+key = COSE::Key::Symmetric.from_cbor(cbor_data)
+
+key.key_value
+```
+
+### Signing Objects
+
+_Pending_
+
+### MAC Objects
+
+_Pending_
+
+### Encryption Objects
+
+_Pending_
 
 ## Development
 
@@ -32,7 +68,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cose.
+Bug reports and pull requests are welcome on GitHub at https://github.com/cedarcode/cose-ruby.
 
 ## License
 

data/cose.gemspec

@@ -10,23 +10,32 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Gonzalo Rodriguez", "Braulio Martinez"]
   spec.email         = ["gonzalo@cedarcode.com", "braulio@cedarcode.com"]
 
-  spec.summary       = "COSE in ruby"
+  spec.summary       = "COSE (RFC 8152) ruby library"
+  spec.homepage      = "https://github.com/cedarcode/cose-ruby"
   spec.license       = "MIT"
 
+  spec.metadata = {
+    "bug_tracker_uri" => "https://github.com/cedarcode/cose-ruby/issues",
+    "changelog_uri" => "https://github.com/cedarcode/cose-ruby/blob/master/CHANGELOG.md",
+    "source_code_uri" => "https://github.com/cedarcode/cose-ruby"
+  }
+
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = ">= 2.2"
+
   spec.add_dependency "cbor", "~> 0.5.9.2"
 
-  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "bundler", ">= 1.17", "< 3"
   spec.add_development_dependency "byebug", "~> 10.0"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rubocop", "0.57.0"
+  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "rspec", "~> 3.8"
+  spec.add_development_dependency "rubocop", "0.58.2"
 end

data/lib/cose/key/base.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "cbor"
+
+module COSE
+  module Key
+    class Base
+      KTY_LABEL = 1
+
+      def self.from_cbor(cbor)
+        from_map(CBOR.decode(cbor))
+      end
+
+      def self.enforce_type(map, kty, error_message)
+        if map[KTY_LABEL] != kty
+          raise error_message
+        end
+      end
+    end
+  end
+end

data/lib/cose/key/ec2.rb

@@ -1,22 +1,22 @@
 # frozen_string_literal: true
 
-require "cbor"
+require "cose/key/base"
 
 module COSE
   module Key
-    class EC2
-      KTY_LABEL = 1
+    class EC2 < Base
       ALG_LABEL = 3
 
       CRV_LABEL = -1
+      D_LABEL = -4
       X_LABEL = -2
       Y_LABEL = -3
 
       KTY_EC2 = 2
 
-      attr_reader :algorithm, :curve, :x_coordinate, :y_coordinate
+      attr_reader :algorithm, :curve, :d_coordinate, :x_coordinate, :y_coordinate
 
-      def initialize(algorithm: nil, curve:, x_coordinate:, y_coordinate:)
+      def initialize(algorithm: nil, curve:, d_coordinate: nil, x_coordinate:, y_coordinate:)
         if !curve
           raise ArgumentError, "Required curve is missing"
         elsif !x_coordinate
@@ -26,26 +26,22 @@ module COSE
         else
           @algorithm = algorithm
           @curve = curve
+          @d_coordinate = d_coordinate
           @x_coordinate = x_coordinate
           @y_coordinate = y_coordinate
         end
       end
 
       def self.from_map(map)
-        if map[KTY_LABEL] == KTY_EC2
-          new(
-            algorithm: map[ALG_LABEL],
-            curve: map[CRV_LABEL],
-            x_coordinate: map[X_LABEL],
-            y_coordinate: map[Y_LABEL]
-          )
-        else
-          raise "Not an EC2 key"
-        end
-      end
-
-      def self.from_cbor(cbor)
-        from_map(CBOR.decode(cbor))
+        enforce_type(map, KTY_EC2, "Not an EC2 key")
+
+        new(
+          algorithm: map[ALG_LABEL],
+          curve: map[CRV_LABEL],
+          d_coordinate: map[D_LABEL],
+          x_coordinate: map[X_LABEL],
+          y_coordinate: map[Y_LABEL]
+        )
       end
     end
   end

data/lib/cose/key/symmetric.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "cose/key/base"
+
+module COSE
+  module Key
+    class Symmetric < Base
+      K_LABEL = -1
+      KTY_SYMMETRIC = 4
+
+      attr_reader :key_value
+
+      def initialize(key_value:)
+        if !key_value
+          raise ArgumentError, "Required key value is missing"
+        end
+
+        @key_value = key_value
+      end
+
+      def self.from_map(map)
+        enforce_type(map, KTY_SYMMETRIC, "Not a Symmetric key")
+
+        new(key_value: map[K_LABEL])
+      end
+    end
+  end
+end

data/lib/cose/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cose
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Gonzalo Rodriguez
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-08 00:00:00.000000000 Z
+date: 2019-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cbor
@@ -29,16 +29,22 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -59,42 +65,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.57.0
+        version: 0.58.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.57.0
+        version: 0.58.2
 description: 
 email:
 - gonzalo@cedarcode.com
@@ -107,8 +113,8 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -116,12 +122,17 @@ files:
 - bin/setup
 - cose.gemspec
 - lib/cose.rb
+- lib/cose/key/base.rb
 - lib/cose/key/ec2.rb
+- lib/cose/key/symmetric.rb
 - lib/cose/version.rb
-homepage: 
+homepage: https://github.com/cedarcode/cose-ruby
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/cedarcode/cose-ruby/issues
+  changelog_uri: https://github.com/cedarcode/cose-ruby/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/cedarcode/cose-ruby
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -130,16 +141,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.2'
 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.0.2
 signing_key: 
 specification_version: 4
-summary: COSE in ruby
+summary: COSE (RFC 8152) ruby library
 test_files: []

data/Gemfile.lock

@@ -1,57 +0,0 @@
-PATH
-  remote: .
-  specs:
-    cose (0.1.0)
-      cbor (~> 0.5.9.2)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.0)
-    byebug (10.0.2)
-    cbor (0.5.9.2)
-    diff-lcs (1.3)
-    jaro_winkler (1.4.0)
-    parallel (1.12.1)
-    parser (2.5.1.0)
-      ast (~> 2.4.0)
-    powerpack (0.1.1)
-    rainbow (3.0.0)
-    rake (10.5.0)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
-    rubocop (0.57.0)
-      jaro_winkler (~> 1.4.0)
-      parallel (~> 1.10)
-      parser (>= 2.5)
-      powerpack (~> 0.1)
-      rainbow (>= 2.2.2, < 4.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.9.0)
-    unicode-display_width (1.4.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.16)
-  byebug (~> 10.0)
-  cose!
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  rubocop (= 0.57.0)
-
-BUNDLED WITH
-   1.16.2