sidetree 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 55fc6b6c312458a0e0d627daeb1f1f5cd84e87a6f1b74c0a9a9d584848e31a8a
+  data.tar.gz: 34a4aa6ee3457c84b0d1148108d19f5e7afea5f32d1210299ca530bdd00d6a59
+SHA512:
+  metadata.gz: 47cfc0743c8da5ccf12bae7fa2114474607a0f68814fccf0738390f87bc52855e96b2eaedc70b68328a8b7b0b7dbc892f6eba199a0ba87b842b369e71603d472
+  data.tar.gz: 0032c7d6faedaf3873fdc1594f19eb3ceb431129cb5fd2dd436e322dfb9b5a155e5901c87c0530e9b42bb6d3ca01562e393c83bbc62f51ec61d4f4c4c37a8c25

data/.github/workflows/main.yml

@@ -0,0 +1,22 @@
+name: Ruby
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: true
+      matrix:
+        ruby: [2.6, 2.7, 3.0, 3.1]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run prettier
+        run: bundle exec rbprettier --check '**/*.rb'
+      - name: Run the default task
+        run: bundle exec rake

data/.gitignore

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

data/.prettierignore

@@ -0,0 +1,9 @@
+/bin
+/log
+/tmp
+/vendor
+Gemfile.lock
+*.txt
+/.idea/
+/.*
+/spec/fixtures/*

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+sidetreerb

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.1.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-02-25
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at azuchi@chaintope.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sidetree.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'rspec', '~> 3.0'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 azuchi
+
+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 @@
+# [WIP]Sidetree for Ruby
+
+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/sidetree`. 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 'sidetree'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install sidetree
+
+## 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 the created tag, 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]/sidetree. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/sidetree/blob/master/CODE_OF_CONDUCT.md).
+
+## 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 Sidetree project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/sidetree/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'sidetree'
+
+# 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/exe/ion

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+require 'thor'
+require 'sidetree'
+
+class ION < Thor
+  class << self
+    def exit_on_failure?
+      true
+    end
+  end
+
+  desc 'create', 'Create ION DID.'
+  def create
+    recovery_key = Sidetree::Key.generate
+    update_key = Sidetree::Key.generate
+    signing_key = Sidetree::Key.generate(id: 'signing-key')
+    document = Sidetree::Model::Document.new(public_keys: [signing_key])
+    did = Sidetree::DID.create(document, update_key, recovery_key, method: Sidetree::Params::METHODS[:ion])
+
+    puts "DID: #{did.short_form}"
+    puts
+    puts "Recovery key: #{recovery_key.encoded_private_key}"
+    puts "Update key: #{update_key.encoded_private_key}"
+    puts "Signing key: #{signing_key.encoded_private_key}"
+    puts
+
+    puts "Long-Form DID: #{did.to_s}"
+    op = did.create_op
+    puts "DID suffix data: #{op.suffix.to_h.to_json}"
+    puts "Document delta: #{op.delta.to_h.to_json}"
+  end
+end
+
+ION.start(ARGV)

data/lib/sidetree/did.rb

@@ -0,0 +1,91 @@
+module Sidetree
+  class DID
+    attr_reader :method
+    attr_reader :suffix
+    attr_reader :long_suffix
+
+    # @raise [Sidetree::Error]
+    def initialize(did)
+      if !did.start_with?('did:ion:') && !did.start_with?('did:sidetree:')
+        raise Error, 'Expected DID method not given in DID.'
+      end
+      if did.count(':') > (Sidetree::Params.testnet? ? 4 : 3)
+        raise Error, 'Unsupported DID format.'
+      end
+      if Sidetree::Params.testnet?
+        _, @method, _, @suffix, @long_suffix = did.split(':')
+      else
+        _, @method, @suffix, @long_suffix = did.split(':')
+      end
+
+      if @long_suffix
+        unless suffix == create_op.suffix.unique_suffix
+          raise Error, 'DID document mismatches short-form DID.'
+        end
+      end
+    end
+
+    # Create DID from +document+, +update_key+ and +recovery_key+.
+    # @param [Sidetree::Model::Document] document
+    # @param [Sidetree::Key] update_key update key
+    # @param [Sidetree::Key] recovery_key recovery key
+    # @param [String] method DID method, default value is sidetree.
+    # @raise [Sidetree::Error]
+    # @return [Sidetree::DID]
+    def self.create(
+      document,
+      update_key,
+      recovery_key,
+      method: Sidetree::Params::DEFAULT_METHOD
+    )
+      unless document.is_a?(Sidetree::Model::Document)
+        raise Error, 'document must be Sidetree::Model::Document instance.'
+      end
+      unless update_key.is_a?(Sidetree::Key)
+        raise Error, 'update_key must be Sidetree::Key instance.'
+      end
+      unless recovery_key.is_a?(Sidetree::Key)
+        raise Error, 'recovery_key must be Sidetree::Key instance.'
+      end
+
+      patches = [
+        { 'action': OP::PatchAction::REPLACE, 'document': document.to_h }
+      ]
+      delta = Model::Delta.new(patches, update_key.to_commitment)
+      suffix =
+        Sidetree::Model::Suffix.new(delta.to_hash, recovery_key.to_commitment)
+      DID.new(
+        OP::Create.new(suffix, delta).did(method: method, include_long: true)
+      )
+    end
+
+    def short_form?
+      long_suffix.nil?
+    end
+
+    def long_form?
+      !short_form?
+    end
+
+    def create_op
+      long_form? ? OP::Create.from_base64(@long_suffix) : nil
+    end
+
+    # Return short form did.
+    # @return [String]
+    def short_form
+      did = "did:#{method}"
+      did += ":#{Sidetree::Params.network}" if Sidetree::Params.testnet?
+      did += ":#{suffix}"
+      did
+    end
+
+    # Return DID string.
+    # @return [String]
+    def to_s
+      did = short_form
+      did += ":#{long_suffix}" if long_form?
+      did
+    end
+  end
+end

data/lib/sidetree/key.rb

@@ -0,0 +1,181 @@
+module Sidetree
+  class Key
+    attr_reader :private_key, :public_key, :id, :purposes, :type
+
+    # @param [Integer] private_key private key.
+    # @param [ECDSA::Point] public_key public key
+    # @param [String] id
+    # @param [Array[String]] purposes
+    # @param [String] type
+    def initialize(
+      private_key: nil,
+      public_key: nil,
+      id: nil,
+      purposes: [],
+      type: nil
+    )
+      if private_key
+        unless Key.valid_private_key?(private_key)
+          raise Error, 'private key is invalid range.'
+        end
+
+        @private_key = private_key
+        pub = ECDSA::Group::Secp256k1.generator.multiply_by_scalar(private_key)
+        if public_key
+          unless pub == public_key
+            raise Error, 'Public and private keys do not match.'
+          end
+        else
+          public_key = pub
+        end
+      end
+
+      unless public_key
+        raise Error, 'Specify either the private key or the public key'
+      end
+      unless public_key.is_a?(ECDSA::Point)
+        raise Error, 'public key must be an ECDSA::Point instance.'
+      end
+      unless ECDSA::Group::Secp256k1.valid_public_key?(public_key)
+        raise Error, 'public key is invalid.'
+      end
+
+      @public_key = public_key
+
+      purposes.each do |purpose|
+        if purpose && !Sidetree::OP::PublicKeyPurpose.values.include?(purpose)
+          raise Error, "Unknown purpose '#{purpose}' specified."
+        end
+      end
+
+      Sidetree::Validator.validate_id!(id) if id
+
+      @purposes = purposes
+      @id = id
+      @type = type
+    end
+
+    # Generate Secp256k1 key.
+    # @option [String] id Public key ID.
+    # @option [String] purpose Purpose for public key. Supported values defined by [Sidetree::PublicKeyPurpose].
+    # @return [Sidetree::Key]
+    # @raise [Sidetree::Error]
+    def self.generate(id: nil, purposes: [])
+      private_key =
+        1 + SecureRandom.random_number(ECDSA::Group::Secp256k1.order - 1)
+      Key.new(private_key: private_key, purposes: purposes, id: id)
+    end
+
+    # Generate key instance from jwk Hash.
+    # @param [Hash] data jwk Hash object.
+    # @return [Sidetree::Key]
+    # @raise [Sidetree::Error]
+    def self.from_hash(data)
+      key_data = data['publicKeyJwk'] ? data['publicKeyJwk'] : data
+      key_type = key_data['kty']
+      curve = key_data['crv']
+      if key_type.nil? || key_type != 'EC'
+        raise Error, "Unsupported key type '#{key_type}' specified."
+      end
+      if curve.nil? || curve != 'secp256k1'
+        raise Error, "Unsupported curve '#{curve}' specified."
+      end
+      raise Error, 'x property required.' unless key_data['x']
+      raise Error, 'y property required.' unless key_data['y']
+
+      # `x` and `y` need 43 Base64URL encoded bytes to contain 256 bits.
+      unless key_data['x'].length == 43
+        raise Error, "Secp256k1 JWK 'x' property must be 43 bytes."
+      end
+      unless key_data['y'].length == 43
+        raise Error, "Secp256k1 JWK 'y' property must be 43 bytes."
+      end
+
+      x = Base64.urlsafe_decode64(key_data['x'])
+      y = Base64.urlsafe_decode64(key_data['y'])
+      point =
+        ECDSA::Format::PointOctetString.decode(
+          ['04'].pack('H*') + x + y,
+          ECDSA::Group::Secp256k1
+        )
+      private_key =
+        if key_data['d']
+          Base64.urlsafe_decode64(key_data['d']).unpack1('H*').to_i(16)
+        else
+          nil
+        end
+
+      purposes = data['purposes'] ? data['purposes'] : []
+      Key.new(
+        public_key: point,
+        private_key: private_key,
+        purposes: purposes,
+        id: data['id'],
+        type: data['type']
+      )
+    end
+
+    # Check whether private is valid range.
+    # @param [Integer] private_key
+    # @return [Boolean]
+    def self.valid_private_key?(private_key)
+      0x01 <= private_key && private_key < ECDSA::Group::Secp256k1.order
+    end
+
+    # Generate JSON::JWK object.
+    # @return [JSON::JWK]
+    def to_jwk
+      jwk =
+        JSON::JWK.new(
+          kty: 'EC',
+          crv: 'secp256k1',
+          x:
+            Base64.urlsafe_encode64(
+              ECDSA::Format::FieldElementOctetString.encode(
+                public_key.x,
+                public_key.group.field
+              ),
+              padding: false
+            ),
+          y:
+            Base64.urlsafe_encode64(
+              ECDSA::Format::FieldElementOctetString.encode(
+                public_key.y,
+                public_key.group.field
+              ),
+              padding: false
+            )
+        )
+      jwk['d'] = encoded_private_key if private_key
+      jwk
+    end
+
+    # Generate commitment for this key.
+    # @return [String] Base64 encoded commitment.
+    def to_commitment
+      digest = Digest::SHA256.digest(to_jwk.normalize.to_json_c14n)
+
+      Sidetree.to_hash(digest)
+    end
+
+    def to_h
+      h = { publicKeyJwk: to_jwk.normalize, purposes: purposes }
+      h[:id] = id if id
+      h[:type] = type if type
+      h.stringify_keys
+    end
+
+    # Return base64 encoded private key.
+    # @return [String]
+    def encoded_private_key
+      if private_key
+        Base64.urlsafe_encode64(
+          [private_key.to_s(16).rjust(32 * 2, '0')].pack('H*'),
+          padding: false
+        )
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/sidetree/model/delta.rb

@@ -0,0 +1,28 @@
+module Sidetree
+  module Model
+    class Delta
+      attr_reader :patches, :update_commitment
+
+      # @param [Array[Hash]] patches
+      # @param [String] update_commitment
+      # @raise [Sidetree::Error]
+      def initialize(patches, update_commitment)
+        @patches = patches
+        @update_commitment = update_commitment
+      end
+
+      def self.parse(object)
+        Sidetree::Validator.validate_delta!(object)
+        Delta.new(object[:patches], object[:updateCommitment])
+      end
+
+      def to_h
+        { patches: patches, updateCommitment: update_commitment }
+      end
+
+      def to_hash
+        Sidetree.to_hash(to_h)
+      end
+    end
+  end
+end

data/lib/sidetree/model/document.rb

@@ -0,0 +1,40 @@
+module Sidetree
+  module Model
+    # DID document class.
+    class Document
+      attr_reader :public_keys
+      attr_reader :services
+
+      # @param [Array[Sidetree::Key]] public_keys The array of public keys.
+      # @param [Array[Sidetree::Model::Service]] services The array of service.
+      def initialize(public_keys: [], services: [])
+        public_keys.each do |public_key|
+          unless public_key.is_a?(Sidetree::Key)
+            raise Error, 'public_keys should be array of Sidetree::Key objects.'
+          end
+        end
+        id_set = public_keys.map(&:id)
+        if (id_set.count - id_set.uniq.count) > 0
+          raise Error 'Public key id has to be unique.'
+        end
+        services.each do |service|
+          unless service.is_a?(Sidetree::Model::Service)
+            raise Error,
+                  'services should be array of Sidetree::Model::Service objects.'
+          end
+        end
+        id_set = services.map(&:id)
+        if (id_set.count - id_set.uniq.count) > 0
+          raise Error 'Service id has to be unique.'
+        end
+
+        @public_keys = public_keys
+        @services = services
+      end
+
+      def to_h
+        { publicKeys: public_keys.map(&:to_h), services: services.map(&:to_h) }
+      end
+    end
+  end
+end