cose-key 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 532189539f48e03f8810ec39391ad0a4a3fc35e5db0240ec9db240c6f6d61298
+  data.tar.gz: 265f27619c0033f462ae072e88a6d3c392cdfe6275f9cde35b1ad7979d43785d
+SHA512:
+  metadata.gz: 64817196e896c16d36175848afe1bb962cf38dcdd69937e68dc87cfd66c9c44b4d3dc6dbb0d3a6877f3f1eeecc4e516fe80be7520805cc0f14d88b4e2e0162eb
+  data.tar.gz: f50a720110310f8ef9dc9ed33e7dd0c56cf70d6c7914dce12787035e75691c930ddf2b67863219082d95cd4d6110c4f7d888672718af713a92e3fad63ae407bf

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,9 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+  - 2.4.4
+  - 2.3.7
+before_install: gem install bundler -v 1.16.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at nov@matake.jp. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in cose-key.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 nov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# COSE::Key
+
+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/key`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cose-key'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cose-key
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cose-key. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the COSE::Key project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/cose-key/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,19 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+namespace :coverage do
+  desc "Open coverage report"
+  task :report do
+    require 'simplecov'
+    `open "#{File.join SimpleCov.coverage_path, 'index.html'}"`
+  end
+end
+
+task :spec do
+  Rake::Task[:'coverage:report'].invoke unless ENV['TRAVIS_RUBY_VERSION']
+end
+
+task default: :spec

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cose/key"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cose-key.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |gem|
+  gem.name          = 'cose-key'
+  gem.version       = File.read('VERSION')
+  gem.authors       = ['nov matake']
+  gem.email         = ['nov@matake.jp']
+  gem.homepage      = 'https://github.com/nov/cose-key'
+  gem.summary       = %q{COSE Key in Ruby}
+  gem.description   = %q{COSE Key (RSA & EC) in Ruby}
+  gem.license       = 'MIT'
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.require_paths = ['lib']
+  gem.required_ruby_version = '>= 2.3'
+  gem.add_runtime_dependency 'cbor'
+  gem.add_development_dependency 'rake', '~> 10.0'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rspec-its'
+end

data/lib/cose/key/ec2.rb

@@ -0,0 +1,68 @@
+module COSE
+  class Key
+    class EC2 < Key
+      CRV = -1
+      X = -2
+      Y = -3
+      D = -4
+
+      ES256 = -7
+      ES384 = -35
+      ES512 = -36
+
+      P256 = 1
+      P384 = 2
+      P521 = 3
+
+      attr_accessor :crv, :x, :y, :d
+
+      def initialize(attrs = {})
+        super
+        self.crv = attrs[CRV]
+        self.x = attrs[X]
+        self.y = attrs[Y]
+        self.d = attrs[D]
+      end
+
+      def curve_name
+        case crv
+        when P256
+          'prime256v1'
+        when P384
+          'secp384r1'
+        when P521
+          'secp521r1'
+        else
+          raise 'Unknown Curve'
+        end
+      end
+
+      def digest
+        case alg
+        when ES256
+          OpenSSL::Digest::SHA256
+        when ES384
+          OpenSSL::Digest::SHA384
+        when ES512
+          OpenSSL::Digest::SHA512
+        else
+          raise 'Unknown Algorithm'
+        end.new
+      end
+
+      def to_key
+        key = OpenSSL::PKey::EC.new curve_name
+        key.private_key = OpenSSL::BN.new(d, 2) if d
+        key.public_key = OpenSSL::PKey::EC::Point.new(
+          OpenSSL::PKey::EC::Group.new(curve_name),
+          OpenSSL::BN.new([
+            '04' +
+            x.unpack('H*').first +
+            y.unpack('H*').first
+          ].pack('H*'), 2)
+        )
+        key
+      end
+    end
+  end
+end

data/lib/cose/key/rsa.rb

@@ -0,0 +1,69 @@
+module COSE
+  class Key
+    class RSA < Key
+      N = -1
+      E = -2
+      D = -3
+      P = -4
+      Q = -5
+      DP = -6
+      DQ = -7
+      QI = -8
+
+      PS256 = -37
+      PS384 = -38
+      PS512 = -39
+      RSAES_OAEP_SHA1   = -40
+      RSAES_OAEP_SHA256 = -41
+      RSAES_OAEP_SHA512 = -42
+
+      attr_accessor :n, :e, :d, :p, :q, :dp, :dq, :qi
+
+      def initialize(attrs = {})
+        super
+        self.n = attrs[N]
+        self.e = attrs[E]
+        self.d = attrs[D]
+        self.p = attrs[P]
+        self.q = attrs[Q]
+        self.dp = attrs[DP]
+        self.dq = attrs[DQ]
+        self.qi = attrs[QI]
+      end
+
+      def digest
+        case alg
+        when RSAES_OAEP_SHA1
+          OpenSSL::Digest::SHA1
+        when PS256, RSAES_OAEP_SHA256
+          OpenSSL::Digest::SHA256
+        when PS384
+          OpenSSL::Digest::SHA384
+        when PS512, RSAES_OAEP_SHA512
+          OpenSSL::Digest::SHA512
+        else
+          raise 'Unknown Algorithm'
+        end.new
+      end
+
+      def to_key
+        key = OpenSSL::PKey::RSA.new
+        if key.respond_to? :set_key
+          key.set_key n, e, d
+          key.set_factors p, q if p && q
+          key.set_crt_params dp, dq, qi if dp && dq && qi
+        else
+          key.e = e
+          key.n = n
+          key.d = d if d
+          key.p = p if p
+          key.q = q if q
+          key.dmp1 = dp if dp
+          key.dmq1 = dq if dq
+          key.iqmp = qi if qi
+        end
+        key
+      end
+    end
+  end
+end

data/lib/cose/key.rb

@@ -0,0 +1,60 @@
+require 'openssl'
+require 'cbor'
+
+module COSE
+  class Key
+    KTY = 1
+    KID = 2
+    ALG = 3
+    OPS = 4
+    BASE_IV = 5
+
+    KTY_OKP = 1
+    KTY_EC2 = 2
+    KTY_RSA = 3
+    KTY_SYMMETRIC = 4
+
+    attr_accessor :kty, :kid, :alg, :ops, :base_iv
+
+    def initialize(attrs = {})
+      self.kty = attrs[KTY]
+      self.kid = attrs[KID]
+      self.alg = attrs[ALG]
+      self.ops = attrs[OPS]
+      self.base_iv = attrs[BASE_IV]
+    end
+
+    def digest
+      raise 'Implement me'
+    end
+
+    def to_key
+      raise 'Implement me'
+    end
+
+    class << self
+      def decode(cbor)
+        detect CBOR.decode(cbor)
+      end
+
+      def detect(attrs = {})
+        klass = case attrs[KTY]
+        when KTY_OKP
+          raise 'Unsupported Key Type: OKP'
+        when KTY_EC2
+          EC2
+        when KTY_RSA
+          RSA
+        when KTY_SYMMETRIC
+          raise 'Unsupported Key Type: Symmetric'
+        else
+          raise 'Unknown Key Type'
+        end
+        klass.new attrs
+      end
+    end
+  end
+end
+
+require 'cose/key/ec2'
+require 'cose/key/rsa'

data/spec/cose/key_spec.rb

@@ -0,0 +1,42 @@
+RSpec.describe COSE::Key do
+  let(:ec2_cbor) do
+    "\xA5\x01\x02\x03& \x01!X \x06\x0F\xBD\x82\xE5U\xC4\xDEl\f\x8F7?_O\xFB\xC1H\b8\x0E\xA4\xB7b\xA8\f\x89\xF5\xFBS\xC7u\"X \n\x19\x98\x15\xF2\x10\x99#\xBE[\xB6\xE7PCo\xC5h:\xD2$z\xD0\x03\xD5[\xD8su\x94$\x9A\xD9"
+  end
+  let(:ec2_pem) do
+    <<~PEM
+    -----BEGIN PUBLIC KEY-----
+    MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEBg+9guVVxN5sDI83P19P+8FICDgO
+    pLdiqAyJ9ftTx3UKGZgV8hCZI75btudQQ2/FaDrSJHrQA9Vb2HN1lCSa2Q==
+    -----END PUBLIC KEY-----
+    PEM
+  end
+
+  context 'for EC keys' do
+    let(:cbor) { ec2_cbor }
+    let(:decoded) { COSE::Key.decode cbor }
+
+    describe '.decode' do
+      subject { decoded }
+      it { should be_instance_of COSE::Key::EC2 }
+    end
+
+    describe '#curve_name' do
+      subject { decoded.curve_name }
+      it { should == 'prime256v1' }
+    end
+
+    describe '#digest' do
+      subject { decoded.digest }
+      it { should be_instance_of OpenSSL::Digest::SHA256 }
+    end
+
+    describe '#to_key' do
+      subject { decoded.to_key }
+      it { should be_instance_of OpenSSL::PKey::EC }
+    end
+  end
+
+  context 'for RSA keys' do
+    it :TODO
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter 'spec'
+end
+
+require 'rspec'
+require 'rspec/its'
+require 'cose/key'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = [:should, :expect]
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: cose-key
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- nov matake
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cbor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: COSE Key (RSA & EC) in Ruby
+email:
+- nov@matake.jp
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- bin/console
+- bin/setup
+- cose-key.gemspec
+- lib/cose/key.rb
+- lib/cose/key/ec2.rb
+- lib/cose/key/rsa.rb
+- spec/cose/key_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/nov/cose-key
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: COSE Key in Ruby
+test_files:
+- spec/cose/key_spec.rb
+- spec/spec_helper.rb