shopify_app 7.2.0 → 17.1.0

data/Rakefile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 

data/SECURITY.md

@@ -0,0 +1,59 @@
+# Security Policy
+
+## Supported versions
+
+### New features
+
+New features will only be added to the master branch and will not be made available in point releases.
+
+### Bug fixes
+
+Only the latest release series will receive bug fixes. When enough bugs are fixed and its deemed worthy to release a new gem, this is the branch it happens from.
+
+### Security issues
+
+Only the latest release series will receive patches and new versions in case of a security issue.
+
+### Severe security issues
+
+For severe security issues we will provide new versions as above, and also the last major release series will receive patches and new versions. The classification of the security issue is judged by the core team.
+
+### Unsupported Release Series
+
+When a release series is no longer supported, it's your own responsibility to deal with bugs and security issues. If you are not comfortable maintaining your own versions, you should upgrade to a supported version.
+
+## Reporting a bug
+
+All security bugs in shopify repositories should be reported to [our hackerone program](https://hackerone.com/shopify)
+Shopify's whitehat program is our way to reward security researchers for finding serious security vulnerabilities in the In Scope properties listed at the bottom of this page, including our core application (all functionality associated with a Shopify store, particularly your-store.myshopify.com/admin) and certain ancillary applications.
+
+## Disclosure Policy
+
+We look forward to working with all security researchers and strive to be respectful, always assume the best and treat others as peers. We expect the same in return from all participants. To achieve this, our team strives to:
+
+- Reply to all reports within one business day and triage within two business days (if applicable)
+- Be as transparent as possible, answering all inquires about our report decisions and adding hackers to duplicate HackerOne reports
+- Award bounties within a week of resolution (excluding extenuating circumstances)
+- Only close reports as N/A when the issue reported is included in Known Issues, Ineligible Vulnerabilities Types or lacks evidence of a vulnerability
+
+**The following rules must be followed in order for any rewards to be paid:**
+
+- You may only test against shops you have created which include your HackerOne YOURHANDLE @ wearehackerone.com registered email address.
+- You must not attempt to gain access to, or interact with, any shops other than those created by you.
+- The use of commercial scanners is prohibited (e.g., Nessus).
+- Rules for reporting must be followed.
+- Do not disclose any issues publicly before they have been resolved.
+- Shopify reserves the right to modify the rules for this program or deem any submissions invalid at any time. Shopify may cancel the whitehat program without notice at any time.
+- Contacting Shopify Support over chat, email or phone about your HackerOne report is not allowed. We may disqualify you from receiving a reward, or from participating in the program altogether.
+- You are not an employee of Shopify; employees should report bugs to the internal bug bounty program.
+- You hereby represent, warrant and covenant that any content you submit to Shopify is an original work of authorship and that you are legally entitled to grant the rights and privileges conveyed by these terms. You further represent, warrant and covenant that the consent of no other person or entity is or will be necessary for Shopify to use the submitted content.
+- By submitting content to Shopify, you irrevocably waive all moral rights which you may have in the content.
+- All content submitted by you to Shopify under this program is licensed under the MIT License.
+- You must report any discovered vulnerability to Shopify as soon as you have validated the vulnerability.
+- Failure to follow any of the foregoing rules will disqualify you from participating in this program.
+
+** Please see our [Hackerone Profile](https://hackerone.com/shopify) for full details
+
+## Receiving Security Updates
+
+To recieve all general updates to vulnerabilities, please subscribe to our hackerone [Hacktivity](https://hackerone.com/shopify/hacktivity)

data/app/assets/images/storage_access.svg

@@ -0,0 +1 @@
+<svg width="140" height="140" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="M79 55a9 9 0 00-18 0v8h18v-8zm6 8v-8a15 15 0 00-30 0v8h-5a2 2 0 00-2 2v20a15 15 0 0015 15h14a15 15 0 0015-15V65a2 2 0 00-2-2h-5zM70 90a3 3 0 01-3-3V75a3 3 0 116 0v12a3 3 0 01-3 3z" fill="#8C9196"/></svg>

data/app/assets/javascripts/shopify_app/enable_cookies.js

@@ -0,0 +1,3 @@
+//= require ./itp_helper.js
+//= require ./storage_access.js
+//= require ./partition_cookies.js

data/app/assets/javascripts/shopify_app/itp_helper.js

@@ -0,0 +1,40 @@
+(function() {
+  function ITPHelper(opts) {
+    this.itpContent = document.getElementById('TopLevelInteractionContent');
+    this.itpAction = document.getElementById('TopLevelInteractionButton');
+    this.redirectUrl = opts.redirectUrl;
+  }
+
+  ITPHelper.prototype.redirect = function() {
+    sessionStorage.setItem('shopify.top_level_interaction', true);
+    window.location.href = this.redirectUrl;
+  }
+
+  ITPHelper.prototype.userAgentIsAffected = function() {
+    return Boolean(document.hasStorageAccess);
+  }
+
+  ITPHelper.prototype.canPartitionCookies = function() {
+    var versionRegEx = /Version\/12\.0\.?\d? Safari/;
+    return versionRegEx.test(navigator.userAgent);
+  }
+
+  ITPHelper.prototype.setUpContent = function(onClick) {
+    this.itpContent.style.display = 'block';
+    this.itpAction.addEventListener('click', this.redirect.bind(this));
+  }
+
+  ITPHelper.prototype.execute = function() {
+    if (!this.itpContent) {
+      return;
+    }
+
+    if (this.userAgentIsAffected()) {
+      this.setUpContent();
+    } else {
+      this.redirect();
+    }
+  }
+
+  this.ITPHelper = ITPHelper;
+})(window);

data/app/assets/javascripts/shopify_app/partition_cookies.js

@@ -0,0 +1,8 @@
+(function() {
+  document.addEventListener("DOMContentLoaded", function() {
+    var redirectTargetElement = document.getElementById("redirection-target");
+    var targetInfo = JSON.parse(redirectTargetElement.dataset.target)
+    var storageAccessHelper = new StorageAccessHelper(targetInfo);
+    storageAccessHelper.execute();
+  });
+})();

data/app/assets/javascripts/shopify_app/redirect.js

@@ -0,0 +1,33 @@
+(function() {
+  function redirect() {
+    var redirectTargetElement = document.getElementById("redirection-target");
+
+    if (!redirectTargetElement) {
+      return;
+    }
+
+    var targetInfo = JSON.parse(redirectTargetElement.dataset.target)
+
+    if (window.top == window.self) {
+      // If the current window is the 'parent', change the URL by setting location.href
+      window.top.location.href = targetInfo.url;
+    } else {
+      // If the current window is the 'child', change the parent's URL with postMessage
+      normalizedLink = document.createElement('a');
+      normalizedLink.href = targetInfo.url;
+
+      data = JSON.stringify({
+        message: 'Shopify.API.remoteRedirect',
+        data: {location: normalizedLink.href}
+      });
+      window.parent.postMessage(data, targetInfo.myshopifyUrl);
+    }
+  }
+
+  document.addEventListener("DOMContentLoaded", redirect);
+
+  // In the turbolinks context, neither DOMContentLoaded nor turbolinks:load
+  // consistently fires. This ensures that we at least attempt to fire in the
+  // turbolinks situation as well.
+  redirect();
+})();

data/app/assets/javascripts/shopify_app/request_storage_access.js

@@ -0,0 +1,3 @@
+//= require ./itp_helper.js
+//= require ./storage_access.js
+//= require ./storage_access_redirect.js

data/app/assets/javascripts/shopify_app/storage_access.js

@@ -0,0 +1,154 @@
+(function() {
+  var ACCESS_GRANTED_STATUS = 'storage_access_granted';
+  var ACCESS_DENIED_STATUS = 'storage_access_denied';
+
+  function StorageAccessHelper(redirectData) {
+    this.redirectData = redirectData;
+  }
+
+  StorageAccessHelper.prototype.setNormalizedLink = function(storageAccessStatus) {
+    return storageAccessStatus === ACCESS_GRANTED_STATUS ? this.redirectData.hasStorageAccessUrl : this.redirectData.doesNotHaveStorageAccessUrl;
+  }
+
+  StorageAccessHelper.prototype.redirectToAppTLD = function(storageAccessStatus) {
+    var normalizedLink = document.createElement('a');
+
+    normalizedLink.href = this.setNormalizedLink(storageAccessStatus);
+
+    data = JSON.stringify({
+      message: 'Shopify.API.remoteRedirect',
+      data: {
+        location: normalizedLink.href,
+      }
+    });
+    window.parent.postMessage(data, this.redirectData.myshopifyUrl);
+  }
+
+  StorageAccessHelper.prototype.redirectToAppsIndex = function() {
+    window.parent.location.href = this.redirectData.myshopifyUrl + '/admin/apps';
+  }
+
+  StorageAccessHelper.prototype.redirectToAppTargetUrl = function() {
+    window.location.href = this.redirectData.appTargetUrl;
+  }
+
+  StorageAccessHelper.prototype.sameSiteNoneIncompatible = function(ua) {
+    return ua.includes("iPhone OS 12_") || ua.includes("iPad; CPU OS 12_") || //iOS 12
+    (ua.includes("UCBrowser/")
+        ? this.isOlderUcBrowser(ua) //UC Browser < 12.13.2
+        : (ua.includes("Chrome/5") || ua.includes("Chrome/6"))) ||
+    ua.includes("Chromium/5") || ua.includes("Chromium/6") ||
+    (ua.includes(" OS X 10_14_") &&
+        ((ua.includes("Version/") && ua.includes("Safari")) || //Safari on MacOS 10.14
+        ua.endsWith("(KHTML, like Gecko)"))); //Web view on MacOS 10.14
+  }
+
+  StorageAccessHelper.prototype.isOlderUcBrowser = function(ua) {
+    var match = ua.match(/UCBrowser\/(\d+)\.(\d+)\.(\d+)\./);
+    if (!match) return false;
+    var major = parseInt(match[1]);
+    var minor = parseInt(match[2]);
+    var build = parseInt(match[3]);
+    if (major != 12) return major < 12;
+    if (minor != 13) return minor < 13;
+    return build < 2;
+  }
+
+  StorageAccessHelper.prototype.setCookie = function(value) {
+    if(!this.sameSiteNoneIncompatible(navigator.userAgent)) {
+      value += '; secure; SameSite=None'
+    }
+    document.cookie = value;
+  }
+
+  StorageAccessHelper.prototype.grantedStorageAccess = function() {
+    try {
+      sessionStorage.setItem('shopify.granted_storage_access', true);
+      this.setCookie('shopify.granted_storage_access=true');
+      if (!document.cookie) {
+        throw 'Cannot set third-party cookie.'
+      }
+      this.redirectToAppTargetUrl();
+    } catch (error) {
+      console.warn('Third party cookies may be blocked.', error);
+      this.redirectToAppTLD(ACCESS_DENIED_STATUS);
+    }
+  }
+
+  StorageAccessHelper.prototype.handleRequestStorageAccess = function() {
+    return document.requestStorageAccess().then(this.grantedStorageAccess.bind(this), this.redirectToAppsIndex.bind(this, ACCESS_DENIED_STATUS));
+  }
+
+  StorageAccessHelper.prototype.setupRequestStorageAccess = function() {
+    var requestContent = document.getElementById('RequestStorageAccess');
+    var requestButton = document.getElementById('TriggerAllowCookiesPrompt');
+
+    requestButton.addEventListener('click', this.handleRequestStorageAccess.bind(this));
+    requestContent.style.display = 'block';
+  }
+
+  StorageAccessHelper.prototype.handleHasStorageAccess = function() {
+    if (sessionStorage.getItem('shopify.granted_storage_access')) {
+      // If app was classified by ITP and used Storage Access API to acquire access
+      this.redirectToAppTargetUrl();
+    } else {
+      // If app has not been classified by ITP and still has storage access
+      this.redirectToAppTLD(ACCESS_GRANTED_STATUS);
+    }
+  }
+
+  StorageAccessHelper.prototype.handleGetStorageAccess = function() {
+    if (sessionStorage.getItem('shopify.top_level_interaction')) {
+      // If merchant has been redirected to interact with TLD (requirement for prompting request to gain storage access)
+      this.setupRequestStorageAccess();
+    } else {
+      // If merchant has not been redirected to interact with TLD (requirement for prompting request to gain storage access)
+      this.redirectToAppTLD(ACCESS_DENIED_STATUS);
+    }
+  }
+
+  StorageAccessHelper.prototype.manageStorageAccess = function() {
+    return document.hasStorageAccess().then(function(hasAccess) {
+      if (hasAccess) {
+        this.handleHasStorageAccess();
+      } else {
+        this.handleGetStorageAccess();
+      }
+    }.bind(this));
+  }
+
+  StorageAccessHelper.prototype.execute = function() {
+    if (ITPHelper.prototype.canPartitionCookies()) {
+      this.setUpCookiePartitioning();
+      return;
+    }
+
+    if (ITPHelper.prototype.userAgentIsAffected()) {
+      this.manageStorageAccess();
+    } else {
+      this.grantedStorageAccess();
+    }
+  }
+
+  /* ITP 2.0 solution: handles cookie partitioning */
+  StorageAccessHelper.prototype.setUpHelper = function() {
+    var shopifyData = document.body.dataset;
+    return new ITPHelper({redirectUrl: shopifyData.shopOrigin + "/admin/apps/" + shopifyData.apiKey + shopifyData.returnTo});
+  }
+
+  StorageAccessHelper.prototype.setCookieAndRedirect = function() {
+    this.setCookie('shopify.cookies_persist=true');
+    var helper = this.setUpHelper();
+    helper.redirect();
+  }
+
+  StorageAccessHelper.prototype.setUpCookiePartitioning = function() {
+    var itpContent = document.getElementById('CookiePartitionPrompt');
+    itpContent.style.display = 'block';
+
+    var button = document.getElementById('AcceptCookies');
+    button.addEventListener('click', this.setCookieAndRedirect.bind(this));
+  }
+
+  this.StorageAccessHelper = StorageAccessHelper;
+})(window);

data/app/assets/javascripts/shopify_app/storage_access_redirect.js

@@ -0,0 +1,17 @@
+(function() {
+  function redirect() {
+    var redirectTargetElement = document.getElementById("redirection-target");
+
+    var targetInfo = JSON.parse(redirectTargetElement.dataset.target)
+
+    if (window.top == window.self) {
+      // If the current window is the 'parent', change the URL by setting location.href
+      window.top.location.href = targetInfo.hasStorageAccessUrl;
+    } else {
+        var storageAccessHelper = new StorageAccessHelper(targetInfo);
+        storageAccessHelper.execute();
+    }
+  }
+
+  document.addEventListener("DOMContentLoaded", redirect);
+})();

data/app/assets/javascripts/shopify_app/top_level.js

@@ -0,0 +1,2 @@
+//= require ./itp_helper.js
+//= require ./top_level_interaction.js

data/app/assets/javascripts/shopify_app/top_level_interaction.js

@@ -0,0 +1,11 @@
+(function() {
+  function setUpTopLevelInteraction() {
+    var TopLevelInteraction = new ITPHelper({
+      redirectUrl: document.body.dataset.redirectUrl,
+    });
+
+    TopLevelInteraction.execute();
+  }
+
+  document.addEventListener("DOMContentLoaded", setUpTopLevelInteraction);
+})();

data/app/controllers/concerns/shopify_app/authenticated.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ShopifyApp
+  module Authenticated
+    extend ActiveSupport::Concern
+
+    included do
+      include ShopifyApp::Localization
+      include ShopifyApp::LoginProtection
+      include ShopifyApp::CsrfProtection
+      include ShopifyApp::EmbeddedApp
+      before_action :login_again_if_different_user_or_shop
+      around_action :activate_shopify_session
+    end
+  end
+end

data/app/controllers/concerns/shopify_app/ensure_authenticated_links.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ShopifyApp
+  module EnsureAuthenticatedLinks
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :redirect_to_splash_page, if: :missing_expected_jwt?
+    end
+
+    private
+
+    def redirect_to_splash_page
+      splash_page_path = root_path(return_to: request.fullpath, shop: current_shopify_domain)
+      redirect_to(splash_page_path)
+    rescue ShopifyApp::LoginProtection::ShopifyDomainNotFound => error
+      Rails.logger.warn("[ShopifyApp::EnsureAuthenticatedLinks] Redirecting to login: [#{error.class}] "\
+                         "Could not determine current shop domain")
+      redirect_to(ShopifyApp.configuration.login_url)
+    end
+
+    def missing_expected_jwt?
+      jwt_shopify_domain.blank?
+    end
+  end
+end

data/app/controllers/concerns/shopify_app/require_known_shop.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module ShopifyApp
+  module RequireKnownShop
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :check_shop_domain
+      before_action :check_shop_known
+    end
+
+    def current_shopify_domain
+      return if params[:shop].blank?
+      @shopify_domain ||= ShopifyApp::Utils.sanitize_shop_domain(params[:shop])
+    end
+
+    private
+
+    def check_shop_domain
+      redirect_to(ShopifyApp.configuration.login_url) unless current_shopify_domain
+    end
+
+    def check_shop_known
+      @shop = SessionRepository.retrieve_shop_session_by_shopify_domain(current_shopify_domain)
+      redirect_to(shop_login) unless @shop
+    end
+
+    def shop_login
+      url = URI(ShopifyApp.configuration.login_url)
+
+      url.query = URI.encode_www_form(
+        shop: params[:shop],
+        return_to: request.fullpath,
+      )
+
+      url.to_s
+    end
+  end
+end

data/app/controllers/concerns/shopify_app/shop_access_scopes_verification.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module ShopifyApp
+  module ShopAccessScopesVerification
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :login_on_scope_changes
+    end
+
+    protected
+
+    def login_on_scope_changes
+      redirect_to(shop_login) if scopes_mismatch?
+    end
+
+    private
+
+    def scopes_mismatch?
+      ShopifyApp.configuration.shop_access_scopes_strategy.update_access_scopes?(current_shopify_domain)
+    end
+
+    def current_shopify_domain
+      return if params[:shop].blank?
+      ShopifyApp::Utils.sanitize_shop_domain(params[:shop])
+    end
+
+    def shop_login
+      ShopifyApp::Utils.shop_login_url(shop: params[:shop], return_to: request.fullpath)
+    end
+  end
+end

data/app/controllers/shopify_app/authenticated_controller.rb

@@ -1,8 +1,8 @@
+# frozen_string_literal: true
 module ShopifyApp
-  class AuthenticatedController < ApplicationController
-    include ShopifyApp::LoginProtection
-    before_action :login_again_if_different_shop
-    around_action :shopify_session
-    layout ShopifyApp.configuration.embedded_app? ? 'embedded_app' : 'application'
+  class AuthenticatedController < ActionController::Base
+    include ShopifyApp::Authenticated
+
+    protect_from_forgery with: :exception
   end
 end

data/app/controllers/shopify_app/callback_controller.rb

@@ -0,0 +1,196 @@
+# frozen_string_literal: true
+
+module ShopifyApp
+  # Performs login after OAuth completes
+  class CallbackController < ActionController::Base
+    include ShopifyApp::LoginProtection
+
+    def callback
+      return respond_with_error if invalid_request?
+
+      store_access_token_and_build_session
+
+      if start_user_token_flow?
+        return respond_with_user_token_flow
+      end
+
+      perform_post_authenticate_jobs
+
+      respond_successfully
+    end
+
+    private
+
+    def respond_successfully
+      if jwt_request?
+        head(:ok)
+      else
+        redirect_to(return_address)
+      end
+    end
+
+    def respond_with_user_token_flow
+      redirect_to(login_url_with_optional_shop)
+    end
+
+    def store_access_token_and_build_session
+      if native_browser_request?
+        reset_session_options
+      end
+      set_shopify_session
+    end
+
+    def invalid_request?
+      return true unless auth_hash
+
+      jwt_request? && !valid_jwt_auth?
+    end
+
+    def native_browser_request?
+      !jwt_request?
+    end
+
+    def perform_post_authenticate_jobs
+      install_webhooks
+      install_scripttags
+      perform_after_authenticate_job
+    end
+
+    def respond_with_error
+      if jwt_request?
+        head(:unauthorized)
+      else
+        flash[:error] = I18n.t('could_not_log_in')
+        redirect_to(login_url_with_optional_shop)
+      end
+    end
+
+    # Override user_session_by_cookie from LoginProtection to bypass allow_cookie_authentication
+    # setting check because session cookies are justified at top level
+    def user_session_by_cookie
+      return unless session[:user_id].present?
+      ShopifyApp::SessionRepository.retrieve_user_session(session[:user_id])
+    end
+
+    def start_user_token_flow?
+      if jwt_request?
+        false
+      else
+        return false unless ShopifyApp::SessionRepository.user_storage.present?
+        update_user_access_scopes?
+      end
+    end
+
+    def update_user_access_scopes?
+      return true if user_session.blank?
+      user_access_scopes_strategy.update_access_scopes?(user_id: session[:user_id])
+    end
+
+    def user_access_scopes_strategy
+      ShopifyApp.configuration.user_access_scopes_strategy
+    end
+
+    def jwt_request?
+      jwt_shopify_domain || jwt_shopify_user_id
+    end
+
+    def valid_jwt_auth?
+      auth_hash && jwt_shopify_domain == shop_name && jwt_shopify_user_id == associated_user_id
+    end
+
+    def auth_hash
+      request.env['omniauth.auth']
+    end
+
+    def shop_name
+      auth_hash.uid
+    end
+
+    def offline_access_token
+      ShopifyApp::SessionRepository.retrieve_shop_session_by_shopify_domain(shop_name)&.token
+    end
+
+    def online_access_token
+      ShopifyApp::SessionRepository.retrieve_user_session_by_shopify_user_id(associated_user_id)&.token
+    end
+
+    def associated_user
+      return unless auth_hash.dig('extra', 'associated_user').present?
+
+      auth_hash['extra']['associated_user'].merge('scope' => auth_hash['extra']['associated_user_scope'])
+    end
+
+    def associated_user_id
+      associated_user && associated_user['id']
+    end
+
+    def token
+      auth_hash['credentials']['token']
+    end
+
+    def access_scopes
+      return unless auth_hash['extra']['scope']
+      auth_hash['extra']['scope']
+    end
+
+    def reset_session_options
+      request.session_options[:renew] = true
+      session.delete(:_csrf_token)
+    end
+
+    def set_shopify_session
+      session_store = ShopifyAPI::Session.new(
+        domain: shop_name,
+        token: token,
+        api_version: ShopifyApp.configuration.api_version,
+        access_scopes: access_scopes
+      )
+
+      session[:shopify_user] = associated_user
+      if session[:shopify_user].present?
+        session[:shop_id] = nil if shop_session && shop_session.domain != shop_name
+        session[:user_id] = ShopifyApp::SessionRepository.store_user_session(session_store, associated_user)
+      else
+        session[:shop_id] = ShopifyApp::SessionRepository.store_shop_session(session_store)
+        session[:user_id] = nil if user_session && user_session.domain != shop_name
+      end
+      session[:shopify_domain] = shop_name
+      session[:user_session] = auth_hash&.extra&.session
+    end
+
+    def install_webhooks
+      return unless ShopifyApp.configuration.has_webhooks?
+
+      WebhooksManager.queue(
+        shop_name,
+        offline_access_token || online_access_token,
+        ShopifyApp.configuration.webhooks
+      )
+    end
+
+    def install_scripttags
+      return unless ShopifyApp.configuration.has_scripttags?
+
+      ScripttagsManager.queue(
+        shop_name,
+        offline_access_token || online_access_token,
+        ShopifyApp.configuration.scripttags
+      )
+    end
+
+    def perform_after_authenticate_job
+      config = ShopifyApp.configuration.after_authenticate_job
+
+      return unless config && config[:job].present?
+
+      job = config[:job]
+      job = job.constantize if job.is_a?(String)
+
+      if config[:inline] == true
+        job.perform_now(shop_domain: session[:shopify_domain])
+      else
+        job.perform_later(shop_domain: session[:shopify_domain])
+      end
+    end
+  end
+end