apache_secure_download 0.0.1.207 → 0.0.2.213

data/ChangeLog

@@ -1,5 +1,10 @@
 = Revision history for apache_secure_download
 
+== 0.0.2 [2008-02-20]
+
+* Added helper module Apache::SecureDownload::Util
+* Made directory structure reflect module structure
+
 == 0.0.1 [2008-02-15]
 
 * Birthday :-)

data/README

@@ -2,7 +2,7 @@
 
 == VERSION
 
-This documentation refers to apache_secure_download version 0.0.1
+This documentation refers to apache_secure_download version 0.0.2
 
 
 == DESCRIPTION
@@ -16,10 +16,22 @@ Place the following snippet in your Apache config:
 
     <Location /secure>
       # pass your shared secret string to the handler -- secret means SECRET!
-      RubyAccessHandler Apache::SecureDownload.new("secret-string")
+      RubyAccessHandler Apache::SecureDownload.new("secret")
     </Location>
   </IfModule>
 
+And create links to your resources with timestamp and token:
+
+  require 'apache/secure_download/util'
+
+  timestamp = 1.minute.from_now  # e.g.
+  token     = Apache::SecureDownload::Util.token("secret", path, timestamp)
+
+  url = path + "?timestamp=#{timestamp}&token=#{token}"
+
+  # or simply use the provided helper:
+  url = Apache::SecureDownload::Util.secure_url("secret", path, 1.minute.from_now)
+
 
 == AUTHORS
 

data/Rakefile

@@ -1,4 +1,4 @@
-require %q{lib/apache_secure_download/version}
+require %q{lib/apache/secure_download/version}
 
 begin
   require 'hen'

data/lib/apache/secure_download/util.rb

@@ -0,0 +1,57 @@
+#--
+###############################################################################
+#                                                                             #
+# A component of apache_secure_download.                                      #
+#                                                                             #
+# Copyright (C) 2008 University of Cologne,                                   #
+#                    Albertus-Magnus-Platz,                                   #
+#                    50932 Cologne, Germany                                   #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@uni-koeln.de>                                    #
+#                                                                             #
+# apache_secure_download is free software: you can redistribute it and/or     #
+# modify it under the terms of the GNU General Public License as published by #
+# the Free Software Foundation, either version 3 of the License, or (at your  #
+# option) any later version.                                                  #
+#                                                                             #
+# apache_secure_download is distributed in the hope that it will be useful,   #
+# but WITHOUT ANY WARRANTY; without even the implied warranty of              #
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General    #
+# Public License for more details.                                            #
+#                                                                             #
+# You should have received a copy of the GNU General Public License along     #
+# with apache_secure_download. If not, see <http://www.gnu.org/licenses/>.    #
+#                                                                             #
+###############################################################################
+#++
+
+require 'digest/sha1'
+require 'uri'
+
+module Apache
+
+  class SecureDownload
+
+    module Util
+
+      extend self
+
+      def token(secret, path, timestamp)
+        Digest::SHA1.hexdigest(secret + path + timestamp.to_s)
+      end
+
+      def secure_url(secret, url, timestamp = Time.now + 60)
+        path, _, query = URI.split(url)[5..7]
+        path << '?' << query if query
+
+        timestamp = timestamp.to_i
+
+        url + "#{query ? '&' : '?'}timestamp=#{timestamp}&token=#{token(secret, path, timestamp)}"
+      end
+
+    end
+
+  end
+
+end

data/lib/{apache_secure_download → apache/secure_download}/version.rb

@@ -6,7 +6,7 @@ module Apache
 
       MAJOR = 0
       MINOR = 0
-      TINY  = 1
+      TINY  = 2
 
       class << self
 

data/lib/apache/secure_download.rb

@@ -0,0 +1,52 @@
+#--
+###############################################################################
+#                                                                             #
+# apache_secure_download -- Apache module providing secure downloading        #
+#                           functionality                                     #
+#                                                                             #
+# Copyright (C) 2008 University of Cologne,                                   #
+#                    Albertus-Magnus-Platz,                                   #
+#                    50932 Cologne, Germany                                   #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@uni-koeln.de>                                    #
+#                                                                             #
+# apache_secure_download is free software: you can redistribute it and/or     #
+# modify it under the terms of the GNU General Public License as published by #
+# the Free Software Foundation, either version 3 of the License, or (at your  #
+# option) any later version.                                                  #
+#                                                                             #
+# apache_secure_download is distributed in the hope that it will be useful,   #
+# but WITHOUT ANY WARRANTY; without even the implied warranty of              #
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General    #
+# Public License for more details.                                            #
+#                                                                             #
+# You should have received a copy of the GNU General Public License along     #
+# with apache_secure_download. If not, see <http://www.gnu.org/licenses/>.    #
+#                                                                             #
+###############################################################################
+#++
+
+require 'rubygems'
+require 'apache/secure_download/util'
+
+module Apache
+
+  class SecureDownload
+
+    def initialize(secret)
+      raise ArgumentError, 'secret string missing' unless @secret = secret
+    end
+
+    def check_access(request)
+      timestamp = request.param('timestamp')
+
+      return FORBIDDEN if timestamp.to_i < Time.now.to_i
+      return FORBIDDEN if request.param('token') != Util.token(@secret, request.uri, timestamp)
+
+      return OK
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: apache_secure_download
 version: !ruby/object:Gem::Version 
-  version: 0.0.1.207
+  version: 0.0.2.213
 platform: ruby
 authors: 
 - Jens Wille
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-02-15 00:00:00 +01:00
+date: 2008-02-20 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -24,8 +24,9 @@ extra_rdoc_files:
 - ChangeLog
 - README
 files: 
-- lib/apache_secure_download/version.rb
-- lib/apache_secure_download.rb
+- lib/apache/secure_download.rb
+- lib/apache/secure_download/version.rb
+- lib/apache/secure_download/util.rb
 - COPYING
 - README
 - ChangeLog

data/lib/apache_secure_download.rb

@@ -1,26 +0,0 @@
-require 'digest/sha1'
-
-module Apache
-
-  class SecureDownload
-
-    def initialize(secret)
-      raise ArgumentError, 'secret string missing' unless @secret = secret
-    end
-
-    def check_access(request)
-      return FORBIDDEN if request.param('timestamp').to_i < Time.now.to_i
-      return FORBIDDEN if request.param('token') != compute_token(request)
-
-      return OK
-    end
-
-    private
-
-    def compute_token(request)
-      Digest::SHA1.hexdigest(@secret + request.uri + request.param('timestamp'))
-    end
-
-  end
-
-end