carrierwave_securefile 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
data/.document ADDED
@@ -0,0 +1,5 @@
1
+ lib/**/*.rb
2
+ bin/*
3
+ -
4
+ features/**/*.feature
5
+ LICENSE.txt
data/Gemfile ADDED
@@ -0,0 +1,16 @@
1
+ source "http://rubygems.org"
2
+ # Add dependencies required to use your gem here.
3
+ # Example:
4
+ # gem "activesupport", ">= 2.3.5"
5
+
6
+ # Add dependencies to develop your gem here.
7
+ # Include everything needed to run rake, tests, features, etc.
8
+ group :development do
9
+ gem "shoulda", ">= 0"
10
+ gem "bundler", "~> 1.0.0"
11
+ gem "jeweler", "~> 1.6.4"
12
+ gem "rcov", ">= 0"
13
+ end
14
+
15
+ gem 'carrierwave', '~> 0.5.8'
16
+ gem 'crypt19', '1.2.1'
data/Gemfile.lock ADDED
@@ -0,0 +1,28 @@
1
+ GEM
2
+ remote: http://rubygems.org/
3
+ specs:
4
+ activesupport (3.1.3)
5
+ multi_json (~> 1.0)
6
+ carrierwave (0.5.8)
7
+ activesupport (~> 3.0)
8
+ crypt19 (1.2.1)
9
+ git (1.2.5)
10
+ jeweler (1.6.4)
11
+ bundler (~> 1.0)
12
+ git (>= 1.2.5)
13
+ rake
14
+ multi_json (1.0.3)
15
+ rake (0.9.2.2)
16
+ rcov (0.9.11)
17
+ shoulda (2.11.3)
18
+
19
+ PLATFORMS
20
+ ruby
21
+
22
+ DEPENDENCIES
23
+ bundler (~> 1.0.0)
24
+ carrierwave (~> 0.5.8)
25
+ crypt19 (= 1.2.1)
26
+ jeweler (~> 1.6.4)
27
+ rcov
28
+ shoulda
data/LICENSE.txt ADDED
@@ -0,0 +1,20 @@
1
+ Copyright (c) 2011 Doug Clark
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,92 @@
1
+ # CarrierWave_SecureFile
2
+
3
+ A gem to add secured file uploading to CarrierWave. Uses the Crypt19 gem to encrypt and decrypt files.
4
+
5
+ Uses blowfish for encryption. Will look into adding other encryption types in the future.
6
+
7
+ Was uploading to RackSpace Cloud Files for testing - haven't tested using local file uploads or other cloud services, but
8
+ it should work fine just the same.
9
+
10
+ ## Requirements
11
+
12
+ Ruby 1.9.3 w/ Rails 3.1.3. Realistically, it should work on Ruby 1.9.x and Rails 3.1.x, but may work on other configurations.
13
+ It hasn't been tested.
14
+
15
+ ## Installation
16
+
17
+ Add the following to your gemfile:
18
+
19
+ ``` ruby
20
+ gem 'carrierwave_securefile'
21
+ ```
22
+
23
+ ...and run the obligatory
24
+
25
+ ```
26
+ bundle
27
+ ```
28
+
29
+ command to install.
30
+
31
+ ## Usage
32
+ ### Initializer
33
+
34
+ Add an initializer in yourapp/config/initializers. Name it *carrierwave_securefile.rb*. Add the following:
35
+
36
+ ``` ruby
37
+ CarrierWave::SecureFile.configure do |config|
38
+ config.cypher = ("Your cypher code here")[0..55]
39
+ end
40
+ ```
41
+
42
+ The cypher must be no longer than 56 characters.
43
+
44
+ ### Uploader
45
+
46
+ ``` ruby
47
+ process :secure_file
48
+ def secure_file
49
+ CarrierWave::SecureFile::Uploader.secure_file( model, self.to_s )
50
+ end
51
+ ```
52
+
53
+ This sends the model data (typically nil, but differentiates between uploads and downloads) as well as the current file name
54
+ (self.to_s - which is needed to encrypt the file).
55
+
56
+ ### Downloader
57
+
58
+ You will not be able to call YourUploader.asset_file (or whatever you chose with your CarrierWave uploader) directly. Create
59
+ a new get controller action, and use the following code. Change where appropriate. Assumed using an uploader named
60
+ UserFileUploader, and a model called UserFile.
61
+
62
+ ``` ruby
63
+ def file
64
+ # get the decrypted file from the server. needs the uploader model and the record the file is attached to in your ORM.
65
+ decrypted_file = CarrierWave::SecureFile::Downloader.call( UserFileUploader, UserFile.find(params[:id]) )
66
+ # decrypted file is a hash set up as follows:
67
+ # decrypted_file[:file] - the decrypted file, hopefully saved in a tmp path, not somewhere public facing.
68
+ # decrypted_file[:content_type] - returns content type, if available.
69
+ # send the file to the user:
70
+ send_file decrypted_file[:file], :content_type => decrypted_file[:content_type]
71
+ # then immediately destroy the file. You don't want an unencrypted file saved on your server... or do you?
72
+ File.unlink decrypted_file[:file]
73
+ end
74
+ ```
75
+
76
+ And that's it! You're good to go.
77
+
78
+
79
+ # Contributing to carrierwave_securefile
80
+
81
+ * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
82
+ * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
83
+ * Fork the project
84
+ * Start a feature/bugfix branch
85
+ * Commit and push until you are happy with your contribution
86
+ * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
87
+ * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
88
+
89
+ ### Copyright
90
+
91
+ Copyright (c) 2011 Doug Clark. See LICENSE.txt for further details.
92
+
data/Rakefile ADDED
@@ -0,0 +1,53 @@
1
+ # encoding: utf-8
2
+
3
+ require 'rubygems'
4
+ require 'bundler'
5
+ begin
6
+ Bundler.setup(:default, :development)
7
+ rescue Bundler::BundlerError => e
8
+ $stderr.puts e.message
9
+ $stderr.puts "Run `bundle install` to install missing gems"
10
+ exit e.status_code
11
+ end
12
+ require 'rake'
13
+
14
+ require 'jeweler'
15
+ Jeweler::Tasks.new do |gem|
16
+ # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
17
+ gem.name = "carrierwave_securefile"
18
+ gem.homepage = "http://github.com/dougc84/carrierwave_securefile"
19
+ gem.license = "MIT"
20
+ gem.summary = %Q{Secure, encrypted file uploads using Crypt19 and CarrierWave}
21
+ gem.description = %Q{Secure, encrypted file uploads using Crypt19 and CarrierWave}
22
+ gem.email = "doug@dougclarkonline.com"
23
+ gem.authors = ["Doug Clark"]
24
+ # dependencies defined in Gemfile
25
+ end
26
+ Jeweler::RubygemsDotOrgTasks.new
27
+
28
+ require 'rake/testtask'
29
+ Rake::TestTask.new(:test) do |test|
30
+ test.libs << 'lib' << 'test'
31
+ test.pattern = 'test/**/test_*.rb'
32
+ test.verbose = true
33
+ end
34
+
35
+ require 'rcov/rcovtask'
36
+ Rcov::RcovTask.new do |test|
37
+ test.libs << 'test'
38
+ test.pattern = 'test/**/test_*.rb'
39
+ test.verbose = true
40
+ test.rcov_opts << '--exclude "gems/*"'
41
+ end
42
+
43
+ task :default => :test
44
+
45
+ require 'rake/rdoctask'
46
+ Rake::RDocTask.new do |rdoc|
47
+ version = File.exist?('VERSION') ? File.read('VERSION') : ""
48
+
49
+ rdoc.rdoc_dir = 'rdoc'
50
+ rdoc.title = "carrierwave_securefile #{version}"
51
+ rdoc.rdoc_files.include('README*')
52
+ rdoc.rdoc_files.include('lib/**/*.rb')
53
+ end
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 0.1.0
@@ -0,0 +1,69 @@
1
+ # Generated by jeweler
2
+ # DO NOT EDIT THIS FILE DIRECTLY
3
+ # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
4
+ # -*- encoding: utf-8 -*-
5
+
6
+ Gem::Specification.new do |s|
7
+ s.name = "carrierwave_securefile"
8
+ s.version = "0.1.0"
9
+
10
+ s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
11
+ s.authors = ["Doug Clark"]
12
+ s.date = "2011-11-28"
13
+ s.description = "Secure, encrypted file uploads using Crypt19 and CarrierWave"
14
+ s.email = "doug@dougclarkonline.com"
15
+ s.extra_rdoc_files = [
16
+ "LICENSE.txt",
17
+ "README.md"
18
+ ]
19
+ s.files = [
20
+ ".document",
21
+ "Gemfile",
22
+ "Gemfile.lock",
23
+ "LICENSE.txt",
24
+ "README.md",
25
+ "Rakefile",
26
+ "VERSION",
27
+ "carrierwave_securefile.gemspec",
28
+ "lib/carrierwave/securefile.rb",
29
+ "lib/carrierwave/securefile/configuration.rb",
30
+ "lib/carrierwave/securefile/downloader.rb",
31
+ "lib/carrierwave/securefile/uploader.rb",
32
+ "lib/carrierwave_securefile.rb",
33
+ "test/helper.rb",
34
+ "test/test_carrierwave_securefile.rb"
35
+ ]
36
+ s.homepage = "http://github.com/dougc84/carrierwave_securefile"
37
+ s.licenses = ["MIT"]
38
+ s.require_paths = ["lib"]
39
+ s.rubygems_version = "1.8.10"
40
+ s.summary = "Secure, encrypted file uploads using Crypt19 and CarrierWave"
41
+
42
+ if s.respond_to? :specification_version then
43
+ s.specification_version = 3
44
+
45
+ if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
46
+ s.add_runtime_dependency(%q<carrierwave>, ["~> 0.5.8"])
47
+ s.add_runtime_dependency(%q<crypt19>, ["= 1.2.1"])
48
+ s.add_development_dependency(%q<shoulda>, [">= 0"])
49
+ s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
50
+ s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
51
+ s.add_development_dependency(%q<rcov>, [">= 0"])
52
+ else
53
+ s.add_dependency(%q<carrierwave>, ["~> 0.5.8"])
54
+ s.add_dependency(%q<crypt19>, ["= 1.2.1"])
55
+ s.add_dependency(%q<shoulda>, [">= 0"])
56
+ s.add_dependency(%q<bundler>, ["~> 1.0.0"])
57
+ s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
58
+ s.add_dependency(%q<rcov>, [">= 0"])
59
+ end
60
+ else
61
+ s.add_dependency(%q<carrierwave>, ["~> 0.5.8"])
62
+ s.add_dependency(%q<crypt19>, ["= 1.2.1"])
63
+ s.add_dependency(%q<shoulda>, [">= 0"])
64
+ s.add_dependency(%q<bundler>, ["~> 1.0.0"])
65
+ s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
66
+ s.add_dependency(%q<rcov>, [">= 0"])
67
+ end
68
+ end
69
+
@@ -0,0 +1,17 @@
1
+ module CarrierWave
2
+ module SecureFile
3
+
4
+ def self.configure
5
+ yield configuration
6
+ end
7
+
8
+ def self.configuration
9
+ @configuration ||= CarrierWave::SecureFile::Configuration.new
10
+ end
11
+
12
+ class Configuration
13
+ attr_accessor :cypher
14
+ end
15
+
16
+ end
17
+ end
@@ -0,0 +1,28 @@
1
+ module CarrierWave
2
+ module SecureFile
3
+ module Downloader
4
+
5
+
6
+ class << self
7
+
8
+ def call(uploader_model,activerecord_record)
9
+ downloader = uploader_model.new
10
+ uploaded_file = activerecord_record
11
+ downloader.download!(uploaded_file.user_file.to_s)
12
+ file = downloader.to_s
13
+ ext_file = file + ".x1"
14
+ File.rename(file,ext_file)
15
+ p "Downloader Configuration: "
16
+ configuration = CarrierWave::SecureFile.configuration
17
+ bf = Crypt::Blowfish.new(configuration.cypher)
18
+ bf.decrypt_file(ext_file, file)
19
+ File.unlink(ext_file)
20
+ return { :file => file, :content_type => uploaded_file.content_type }
21
+ end
22
+
23
+ end
24
+
25
+
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,21 @@
1
+ module CarrierWave
2
+ module SecureFile
3
+ module Uploader
4
+
5
+
6
+ def self.secure_file(model=nil, file)
7
+ if model
8
+ ext_file = file + ".x1"
9
+ File.rename(file, ext_file)
10
+ configuration = CarrierWave::SecureFile.configuration
11
+ bf = Crypt::Blowfish.new(configuration.cypher)
12
+ bf.encrypt_file(ext_file, file)
13
+ File.unlink(ext_file)
14
+ file
15
+ end
16
+ end
17
+
18
+
19
+ end
20
+ end
21
+ end
@@ -0,0 +1,6 @@
1
+ module CarrierWave
2
+ module SecureFile
3
+ class << self
4
+ end
5
+ end
6
+ end
@@ -0,0 +1,17 @@
1
+ require 'digest/md5'
2
+ # require 'carrierwave/securefile.rb'
3
+ require 'carrierwave/securefile/uploader.rb'
4
+ require 'carrierwave/securefile/downloader.rb'
5
+ require 'carrierwave/securefile/configuration.rb'
6
+
7
+ unless defined? Crypt
8
+ begin
9
+ require 'crypt/blowfish'
10
+ rescue LoadError
11
+ puts "WARNING: Failed to require crypt/blowfish, encryption may fail!"
12
+ puts " You may need to add the crypt19 gem."
13
+ end
14
+ end
15
+
16
+ module CarrierWave
17
+ end
data/test/helper.rb ADDED
@@ -0,0 +1,18 @@
1
+ require 'rubygems'
2
+ require 'bundler'
3
+ begin
4
+ Bundler.setup(:default, :development)
5
+ rescue Bundler::BundlerError => e
6
+ $stderr.puts e.message
7
+ $stderr.puts "Run `bundle install` to install missing gems"
8
+ exit e.status_code
9
+ end
10
+ require 'test/unit'
11
+ require 'shoulda'
12
+
13
+ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
14
+ $LOAD_PATH.unshift(File.dirname(__FILE__))
15
+ require 'carrierwave_securefile'
16
+
17
+ class Test::Unit::TestCase
18
+ end
@@ -0,0 +1,7 @@
1
+ require 'helper'
2
+
3
+ class TestCarrierwaveSecurefile < Test::Unit::TestCase
4
+ should "probably rename this file and start testing for real" do
5
+ flunk "hey buddy, you should probably rename this file and start testing for real"
6
+ end
7
+ end
metadata ADDED
@@ -0,0 +1,131 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: carrierwave_securefile
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ prerelease:
6
+ platform: ruby
7
+ authors:
8
+ - Doug Clark
9
+ autorequire:
10
+ bindir: bin
11
+ cert_chain: []
12
+ date: 2011-11-28 00:00:00.000000000 Z
13
+ dependencies:
14
+ - !ruby/object:Gem::Dependency
15
+ name: carrierwave
16
+ requirement: &70177636244440 !ruby/object:Gem::Requirement
17
+ none: false
18
+ requirements:
19
+ - - ~>
20
+ - !ruby/object:Gem::Version
21
+ version: 0.5.8
22
+ type: :runtime
23
+ prerelease: false
24
+ version_requirements: *70177636244440
25
+ - !ruby/object:Gem::Dependency
26
+ name: crypt19
27
+ requirement: &70177636242980 !ruby/object:Gem::Requirement
28
+ none: false
29
+ requirements:
30
+ - - =
31
+ - !ruby/object:Gem::Version
32
+ version: 1.2.1
33
+ type: :runtime
34
+ prerelease: false
35
+ version_requirements: *70177636242980
36
+ - !ruby/object:Gem::Dependency
37
+ name: shoulda
38
+ requirement: &70177636241800 !ruby/object:Gem::Requirement
39
+ none: false
40
+ requirements:
41
+ - - ! '>='
42
+ - !ruby/object:Gem::Version
43
+ version: '0'
44
+ type: :development
45
+ prerelease: false
46
+ version_requirements: *70177636241800
47
+ - !ruby/object:Gem::Dependency
48
+ name: bundler
49
+ requirement: &70177636240380 !ruby/object:Gem::Requirement
50
+ none: false
51
+ requirements:
52
+ - - ~>
53
+ - !ruby/object:Gem::Version
54
+ version: 1.0.0
55
+ type: :development
56
+ prerelease: false
57
+ version_requirements: *70177636240380
58
+ - !ruby/object:Gem::Dependency
59
+ name: jeweler
60
+ requirement: &70177636238540 !ruby/object:Gem::Requirement
61
+ none: false
62
+ requirements:
63
+ - - ~>
64
+ - !ruby/object:Gem::Version
65
+ version: 1.6.4
66
+ type: :development
67
+ prerelease: false
68
+ version_requirements: *70177636238540
69
+ - !ruby/object:Gem::Dependency
70
+ name: rcov
71
+ requirement: &70177636236660 !ruby/object:Gem::Requirement
72
+ none: false
73
+ requirements:
74
+ - - ! '>='
75
+ - !ruby/object:Gem::Version
76
+ version: '0'
77
+ type: :development
78
+ prerelease: false
79
+ version_requirements: *70177636236660
80
+ description: Secure, encrypted file uploads using Crypt19 and CarrierWave
81
+ email: doug@dougclarkonline.com
82
+ executables: []
83
+ extensions: []
84
+ extra_rdoc_files:
85
+ - LICENSE.txt
86
+ - README.md
87
+ files:
88
+ - .document
89
+ - Gemfile
90
+ - Gemfile.lock
91
+ - LICENSE.txt
92
+ - README.md
93
+ - Rakefile
94
+ - VERSION
95
+ - carrierwave_securefile.gemspec
96
+ - lib/carrierwave/securefile.rb
97
+ - lib/carrierwave/securefile/configuration.rb
98
+ - lib/carrierwave/securefile/downloader.rb
99
+ - lib/carrierwave/securefile/uploader.rb
100
+ - lib/carrierwave_securefile.rb
101
+ - test/helper.rb
102
+ - test/test_carrierwave_securefile.rb
103
+ homepage: http://github.com/dougc84/carrierwave_securefile
104
+ licenses:
105
+ - MIT
106
+ post_install_message:
107
+ rdoc_options: []
108
+ require_paths:
109
+ - lib
110
+ required_ruby_version: !ruby/object:Gem::Requirement
111
+ none: false
112
+ requirements:
113
+ - - ! '>='
114
+ - !ruby/object:Gem::Version
115
+ version: '0'
116
+ segments:
117
+ - 0
118
+ hash: 539206744974253030
119
+ required_rubygems_version: !ruby/object:Gem::Requirement
120
+ none: false
121
+ requirements:
122
+ - - ! '>='
123
+ - !ruby/object:Gem::Version
124
+ version: '0'
125
+ requirements: []
126
+ rubyforge_project:
127
+ rubygems_version: 1.8.10
128
+ signing_key:
129
+ specification_version: 3
130
+ summary: Secure, encrypted file uploads using Crypt19 and CarrierWave
131
+ test_files: []