siwe_rails 0.1.0

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

@@ -0,0 +1,65 @@
+html, body {
+	position: relative;
+	width: 100%;
+	height: 100%;
+}
+
+body {
+	color: #333;
+	margin: 0;
+	padding: 8px;
+	box-sizing: border-box;
+	font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen-Sans, Ubuntu, Cantarell, "Helvetica Neue", sans-serif;
+}
+
+a {
+	color: rgb(0,100,200);
+	text-decoration: none;
+}
+
+a:hover {
+	text-decoration: underline;
+}
+
+a:visited {
+	color: rgb(0,80,160);
+}
+
+label {
+	display: block;
+}
+
+input, button, select, textarea {
+	font-family: inherit;
+	font-size: inherit;
+	-webkit-padding: 0.4em 0;
+	padding: 0.4em;
+	margin: 0 0 0.5em 0;
+	box-sizing: border-box;
+	border: 1px solid #ccc;
+	border-radius: 2px;
+}
+
+input:disabled {
+	color: #ccc;
+}
+
+button {
+	color: #333;
+	background-color: #f4f4f4;
+	outline: none;
+}
+
+button:disabled {
+	color: #999;
+}
+
+button:not(:disabled):active {
+	background-color: #ddd;
+}
+
+button:focus {
+	border-color: #666;
+}
+
+*,:after,:before{border:0 solid;box-sizing:border-box}:after,:before{--tw-content:""}html{-webkit-text-size-adjust:100%;font-family:ui-sans-serif,system-ui,-apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Helvetica Neue,Arial,Noto Sans,sans-serif,Apple Color Emoji,Segoe UI Emoji,Segoe UI Symbol,Noto Color Emoji;line-height:1.5;-moz-tab-size:4;-o-tab-size:4;tab-size:4}body{line-height:inherit;margin:0}hr{border-top-width:1px;color:inherit;height:0}abbr:where([title]){-webkit-text-decoration:underline dotted;text-decoration:underline dotted}h1,h2,h3,h4,h5,h6{font-size:inherit;font-weight:inherit}a{color:inherit;text-decoration:inherit}b,strong{font-weight:bolder}code,kbd,pre,samp{font-family:ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,monospace;font-size:1em}small{font-size:80%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}table{border-collapse:collapse;border-color:inherit;text-indent:0}button,input,optgroup,select,textarea{color:inherit;font-family:inherit;font-size:100%;line-height:inherit;margin:0;padding:0}button,select{text-transform:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button;background-color:transparent;background-image:none}:-moz-focusring{outline:auto}:-moz-ui-invalid{box-shadow:none}progress{vertical-align:baseline}::-webkit-inner-spin-button,::-webkit-outer-spin-button{height:auto}[type=search]{-webkit-appearance:textfield;outline-offset:-2px}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-file-upload-button{-webkit-appearance:button;font:inherit}summary{display:list-item}blockquote,dd,dl,figure,h1,h2,h3,h4,h5,h6,hr,p,pre{margin:0}fieldset{margin:0}fieldset,legend{padding:0}menu,ol,ul{list-style:none;margin:0;padding:0}textarea{resize:vertical}input::-moz-placeholder,textarea::-moz-placeholder{color:#9ca3af;opacity:1}input:-ms-input-placeholder,textarea:-ms-input-placeholder{color:#9ca3af;opacity:1}input::placeholder,textarea::placeholder{color:#9ca3af;opacity:1}[role=button],button{cursor:pointer}:disabled{cursor:default}audio,canvas,embed,iframe,img,object,svg,video{display:block;vertical-align:middle}img,video{height:auto;max-width:100%}[hidden]{display:none}*,:after,:before{--tw-translate-x:0;--tw-translate-y:0;--tw-rotate:0;--tw-skew-x:0;--tw-skew-y:0;--tw-scale-x:1;--tw-scale-y:1;--tw-transform:translateX(var(--tw-translate-x)) translateY(var(--tw-translate-y)) rotate(var(--tw-rotate)) skewX(var(--tw-skew-x)) skewY(var(--tw-skew-y)) scaleX(var(--tw-scale-x)) scaleY(var(--tw-scale-y));--tw-border-opacity:1;--tw-ring-offset-shadow:0 0 #0000;--tw-ring-shadow:0 0 #0000;--tw-shadow:0 0 #0000;--tw-shadow-colored:0 0 #0000;border-color:rgb(229 231 235/var(--tw-border-opacity))}.visible{visibility:visible}.invisible{visibility:hidden}.mb-8{margin-bottom:2rem}.mt-auto{margin-top:auto}.flex{display:flex}.h-screen{height:100vh}.h-96{height:24rem}.h-12{height:3rem}.h-8{height:2rem}.w-full{width:100%}.w-96{width:24rem}.w-6{width:1.5rem}.flex-grow{flex-grow:1}.transform{transform:var(--tw-transform)}.flex-col{flex-direction:column}.flex-wrap{flex-wrap:wrap}.items-center{align-items:center}.justify-center{justify-content:center}.justify-evenly{justify-content:space-evenly}.self-center{align-self:center}.rounded-20{border-radius:20px}.border{border-width:1px}.border-white{--tw-border-opacity:1;border-color:rgb(255 255 255/var(--tw-border-opacity))}.bg-gray{--tw-bg-opacity:1;background-color:rgb(33 33 33/var(--tw-bg-opacity))}.bg-white{--tw-bg-opacity:1;background-color:rgb(255 255 255/var(--tw-bg-opacity))}.bg-cover{background-size:cover}.bg-center{background-position:50%}.bg-no-repeat{background-repeat:no-repeat}.p-12{padding:3rem}.text-center{text-align:center}.font-satoshi{font-family:Satoshi}.text-xs{font-size:.75rem;line-height:1rem}.font-bold{font-weight:700}.shadow-lg{--tw-shadow:0 10px 15px -3px rgba(0,0,0,.1),0 4px 6px -4px rgba(0,0,0,.1);--tw-shadow-colored:0 10px 15px -3px var(--tw-shadow-color),0 4px 6px -4px var(--tw-shadow-color)}.shadow-lg,.shadow-xl{box-shadow:var(--tw-ring-offset-shadow,0 0 #0000),var(--tw-ring-shadow,0 0 #0000),var(--tw-shadow)}.shadow-xl{--tw-shadow:0 20px 25px -5px rgba(0,0,0,.1),0 8px 10px -6px rgba(0,0,0,.1);--tw-shadow-colored:0 20px 25px -5px var(--tw-shadow-color),0 8px 10px -6px var(--tw-shadow-color)}.shadow-white{--tw-shadow-color:#fff;--tw-shadow:var(--tw-shadow-colored)}.transition-all{transition-duration:.15s;transition-property:all;transition-timing-function:cubic-bezier(.4,0,.2,1)}.duration-100{transition-duration:.1s}.ease-in-out{transition-timing-function:cubic-bezier(.4,0,.2,1)}.tooltip{position:absolute;visibility:hidden}.has-tooltip:hover .tooltip{visibility:visible;z-index:50}body,html{background:#ecf2fe;display:flex;flex-direction:column;font-family:Satoshi;font-size:18px;height:100vh;margin:0;overflow-x:hidden;padding:0;position:relative;width:100vw}h1,h2,h3,h4,h5,h6{font-family:Satoshi;font-weight:800}h1{font-size:76px;letter-spacing:-4.5%;line-height:129px}h2{font-size:66px;letter-spacing:-3%;line-height:101px}h3{font-size:52px;letter-spacing:-1.5%;line-height:80px}h4{font-size:48px;letter-spacing:-1%;line-height:63px}h5{font-size:32px;line-height:49px}h5,h6{letter-spacing:-.5%}h6{font-size:24px;line-height:37px}body{color:#222}a{color:#04d2ca;text-decoration:none}td,th{font-family:Satoshi;font-weight:400}pre{word-wrap:break-word;white-space:pre-wrap;white-space:-moz-pre-wrap;white-space:-pre-wrap;white-space:-o-pre-wrap}.web3modal-modal-lightbox{z-index:30!important}.walletconnect-modal__base{background-color:#273137!important}.walletconnect-qrcode__text{color:#fff!important}.walletconnect-modal__mobile__toggle{background:hsla(0,0%,100%,.1)!important}.walletconnect-qrcode__image{border:24px solid #fff!important;border-radius:8px!important}.walletconnect-modal__base__row:hover{background:hsla(0,0%,100%,.1)!important}.walletconnect-modal__mobile__toggle_selector{background:hsla(0,0%,100%,.2)!important}::-webkit-scrollbar-track{background-color:#ccc;border-radius:8px}::-webkit-scrollbar-thumb{background-color:#888;border-radius:8px}::-webkit-scrollbar{background-color:#ccc;border-radius:8px;height:6px;width:6px}.grecaptcha-badge{visibility:hidden}.hover\:scale-105:hover{--tw-scale-x:1.05;--tw-scale-y:1.05;transform:var(--tw-transform)}

data/app/assets/stylesheets/siwe_rails/background.scss

@@ -0,0 +1,3 @@
+body > div.background {
+  background-image: image-url("siwe_rails/swe-landing.svg");
+}

data/app/controllers/siwe_rails/application_controller.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'siwe'
+
+module SiweRails
+  class ApplicationController < ActionController::Base
+    SESSION_SIWE_MESSAGE_KEY = 'siwe/message' # Session key
+
+    def index
+      render :index
+    end
+
+    # /#{prefix}/message
+    def message
+      message = Siwe::Message.new(
+        request.host_with_port,
+        request.params[:address],
+        "#{request.protocol}#{request.host_with_port}",
+        '1',
+        sign_params
+      )
+      session[SESSION_SIWE_MESSAGE_KEY] = message.to_json_string
+      render plain: message.prepare_message
+    end
+
+    # /#{prefix}/signature
+    def signature
+      message = Siwe::Message.from_json_string session[SESSION_SIWE_MESSAGE_KEY]
+
+      if message.validate(params.require(:signature))
+        session[SESSION_SIWE_MESSAGE_KEY] = nil
+        session[SiweRails.SIWE_ENS] = params[:ens]
+        session[SiweRails.SIWE_ADDRESS] = message.address
+
+        redirect_to SiweRails.redirect_uri, status: 308
+      else
+        head :bad_request
+      end
+    end
+
+    private
+
+    # Calculates expiration date
+    def expires_at
+      (Time.now.utc + SiweRails.expiration_time).iso8601
+    end
+
+    # Default required params
+    def default_sign_params
+      {
+        statement: SiweRails.statement,
+        nonce: Siwe::Util.generate_nonce,
+        chain_id: request.params[:chainId]
+      }
+    end
+
+    # Add optional params if present
+    def sign_params
+      params = default_sign_params
+      params[:expiration_time] = expires_at unless SiweRails.expiration_time.nil?
+      params[:not_before] = SiweRails.not_before unless SiweRails.not_before.nil?
+      params[:request_id] = SecureRandom.uuid if SiweRails.request_id
+      params[:resources] = SiweRails.resources unless SiweRails.resources.nil?
+      params
+    end
+  end
+end

data/app/views/siwe_rails/application/index.html.erb

@@ -0,0 +1,63 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>SIWE Rails</title>
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <%= stylesheet_link_tag "siwe_rails/application", media: "all" %>
+    <%= stylesheet_link_tag "siwe_rails/background", media: "all" %>
+
+    <link
+      href="https://api.fontshare.com/css?f[]=satoshi@300,301,400,401,500,501,700,701,900,901,1,2&display=swap"
+      rel="stylesheet"
+    />
+
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/ethers/5.5.2/ethers.umd.min.js"></script>
+    <script src="https://cdn.jsdelivr.net/npm/web3modal@1.9.5/dist/index.min.js"></script>
+    <%= javascript_include_tag "siwe_rails/web3bundle" %>
+    <%= javascript_include_tag "siwe_rails/siwe" %>
+  </head>
+  <body>
+
+    <div class="background bg-no-repeat bg-cover bg-center bg-swe-landing font-satoshi bg-gray flex-grow w-full h-screen items-center flex justify-center flex-wrap flex-col">
+        <div class="w-96 text-center bg-white rounded-20 text-grey flex h-96 flex-col p-12 shadow-lg shadow-white">
+          <%= image_tag("siwe_rails/modal_icon.png", :height => 72, :width => 72, :alt => "Ethereum logo", :class => "self-center mb-8") %>
+          <h5>Welcome</h5>
+          <span class="text-xs">Sign-In with Ethereum to continue to your application</span>
+
+          <button
+              class="h-12 border hover:scale-105 justify-evenly shadow-xl border-white mt-auto duration-100 ease-in-out transition-all transform flex items-center"
+              id="siwe"
+              >
+              <svg
+                  xmlns="http://www.w3.org/2000/svg"
+                  clip-rule="evenodd"
+                  fill-rule="evenodd"
+                  stroke-linejoin="round"
+                  stroke-miterlimit="1.41421"
+                  viewBox="170 30 220 350"
+                  class="w-6 h-8"
+                  >
+                  <g fill-rule="nonzero" transform="matrix(.781253 0 0 .781253 180 37.1453)">
+                  <path d="m127.961 0-2.795 9.5v275.668l2.795 2.79 127.962-75.638z" fill="#343434" /><path
+                                                                                    d="m127.962 0-127.962 212.32 127.962 75.639v-133.801z"
+                                                                                    fill="#8c8c8c"
+                                                                                    />
+                  <path d="m127.961 312.187-1.575 1.92v98.199l1.575 4.601 128.038-180.32z" fill="#3c3c3b" /><path
+                                                                                           d="m127.962 416.905v-104.72l-127.962-75.6z"
+                                                                                           fill="#8c8c8c"
+                                                                                           />
+                  <path d="m127.961 287.958 127.96-75.637-127.96-58.162z" fill="#141414" /><path
+                                                                          d="m.001 212.321 127.96 75.637v-133.799z"
+                                                                          fill="#393939"
+                                                                          />
+                  </g>
+              </svg>
+            <p class="font-bold">Sign-In with Ethereum</p>
+          </button>
+        </div>
+    </div>
+
+  </body>
+</html>

data/config/routes.rb

@@ -0,0 +1,6 @@
+SiweRails::Engine.routes.draw do
+  root to: 'application#index'
+
+  post 'message' => 'application#message'
+  post 'signature' => 'application#signature'
+end

data/lib/siwe_rails/engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module SiweRails
+  class Engine < ::Rails::Engine
+    isolate_namespace SiweRails
+  end
+end

data/lib/siwe_rails/version.rb

@@ -0,0 +1,3 @@
+module SiweRails
+  VERSION = '0.1.0'
+end

data/lib/siwe_rails.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+require 'siwe_rails/version'
+require 'siwe_rails/engine'
+
+module SiweRails
+  # Session address key
+  def self.SIWE_ADDRESS
+    'siwe/address'
+  end
+
+  # Session address key
+  def self.SIWE_ENS
+    'siwe/ens'
+  end
+
+  # Prefix to use when mounting the routes
+  def self.prefix
+    if Rails.configuration.x.siwe.prefix.nil?
+      'siwe'
+    else
+      Rails.configuration.x.siwe.prefix
+    end
+  end
+
+  # Message statement
+  def self.statement
+    if Rails.configuration.x.siwe.statement.nil?
+      'SIWE'
+    else
+      Rails.configuration.x.siwe.statement
+    end
+  end
+
+  # Message expiration time in milliseconds, 7 days by default
+  def self.expiration_time
+    if Rails.configuration.x.siwe.expiration_time.nil?
+      7 * 24 * 60 * 60 * 1000
+    else
+      Rails.configuration.x.siwe.expiration_time
+    end
+  end
+
+  # Message minimum datetime validity
+  def self.not_before
+    if Rails.configuration.x.siwe.not_before.nil?
+      Time.now.utc.iso8601
+    else
+      Rails.configuration.x.siwe.not_before
+    end
+  end
+
+  # Whether to add a request id
+  def self.request_id
+    if Rails.configuration.x.siwe.request_id.nil?
+      false
+    else
+      Rails.configuration.x.siwe.request_id
+    end
+  end
+
+  # Resources
+  def self.resources
+    if Rails.configuration.x.siwe.resources.nil?
+      nil
+    else
+      Rails.configuration.x.siwe.resources
+    end
+  end
+
+  # Redirect URL to receive user information on success
+  def self.redirect_uri
+    if Rails.configuration.x.siwe.redirect_uri.nil?
+      '/'
+    else
+      Rails.configuration.x.siwe.redirect_uri
+    end
+  end
+
+  # Network to use with sign in
+  def self.network
+    if Rails.configuration.x.siwe.network.nil?
+      'mainnet'
+    else
+      Rails.configuration.x.siwe.network
+    end
+  end
+
+  # Infura Key
+  def self.infura
+    if Rails.configuration.x.siwe.infura.nil?
+      ''
+    else
+      Rails.configuration.x.siwe.infura
+    end
+  end
+
+  # Portis ID
+  def self.portis
+    if Rails.configuration.x.siwe.portis.nil?
+      ''
+    else
+      Rails.configuration.x.siwe.portis
+    end
+  end
+
+  # Fortmatic Key
+  def self.fortmatic
+    if Rails.configuration.x.siwe.fortmatic.nil?
+      ''
+    else
+      Rails.configuration.x.siwe.fortmatic
+    end
+  end
+
+  # Whether to enable Torus wallet
+  def self.torus
+    if Rails.configuration.x.siwe.torus.nil?
+      false
+    else
+      Rails.configuration.x.siwe.torus
+    end
+  end
+
+  # Whether to enable Coinbase wallet
+  def self.coinbase
+    if Rails.configuration.x.siwe.coinbase.nil?
+      false
+    else
+      Rails.configuration.x.siwe.coinbase
+    end
+  end
+
+  def self.setup
+    yield self
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: siwe_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Spruce Systems, Inc.
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.1
+- !ruby/object:Gem::Dependency
+  name: sass-rails
+  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: siwe
+  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: Custom Rails Engine to server local pages for SIWE
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/assets/config/siwe_rails_manifest.js
+- app/assets/images/siwe_rails/coinbase.svg
+- app/assets/images/siwe_rails/modal_icon.png
+- app/assets/images/siwe_rails/swe-landing.svg
+- app/assets/javascripts/siwe_rails/siwe.js.erb
+- app/assets/javascripts/siwe_rails/web3bundle.js
+- app/assets/stylesheets/siwe_rails/application.css
+- app/assets/stylesheets/siwe_rails/background.scss
+- app/controllers/siwe_rails/application_controller.rb
+- app/views/siwe_rails/application/index.html.erb
+- config/routes.rb
+- lib/siwe_rails.rb
+- lib/siwe_rails/engine.rb
+- lib/siwe_rails/version.rb
+homepage: https://github.com/spruceid/siwe-rails-engine
+licenses:
+- MIT
+- Apache-2.0
+metadata: {}
+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.22
+signing_key:
+specification_version: 4
+summary: Custom Rails Engine to server local pages for SIWE
+test_files: []