safe_uri 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5020c28e3147e307c5f5c0f4724b51fa1c73dbff05f2fe7088b18cca51f850bd
+  data.tar.gz: 500fdcb4d323fb6c82186e6a56ef61af894aa1d63777638a35db876f53e042c1
+SHA512:
+  metadata.gz: 5720d70c0fd94b8b855deea5c355fb91b21f0711b5c2acb6937336edc904ca97d154806313633a5c27d491f13411c401c9486650f54318c2f43d19e75f36ff93
+  data.tar.gz: b63699cf84fb5b6f2ec74d560a7d4e730552b519346c733725d73336153732c70e51a9f2b55160ef9be0a2a26da82a6cca271a57f55e3aad3e490ebd628a7469

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,13 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+before_install:
+  - gem update --system
+  - gem install bundler -v 2.0.1
+
+rvm:
+  - 2.3.0
+  - 2.4.0
+  - 2.5.0
+  - 2.6.0

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in safe_uri.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    safe_uri (0.1.0)
+      addressable
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    diff-lcs (1.3)
+    public_suffix (3.0.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  safe_uri!
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Koji Onishi
+
+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,39 @@
+# SafeURI
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/safe_uri`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'safe_uri'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install safe_uri
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/safe_uri.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "safe_uri"
+
+# 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/safe_uri/exceptions.rb

@@ -0,0 +1,4 @@
+module SafeURI
+  class SafeURIERROR < StandardError; end
+  class UnsupportedScheme < SafeURIERROR; end
+end

data/lib/safe_uri/open-uri.rb

@@ -0,0 +1,31 @@
+module SafeURI
+  # Kernel.open、URI.open is vulnerable to command injection if pipe charactor '|' is given as input.
+  # https://docs.ruby-lang.org/en/2.6.0/Kernel.html#method-c-open
+	# https://docs.rubocop.org/en/latest/cops_security/#securityopen
+  # This occurs as open-uri delegates its #open method to Kernel#open, while overriding Kernel#open.
+  # #open below provides safer alternative to URI.open equivalent.
+  # raises exception when pipe charactor is specified (usually Errno::ENOENT)
+  def self.open(url, *args, **options)
+
+    parsed_url = parse_url(url)
+    if parsed_url.scheme
+      if parsed_url.respond_to?(:open)
+        parse_url(url).open(*args, **options)
+      else
+        raise UnsupportedScheme.new, "scheme #{parsed_url.scheme} is not supported by open-uri"
+      end
+    else
+      # avoid falling back to Kernel.open
+      File.open(url, *args, **options)
+    end
+  end
+
+  def self.parse_url(url)
+    # To percent-encode multi-byte charactors (that might be included as part of given url)
+    # SafeURI relies on Addressable::URI#normalize that can handle proper encoding
+    # while avoiding double-encoding when percent-encoded charactors already exists.
+    normalized_url = Addressable::URI.parse(url).normalize.to_s
+    URI.parse(normalized_url)
+  end
+end
+

data/lib/safe_uri/version.rb

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

data/lib/safe_uri.rb

@@ -0,0 +1,9 @@
+require 'open-uri'
+require 'addressable/uri'
+
+require 'safe_uri/version'
+require 'safe_uri/exceptions'
+require 'safe_uri/open-uri'
+
+module SafeURI
+end

data/safe_uri.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "safe_uri/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "safe_uri"
+  spec.version       = SafeURI::VERSION
+  spec.authors       = ["Koji Onishi"]
+  spec.email         = ["fursich0@gmail.com"]
+  spec.required_ruby_version = '>= 2.3.0'
+
+  spec.summary       = %q{a simple, safe alternative for URI.#open and Kernel.#open. With SafeURI.open you are not affected by pipe character injection that potentailly leads to various vulnerabilities.}
+  spec.description   = %q{SafeURI is an alternative implementation that allows you to open an URI with safer approach - with SafeURI.#open, you can always force to use URI.parse(url).open, or File.open(filename) depending on the provided argument. The pipe character '|' is NOT accepted as it does not delegate to Kernel.#open (falls back to File.#open), unlike URI.#open that falls back to Kernel.#open when un-openable arguments are given.}
+  spec.homepage      = 'https://github.com/fursich/safe_uri'
+  spec.license       = "MIT"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_runtime_dependency "addressable"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: safe_uri
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Koji Onishi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+description: SafeURI is an alternative implementation that allows you to open an URI
+  with safer approach - with SafeURI.#open, you can always force to use URI.parse(url).open,
+  or File.open(filename) depending on the provided argument. The pipe character '|'
+  is NOT accepted as it does not delegate to Kernel.#open (falls back to File.#open),
+  unlike URI.#open that falls back to Kernel.#open when un-openable arguments are
+  given.
+email:
+- fursich0@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/safe_uri.rb
+- lib/safe_uri/exceptions.rb
+- lib/safe_uri/open-uri.rb
+- lib/safe_uri/version.rb
+- safe_uri.gemspec
+homepage: https://github.com/fursich/safe_uri
+licenses:
+- MIT
+metadata: {}
+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.1
+signing_key: 
+specification_version: 4
+summary: a simple, safe alternative for URI.#open and Kernel.#open. With SafeURI.open
+  you are not affected by pipe character injection that potentailly leads to various
+  vulnerabilities.
+test_files: []