ruby_auth_metamask 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '082c3d67f770e78978eda75d5d4e6094a00264a258a8fc882447bd890d0fe8f9'
+  data.tar.gz: fc4f10499d4006701e0ee14e6707ed010df7dc45e6942df2859d367dc55d7869
+SHA512:
+  metadata.gz: 1f06a0fa4cf7bc7a62c5449bdc04e97ad4713c61db89c6ece9dcf924dd63c3d22990664110171a9c8e316622d82487ff6cefe377a8dc69aa236a3cde995a0872
+  data.tar.gz: b32bb59e75509d5ed13bfdd30de498915c636c2289eb8af06f5223633ec9cd940d35975de53c0a623cbc4bb55a7857c18c06c0c9d5499a1817493514f05d340b

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Ethan Zhang
+
+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,28 @@
+# RubyAuthMetamask
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "ruby_auth_metamask"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install ruby_auth_metamask
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/ruby_auth_metamask_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/ruby_auth_metamask .css

data/app/assets/stylesheets/ruby_auth_metamask/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/ruby_auth_metamask/application_controller.rb

@@ -0,0 +1,4 @@
+module RubyAuthMetamask
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/ruby_auth_metamask/users_controller.rb

@@ -0,0 +1,141 @@
+require 'ecdsa'
+require 'digest/keccak'
+
+module RubyAuthMetamask
+  # a simple wrapper to carry the v value of signture
+  class MySignature
+    attr_reader :sig_obj, :v
+
+    def initialize(sig_obj, v_value)
+      @sig_obj = sig_obj
+      @v = v_value
+    end
+  end
+
+  class UsersController < ApplicationController
+    def signin
+      @message = "ruby_auth_metamask:#{SecureRandom.hex}"
+      session[:message] = @message
+    end
+
+    def verify
+      address = sanitize_and_return_address
+      my_signature = sanitize_and_return_my_signature
+      if address.nil? || my_signature.nil?
+        redirect_to main_app.root_path, notice: 'Address or signature is invalid'
+        return
+      end
+
+      hash = metamask_digest(session[:message])
+      if hash.nil?
+        redirect_to main_app.root_path, notice: 'User authentication failed'
+        return
+      end
+
+      public_key = recover_public_key(hash, my_signature)
+      if public_key.nil?
+        redirect_to main_app.root_path, notice: 'User authentication failed'
+        return
+      end
+
+      unless verify_public_key_and_address(public_key, address)
+        redirect_to main_app.root_path, notice: 'User address does not match public key'
+        return
+      end
+
+      valid = ECDSA.valid_signature?(public_key, hash, my_signature.sig_obj) rescue false
+      if valid
+        redirect_to main_app.root_path, notice: 'User authenticated successfully'
+      else
+        redirect_to main_app.root_path, notice: 'User authentication failed'
+      end
+    end
+
+    private
+
+    def sanitize_and_return_address
+      return nil if params[:address].nil?
+
+      params[:address].downcase
+    end
+
+    def sanitize_and_return_my_signature
+      signature = params[:signature] # 0x0123456789abcdef
+      if signature.nil?
+        return nil
+      elsif signature.size < 3
+        return nil
+      else
+        signature = signature[2..]
+      end
+
+      my_signature_from_hex(signature)
+    end
+
+    def public_key_to_address(public_key)
+      # public_key_string_short = ECDSA::Format::PointOctetString.encode(public_key, compression: true)
+      # pub_key_hex = public_key_string_short.unpack1("H*")
+      # puts "pub key hex: #{pub_key_hex}"
+
+      public_key_string = ECDSA::Format::PointOctetString.encode(public_key, compression: false)
+      calculated_address = Digest::Keccak.digest(public_key_string[1..], 256)
+      calculated_address[-20..].unpack1('H*')
+    end
+
+    def verify_public_key_and_address(public_key, address)
+      "0x#{public_key_to_address(public_key)}".downcase == address.downcase
+    end
+
+    METAMASK_HASH_PREFIX = "\x19Ethereum Signed Message:\n".freeze
+
+    def message_for_hashing(raw_message)
+      "#{METAMASK_HASH_PREFIX}#{raw_message.size}#{raw_message}"
+    end
+
+    def metamask_digest(message)
+      return nil if message.nil?
+
+      Digest::Keccak.digest(message_for_hashing(message), 256)
+    end
+
+    def recovery_id_from_v(v_value)
+      raise 'v needs to be an integerr' unless v_value.is_a? Integer
+
+      rec_id = v_value - 27
+      raise "Invalid recovery id: #{rec_id}" if rec_id < 0 || rec_id > 3
+
+      rec_id
+    end
+
+    def my_signature_from_hex(signature)
+      signature_byte_string = signature
+
+      case signature.size
+      when 130
+        signature_byte_string = [signature].pack('H*')
+      when 65
+        # do nothing
+      else
+        return nil
+      end
+
+      signature_bytes = signature_byte_string.unpack('C*')
+      r = signature_bytes[0, 32].pack('C*').unpack1('H*').to_i(16)
+      s = signature_bytes[32, 32].pack('C*').unpack1('H*').to_i(16)
+      v = signature_bytes[64].to_i
+
+      sig_obj = ECDSA::Signature.new(r, s)
+      MySignature.new(sig_obj, v)
+    end
+
+    def recover_public_key(hash, my_signature)
+      keys = ECDSA.recover_public_key(ECDSA::Group::Secp256k1, hash, my_signature.sig_obj).map do |p|
+        ECDSA::Format::PointOctetString.encode(p, compression: true)
+      end
+      key = keys[recovery_id_from_v(my_signature.v)]
+      return nil if key.nil?
+
+      ECDSA::Format::PointOctetString.decode(key, ECDSA::Group::Secp256k1)
+    end
+  end
+end

data/app/helpers/ruby_auth_metamask/application_helper.rb

@@ -0,0 +1,4 @@
+module RubyAuthMetamask
+  module ApplicationHelper
+  end
+end

data/app/helpers/ruby_auth_metamask/users_helper.rb

@@ -0,0 +1,4 @@
+module RubyAuthMetamask
+  module UsersHelper
+  end
+end

data/app/jobs/ruby_auth_metamask/application_job.rb

@@ -0,0 +1,4 @@
+module RubyAuthMetamask
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/ruby_auth_metamask/application_mailer.rb

@@ -0,0 +1,6 @@
+module RubyAuthMetamask
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/ruby_auth_metamask/application_record.rb

@@ -0,0 +1,5 @@
+module RubyAuthMetamask
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/ruby_auth_metamask/user.rb

@@ -0,0 +1,4 @@
+module RubyAuthMetamask
+  class User < ApplicationRecord
+  end
+end

data/app/views/layouts/ruby_auth_metamask/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Ruby auth metamask</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "ruby_auth_metamask/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/ruby_auth_metamask/users/signin.html.erb

@@ -0,0 +1,68 @@
+<div class="h-screen flex justify-center items-center">
+  <div class="w-1/2 sm:text-base lg:text-xl bg-gray-200 m-4 px-4 py-10 rounded-xl ">
+    <%= form_with url: verify_path, method: :post do |form| %>
+      <div class="flex flex-col justfy-center mt-2 p-4">
+        <div class="w-full bg-orange-200 p-2 rounded-lg ">
+          <%= form.label :address, "Address:", class: "w-2/3" %>
+        </div>
+        <div class="w-full rounded-lg mt-1">
+          <%= form.text_field :address, class: "border-2 border-blue-200 w-full p-2 rounded-lg text-base" %>
+        </div>
+        <div class="w-full mt-2 bg-orange-200 p-2 rounded-lg ">
+          <%= form.label :signature, "Signature:", class: "w-2/3" %>
+        </div>
+        <div class="w-full rounded-lg mt-1">
+          <%= form.text_area :signature, rows: 4, class: "border-2 border-blue-200 w-full p-2 rounded-lg text-base" %>
+        </div>
+        <div class="flex justfy-center mt-10">
+          <hr class="h-px my-2 bg-gray-200 border-0 dark:bg-gray-700" />
+          <%= form.submit "Submit", class: "w-1/2 mx-auto rounded-lg p-3 bg-orange-300" %>
+        </div>
+      </div>
+    <% end %>
+  </div>
+</div>
+
+
+<script src="https://cdn.tailwindcss.com"></script>
+<script src="https://cdn.jsdelivr.net/npm/web3@1.3.6/dist/web3.min.js"></script>
+
+<script>
+
+  function myHandler() {
+    if (! window.ethereum) {
+      alert("MetaMask is not directed. Please install MetaMask extension first.");
+      return
+    }
+
+    const web3 = new Web3(window.ethereum);
+    window.ethereum.request({ method: 'eth_requestAccounts' })
+      .then(accounts => {
+        const accountAddress = accounts[0];
+        console.log('Account Address:', accountAddress);
+
+        const addrInput = document.getElementById("address");
+        addrInput.value = accountAddress;
+
+        const message = "<%= @message %>";
+
+        web3.eth.personal.sign(message, accountAddress, (error, signature) => {
+          if (!error) {
+            console.log("Signature: ", signature);
+            const sigInput = document.getElementById("signature");
+            sigInput.value = signature;
+          } else {
+            alert("Error signing message: " + error);
+            return;
+          }
+        });
+      })
+      .catch(error => {
+          alert("Error requesting accounts: " + error);
+          return;
+      });
+  };
+
+  myHandler();
+
+</script>

data/config/routes.rb

@@ -0,0 +1,6 @@
+RubyAuthMetamask::Engine.routes.draw do
+  get  'signin', to: 'users#signin', as: 'signin'
+  post 'verify', to: 'users#verify', as: 'verify'
+
+  root           to: 'users#signin'
+end

data/db/migrate/20231213214539_create_ruby_auth_metamask_users.rb

@@ -0,0 +1,9 @@
+class CreateRubyAuthMetamaskUsers < ActiveRecord::Migration[7.1]
+  def change
+    create_table :ruby_auth_metamask_users do |t|
+      t.string :address
+
+      t.timestamps
+    end
+  end
+end

data/lib/ruby_auth_metamask/engine.rb

@@ -0,0 +1,5 @@
+module RubyAuthMetamask
+  class Engine < ::Rails::Engine
+    isolate_namespace RubyAuthMetamask
+  end
+end

data/lib/ruby_auth_metamask/version.rb

@@ -0,0 +1,3 @@
+module RubyAuthMetamask
+  VERSION = "0.1.0"
+end

data/lib/ruby_auth_metamask.rb

@@ -0,0 +1,6 @@
+require "ruby_auth_metamask/version"
+require "ruby_auth_metamask/engine"
+
+module RubyAuthMetamask
+  # Your code goes here...
+end

data/lib/tasks/ruby_auth_metamask_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :ruby_auth_metamask do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: ruby_auth_metamask
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ethan Zhang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.2
+- !ruby/object:Gem::Dependency
+  name: ecdsa
+  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: keccak
+  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'
+description: This is a Ruby on Rails Engine. It authenticates users against their
+  metamask signature.
+email:
+- yzhang.wa@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/ruby_auth_metamask_manifest.js
+- app/assets/stylesheets/ruby_auth_metamask/application.css
+- app/controllers/ruby_auth_metamask/application_controller.rb
+- app/controllers/ruby_auth_metamask/users_controller.rb
+- app/helpers/ruby_auth_metamask/application_helper.rb
+- app/helpers/ruby_auth_metamask/users_helper.rb
+- app/jobs/ruby_auth_metamask/application_job.rb
+- app/mailers/ruby_auth_metamask/application_mailer.rb
+- app/models/ruby_auth_metamask/application_record.rb
+- app/models/ruby_auth_metamask/user.rb
+- app/views/layouts/ruby_auth_metamask/application.html.erb
+- app/views/ruby_auth_metamask/users/signin.html.erb
+- config/routes.rb
+- db/migrate/20231213214539_create_ruby_auth_metamask_users.rb
+- lib/ruby_auth_metamask.rb
+- lib/ruby_auth_metamask/engine.rb
+- lib/ruby_auth_metamask/version.rb
+- lib/tasks/ruby_auth_metamask_tasks.rake
+homepage: https://github.com/yzhanginwa/ruby_auth_metamask
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/yzhanginwa/ruby_auth_metamask
+  source_code_uri: https://github.com/yzhanginwa/ruby_auth_metamask
+  changelog_uri: https://github.com/yzhanginwa/ruby_auth_metamask
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key: 
+specification_version: 4
+summary: A Ruby on Rails Engine to authenticate metamask users
+test_files: []