url_authenticator 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+MIT LICENSE
+
+Copyright (c) 2010 Tomasz Werbicki <tomasz@werbicki.net>
+
+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,36 @@
+UrlAuthenticator
+================
+
+A library to sign and verify signed URLs.
+
+Usage
+-----
+
+	require "url_authenticator"
+	
+	url = "http://example.com"
+	signed_url = UrlAuthenticator.sign(url, "your_secret")
+	# => "http://example.com?expires=1323787739&signature=c064a2cbda335ed784387ad69abd1880"
+
+	UrlAuthenticator.verify(signed_url, "your_secret") # => true
+
+
+
+	# If you want to extend expire period (20 minutes default):
+	expires_at = Time.now + 40 * 60
+	signed_url = UrlAuthenticator.sign(url, "your_secret", expires_at)
+	# => "http://example.com?expires=1323789137&signature=813b0e16bd5bc3618dd84d2274e9c212"
+
+
+	# If you want to use different time for expiration verification (default Time.now):
+	now = Time.new(2000, 7, 7, 12, 30)
+	UrlAuthenticator.verify(signed_url, "your_secret", now) # => true
+
+### Settings
+
+	UrlAuthenticator.default_secre = "your_secret"
+
+License
+-------
+
+[MIT License](https://github.com/neaf/url_authenticator/blob/master/MIT-LICENSE)

data/Rakefile

@@ -0,0 +1,15 @@
+#!/usr/bin/env rake
+require 'rake/testtask'
+
+dir = File.dirname(__FILE__)
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = Dir.glob("#{dir}/test/*_test.rb").sort
+  t.warning = true
+end
+
+desc "Run gem tests by default"
+task :default => :test

data/lib/url_authenticator.rb

@@ -0,0 +1,60 @@
+require "uri"
+require "cgi"
+require "openssl"
+
+module UrlAuthenticator
+  class << self
+    attr_accessor :default_secret
+  end
+
+  def self.sign(url, secret = nil, expires = nil)
+    secret ||= default_secret
+    raise ArgumentError.new("Pass secret explicitly or set default_secret for UrlAuthenticator") unless secret
+    Signer.new(secret, expires).sign(url)
+  end
+
+  def self.verify(url, secret = nil, now = nil)
+    secret ||= default_secret
+    raise ArgumentError.new("Pass secret explicitly or set default_secret for UrlAuthenticator") unless secret
+    Verifier.new(secret, now).verify(url)
+  end
+
+  class Verifier
+    def initialize(secret, now = nil)
+      @secret = secret
+      @now = (now || Time.now).utc.to_i
+    end
+
+    def verify(url)
+      uri = URI.parse(url)
+      params = CGI.parse(uri.query || "")
+      expires = params["expires"].first.to_i
+      signature = params["signature"].first
+      signature_valid(url, signature) && @now <= expires
+    end
+
+    def signature_valid(url, signature)
+      unsigned = url.sub(/(\?|&)signature=#{signature}/, "")
+      OpenSSL::HMAC.hexdigest("md5", @secret, unsigned) == signature
+    end
+  end
+
+  class Signer
+    def initialize(secret, expires = nil)
+      @secret = secret
+      @expires = (expires || Time.now + 20 * 60).utc.to_i
+    end
+
+    def sign(url)
+      url = append_param(url, "expires", @expires)
+      signature = OpenSSL::HMAC.hexdigest("md5", @secret, url)
+      append_param(url, "signature", signature)
+    end
+
+    def append_param(url, name, value)
+      parameter = [name, value].join('=')
+      separator = url.include?('?') ? '&' : '?'
+      [url, parameter].join(separator)
+    end
+  end
+end

data/test/signer_test.rb

@@ -0,0 +1,16 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class SignerTest < Test::Unit::TestCase
+  EXPIRES_TIME = Time.utc(2011, 12, 12, 12, 30)
+  SECRET = "password"
+  VALID_URL = "http://themes.cardflick.co/themes?expires=1323693000&signature=adeb9e4c42661f04121f51bb53ddb10a"
+  BASE_URL = "http://themes.cardflick.co/themes"
+
+  def signer(time=EXPIRES_TIME)
+    UrlAuthenticator::Signer.new(SECRET, time)
+  end
+
+  def test_sign_returns_signed_url
+    assert_equal VALID_URL, signer.sign(BASE_URL)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require "test/unit"
+require File.dirname(__FILE__) + '/../lib/url_authenticator.rb'

data/test/url_authenticator_test.rb

@@ -0,0 +1,16 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class UrlAuthenticatorTest < Test::Unit::TestCase
+  SECRET = "password"
+  BASE_URL = "http://themes.cardflick.co/themes"
+
+  def test_api_cohesion
+    signed = UrlAuthenticator.sign(BASE_URL, SECRET)
+    assert UrlAuthenticator.verify(signed, SECRET)
+  end
+
+  def test_api_correctnes
+    signed = UrlAuthenticator.sign(BASE_URL, "first")
+    assert !UrlAuthenticator.verify(signed, "second")
+  end
+end

data/test/verifier_test.rb

@@ -0,0 +1,41 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class VerifierTest < Test::Unit::TestCase
+  GENERATION_TIME = Time.utc(2011, 12, 12, 12, 0)
+  EXPIRES_TIME = Time.utc(2011, 12, 12, 12, 30)
+  SECRET = "password"
+  VALID_URL = "http://themes.cardflick.co/themes?expires=1323693000&signature=adeb9e4c42661f04121f51bb53ddb10a"
+  NO_EXPIRES_URL = "http://themes.cardflick.co/themes?signature=daac5be63c57def09223748d76d713f0"
+  INVALID_URL = "http://themes.cardflick.co/themes?expires=1323693000&signature=adeb9e4c42661f04121f51bb53ddb20b"
+  NO_SIG_URL = "http://themes.cardflick.co/themes?expires=1323693000"
+  BASE_URL = "http://themes.cardflick.co/themes"
+
+  def verifier(time=GENERATION_TIME)
+    UrlAuthenticator::Verifier.new(SECRET, time)
+  end
+
+  def test_verify_returns_true_for_correct_signature
+    assert verifier.verify(VALID_URL)
+  end
+
+  def test_verify_returns_false_when_timestamp_is_stale
+    stale = EXPIRES_TIME + 1
+    assert !verifier(stale).verify(VALID_URL)
+  end
+
+  def test_verify_returns_false_when_incorrect_signature
+    assert !verifier.verify(INVALID_URL)
+  end
+
+  def test_verify_returns_false_when_no_signature
+    assert !verifier.verify(NO_SIG_URL)
+  end
+
+  def test_verify_without_expires_is_false
+    assert !verifier.verify(NO_EXPIRES_URL)
+  end
+
+  def test_verify_works_when_no_params
+    assert !verifier.verify(BASE_URL)
+  end
+end

data/url_authenticator.gemspec

@@ -0,0 +1,11 @@
+Gem::Specification.new do |s|
+  s.name = %q{url_authenticator}
+  s.version = "0.0.1"
+  s.date = %q{2011-12-13}
+  s.summary = %q{Helper classes for signing and verifying signed URLs with expiration time.}
+  s.authors = ["Tomasz Werbicki", "Tomasz Paczkowski"]
+  s.homepage = "https://github.com/neaf/url_authenticator"
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- test/*`.split("\n")
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: url_authenticator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tomasz Werbicki
+- Tomasz Paczkowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-13 00:00:00.000000000Z
+dependencies: []
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/url_authenticator.rb
+- test/signer_test.rb
+- test/test_helper.rb
+- test/url_authenticator_test.rb
+- test/verifier_test.rb
+- url_authenticator.gemspec
+homepage: https://github.com/neaf/url_authenticator
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Helper classes for signing and verifying signed URLs with expiration time.
+test_files:
+- test/signer_test.rb
+- test/test_helper.rb
+- test/url_authenticator_test.rb
+- test/verifier_test.rb