cose 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 110dd14d01e9d95f2204f1f822e79193f0bfe058eaac32550e8db378acb53d56
-  data.tar.gz: 446fd8dc498be1145266c8582d9b1fe4ad6d416b4a4f8f43dd7fd226fc52f17a
+  metadata.gz: 0eb0523fe9b7196988a95f1055ad305d36f6cad45337c344d9b2a55d2f42465e
+  data.tar.gz: 181105f066d6797199b8c495dfc3e4552248692e95c360a77fafad4c0a501046
 SHA512:
-  metadata.gz: 32a204e8b5675c70900f6b255bf877d6951467b8e9508be9f133d4c5abe3aaad9e91a1e29535c25bded3777feb0a44a1c161a2544809ab0b1ce73a8b151921e5
-  data.tar.gz: a80dba546e7fdaadddfb1e3fb05a0e8ce3066928d9e415d24268678cd2fd3fd39d03f6dc67b4243911fbdb2a3b7ab7d396f54510e7e72fa77fa79d8ecb797872
+  metadata.gz: 423c129d28fca26cdf359deff30dc9cb9a45dce499df15d2607010dc1cbdd4e3aacfb79609d90b6b4e0dff758cf0b375b93cc871a42e4871e89812e04088d0ad
+  data.tar.gz: 13add48d5e31fad84eb20d42805163de9a993ccec0b02bc0d6da0b4b19390db55064f58a1446421a227307e62b231d412e73bb7f0bb8919091316911d7a8cc10

data/.gitignore

@@ -11,3 +11,5 @@
 .rspec_status
 
 /Gemfile.lock
+
+.byebug_history

data/CHANGELOG.md

@@ -1,6 +1,19 @@
 # Changelog
 
-## [0.2.0] - 2019-03-04
+## [v0.3.0] - 2019-03-09
+
+### Added
+
+- Support deserialization of security messages:
+  - COSE_Sign
+  - COSE_Sign1
+  - COSE_Mac
+  - COSE_Mac0
+  - COSE_Encrypt
+  - COSE_Encrypt0
+- Works with ruby 2.6
+
+## [v0.2.0] - 2019-03-04
 
 ### Added
 
@@ -15,5 +28,6 @@
 - 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.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

@@ -50,15 +50,118 @@ key.key_value
 
 ### Signing Objects
 
-_Pending_
+#### COSE_Sign
+
+```ruby
+cbor_data = "..."
+
+sign = COSE::Sign.deserialize(cbor_data)
+
+sign.protected_headers
+sign.unprotected_headers
+sign.payload
+
+sign.signatures.each do |signature|
+  signature.protected_headers
+  signature.unprotected_headers
+  signature.signature
+end
+```
+
+#### COSE_Sign1
+
+```ruby
+cbor_data = "..."
+
+sign1 = COSE::Sign1.deserialize(cbor_data)
+
+sign1.protected_headers
+sign1.unprotected_headers
+sign1.payload
+sign1.signature
+```
 
 ### MAC Objects
 
-_Pending_
+#### COSE_Mac
+
+```ruby
+cbor_data = "..."
+
+mac = COSE::Mac.deserialize(cbor_data)
+
+mac.protected_headers
+mac.unprotected_headers
+mac.payload
+mac.tag
+
+mac.recipients.each do |recipient|
+  recipient.protected_headers
+  recipient.unprotected_headers
+  recipient.ciphertext
+
+  if recipient.recipients
+    recipient.recipients.each do |recipient|
+      recipient.protected_headers
+      recipient.unprotected_headers
+      recipient.ciphertext
+    end
+  end
+end
+```
+
+#### COSE_Mac0
+
+```ruby
+cbor_data = "..."
+
+mac0 = COSE::Mac0.deserialize(cbor_data)
+
+mac0.protected_headers
+mac0.unprotected_headers
+mac0.payload
+mac0.tag
+```
 
 ### Encryption Objects
 
-_Pending_
+#### COSE_Encrypt
+
+```ruby
+cbor_data = "..."
+
+encrypt = COSE::Encrypt.deserialize(cbor_data)
+
+encrypt.protected_headers
+encrypt.unprotected_headers
+encrypt.ciphertext
+
+encrypt.recipients.each do |recipient|
+  recipient.protected_headers
+  recipient.unprotected_headers
+  recipient.ciphertext
+
+  if recipient.recipients
+    recipient.recipients.each do |recipient|
+      recipient.protected_headers
+      recipient.unprotected_headers
+      recipient.ciphertext
+    end
+  end
+end
+```
+
+#### COSE_Encrypt0
+
+```ruby
+cbor_data = "..."
+
+encrypt0 = COSE::Encrypt0.deserialize(cbor_data)
+
+encrypt0.protected_headers
+encrypt0.unprotected_headers
+encrypt0.ciphertext
+```
 
 ## Development
 

data/cose.gemspec

@@ -34,8 +34,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "cbor", "~> 0.5.9.2"
 
   spec.add_development_dependency "bundler", ">= 1.17", "< 3"
-  spec.add_development_dependency "byebug", "~> 10.0"
+  spec.add_development_dependency "byebug", "~> 11.0"
   spec.add_development_dependency "rake", "~> 12.3"
   spec.add_development_dependency "rspec", "~> 3.8"
-  spec.add_development_dependency "rubocop", "0.58.2"
+  spec.add_development_dependency "rubocop", "0.65.0"
 end

data/lib/cose/encrypt.rb

@@ -0,0 +1,19 @@
+require "cose/security_message"
+require "cose/recipient"
+
+module COSE
+  class Encrypt < SecurityMessage
+    attr_reader :ciphertext, :recipients
+
+    def self.keyword_arguments_for_initialize(decoded)
+      { ciphertext: decoded[0], recipients: decoded[1].map { |s| COSE::Recipient.deserialize(s) } }
+    end
+
+    def initialize(ciphertext:, recipients:, **keyword_arguments)
+      super(**keyword_arguments)
+
+      @ciphertext = ciphertext
+      @recipients = recipients
+    end
+  end
+end

data/lib/cose/encrypt0.rb

@@ -0,0 +1,17 @@
+require "cose/security_message"
+
+module COSE
+  class Encrypt0 < SecurityMessage
+    attr_reader :ciphertext
+
+    def self.keyword_arguments_for_initialize(decoded)
+      { ciphertext: decoded[0] }
+    end
+
+    def initialize(ciphertext:, **keyword_arguments)
+      super(**keyword_arguments)
+
+      @ciphertext = ciphertext
+    end
+  end
+end

data/lib/cose/mac.rb

@@ -0,0 +1,24 @@
+require "cbor"
+require "cose/security_message"
+
+module COSE
+  class Mac < SecurityMessage
+    attr_reader :payload, :tag, :recipients
+
+    def self.keyword_arguments_for_initialize(decoded)
+      {
+        payload: CBOR.decode(decoded[0]),
+        tag: decoded[1],
+        recipients: decoded[2].map { |s| COSE::Recipient.deserialize(s) }
+      }
+    end
+
+    def initialize(payload:, tag:, recipients:, **keyword_arguments)
+      super(**keyword_arguments)
+
+      @payload = payload
+      @tag = tag
+      @recipients = recipients
+    end
+  end
+end

data/lib/cose/mac0.rb

@@ -0,0 +1,19 @@
+require "cbor"
+require "cose/security_message"
+
+module COSE
+  class Mac0 < SecurityMessage
+    attr_reader :payload, :tag
+
+    def self.keyword_arguments_for_initialize(decoded)
+      { payload: CBOR.decode(decoded[0]), tag: decoded[1] }
+    end
+
+    def initialize(payload:, tag:, **keyword_arguments)
+      super(**keyword_arguments)
+
+      @payload = payload
+      @tag = tag
+    end
+  end
+end

data/lib/cose/recipient.rb

@@ -0,0 +1,24 @@
+require "cose/security_message"
+
+module COSE
+  class Recipient < SecurityMessage
+    attr_reader :ciphertext, :recipients
+
+    def self.keyword_arguments_for_initialize(decoded)
+      keyword_arguments = { ciphertext: decoded[0] }
+
+      if decoded[1]
+        keyword_arguments[:recipients] = decoded[1].map { |s| COSE::Recipient.deserialize(s) }
+      end
+
+      keyword_arguments
+    end
+
+    def initialize(ciphertext:, recipients: nil, **keyword_arguments)
+      super(**keyword_arguments)
+
+      @ciphertext = ciphertext
+      @recipients = recipients
+    end
+  end
+end

data/lib/cose/security_message.rb

@@ -0,0 +1,26 @@
+require "cbor"
+
+module COSE
+  class SecurityMessage
+    attr_reader :protected_headers, :unprotected_headers
+
+    def self.deserialize(cbor)
+      decoded = CBOR.decode(cbor)
+
+      if decoded.respond_to?(:value)
+        decoded = decoded.value
+      end
+
+      new(
+        protected_headers: CBOR.decode(decoded[0]),
+        unprotected_headers: decoded[1],
+        **keyword_arguments_for_initialize(decoded[2..-1])
+      )
+    end
+
+    def initialize(protected_headers:, unprotected_headers:)
+      @protected_headers = protected_headers
+      @unprotected_headers = unprotected_headers
+    end
+  end
+end

data/lib/cose/sign.rb

@@ -0,0 +1,20 @@
+require "cbor"
+require "cose/security_message"
+require "cose/signature"
+
+module COSE
+  class Sign < SecurityMessage
+    attr_reader :payload, :signatures
+
+    def self.keyword_arguments_for_initialize(decoded)
+      { payload: CBOR.decode(decoded[0]), signatures: decoded[1].map { |s| COSE::Signature.deserialize(s) } }
+    end
+
+    def initialize(payload:, signatures:, **keyword_arguments)
+      super(**keyword_arguments)
+
+      @payload = payload
+      @signatures = signatures
+    end
+  end
+end

data/lib/cose/sign1.rb

@@ -0,0 +1,19 @@
+require "cbor"
+require "cose/security_message"
+
+module COSE
+  class Sign1 < SecurityMessage
+    attr_reader :payload, :signature
+
+    def self.keyword_arguments_for_initialize(decoded)
+      { payload: CBOR.decode(decoded[0]), signature: decoded[1] }
+    end
+
+    def initialize(payload:, signature:, **keyword_arguments)
+      super(**keyword_arguments)
+
+      @payload = payload
+      @signature = signature
+    end
+  end
+end

data/lib/cose/signature.rb

@@ -0,0 +1,17 @@
+require "cose/security_message"
+
+module COSE
+  class Signature < SecurityMessage
+    attr_reader :signature
+
+    def self.keyword_arguments_for_initialize(decoded)
+      { signature: decoded[0] }
+    end
+
+    def initialize(signature:, **keyword_arguments)
+      super(**keyword_arguments)
+
+      @signature = signature
+    end
+  end
+end

data/lib/cose/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cose
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Gonzalo Rodriguez
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-04 00:00:00.000000000 Z
+date: 2019-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cbor
@@ -51,14 +51,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -93,14 +93,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.58.2
+        version: 0.65.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.58.2
+        version: 0.65.0
 description: 
 email:
 - gonzalo@cedarcode.com
@@ -122,9 +122,18 @@ files:
 - bin/setup
 - cose.gemspec
 - lib/cose.rb
+- lib/cose/encrypt.rb
+- lib/cose/encrypt0.rb
 - lib/cose/key/base.rb
 - lib/cose/key/ec2.rb
 - lib/cose/key/symmetric.rb
+- lib/cose/mac.rb
+- lib/cose/mac0.rb
+- lib/cose/recipient.rb
+- lib/cose/security_message.rb
+- lib/cose/sign.rb
+- lib/cose/sign1.rb
+- lib/cose/signature.rb
 - lib/cose/version.rb
 homepage: https://github.com/cedarcode/cose-ruby
 licenses:
@@ -148,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: COSE (RFC 8152) ruby library