siwe 0.1.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6672768ccc989b67fd335a571585a7bbae2f88ccd8c095f7332a308f39037dab
-  data.tar.gz: 3612d9b498a36fa37e0cb70e81e2ae64450baf34d7ef9d75cc666957957c15de
+  metadata.gz: 3ee917f6a6a6cfe1877f32dd8c70cd2628b745c6a941f7d6bcaebd1e0c19c592
+  data.tar.gz: 4162a2428f5a0efce7d190a1ca1bbff06c3574447853fa9dfae183301f084ab7
 SHA512:
-  metadata.gz: 6f42e272519ac16310a8ee9bf75139e121acaf52b446b0ed35e8868bb17bfcb816caced089dc7e342e5a686a1ab532cab6a9d385a3b80cbc7b6a15c668e019aa
-  data.tar.gz: 93c9e1a87a4dae94562f89b44de590f03a23c673dfb30962f2cd47c52aa4547f3b8c0a0b0a3263773b4113783dcfcd97154de7d9401b689935dfa3da671b001a
+  metadata.gz: 648ec9080c223f0ffea368c522f4a29aa5f9b3203fe91a090133ca4143d7d637bd9b7f586de5883a2ed3e9a06473aaedb8e57ff94aa67ffc45462681cb259500
+  data.tar.gz: e3212a3795f6dd22d584d77d59eacfa3150aa0ddf284f30f85ea129253f1f3d77afe4c1d049df8f655f50f3dafbe2748ce0df7468af562aa9f69768dd858da9d

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    siwe (0.1.4)
-      eth (~> 0.5.0)
+    siwe (1.0.0)
+      eth (~> 0.5.1)
 
 GEM
   remote: https://rubygems.org/
@@ -12,17 +12,17 @@ GEM
     benchmark (0.2.0)
     diff-lcs (1.5.0)
     e2mmap (0.1.0)
-    eth (0.5.0)
+    eth (0.5.1)
       keccak (~> 1.3)
       konstructor (~> 1.0)
-      openssl (~> 3.0)
+      openssl (~> 2.2)
       rbsecp256k1 (~> 5.1)
-      rlp (~> 0.7)
       scrypt (~> 3.0)
     ffi (1.15.5)
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
       rake
+    ipaddr (1.2.3)
     jaro_winkler (1.5.4)
     keccak (1.3.0)
     konstructor (1.0.2)
@@ -33,7 +33,8 @@ GEM
     mini_portile2 (2.7.1)
     nokogiri (1.13.1-x86_64-linux)
       racc (~> 1.4)
-    openssl (3.0.0)
+    openssl (2.2.1)
+      ipaddr
     parallel (1.21.0)
     parser (3.1.0.0)
       ast (~> 2.4.1)
@@ -49,7 +50,6 @@ GEM
     reverse_markdown (2.1.1)
       nokogiri
     rexml (3.2.5)
-    rlp (0.7.3)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)

data/lib/siwe/exceptions.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Siwe
+  # Used when the message is already expired. (Expires At < Time.now)
+  class ExpiredMessage < StandardError
+    def initialize(msg = "Message expired.")
+      super
+    end
+  end
+
+  # Used when the message is not yet valid. (Not Before > Time.now)
+  class NotValidMessage < StandardError
+    def initialize(msg = "Message not yet valid.")
+      super
+    end
+  end
+
+  # Used when the signature doesn't correspond to the address of the message.
+  class InvalidSignature < StandardError
+    def initialize(msg = "Signature doesn't match message.")
+      super
+    end
+  end
+end

data/lib/siwe/message.rb

@@ -74,9 +74,6 @@ module Siwe
     # expressed as RFC 3986 URIs separated by `\n- `.
     attr_accessor :resources
 
-    # Signature of the message signed by the wallet.
-    attr_accessor :signature
-
     def initialize(domain, address, uri, version, options = {})
       @domain = domain
       @address = address
@@ -91,13 +88,11 @@ module Siwe
       @not_before = options.fetch :not_before, ""
       @request_id = options.fetch :request_id, ""
       @resources = options.fetch :resources, []
-      @signature = options.fetch :signature, ""
-      validate(true)
     end
 
     def self.from_message(msg)
       if (message = msg.match SIWE_MESSAGE)
-        msg = new(
+        new(
           message[:domain],
           message[:address],
           message[:uri],
@@ -113,8 +108,7 @@ module Siwe
             resources: message[:resources]&.split("\n- ")&.drop(1) || []
           }
         )
-        msg.validate(true)
-        msg
+
       else
         throw "Invalid message input."
       end
@@ -133,15 +127,14 @@ module Siwe
         expiration_time: @expiration_time,
         not_before: @not_before,
         request_id: @request_id,
-        resources: @resources,
-        signature: @signature
+        resources: @resources
       }
       obj.to_json
     end
 
     def self.from_json_string(str)
       obj = JSON.parse str, { symbolize_names: true }
-      msg = Siwe::Message.new(
+      Siwe::Message.new(
         obj[:domain],
         obj[:address],
         obj[:uri],
@@ -153,30 +146,30 @@ module Siwe
           expiration_time: obj[:expiration_time],
           not_before: obj[:not_before],
           request_id: obj[:request_id],
-          resources: obj[:resources],
-          signature: obj[:signature]
+          resources: obj[:resources]
         }
       )
-      msg.validate(true)
-      msg
     end
 
-    def validate(skip_signature = false)
-      raise "Message expired." if !@expiration_time.empty? && Time.now.utc > Time.parse(@expiration_time)
-      raise "Message not yet valid." if !@not_before.empty? && Time.now.utc < Time.parse(@not_before)
+    def validate(signature)
+      raise Siwe::ExpiredMessage if !@expiration_time.empty? && Time.now.utc > Time.parse(@expiration_time)
+      raise Siwe::NotValidMessage if !@not_before.empty? && Time.now.utc < Time.parse(@not_before)
 
-      unless skip_signature
-        raise "Missing signature field." if @signature.empty?
+      raise Siwe::InvalidSignature if signature.empty?
 
-        pub_key = Eth::Signature.personal_recover personal_sign, @signature
+      begin
+        pub_key = Eth::Signature.personal_recover prepare_message, signature
         signature_address = Eth::Util.public_key_to_address pub_key
-        raise "Signature doesn't match message." unless signature_address.to_s.downcase.eql? @address.to_s.downcase
+      rescue StandardError
+        raise Siwe::InvalidSignature
       end
 
+      raise Siwe::InvalidSignature unless signature_address.to_s.downcase.eql? @address.to_s.downcase
+
       true
     end
 
-    def personal_sign
+    def prepare_message
       greeting = "#{@domain} wants you to sign in with your Ethereum account:"
       address = @address
       statement = "\n#{@statement}\n"

data/lib/siwe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Siwe
-  VERSION = "0.1.5"
+  VERSION = "1.0.0"
 end

data/lib/siwe.rb

@@ -6,6 +6,9 @@ require_relative "siwe/version"
 module Siwe
   autoload :Message, "siwe/message"
   autoload :Util, "siwe/util"
+  autoload :ExpiredMessage, "siwe/exceptions"
+  autoload :NotValidMessage, "siwe/exceptions"
+  autoload :InvalidSignature, "siwe/exceptions"
 
   class Error < StandardError; end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: siwe
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Spruce Systems Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-24 00:00:00.000000000 Z
+date: 2022-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eth
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.5.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -101,6 +101,7 @@ files:
 - bin/console
 - bin/setup
 - lib/siwe.rb
+- lib/siwe/exceptions.rb
 - lib/siwe/message.rb
 - lib/siwe/util.rb
 - lib/siwe/version.rb