redirect_safely 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b4a20e0d74c1fde24f68ea6e94cd81e004ab8592a4fbcc54c01e1ffcf2e6c19b
+  data.tar.gz: 32ad7b69b7ee644e469cd71e0dde434b20dca8582bbb7d0852106172b8a08219
+SHA512:
+  metadata.gz: ea6447a88e462c0d1f952c2e12ebacedc9981e31115277ef866ab903120dfa93df67da57a27abcfd7530475cf501d7025267bb5f9ce66ddb3ed874c4e92ea9ac
+  data.tar.gz: 663634436f759243ca42b1fe197bb9d2afbbc1c817771227a7fe527d11aabcefc4cf08dda2174455a036efe0c671031264407f78eacce04e7fcfaf0200402942

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at opensource@shopify.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/CONTRIBUTION.md

@@ -0,0 +1,22 @@
+# How to Contribute
+## Things we will merge
+- Bug fixes
+- Performance improvements
+- Features which are likely to be useful to the majority of users
+
+## Things we won't merge
+- Code which adds no significant value to the library
+- Code which comes without tests
+- Code which breaks existing tests
+
+## Workflow
+1. Fork it ( https://github.com/shopify/buildkit/fork )
+2. Create your feature branch (git checkout -b my-new-feature)
+3. Commit your changes (git commit -am 'Add some feature')
+4. Push to the branch (git push origin my-new-feature)
+5. Create a new Pull Request
+
+Please keep the following in mind:
+
+Add a short entry to the "unreleased" section in [RedirectSafely](./RedirectSafely) describing your changes.
+Do not change RedirectSafely::VERSION; this is done as part of the release process.

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in redirect_safely.gemspec
+gemspec
+
+gem 'pry-byebug'
+gem 'rubocop'
+gem 'rake'

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    redirect_safely (1.0.0)
+      activemodel
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.22.5)
+      activesupport (= 3.2.22.5)
+      builder (~> 3.0.0)
+    activesupport (3.2.22.5)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    ast (2.4.0)
+    builder (3.0.4)
+    byebug (11.1.1)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.6)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    method_source (0.9.2)
+    multi_json (1.14.1)
+    parallel (1.19.1)
+    parser (2.7.1.1)
+      ast (~> 2.4.0)
+    power_assert (1.1.6)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.8.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rexml (3.2.4)
+    rubocop (0.82.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    ruby-progressbar (1.10.1)
+    test-unit (3.3.5)
+      power_assert
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 3.0)
+  bundler (~> 1.14)
+  pry-byebug
+  rake
+  redirect_safely!
+  rubocop
+  test-unit (~> 3.0)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2020-present, Shopify Inc.
+
+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,72 @@
+# RedirectSafely
+
+Sanitize `return_to`-style URLs, including some edge cases that you probably missed.
+
+`RedirectSafely` is used in production and extracted from Shopify.
+
+## Installation
+
+Add these lines to your application's Gemfile:
+
+```ruby
+gem 'redirect_safely', '~> 1.0'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+- `RedirectSafely.safe?(url, options)`
+
+  Return true if the URL is considered "safe", false otherwise.
+
+  ### Parameters:
+    - `url` String (required) - The URL to test
+
+  ### Options:
+    - `path_match` Regexp (optional) - Match the path portion of the URL against a regexp
+    - `require_absolute` Boolean (optional) - If true, require an absolute URL (domain must be included in `whitelist`)
+    - `require_ssl` Boolean (optional) - If true, and an absolute URL is provided, require a URL starting with `https://`
+    - `whitelist` String[] (optional) - Whitelisted domains for checking absolute URLs
+    - `subdomains` String[] (optional) - Whitelisted subdomains for checking absolute URLs. Must start with a leading `.`.
+
+- `RedirectSafely.make_safe(url, default, options)`
+
+  Return `url` if it's safe, otherwise return `default`.
+
+  Shares options with `safe?`, and is roughly equivalent to:
+
+  ```ruby
+  safe_url = RedirectSafely.safe?(url) ? url : default
+  ```
+
+- `RedirectSafelyValidator`
+
+  If you persist a redirect URL on a model, you can validate that it is `safe?`:
+
+  ```ruby
+  class Request
+    validates :return_to, redirect_safely: true
+  end
+  ```
+
+  You can pass any options supported by `safe?` (but *not* those added by `make_safe`). In the event that you need more
+  control over the options (ie, dynamically producting a whitelist based on other model attributes), write a custom
+  `validate` method:
+
+  ```ruby
+  class Request
+    validates :store_url, presence: true
+    validate :return_to, presence: true
+
+    validate :return_to_is_safe
+
+    private
+
+    def return_to_is_safe
+      errors.add(:return_to, :invalid) unless RedirectSafely.safe?(return_to, whitelist: URI.parse(store_uri).host)
+    end
+  end
+  ```

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "redirect_safely"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/redirect_safely.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+require "version"
+require "redirect_safely_validator"
+
+module RedirectSafely
+  extend self
+
+  def make_safe(uri, default, options = {})
+    if uri.present? && safe?(uri, options)
+      uri
+    else
+      default
+    end
+  end
+
+  def safe?(uri_string, options = {})
+    return false if uri_string =~ %r{///}
+
+    uri = URI.parse(uri_string.to_s)
+
+    if uri.path
+      return false unless uri.path.start_with?('/')
+      return false if uri.path =~ %r{[/\\][/\\]}
+    end
+    return false unless uri.scheme.nil? || ['http', 'https'].include?(uri.scheme)
+    return false unless uri.userinfo.nil?
+    return false if options[:path_match] &&
+    (uri.path !~ options[:path_match] || File.absolute_path(uri.path) !~ options[:path_match])
+    return false if options[:require_absolute] && uri.host.nil?
+    return false if options[:require_ssl] && uri.scheme && uri.scheme != 'https'
+    return false unless valid_host?(uri.host, options[:whitelist], options[:subdomains])
+
+    true
+  rescue URI::InvalidURIError
+    false
+  end
+
+  private
+
+  def valid_host?(host, whitelist, subdomains)
+    raise ArgumentError, "subdomains must start with ." if subdomains && !subdomains.all? { |s| s.start_with?('.') }
+
+    return true if host.nil?
+    return true if whitelist&.include?(host)
+    return true if subdomains && host.end_with?(*subdomains)
+
+    false
+  end
+end

data/lib/redirect_safely_validator.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+require 'active_model/validations'
+
+class RedirectSafelyValidator < ::ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    record.errors.add(attribute, options[:message] || :invalid) unless RedirectSafely.safe?(value, options)
+  end
+end

data/lib/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module RedirectSafely
+  VERSION = "1.0.0"
+end

data/redirect_safely.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+#
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require './lib/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'redirect_safely'
+  spec.version       = RedirectSafely::VERSION
+  spec.authors       = ['Shopify']
+  spec.email         = ['gems@shopify.com']
+
+  spec.summary       = %q{Sanitize redirect_to URLs}
+  spec.description   = %q{Sanitize redirect_to URLs}
+  spec.homepage      = 'https://github.com/shopify/redirect_safely'
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["source_code_uri"] = "https://github.com/shopify/redirect_safely"
+  spec.metadata["changelog_uri"] = "https://github.com/shopify/redirect_safely/blob/master/CHANGELOG.md"
+  spec.metadata['allowed_push_host'] = "https://rubygems.org"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activemodel'
+
+  spec.add_development_dependency 'activesupport', '~>3.0'
+  spec.add_development_dependency 'test-unit', '~>3.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: redirect_safely
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Shopify
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Sanitize redirect_to URLs
+email:
+- gems@shopify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTION.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/redirect_safely.rb
+- lib/redirect_safely_validator.rb
+- lib/version.rb
+- redirect_safely.gemspec
+homepage: https://github.com/shopify/redirect_safely
+licenses: []
+metadata:
+  source_code_uri: https://github.com/shopify/redirect_safely
+  changelog_uri: https://github.com/shopify/redirect_safely/blob/master/CHANGELOG.md
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Sanitize redirect_to URLs
+test_files: []