paperclip-nginx-upload 0.0.1

data/.gitignore

@@ -0,0 +1,16 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+spec/tmp
+tmp

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - 1.9.3
+
+script: "bundle exec rspec"

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Tim Fischbach
+
+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,125 @@
+# Paperclip Nginx Upload
+
+[![Build Status](https://travis-ci.org/tf/paperclip-nginx-upload.png?branch=master)](https://travis-ci.org/tf/paperclip-nginx-upload)
+
+A Paperclip IOAdapter to handle file upload requests which have been
+rewritten by the
+[nginx upload module](https://github.com/vkholodkov/nginx-upload-module).
+
+The gem evolved out of the discussion in the following paperclip
+issue:
+
+https://github.com/thoughtbot/paperclip/issues/1396
+
+## Motivation
+
+Nginx is must faster when it comes to parsing file uploads from the
+body of HTTP requests.  We do not want to occupy our Rails processes
+with this tasks.  Using the
+[nginx upload module](https://github.com/vkholodkov/nginx-upload-module),
+upload request can be rewritten to contain the path of a temp file
+parsed from the request body before they are passed to our Rails app.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'paperclip-nginx-upload'
+
+## Usage
+
+Configure nginx to parse your upload requests. There is an example
+nginx configuration snippet in `examples/nginx.conf`.
+
+Add an initializer to configure the gem:
+
+```ruby
+ # config/intializers/paperclip_nginx_upload.rb
+ require 'paperclip/nginx/upload'
+
+ Paperclip::Nginx::Upload::IOAdapter.default_options.merge!(
+   # location where nginx places file uploads
+   tmp_file_whitelist: ['/tmp/nginx_uploads/**'],
+   
+   # Change this option to true to move temp files created 
+   # by nginx to the paperclip tmp file location. By default
+   # files are copied.
+   move_tempfile: false
+ )    
+```
+
+The adapter is a drop in replacement. When using strong parameters,
+you only have to make sure the param containing the upload can also be
+a hash of values:
+
+```ruby
+ class User
+   has_attached_file :avatar
+ end
+ 
+ class UsersController < ApplicationController
+   def update
+     @user.update_attributes(user_params)
+   end
+ 
+   def user_params
+     params.require(:user)
+      # in production avatar will be a hash generated by nginx
+      .permit(avatar: [:tmp_path, :original_name, :content_type])
+    
+      # in development we want to permit the uploaded file itself
+      .merge(params.require(:user).permit(:avatar))
+   end
+ end
+```
+
+## Security Considerations
+
+Assume an upload request contains a form field named
+`user[avatar]`. Given the nginx configuration from
+`examples/nginx.conf`, the request is rewritten to contain the
+following three form fields instead:
+
+* `user[avatar][original_name]`
+* `user[avatar][conten_type]`
+* `user[avatar][upload_tmp_path]`
+
+By using this gem, you basically tell your app to accept paths to
+local files in the `upload_tmp_path` param and move them around the
+file system. Nginx ensures that these parameters can not be passed in
+from the outside, preventing an attacker from passing `/etc/passwd` as
+`upload_tmp_path` and having it delivered to him as his own upload
+later on.
+
+Still, if you forget to configure the nginx-upload-module correctly
+for one of your upload end points, this could become a threat. This is
+especially dangerous when not using strong parameters. While, as seen
+above, the nested hash has to be permitted explicitly, methods
+assigning attachments directly might be open to attacks:
+
+```ruby
+ @user.avatar = params[:avatar]
+```
+
+Therefore the paperclip-nginx-upload adapter only accepts tmp files
+from locations matching an entry in the `tmp_file_whitelist`. That way
+an attacker will only be able to access running uploads of other
+visitors of the site. He still would have to guess the random file
+names chosen by nginx, which seems rather unfeasable.
+
+## Move vs Copy
+
+By default, temp files created by ngninx are copied before passing
+them to Paperclip. This ensures proper file ownership. When your nginx
+runs as the same user as your rails processes, it might be sufficient
+to simply move the file. Depending on your file system, this might be
+a significant performance gain. In that case set `move_tempfile` to
+`true`.
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/examples/nginx.conf

@@ -0,0 +1,23 @@
+location ~ ^/entries/[0-9]+/files$ {
+    upload_pass @app;
+    
+    upload_store /tmp/nginx_uploads 1;
+    upload_store_access user:rw group:rw all:r;
+ 
+    upload_set_form_field $upload_field_name[original_name] "$upload_file_name";
+    upload_set_form_field $upload_field_name[content_type] "$upload_content_type";
+    upload_set_form_field $upload_field_name[tmp_path] "$upload_tmp_path";
+ 
+    upload_pass_form_field "^authenticity_token$|^format$";
+    upload_cleanup 400 404 500-505;
+ 
+    # Catch "Method not allowed" raised for non-POST requests and
+    # delegate to app
+    error_page 405 = @app;
+}
+ 
+location @app {
+    passenger_enabled on;
+ 
+    ...
+}

data/lib/paperclip/nginx/upload.rb

@@ -0,0 +1,9 @@
+require "paperclip/nginx/upload/io_adapter"
+require "paperclip/nginx/upload/version"
+
+module Paperclip
+  module Nginx
+    module Upload
+    end
+  end
+end

data/lib/paperclip/nginx/upload/io_adapter.rb

@@ -0,0 +1,75 @@
+require 'fileutils'
+require 'paperclip'
+
+module Paperclip
+  module Nginx
+    module Upload
+      class TmpPathNotInWhitelistError < StandardError
+        def initialize(tmp_path, whitelist)
+          super("Paperclip nginx upload adapter received non whitelisted tmp file '#{tmp_path}'. " +
+                "Whitelist: #{whitelist.inspect}")
+        end
+      end
+
+      class IOAdapter < Paperclip::AbstractAdapter
+        def initialize(target, options = {})
+          @target = target
+          @options = self.class.default_options.merge(options)
+
+          require_whitelist_match!(@target[:tmp_path])
+          cache_current_values
+        end
+
+        def self.default_options
+          @default_options ||= {
+            :tmp_path_whitelist => [],
+            :move_tempfile => false
+          }
+        end
+
+        private
+
+        def require_whitelist_match!(path)
+          unless matches_whitelist?(File.expand_path(path))
+            raise TmpPathNotInWhitelistError.new(path, tmp_path_whitelist)
+          end
+        end
+
+        def matches_whitelist?(path)
+          tmp_path_whitelist.any? do |glob|
+            File.fnmatch(glob, path)
+          end
+        end
+
+        def tmp_path_whitelist
+          @options[:tmp_path_whitelist]
+        end
+
+        def cache_current_values
+          self.original_filename = @target[:original_name]
+          @content_type = @target[:content_type].to_s.strip
+          @size = File.size(@target[:tmp_path])
+
+          copy_or_move(@target[:tmp_path], destination.path)
+          @tempfile = destination
+
+          # Required to reopen the tempfile that we have overwritten
+          @tempfile.open
+          @tempfile.binmode
+        end
+
+        def copy_or_move(source_path, destination_path)
+          if @options[:move_tempfile]
+            FileUtils.mv(@target[:tmp_path], destination.path)
+          else
+            FileUtils.cp(@target[:tmp_path], destination.path)
+          end
+        end
+      end
+    end
+  end
+end
+
+Paperclip.io_adapters.register Paperclip::Nginx::Upload::IOAdapter do |target|
+  Hash === target && [:original_name, :content_type, :tmp_path].all? { |key| target.key?(key) }
+end

data/lib/paperclip/nginx/upload/version.rb

@@ -0,0 +1,7 @@
+module Paperclip
+  module Nginx
+    module Upload
+      VERSION = '0.0.1'
+    end
+  end
+end

data/paperclip-nginx-upload.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'paperclip/nginx/upload/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "paperclip-nginx-upload"
+  spec.version       = Paperclip::Nginx::Upload::VERSION
+  spec.authors       = ["Tim Fischbach"]
+  spec.email         = ["tfischbach@codevise.de"]
+  spec.summary       = "Paperclip IOAdapter for integration with nginx upload module"
+  spec.homepage      = "https://github.com/tf/paperclip-nignx-upload"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_runtime_dependency "paperclip"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/paperclip/nginx/upload/io_adapter_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+
+describe Paperclip::Nginx::Upload::IOAdapter do
+  context 'for tmp file in whitelist' do
+    let :tempfile do
+      fixture_file('5k.png').binmode
+    end
+
+    subject do
+      nginx_upload_hash = {
+        :original_name => '5k.png',
+        :tmp_path => tempfile.path,
+        :content_type => "image/x-png-by-browser\r"
+      }
+
+      options = {
+        :tmp_path_whitelist => [File.join(PROJECT_ROOT, 'spec', 'tmp', '**')]
+      }
+
+      Paperclip::Nginx::Upload::IOAdapter.new(nginx_upload_hash, options)
+    end
+
+    it 'gets the right filename' do
+      expect(subject.original_filename).to eq('5k.png')
+    end
+
+    it 'gets content type' do
+      expect(subject.content_type).to eq('image/x-png-by-browser')
+    end
+
+    it 'gets the file\'s size' do
+      expect(subject.size).to eq(4456)
+    end
+
+    it 'returns false for a call to nil?' do
+      expect(subject.nil?).to be(false)
+    end
+
+    it 'generates a MD5 hash of the contents' do
+      hash = Digest::MD5.file(tempfile.path).to_s
+      expect(subject.fingerprint).to eq(hash)
+    end
+
+    it 'reads the contents of the file' do
+      content = tempfile.read
+      expect(content.length).to be > 0
+      expect(subject.read).to eq(content)
+    end
+
+    it 'copies the tempfile by default' do
+      subject
+      expect(File.exist?(tempfile.path)).to eq(true)
+    end
+  end
+
+  context 'for tmp file not in whitelist' do
+    let :tempfile do
+      fixture_file('5k.png').binmode
+    end
+
+    it 'raises an exception' do
+      nginx_upload_hash = {
+        :original_name => '5k.png',
+        :tmp_path => tempfile.path,
+        :content_type => "image/x-png-by-browser\r"
+      }
+
+      expect {
+        Paperclip::Nginx::Upload::IOAdapter.new(nginx_upload_hash, :tmp_path_whitelist => [])
+      }.to raise_error(Paperclip::Nginx::Upload::TmpPathNotInWhitelistError)
+    end
+  end
+
+  context 'with move_tempfile option set to true' do
+    let :tempfile do
+      fixture_file('5k.png').binmode
+    end
+
+    it 'moves the tempfile to the new location' do
+      nginx_upload_hash = {
+        :original_name => '5k.png',
+        :tmp_path => tempfile.path,
+        :content_type => "image/x-png-by-browser\r"
+      }
+
+      Paperclip::Nginx::Upload::IOAdapter.new(nginx_upload_hash,
+                                              :tmp_path_whitelist => [File.join(PROJECT_ROOT, 'spec', 'tmp', '**')],
+                                              :move_tempfile => true)
+
+      expect(File.exist?(tempfile.path)).to eq(false)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rspec'
+
+PROJECT_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..')).freeze
+$LOAD_PATH << File.join(PROJECT_ROOT, 'lib')
+
+require 'paperclip/nginx/upload'
+
+Dir[File.join(PROJECT_ROOT, 'spec', 'support', '**', '*.rb')].each { |file| require(file) }

data/spec/support/fixture_file.rb

@@ -0,0 +1,10 @@
+require 'fileutils'
+
+FIXTURE_DIR = File.join(File.dirname(__FILE__), '..', 'fixtures')
+TMP_DIR = File.join(File.dirname(__FILE__), '..', 'tmp')
+
+def fixture_file(filename)
+  FileUtils.mkdir_p(TMP_DIR)
+  FileUtils.cp(File.join(FIXTURE_DIR, filename), File.join(TMP_DIR, filename))
+  File.new(File.join(TMP_DIR, filename))
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: paperclip-nginx-upload
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tim Fischbach
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: paperclip
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- tfischbach@codevise.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/nginx.conf
+- lib/paperclip/nginx/upload.rb
+- lib/paperclip/nginx/upload/io_adapter.rb
+- lib/paperclip/nginx/upload/version.rb
+- paperclip-nginx-upload.gemspec
+- spec/fixtures/5k.png
+- spec/paperclip/nginx/upload/io_adapter_spec.rb
+- spec/spec_helper.rb
+- spec/support/fixture_file.rb
+homepage: https://github.com/tf/paperclip-nignx-upload
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1774978758898476396
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1774978758898476396
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Paperclip IOAdapter for integration with nginx upload module
+test_files:
+- spec/fixtures/5k.png
+- spec/paperclip/nginx/upload/io_adapter_spec.rb
+- spec/spec_helper.rb
+- spec/support/fixture_file.rb