sidetree 0.1.0 → 0.1.3

data/lib/sidetree/op/create.rb

@@ -11,6 +11,57 @@ module Sidetree
         @suffix = suffix
       end
 
+      # Generate create operation with new generate key.
+      # @param [String] method DID method defined in +Sidetree::Params::METHODS+.
+      # @return [Sidetree::OP::Create]
+      def self.generate(method: Sidetree::Params::METHODS[:ion])
+        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: method
+          )
+        did.create_op
+      end
+
+      # Parse create operation data from json string
+      # @param [String] create_data create operation data(json string).
+      # @return [Sidetree::OP::Create]
+      # @raise [Sidetree::Error]
+      def self.from_json(create_data)
+        begin
+          json = JSON.parse(create_data, symbolize_names: true)
+          json.each do |k, v|
+            case k
+            when :type, :suffixData, :delta
+            else
+              raise Sidetree::Error,
+                    "Create operation missing or unknown property"
+            end
+          end
+          if json[:type] && json[:type] != Sidetree::OP::Type::CREATE
+            raise Sidetree::Error, "Create operation type incorrect"
+          end
+          suffix = Sidetree::Model::Suffix.from_object(json[:suffixData])
+          delta = nil
+          begin
+            # For compatibility with data pruning
+            delta = Sidetree::Model::Delta.from_object(json[:delta]) if json[
+              :delta
+            ]
+          rescue Sidetree::Error
+          end
+          Create.new(suffix, delta)
+        rescue JSON::ParserError
+          raise Sidetree::Error, "create_data not json"
+        end
+      end
+
       def type
         Sidetree::OP::Type::CREATE
       end
@@ -31,20 +82,20 @@ module Sidetree
           expected_base64 =
             Base64.urlsafe_encode64(json.to_json_c14n, padding: false)
           unless expected_base64 == base64_str
-            raise Error, 'Initial state object and JCS string mismatch.'
+            raise Error, "Initial state object and JCS string mismatch."
           end
 
           Create.new(
-            Sidetree::Model::Suffix.parse(json[:suffixData]),
-            Sidetree::Model::Delta.parse(json[:delta])
+            Sidetree::Model::Suffix.from_object(json[:suffixData]),
+            Sidetree::Model::Delta.from_object(json[:delta])
           )
         rescue JSON::ParserError
-          raise Error, 'Long form initial state should be encoded jcs.'
+          raise Error, "Long form initial state should be encoded jcs."
         end
       end
 
       def to_h
-        { suffixData: suffix.to_h, delta: delta.to_h }
+        { suffixData: suffix.to_h, delta: delta&.to_h }
       end
 
       # Generate long_suffix for DID.

data/lib/sidetree/op/deactivate.rb

@@ -0,0 +1,82 @@
+module Sidetree
+  module OP
+    # Deactivate operation class
+    # https://identity.foundation/sidetree/spec/#deactivate
+    class Deactivate < Base
+      attr_reader :did_suffix
+      attr_reader :signed_data
+      attr_reader :revealed_value
+
+      # Initialize
+      # @param [String] did_suffix
+      # @param [JSON::JWS] signed_data
+      # @param [String] revealed_value
+      def initialize(did_suffix, signed_data, revealed_value)
+        Sidetree::Validator.validate_encoded_multi_hash!(
+          did_suffix,
+          "#{type} didSuffix"
+        )
+        Sidetree::Validator.validate_encoded_multi_hash!(
+          revealed_value,
+          "#{type} revealValue"
+        )
+        @did_suffix = did_suffix
+        @signed_data = signed_data
+        @revealed_value = revealed_value
+      end
+
+      # Parse Deactivate operation data from json string
+      # @param [String] deactivate_data deactivate operation data(json string).
+      # @return [Sidetree::OP::Deactivate]
+      # @raise [Sidetree::Error]
+      def self.from_json(deactivate_data)
+        begin
+          json = JSON.parse(deactivate_data, symbolize_names: true)
+          jws, revealed_value, did_suffix = nil, nil, nil
+          json.each do |k, v|
+            case k
+            when :type
+              unless v == Sidetree::OP::Type::DEACTIVATE
+                raise Sidetree::Error, "Deactivate operation type incorrect"
+              end
+            when :didSuffix
+              did_suffix = v
+            when :revealValue
+              revealed_value = v
+            when :signedData
+              jws = Sidetree::Util::JWS.parse(v)
+              unless jws.keys.length == 2
+                raise Sidetree::Error,
+                      "Deactivate operation signed data missing or unknown property"
+              end
+              Sidetree::Util::JWK.validate!(
+                Sidetree::Util::JWK.parse(jws["recoveryKey"])
+              )
+            else
+              raise Sidetree::Error,
+                    "Unexpected property #{k.to_s} in deactivate operation"
+            end
+          end
+          if jws
+            Validator.validate_canonicalize_object_hash!(
+              jws["recoveryKey"],
+              revealed_value,
+              "Deactivate key"
+            )
+          end
+          unless did_suffix
+            raise Sidetree::Error, "The deactivate didSuffix must be a string"
+          end
+          Deactivate.new(did_suffix, jws, revealed_value)
+        rescue JSON::ParserError
+          raise Sidetree::Error, "deactivate_data not json"
+        rescue JSON::JWS::InvalidFormat
+          raise Sidetree::Error, "Invalid signedData"
+        end
+      end
+      def type
+        Sidetree::OP::Type::DEACTIVATE
+      end
+    end
+  end
+end

data/lib/sidetree/op/recover.rb

@@ -0,0 +1,19 @@
+module Sidetree
+  module OP
+    # Recover operation class.
+    # https://identity.foundation/sidetree/spec/#recover
+    class Recover < Updatable
+      # Parse Recover operation data from json string
+      # @param [String] recover_data recover operation data(json string).
+      # @return [Sidetree::OP::Recover]
+      # @raise [Sidetree::Error]
+      def self.from_json(recover_data)
+        parse_json(recover_data, Sidetree::OP::Type::RECOVER)
+      end
+
+      def type
+        Sidetree::OP::Type::RECOVER
+      end
+    end
+  end
+end

data/lib/sidetree/op/updatable.rb

@@ -0,0 +1,98 @@
+module Sidetree
+  module OP
+    class Updatable < Base
+      attr_reader :did_suffix
+      attr_reader :delta
+      attr_reader :signed_data
+      attr_reader :revealed_value
+
+      # Initialize
+      # @param [String] did_suffix
+      # @param [Sidetree::Model::Delta] delta
+      # @param [JSON::JWS] signed_data
+      # @param [String] revealed_value
+      # @raise [Sidetree::Error]
+      def initialize(did_suffix, delta, signed_data, revealed_value)
+        Sidetree::Validator.validate_encoded_multi_hash!(
+          did_suffix,
+          "#{type} didSuffix"
+        )
+        Sidetree::Validator.validate_encoded_multi_hash!(
+          revealed_value,
+          "#{type} revealValue"
+        )
+        if signed_data
+          Validator.validate_canonicalize_object_hash!(
+            signed_data[key_name],
+            revealed_value,
+            type
+          )
+        end
+        @did_suffix = did_suffix
+        @delta = delta
+        @signed_data = signed_data
+        @revealed_value = revealed_value
+      end
+
+      def self.parse_json(data, type)
+        begin
+          json = JSON.parse(data, symbolize_names: true)
+          delta, jws, revealed_value, did_suffix = nil, nil, nil, nil
+          json.each do |k, v|
+            case k
+            when :type
+              unless v == type
+                raise Sidetree::Error,
+                      "#{type.capitalize} operation type incorrect"
+              end
+            when :didSuffix
+              did_suffix = v
+            when :revealValue
+              revealed_value = v
+            when :signedData
+              jws = Sidetree::Util::JWS.parse(v)
+              unless jws.keys.length ==
+                       (type == Sidetree::OP::Type::RECOVER ? 3 : 2)
+                raise Sidetree::Error,
+                      "#{type.capitalize} operation signed data missing or unknown property"
+              end
+              key_name =
+                (
+                  if type == Sidetree::OP::Type::RECOVER
+                    "recoveryKey"
+                  else
+                    "updateKey"
+                  end
+                )
+              Sidetree::Util::JWK.validate!(
+                Sidetree::Util::JWK.parse(jws[key_name])
+              )
+            when :delta
+              delta = Sidetree::Model::Delta.from_object(v)
+            else
+              raise Sidetree::Error,
+                    "Unexpected property #{k.to_s} in #{type} operation"
+            end
+          end
+          unless did_suffix
+            raise Sidetree::Error, "The #{type} didSuffix must be a string"
+          end
+          Module.const_get("Sidetree::OP::#{type.capitalize}").new(
+            did_suffix,
+            delta,
+            jws,
+            revealed_value
+          )
+        rescue JSON::ParserError
+          raise Sidetree::Error, "data dose not json"
+        rescue JSON::JWS::InvalidFormat
+          raise Sidetree::Error, "Invalid signedData"
+        end
+      end
+
+      def key_name
+        type == Sidetree::OP::Type::UPDATE ? "updateKey" : "recoveryKey"
+      end
+    end
+  end
+end

data/lib/sidetree/op/update.rb

@@ -0,0 +1,19 @@
+module Sidetree
+  module OP
+    # Update operation class.
+    # https://identity.foundation/sidetree/spec/#update
+    class Update < Updatable
+      # Parse update operation data from json string
+      # @param [String] update_data update operation data(json string).
+      # @return [Sidetree::OP::Update]
+      # @raise [Sidetree::Error]
+      def self.from_json(update_data)
+        parse_json(update_data, Sidetree::OP::Type::UPDATE)
+      end
+
+      def type
+        Sidetree::OP::Type::UPDATE
+      end
+    end
+  end
+end

data/lib/sidetree/op.rb

@@ -1,28 +1,28 @@
 module Sidetree
   module OP
     module Type
-      CREATE = 'create'
-      UPDATE = 'update'
-      RECOVER = 'recover'
-      DEACTIVATE = 'deactivate'
+      CREATE = "create"
+      UPDATE = "update"
+      RECOVER = "recover"
+      DEACTIVATE = "deactivate"
     end
 
     # Sidetree patch actions. These are the valid values in the action property of a patch.
     module PatchAction
-      REPLACE = 'replace'
-      ADD_PUBLIC_KEYS = 'add-public-keys'
-      REMOVE_PUBLIC_KEYS = 'remove-public-keys'
-      ADD_SERVICES = 'add-services'
-      REMOVE_SERVICES = 'remove-services'
+      REPLACE = "replace"
+      ADD_PUBLIC_KEYS = "add-public-keys"
+      REMOVE_PUBLIC_KEYS = "remove-public-keys"
+      ADD_SERVICES = "add-services"
+      REMOVE_SERVICES = "remove-services"
     end
 
     # DID Document public key purpose.
     module PublicKeyPurpose
-      AUTHENTICATION = 'authentication'
-      ASSERTION_METHOD = 'assertionMethod'
-      CAPABILITY_INVOCATION = 'capabilityInvocation'
-      CAPABILITY_DELEGATION = 'capabilityDelegation'
-      KEY_AGREEMENT = 'keyAgreement'
+      AUTHENTICATION = "authentication"
+      ASSERTION_METHOD = "assertionMethod"
+      CAPABILITY_INVOCATION = "capabilityInvocation"
+      CAPABILITY_DELEGATION = "capabilityDelegation"
+      KEY_AGREEMENT = "keyAgreement"
 
       module_function
 
@@ -31,7 +31,11 @@ module Sidetree
       end
     end
 
-    autoload :Base, 'sidetree/op/base'
-    autoload :Create, 'sidetree/op/create'
+    autoload :Base, "sidetree/op/base"
+    autoload :Updatable, "sidetree/op/updatable"
+    autoload :Create, "sidetree/op/create"
+    autoload :Recover, "sidetree/op/recover"
+    autoload :Update, "sidetree/op/update"
+    autoload :Deactivate, "sidetree/op/deactivate"
   end
 end

data/lib/sidetree/util/anchored_data_serializer.rb

@@ -0,0 +1,41 @@
+module Sidetree
+  module Util
+    module AnchoredDataSerializer
+      DELIMITER = "."
+
+      module_function
+
+      # Serialize given data as Anchor String.
+      # @param [Integer] op_count Number of operations
+      # @param [String] uri Core Index File uri.
+      # @return [String] Anchor String
+      # @raise [Sidetree::Error]
+      def serialize(op_count, uri)
+        if op_count > Sidetree::Params::MAX_OPERATION_COUNT
+          raise Sidetree::Error, "Number of operations greater than max"
+        end
+        "#{op_count}#{DELIMITER}#{uri}"
+      end
+
+      # Deserializes the given string that is read from the blockchain into data.
+      # @param [String] anchor_str Anchor String
+      # @return [Array[Integer, String]]
+      # @raise [Sidetree::Error]
+      def deserialize(anchor_str)
+        data = anchor_str.split(DELIMITER)
+        raise Sidetree::Error, "Invalid anchor string" unless data.length == 2
+        unless data[0] =~ /^[1-9]\d*$/
+          raise Sidetree::Error,
+                "Number of operations in anchor string is not positive number"
+        end
+
+        count = data[0].to_i
+        if count > Sidetree::Params::MAX_OPERATION_COUNT
+          raise Sidetree::Error,
+                "Number of operations in anchor string greater than max"
+        end
+        [count, data[1]]
+      end
+    end
+  end
+end

data/lib/sidetree/util/compressor.rb

@@ -0,0 +1,38 @@
+require "zlib"
+
+module Sidetree
+  module Util
+    module Compressor
+      # The estimated ratio/multiplier of decompressed Sidetree CAS file size compared against the compressed file size.
+      ESTIMATE_DECOMPRESSION_MULTIPLIER = 3
+
+      module_function
+
+      # Compresses teh data in gzip and return it as buffer.
+      # @param [String] data Data to be compressed.
+      # @return [String] compressed data.
+      def compress(data)
+        io = StringIO.new("w")
+        Zlib::GzipWriter.wrap(io) do |w|
+          w.mtime = 0
+          w.write data
+        end
+        io.string.force_encoding("binary")
+      end
+
+      # Decompresses +compressed+.
+      # @param [String] compressed compressed data.
+      # @return [String] decompressed data.
+      # @raise [Sidetree::Error] raise if data exceeds max_bytes size.
+      def decompress(compressed, max_bytes: nil)
+        if max_bytes && compressed.bytesize > max_bytes
+          raise Sidetree::Error, "Exceed maximum compressed chunk file size."
+        end
+        io = StringIO.new(compressed)
+        result = StringIO.new
+        Zlib::GzipReader.wrap(io) { |gz| result << gz.read }
+        result.string
+      end
+    end
+  end
+end

data/lib/sidetree/util/jwk.rb

@@ -0,0 +1,47 @@
+module Sidetree
+  module Util
+    module JWK
+      module_function
+
+      # Parse jwk hash object.
+      # The returned jwk does not include the kid.
+      # @param [Hash] params
+      # @return [JSON::JWK]
+      def parse(params)
+        jwk = JSON::JWK.new(params)
+        jwk.delete("kid")
+        jwk
+      end
+
+      # Validate jwk object as sidetree jwk.
+      # @param [JSON::JWK] jwk
+      # @raise [Sidetree::Error]
+      def validate!(jwk)
+        raise Sidetree::Error unless jwk.is_a?(JSON::JWK)
+        jwk.keys.each do |k|
+          unless %w[kty crv x y].include?(k)
+            raise Sidetree::Error, "JWK Es256k has unknown property"
+          end
+        end
+        unless jwk[:kty] == "EC"
+          raise Sidetree::Error, "JWK Es256k missing or invalid kty"
+        end
+        unless jwk[:crv] == "secp256k1"
+          raise Sidetree::Error, "JWK Es256k missing or invalid crv"
+        end
+        unless jwk[:x].is_a?(String)
+          raise Sidetree::Error, "JWK Es256k missing or invalid type x"
+        end
+        unless jwk[:y].is_a?(String)
+          raise Sidetree::Error, "JWK Es256k missing or invalid type y"
+        end
+        unless jwk[:x].length == 43
+          raise Sidetree::Error, "JWK Es256k has incorrect length of x"
+        end
+        unless jwk[:y].length == 43
+          raise Sidetree::Error, "JWK Es256k has incorrect length of y"
+        end
+      end
+    end
+  end
+end

data/lib/sidetree/util/jws.rb

@@ -0,0 +1,52 @@
+module Sidetree
+  module Util
+    module JWS
+      module_function
+
+      # Sign to +claim+ by +private_key+.
+      # @param [Hash] claim
+      # @param [Sidetree::Key] private_key Private key used by sign.
+      # @return [JSON::JWS]
+      def sign(claim, private_key)
+        jwt = JSON::JWT.new(claim)
+        jwt.header.delete(:typ)
+        jwt.sign(private_key.jws_sign_key, :ES256K)
+      end
+
+      # Parse +jws_string+ to JSON::JWS
+      # @param [String] jws_string JWS data string.
+      # @return [JSON::JWS]
+      # @raise [Sidetree::Error]
+      def parse(jws_string)
+        jws =
+          JSON::JWS.decode_compact_serialized(jws_string, :skip_verification)
+        validate!(jws)
+        jws
+      end
+
+      # Check whether valid +jws+ or not as sidetree jws.
+      # @param [JSON::JWS] jws
+      # @return [Boolean]
+      def valid?(jws)
+        begin
+          validate!(jws)
+          true
+        rescue Sidetree::Error
+          false
+        end
+      end
+
+      # Validate +jws+ as sidetree jws.
+      # @param [JSON::JWS] jws
+      # @raise [Sidetree::Error]
+      def validate!(jws)
+        unless jws.header.length == 1
+          raise Sidetree::Error, "jws header missing or unknown property"
+        end
+        unless jws.header[:alg] == "ES256K"
+          raise Sidetree::Error, "jws header missing or incorrect alg"
+        end
+      end
+    end
+  end
+end

data/lib/sidetree/util.rb

@@ -0,0 +1,8 @@
+module Sidetree
+  module Util
+    autoload :Compressor, "sidetree/util/compressor"
+    autoload :AnchoredDataSerializer, "sidetree/util/anchored_data_serializer"
+    autoload :JWS, "sidetree/util/jws"
+    autoload :JWK, "sidetree/util/jwk"
+  end
+end