pkwde-url_signer 0.2.0

data/COPYING

@@ -0,0 +1,3 @@
+Copyright Caroo GmbH 2009
+
+You may use, copy and redistribute this library under the same terms as Ruby itself (see http://www.ruby-lang.org/en/LICENSE.txt) or under the MIT license (see MIT-LICENSE file).

data/History.txt

@@ -0,0 +1,9 @@
+== 0.1.0 2009-01-16
+	
+* 1 major enhancement:
+  * Added secret handling
+
+== 0.0.1 2009-01-15
+	
+* 1 major enhancement:
+  * Initial release

data/MIT-LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2009 Caroo GmbH
+
+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/Manifest.txt

@@ -0,0 +1,11 @@
+COPYING
+History.txt
+MIT-LICENSE
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/url_signer.rb
+test/test_helper.rb
+test/url_signer_test.rb
+url_signer.gemspec

data/README.rdoc

@@ -0,0 +1,50 @@
+= UrlSigner
+
+* http://github.com/pkwde/url_signer
+
+== DESCRIPTION:
+
+The UrlSigner class was designed to create tamper-proof URLs, that can only be generated and validated by parties that know the shared secret.
+
+== SYNOPSIS:
+
+  >> signer = UrlSigner.new('secret')
+  => #<UrlSigner:0x1b0506c>
+  >> signed_url = signer.sign("http://localhost/testfile.jpg")
+  => "http://localhost/testfile_cd45e1a2.jpg"
+  >> signer.valid?(signed_url)
+  => true
+  
+== REQUIREMENTS:
+
+* ActiveSupport
+
+== INSTALL:
+
+* gem sources -a http://gems.github.com
+* sudo gem install pkwde-url_signer
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Caroo GmbH
+
+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/Rakefile

@@ -0,0 +1,31 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/url_signer'
+
+$hoe = Hoe.new('url_signer', UrlSigner::VERSION) do |p|
+  p.developer('Caroo GmbH', 'dev@pkw.de')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.extra_dev_deps = [
+    ['activesupport'],
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  p.summary = "UrlSigner is a class to cryptographically sign URLs."
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+end
+
+require 'newgem/tasks'
+
+desc "Run unit tests"
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+  t.warning = true
+end
+
+desc 'Generate RDoc'
+Rake::RDocTask.new do |task|
+  task.main = 'README.rdoc'
+  task.title = "UrlSigner #{UrlSigner::VERSION}"
+  task.rdoc_dir = 'doc'
+  task.rdoc_files.include('README.rdoc', 'COPYING', 'MIT-LICENSE',"lib/**/*.rb")
+end

data/lib/url_signer.rb

@@ -0,0 +1,88 @@
+require 'rubygems'
+require 'activesupport'
+require 'uri'
+require 'digest/sha1'
+
+class UrlSigner
+  
+  VERSION = "0.2.0"
+  
+  DEFAULT_HASH_LENGTH = 10
+  DEFAULT_SEPARATOR = "_"
+  
+  # Initialize new url-signer
+  #
+  # == Parameter
+  # secret (String):: secret for hashing
+  # options (Hash):: possible options are:
+  #                 - :hash_length (Integer):: set length of hash
+  #                 - :separator (String):: set separator for hash in url
+  # 
+  def initialize(secret, options = {})
+    self.secret = secret
+    self.hash_length = options[:hash_length] || DEFAULT_HASH_LENGTH
+    self.separator = options[:separator] || DEFAULT_SEPARATOR
+  end
+  
+  # signs a given url
+  # 
+  # == Parameter
+  # url (String):: whole URL to sign
+  # 
+  # == Returns
+  # signed URL (url with inserted hash)
+  #
+  def sign(url)
+    parsed_url = URI.parse(url)
+    suffix = File.extname(parsed_url.path)
+    parsed_url.to_s.gsub(/#{suffix}$/, "#{hash_with_separator(url)}#{suffix}")
+  end
+  
+  # get url without hash (as it was before signing)
+  # 
+  # == Parameter
+  # url (String):: url with inserted hash
+  # 
+  # == Returns
+  # Returns a URL without hash (as it was before signing)
+  def unsign(url)
+    parsed_url = URI.parse(url)
+    suffix = File.extname(parsed_url.path)
+    # extract hash with separator from uri
+    url_without_suffix = parsed_url.to_s.gsub(/#{suffix}$/, "")
+    url_without_hash_and_suffix = url_without_suffix.gsub(/#{separator}.{#{hash_length}}$/, "")
+    unsigned_url = "#{url_without_hash_and_suffix}#{suffix}"
+    return unsigned_url
+  end
+  
+  # validates a given URL
+  # 
+  # == Parameter
+  # url (String):: url to validate
+  # 
+  # == Returns
+  # true or false
+  def valid?(url)
+    hash(unsign(url)) == extract_hash(url)
+  end
+  
+  private
+    
+    attr_accessor :secret, :hash_length, :separator
+    
+    def hash(string)
+      Digest::SHA1.hexdigest(string+secret)[0..(hash_length-1)]
+    end
+    
+    def extract_hash(url)
+      parsed_url = URI.parse(url)
+      suffix = File.extname(parsed_url.path)
+      extracted_hash = File.basename(parsed_url.path,suffix)[-hash_length..-1]
+      return extracted_hash
+    end
+    
+    def hash_with_separator(url)
+      "#{separator}#{hash(url)}"
+    end
+    
+end

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+require "test/unit"
+
+$:.unshift File.expand_path(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require File.dirname(__FILE__) + '/../lib/url_signer'
+
+# siehe http://blog.jayfields.com/2007/11/ruby-testing-private-methods.html
+class Class
+  def publicize_methods
+    saved_private_instance_methods = self.private_instance_methods
+    self.class_eval { public *saved_private_instance_methods }
+    yield
+    self.class_eval { private *saved_private_instance_methods }
+  end
+end

data/test/url_signer_test.rb

@@ -0,0 +1,75 @@
+require "test_helper"
+
+class TestUrlSigner < Test::Unit::TestCase
+  
+  def test_should_set_length_of_hash_in_initializer
+    url_signer = UrlSigner.new("secret", :hash_length => 16)
+    url = "http://images.pkw.de/audi_gebrauchtwagen_300.jpg"
+    signed_url = url_signer.sign(url)
+    UrlSigner.publicize_methods do
+      assert_equal 16, url_signer.extract_hash(signed_url).length
+    end
+    assert url_signer.valid?(url_signer.sign(url))
+  end
+  
+  def test_should_sign_urls
+    url_signer = UrlSigner.new("secret")
+    url = "http://images.pkw.de/audi_gebrauchtwagen_300.jpg"
+    signed_url = url_signer.sign(url)
+    assert_not_equal url, signed_url
+  end
+  
+  def test_round_trip
+    url_signer = UrlSigner.new("secret")
+    url = "http://images.pkw.de/audi_gebrauchtwagen_300.jpg"
+    assert url_signer.valid?(url_signer.sign(url))
+  end
+  
+  def test_should_validate_url
+    url_signer = UrlSigner.new("secret")
+    signed_url = "http://images.pkw.de/audi_gebrauchtwagen_300_c1ed2a4c21.jpg"
+    bad_signed_url = "http://images.pkw.de/audi_gebrauchtwagen_300_d97f0fef87.jpg"
+    assert url_signer.valid?(signed_url)
+    assert !url_signer.valid?(bad_signed_url)
+  end
+  
+  def test_should_use_secret_for_hashing
+    url_signer1 = UrlSigner.new("secret1")
+    url1 = "http://images.pkw.de/audi_gebrauchtwagen_300.jpg"
+    signed_url1 = url_signer1.sign(url1)
+    url_signer2 = UrlSigner.new("secret2")
+    url2 = "http://images.pkw.de/audi_gebrauchtwagen_300.jpg"
+    signed_url2 = url_signer2.sign(url2)
+    assert_equal false, signed_url1 == signed_url2
+  end
+  
+  def test_should_not_be_able_to_reset_secret
+    url_signer = UrlSigner.new("secret")
+    assert_raise(NoMethodError) { url_signer.secret = "new secret" }
+  end
+  
+  def test_should_unsign_url
+    url_signer = UrlSigner.new("secret")
+    url = "http://images.pkw.de/audi_gebrauchtwagen_300.jpg"
+    assert_equal url, url_signer.unsign(url_signer.sign(url))
+  end
+  
+  def test_should_extract_hash_from_url
+    url_signer = UrlSigner.new("secret", :hash_length => 10)
+    url = "http://images.pkw.de/audi_gebrauchtwagen_300.jpg"
+    UrlSigner.publicize_methods do
+      assert_equal "c1ed2a4c21", url_signer.extract_hash(url_signer.sign(url))
+    end
+  end
+  
+  def test_should_have_hash_with_separator
+    url_signer = UrlSigner.new("secret")
+  end
+  
+  def test_should_be_able_to_set_separator_in_initializer
+    url_signer = UrlSigner.new("secret", :separator => "~")
+    url = "http://images.pkw.de/audi_gebrauchtwagen_300.jpg"
+    assert_match /http\:\/\/images\.pkw\.de\/audi_gebrauchtwagen_300\~.{#{UrlSigner::DEFAULT_HASH_LENGTH}}\.jpg/, url_signer.sign(url)
+  end
+  
+end

data/url_signer.gemspec

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{url_signer}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Caroo GmbH"]
+  s.date = %q{2009-01-16}
+  s.description = %q{The UrlSigner class was designed to create tamper-proof URLs, that can only be generated and validated by parties that know the shared secret.}
+  s.email = ["dev@pkw.de"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc"]
+  s.files = ["COPYING", "History.txt", "MIT-LICENSE", "Manifest.txt", "PostInstall.txt", "README.rdoc", "Rakefile", "lib/url_signer.rb", "test/test_helper.rb", "test/url_signer_test.rb", "url_signer.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/pkwde/url_signer}
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{url_signer}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{UrlSigner is a class to cryptographically sign URLs.}
+  s.test_files = ["test/test_helper.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<activesupport>, [">= 0"])
+      s.add_development_dependency(%q<newgem>, [">= 1.2.3"])
+      s.add_development_dependency(%q<hoe>, [">= 1.8.0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<newgem>, [">= 1.2.3"])
+      s.add_dependency(%q<hoe>, [">= 1.8.0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<newgem>, [">= 1.2.3"])
+    s.add_dependency(%q<hoe>, [">= 1.8.0"])
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: pkwde-url_signer
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Caroo GmbH
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-16 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: The UrlSigner class was designed to create tamper-proof URLs, that can only be generated and validated by parties that know the shared secret.
+email: 
+- dev@pkw.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+files: 
+- COPYING
+- History.txt
+- MIT-LICENSE
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- lib/url_signer.rb
+- test/test_helper.rb
+- test/url_signer_test.rb
+- url_signer.gemspec
+has_rdoc: true
+homepage: http://github.com/pkwde/url_signer
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: url_signer
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: UrlSigner is a class to cryptographically sign URLs.
+test_files: 
+- test/test_helper.rb