sidetree 0.1.1 → 0.1.4

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

data/lib/sidetree/validator.rb

@@ -215,6 +215,18 @@ module Sidetree
       end
     end
 
+    # Verify that the Multihash of +content+ matches that of +multihash+.
+    # @param [String] content content to be hashed
+    # @param [String] multihash Hash value to be checked
+    # @param [String] target Name of the target object to include in the error message
+    # @raise [Sidetree::Error]
+    def validate_canonicalize_object_hash!(content, multihash, target)
+      unless Sidetree.to_hash(content) == multihash
+        raise Sidetree::Error,
+              "Canonicalized #{target} object hash does not match expected hash '#{multihash}'"
+      end
+    end
+
     def validate_did_type!(type)
       return unless type
       raise Error, "DID type must be a string." unless type.instance_of?(String)
@@ -245,5 +257,16 @@ module Sidetree
       validate_encoded_multi_hash!(suffix[:deltaHash], "delta hash")
       validate_did_type!(suffix[:type])
     end
+
+    def validate_cas_file_uri!(uri, target)
+      unless uri.is_a?(String)
+        raise Sidetree::Error,
+              "Input #{target} CAS file URI '#{uri}' needs to be of string type"
+      end
+      if uri.bytesize > Sidetree::Params::MAX_CAS_URI_LENGTH
+        raise Sidetree::Error,
+              "Input #{target} CAS file URI byte size cannot exceed #{Sidetree::Params::MAX_CAS_URI_LENGTH}"
+      end
+    end
   end
 end

data/lib/sidetree/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sidetree
-  VERSION = "0.1.1"
+  VERSION = "0.1.4"
 end

data/lib/sidetree.rb

@@ -13,11 +13,13 @@ module Sidetree
   class Error < StandardError
   end
 
+  autoload :Util, "sidetree/util"
   autoload :Key, "sidetree/key"
   autoload :DID, "sidetree/did"
   autoload :Model, "sidetree/model"
   autoload :OP, "sidetree/op"
   autoload :Validator, "sidetree/validator"
+  autoload :CAS, "sidetree/cas"
 
   module Params
     # Algorithm for generating hashes of protocol-related values. 0x12 = sha2-256
@@ -26,7 +28,22 @@ module Sidetree
 
     # Maximum canonicalized operation delta buffer size.
     MAX_DELTA_SIZE = 1000
-
+    # Maximum compressed chunk file size. 10MB.
+    MAX_CHUNK_FILE_SIZE = 10_000_000
+    # Maximum compressed Provisional Index File size. 1 MB (zipped)
+    MAX_PROVISIONAL_INDEX_FILE_SIZE = 1_000_000
+    # Maximum compressed Proof File size. 2.5 MB (zipped)
+    MAX_PROOF_FILE_SIZE = 2_500_000
+    # Maximum compressed Core Index File size. 1 MB (zipped)
+    MAX_CORE_INDEX_FILE_SIZE = 1_000_000
+    # Maximum writer lock ID size
+    MAX_WRITER_LOCK_ID_SIZE = 200
+    # Maximum length of CAS URIs. 100 bytes
+    MAX_CAS_URI_LENGTH = 100
+    # Maximum number of operations per batch. 10000 ops.
+    MAX_OPERATION_COUNT = 10_000
+    # Default public key type
+    DEFAULT_PUBKEY_TYPE = "EcdsaSecp256k1VerificationKey2019"
     # Default DID method
     DEFAULT_METHOD = "sidetree"
 

data/sidetree.gemspec

@@ -39,5 +39,6 @@ Gem::Specification.new do |spec|
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'prettier', '~> 3.1.2'
+  spec.add_development_dependency 'prettier', '~> 3.2.0'
+  spec.add_development_dependency 'webmock', '~> 3.14.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidetree
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.4
 platform: ruby
 authors:
 - azuchi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-29 00:00:00.000000000 Z
+date: 2022-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ecdsa
@@ -86,14 +86,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.2
+        version: 3.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.2
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.14.0
 description: Ruby implementation for Sidetree protocol.
 email:
 - azuchi@chaintope.com
@@ -116,11 +130,21 @@ files:
 - bin/console
 - bin/setup
 - lib/sidetree.rb
+- lib/sidetree/cas.rb
+- lib/sidetree/cas/fetch_result.rb
+- lib/sidetree/cas/ipfs.rb
 - lib/sidetree/did.rb
 - lib/sidetree/key.rb
 - lib/sidetree/model.rb
+- lib/sidetree/model/cas_file_base.rb
+- lib/sidetree/model/chunk.rb
+- lib/sidetree/model/chunk_file.rb
+- lib/sidetree/model/core_index_file.rb
+- lib/sidetree/model/core_proof_file.rb
 - lib/sidetree/model/delta.rb
 - lib/sidetree/model/document.rb
+- lib/sidetree/model/provisional_index_file.rb
+- lib/sidetree/model/provisional_proof_file.rb
 - lib/sidetree/model/service.rb
 - lib/sidetree/model/suffix.rb
 - lib/sidetree/op.rb
@@ -128,6 +152,13 @@ files:
 - lib/sidetree/op/create.rb
 - lib/sidetree/op/deactivate.rb
 - lib/sidetree/op/recover.rb
+- lib/sidetree/op/updatable.rb
+- lib/sidetree/op/update.rb
+- lib/sidetree/util.rb
+- lib/sidetree/util/anchored_data_serializer.rb
+- lib/sidetree/util/compressor.rb
+- lib/sidetree/util/jwk.rb
+- lib/sidetree/util/jws.rb
 - lib/sidetree/validator.rb
 - lib/sidetree/version.rb
 - sidetree.gemspec