jekyll-filesystem-jail 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7481a349425be49a0e0aded08ea090c07943ee8a
+  data.tar.gz: 1cf55342e19a7e77ac0a7ee0098fe090aa8783d3
+SHA512:
+  metadata.gz: 99b3451809cf2840ed4382d62fb2892820624a70318fa4fde2c1e6173f5c962dcd327b01b2f968c7c815413f7d683b640ac6c4f11f5d6becf16d5b96ffa06f58
+  data.tar.gz: ce3ce74ecb72dc0eba15a38ebc8a0dabdbd208fa9e3ad2e14b63c4deb3d5aed4e151b1a1ae1a51ce03a6918a94b78944aa6615203cfa676e28d7b0b716d2a2d1

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+script : script/cibuild
+rvm:
+- 2.1
+- 2.0
+- 1.9.3
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 GitHub, Inc.
+
+MIT License
+
+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,35 @@
+# Jekyll File System Jail
+
+How Jekyll accesses your file system (safely).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'jekyll-filesystem-adapter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jekyll-filesystem-adapter
+
+## Usage
+
+It's installed with Jekyll by default and accessible via `Jekyll.fs`.
+Any and all plugins utilizing the file system must use Jekyll.fs to
+be considered secure.
+
+## Contributing
+
+1. Fork it ( https://github.com/jekyll/jekyll-filesystem-jail/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
+
+# Credit
+
+Written by Parker Moore (@parkr).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/jekyll-filesystem-jail.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll-filesystem-jail/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-filesystem-jail"
+  spec.version       = Jekyll::FileSystem::Jail::VERSION
+  spec.authors       = ["Parker Moore"]
+  spec.email         = ["parkrmoore@gmail.com"]
+  spec.summary       = %q{How Jekyll accesses your file system (safely).}
+  spec.homepage      = "https://github.com/jekyll/jekyll-filesystem-jail"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "jekyll", "~> 2.0"
+end

data/lib/jekyll-filesystem-jail.rb

@@ -0,0 +1,166 @@
+# encoding: UTF-8
+require "jekyll-filesystem-jail/version"
+require 'fileutils'
+
+module Jekyll
+  module FileSystem
+    class Jail
+
+      class << self
+        def sanitized_path(base_directory, questionable_path)
+          clean_path = File.expand_path(questionable_path, "/")
+          clean_path.gsub!(/\A\w\:\//, '/')
+
+          unless clean_path.start_with?(base_directory)
+            File.join(base_directory, clean_path)
+          else
+            clean_path
+          end
+        end
+      end
+
+      attr_reader :base_dir, :safe, :site
+
+      def initialize(base_directory, options = {})
+        @base_dir = base_directory
+        @safe     = options.fetch(:safe, false)
+        @site     = options.fetch(:site, nil)
+      end
+
+      def safe?
+        @safe || (@site && @site.safe) || false
+      end
+
+      def sanitized_path(*paths)
+        case paths.size
+        when 2
+          self.class.sanitized_path(*paths)
+        when 1
+          self.class.sanitized_path(base_dir, paths.pop)
+        else
+          raise ArgumentError.new("FileSystemAdapter#sanitized_path takes 1 or 2 arguments.")
+        end
+      end
+
+      def realpath(questionable_path)
+        File.realpath(questionable_path)
+      end
+
+      #
+      # Asking Questions
+      #
+
+      def symlink?(path_to_check)
+        File.symlink? path_to_check
+      end
+
+      def file?(path_to_check)
+        File.file? path_to_check
+      end
+
+      def directory?(path_to_check)
+        File.directory? path_to_check
+      end
+
+      def exist?(path_to_check)
+        File.exist? path_to_check
+      end
+
+      def file_allowed?(path_to_check)
+        !safe? || !symlink?(path_to_check)
+      end
+
+      #
+      # Directory Actions
+      #
+
+      def chdir(directory_to_go_to, &block)
+        Dir.chdir(directory_to_go_to, &block)
+      end
+
+      def glob(path_to_glob, flags = nil)
+        full_path = path_to_glob
+        if flags.nil?
+          Dir.glob(full_path)
+        else
+          Dir.glob(full_path, flags)
+        end.sort
+      end
+
+      def dir_entries(directory)
+        chdir(directory) do
+          glob(sanitized_path(directory, '*')).map do |entry|
+            relative_to(directory, entry)
+          end
+        end
+      end
+
+      def full_directory_glob(directory)
+        full_path = directory
+        Dir.glob(File.join(full_path, "**", "*"))
+      end
+
+      def rm_rf(file_or_files)
+        files = Array(file_or_files).map do |path|
+          sanitized_path(path)
+        end.select do |path|
+          exist?(path)
+        end
+        FileUtils.rm_r(files, { :secure => true })
+      end
+
+      def mkdir_p(dir_to_create)
+        directory = dir_to_create
+        FileUtils.mkdir_p(directory) unless exist?(directory)
+      end
+
+      #
+      # File Actions
+      #
+
+      def read(path, options = {})
+        File.open(path, 'rb') do |f|
+          if options[:bytes].nil?
+            f.read
+          else
+            f.read options[:bytes]
+          end
+        end
+      end
+
+      def write(path, content, options = {})
+        File.open(path, 'wb') do |f|
+          f.write(content)
+        end
+      end
+
+      def relative_to(prefix, entry)
+        regexp = Regexp.new("")
+        if prefix.end_with?("/")
+          entry.sub(/\A#{Regexp.escape(prefix)}/, '')
+        else
+          entry.sub(/\A#{Regexp.escape(prefix)}\//, '')
+        end
+      end
+
+      def sanitize_filename(name)
+        name.gsub(/[^\w\s-]+/, '')
+            .gsub(/(^|\b\s)\s+($|\s?\b)/, '\\1\\2')
+            .gsub(/\s+/, '_')
+      end
+
+      def mtime(path)
+        File.mtime path
+      end
+
+      def basename(path, suffix = '')
+        File.basename(path, suffix)
+      end
+
+      def dirname(path)
+        File.dirname(path)
+      end
+
+    end
+  end
+end

data/lib/jekyll-filesystem-jail/version.rb

@@ -0,0 +1,7 @@
+module Jekyll
+  module FileSystem
+    class Jail
+      VERSION = '0.1.0'
+    end
+  end
+end

data/script/bootstrap

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+bundle install

data/script/cibuild

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+bundle exec rspec

data/spec/jekyll_filesystem_adapter_spec.rb

@@ -0,0 +1,231 @@
+require 'spec_helper'
+
+describe(Jekyll::FileSystem::Jail) do
+
+  context "class methods" do
+    let(:base_dir)     { source_dir }
+    let(:outside_file) { "/etc/passwd" }
+    let(:inside_file)  { "resume/index.md" }
+
+    context ".sanitized_path" do
+      it "sanitizes a questionable path outside the base directory correctly" do
+        expect(described_class.sanitized_path(base_dir, outside_file)).to(
+          eql(source_dir('etc', 'passwd'))
+        )
+      end
+
+      it "sanitizes a path inside the base directory correctly" do
+        expect(described_class.sanitized_path(base_dir, inside_file)).to(
+          eql(source_dir('resume', 'index.md'))
+        )
+      end
+    end
+  end
+
+  context "an instance" do
+    let(:source) { source_dir }
+    let(:safe)   { false }
+    let(:site)   { nil }
+    subject do
+      described_class.new(source_dir, { safe: safe, site: site })
+    end
+
+    context "#realpath" do
+      it "reads the destination of symlinks" do
+        expect(subject.realpath(source_dir('symlink.md'))).to eql(source_dir('homepage.md'))
+      end
+
+      it "errors if the file isn't there" do
+        expect(->{ subject.realpath(source_dir('non_existent_file.txt')) }).to raise_error
+      end
+    end
+
+    context "#symlink?" do
+      it "knows that a symlink is a symlink" do
+        expect(subject.symlink?('symlink.md')).to be_truthy
+      end
+
+      it "knows that a regular file is not a symlink" do
+        expect(subject.symlink?('homepage.md')).to be_falsey
+      end
+    end
+
+    context "#file?" do
+      it "knows a file is a file" do
+        expect(subject.file?('homepage.md')).to be_truthy
+      end
+
+      it "knows a directory is not a file" do
+        expect(subject.file?('about')).to be_falsey
+      end
+
+      it "knows a non-existent file is a not a file" do
+        expect(subject.file?('non_existent_file.md')).to be_falsey
+      end
+
+      it "prevents traversal outside base directory" do
+        expect(subject.file?('/etc/hosts')).to be_falsey
+      end
+    end
+
+    context "#directory?" do
+      it "knows a file is not a directory" do
+        expect(subject.directory?('homepage.md')).to be_falsey
+      end
+
+      it "knows a directory is a directory" do
+        expect(subject.directory?('about')).to be_truthy
+      end
+
+      it "knows a non-existent directory is a not a directory" do
+        expect(subject.directory?('i-dont-exist')).to be_falsey
+      end
+
+      it "prevents traversal outside base directory" do
+        expect(subject.directory?('/etc')).to be_falsey
+      end
+    end
+
+    context "#sanitized_path" do
+      it "assumes the base path of the instance" do
+        expect(subject.sanitized_path('homepage.md')).to start_with(source_dir)
+      end
+
+      it "allows you to put through a base path if you want, too" do
+        expect(subject.sanitized_path(tmp_dir, 'homepage.md')).to start_with(tmp_dir)
+      end
+
+      it "errors with more than 2 arguments" do
+        expect(->{ subject.sanitized_path(tmp_dir, 'homepage', 'the thing.md') }).to raise_error
+      end
+    end
+
+    context "#read" do
+      it "reads in an entire existing file" do
+        expect(subject.read(source_dir('homepage.md'))).to eql(<<-FILE
+---
+title: Home Page
+---
+
+Welcome to my homepage!
+FILE
+)
+      end
+
+      it "reads in just some bytes of an existing file" do
+        expect(subject.read(source_dir('homepage.md'), { bytes: 5 })).to eql("---\nt")
+      end
+    end
+
+    context "#exist?" do
+      it "can tell if a file exists on the filesystem" do
+        expect(subject.exist?('homepage.md')).to be_truthy
+      end
+
+      it "can tell if a file doesn't exist" do
+        expect(subject.exist?('index.md')).to be_falsey
+      end
+    end
+
+    context "#glob" do
+      it "grabs the right number of files from a directory" do
+        expect(subject.glob('about/**/*').size).to eql(2)
+      end
+
+      it "grabs the right files" do
+        expect(
+          -> {
+            subject.chdir(source_dir('about')) do
+              subject.glob('about/**/*')
+            end
+          }.call
+        ).to eql(
+          %w(hansel.md index.md)
+        )
+      end
+
+      it "can grab subdirectories" do
+        expect(
+          subject.glob('**/*')
+        ).to eql(
+          %w(about about/hansel.md about/index.md homepage.md symlink.md)
+        )
+      end
+    end
+
+    context "#dir_entries" do
+      it "grabs just the entries in the immediate folder" do
+        expect(subject.dir_entries(source_dir)).to eql(
+          %w(about homepage.md symlink.md)
+        )
+      end
+    end
+
+    context "#rm_rf" do
+      subject do
+        described_class.new(tmp_dir, { safe: safe, site: site })
+      end
+      let(:all_files)       { [tmp_dir('not_exist')] + files_to_create }
+      let(:files_to_create) { [tmp_dir('exit'), tmp_dir('exist')] }
+      before(:each) do
+        FileUtils.touch files_to_create
+      end
+
+      it "deletes only the files that exist" do
+        expect(subject.rm_rf(all_files)).to eql(files_to_create)
+      end
+    end
+
+    context "#mkdir_p" do
+      after(:each) do
+        subject.rm_rf('etc')
+      end
+
+      it "creates a folder" do
+        expect(subject.mkdir_p('/etc/hosts')).to eql([source_dir('etc/hosts')])
+      end
+    end
+
+    context "safe mode turned on" do
+      let(:safe) { true }
+
+      context "#file_allowed?" do
+        it "reports that a symlinked file isn't allowed" do
+          expect(subject.file_allowed?('symlink.md')).to be_falsey
+        end
+
+        it "reports that a normal file is allowed" do
+          expect(subject.file_allowed?('homepage.md')).to be_truthy
+        end
+      end
+
+      context "#safe?" do
+        it "reports safe mode turned on" do
+          expect(subject.safe?).to be_truthy
+        end
+      end
+    end
+
+    context "safe mode turned off" do
+      let(:safe) { false }
+
+      context "#file_allowed?" do
+        it "reports that a symlinked file is allowed" do
+          expect(subject.file_allowed?('symlink.md')).to be_truthy
+        end
+
+        it "reports that a normal file is allowed" do
+          expect(subject.file_allowed?('homepage.md')).to be_truthy
+        end
+      end
+
+      context "#safe" do
+        it "reports safe mode turned off" do
+          expect(subject.safe?).to be_falsey
+        end
+      end
+    end
+
+  end
+
+end

data/spec/source/homepage.md

@@ -0,0 +1,5 @@
+---
+title: Home Page
+---
+
+Welcome to my homepage!

data/spec/source/symlink.md

@@ -0,0 +1,5 @@
+---
+title: Home Page
+---
+
+Welcome to my homepage!

data/spec/spec_helper.rb

@@ -0,0 +1,83 @@
+TEST_DIR    = File.dirname(__FILE__)
+PROJECT_DIR = File.dirname(TEST_DIR)
+TMP_DIR     = File.expand_path('tmp', PROJECT_DIR)
+
+-> {
+  require 'fileutils'
+  FileUtils.mkdir(TMP_DIR) unless File.directory?(TMP_DIR)
+}.call
+
+require File.expand_path('lib/jekyll-filesystem-jail.rb', PROJECT_DIR)
+
+RSpec.configure do |config|
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+
+  def test_dir(*files)
+    File.join(TEST_DIR, *files)
+  end
+
+  def source_dir(*files)
+    test_dir('source', *files)
+  end
+
+  def tmp_dir(*files)
+    File.join(TMP_DIR, *files)
+  end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-filesystem-jail
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Parker Moore
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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'
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  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'
+description: 
+email:
+- parkrmoore@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll-filesystem-jail.gemspec
+- lib/jekyll-filesystem-jail.rb
+- lib/jekyll-filesystem-jail/version.rb
+- script/bootstrap
+- script/cibuild
+- spec/jekyll_filesystem_adapter_spec.rb
+- spec/source/about/hansel.md
+- spec/source/about/index.md
+- spec/source/homepage.md
+- spec/source/symlink.md
+- spec/spec_helper.rb
+homepage: https://github.com/jekyll/jekyll-filesystem-jail
+licenses:
+- MIT
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: How Jekyll accesses your file system (safely).
+test_files:
+- spec/jekyll_filesystem_adapter_spec.rb
+- spec/source/about/hansel.md
+- spec/source/about/index.md
+- spec/source/homepage.md
+- spec/source/symlink.md
+- spec/spec_helper.rb