sigmund 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 04869d6df5edfc8be15b695c2efa7c48e1ae7b5e
+  data.tar.gz: 0dadab9b98741b7e755efbfb843672f3dee47a25
+SHA512:
+  metadata.gz: c7fcf52f1a82477889fae5e4f0f4bf7873e94c8035ea08e802edf69d48f416d87fbb6bdaf0d6ef57fe7bbccdae7b2140873e85dff4811991d5ac616cb797dac7
+  data.tar.gz: 23b0e3ecf935a1f3cca0603b973fe889e19da34dd4de1519e2043da5a598556c3919ba4a108c08b87a566c14c91b5175e29199aa8fcb5e4f42db8a7ebddd0fce

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Leonard van Driel
+
+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,45 @@
+# Sigmund
+
+*Sign urls and verify signatures*
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sigmund'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sigmund
+
+## Usage
+
+To sign a url, use:
+
+    Sigmund.sign("http://www.test.com/path", 'secret_key')
+
+This will append a `sig` parameter to the url containing a HMAC SHA1 signature.
+
+Now to verify a signature, use:
+
+    Sigmund.verify("http://www.test.com/path?sig=ZCqYKJiLS7WMZX7l5wEU016Mv1s", 'secret_key')
+
+This will return true only if a valid signature is present.
+
+## 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
+
+## License
+Sigmund is licensed under the terms of the MIT License, see the included LICENSE file.
+
+## Authors
+- [Leonard van Driel](http://www.leonardvandriel.nl/)

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib/sigmund'
+  t.test_files = FileList['test/lib/*_test.rb', 'test/lib/sigmund/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/lib/sigmund/base.rb

@@ -0,0 +1,75 @@
+require 'digest/hmac'
+require 'base64'
+
+module Sigmund
+
+  class Base
+
+    def self.hmac_procedure(key, digester)
+      Proc.new do |data|
+        hmac = Digest::HMAC.new(key, digester)
+        hmac.update(data)
+        hmac.digest
+      end
+    end
+
+    def self.sign_uri(uri, proc, exclude, param)
+      normalized = normalize_uri(uri, exclude, param)
+      sig = compute_signature(normalized, proc)
+      append_signature(uri, sig, param)
+    end
+
+    def self.verify_uri(uri, proc, exclude, param)
+      normalized = normalize_uri(uri, exclude, param)
+      sig = compute_signature(normalized, proc)
+      (extract_signature(uri, param) == sig)
+    end
+
+    def self.normalize_uri(uri, exclude, param)
+      u = uri.dup
+      if u.query
+        components = u.query.split('&')
+        components.reject! { |c| c.start_with?(param + '=') }
+        u.query = components.join('&')
+      end
+      u.scheme = nil if u.scheme == '' || exclude.include?(:scheme)
+      u.host = nil if u.host == '' || exclude.include?(:host)
+      u.path = '' if u.path == nil || exclude.include?(:path)
+      u.query = nil if u.query == '' || exclude.include?(:query)
+      u.fragment = nil if u.fragment == '' || exclude.include?(:fragment)
+      u.normalize!
+      u
+    end
+
+    def self.compute_signature(uri, proc)
+      data = proc.call(uri.to_s)
+      encode_base64(data)
+    end
+
+    def self.append_signature(uri, signature, param)
+      u = uri.dup
+      u.query ||= ''
+      u.query += (u.query.size > 0 ? '&' : '')
+      u.query += param + '=' + signature
+      u
+    end
+
+    def self.extract_signature(uri, param)
+      return unless uri.query
+      components = uri.query.split('&').select{ |c| c.start_with?(param + '=') }
+      return unless components.size == 1
+      components.first[4..-1]
+    end
+
+    def self.encode_base64(data)
+      Base64.urlsafe_encode64(data).gsub('=','')
+    end
+
+    def self.decode_base64(data)
+      padded = data + ('=' * (-data.size % 4))
+      Base64.urlsafe_decode64(padded)
+    end
+
+  end
+
+end

data/lib/sigmund/version.rb

@@ -0,0 +1,3 @@
+module Sigmund
+  VERSION = "0.0.1"
+end

data/lib/sigmund.rb

@@ -0,0 +1,24 @@
+require "sigmund/base"
+
+module Sigmund
+
+    class SignatureBrokenError < RuntimeError; end
+
+    @digester = Digest::SHA1
+    @exclude = [:scheme, :host]
+    @param = 'sig'
+
+    def self.sign(string, key, digester: @digester, exclude: @exclude, param: @param)
+      proc = Base.hmac_procedure(key, digester)
+      Base.sign_uri(URI(string), proc, exclude, param)
+    end
+
+    def self.verify(string, key, digester: @digester, exclude: @exclude, param: @param)
+      proc = Base.hmac_procedure(key, digester)
+      Base.verify_uri(URI(string), proc, exclude, param)
+    end
+
+    def self.verify!(string, key, options = {})
+      raise SignatureBrokenError.new unless verify(string, key, *options)
+    end
+end

data/sigmund.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sigmund/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sigmund"
+  spec.version       = Sigmund::VERSION
+  spec.authors       = ["Leonard van Driel"]
+  spec.email         = ["leonardvandriel@gmail.com"]
+  spec.description   = %q{Sign urls and verify signatures}
+  spec.summary       = %q{Sign urls and verify signatures, easy!}
+  spec.homepage      = "https://github.com/leonardvandriel/sigmund"
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/test/lib/sigmund/base_test.rb

@@ -0,0 +1,100 @@
+require_relative '../../test_helper'
+
+describe Sigmund::Base do
+
+  let(:uri) { URI('http://www.test.com/path?query#fragment') }
+
+  describe "hmac_procedure" do
+    it "returns sha1 procedure" do
+      digest = Sigmund::Base.hmac_procedure('test', Digest::SHA1).call('x')
+      Sigmund::Base.encode_base64(digest).must_equal("9nX6BQQtf-lOAkme0pXTWm7b2zo")
+    end
+  end
+
+  describe "sign_uri" do
+    it "signs a uri" do
+      u = Sigmund::Base.sign_uri(uri, Proc.new{ |d| d + 'x' }, [], 'sig')
+      u.to_s.must_equal('http://www.test.com/path?query&sig=aHR0cDovL3d3dy50ZXN0LmNvbS9wYXRoP3F1ZXJ5I2ZyYWdtZW50eA#fragment')
+    end
+  end
+
+  describe "normalize_uri" do
+    it "downcases scheme and host" do
+      u = Sigmund::Base.normalize_uri(URI('hTTp://www.TEST.com/'), [], 'sig')
+      u.to_s.must_equal('http://www.test.com/')
+    end
+
+    it "appends /" do
+      u = Sigmund::Base.normalize_uri(URI('http://www.test.com'), [], 'sig')
+      u.to_s.must_equal('http://www.test.com/')
+    end
+
+    it "removes empty query" do
+      u = Sigmund::Base.normalize_uri(URI('http://www.test.com/?'), [], 'sig')
+      u.to_s.must_equal('http://www.test.com/')
+    end
+
+    it "removes empty fragment" do
+      u = Sigmund::Base.normalize_uri(URI('http://www.test.com/#'), [], 'sig')
+      u.to_s.must_equal('http://www.test.com/')
+    end
+
+    it "removes existing signature" do
+      u = Sigmund::Base.normalize_uri(URI('http://www.test.com/?sig=test'), [], 'sig')
+      u.to_s.must_equal('http://www.test.com/')
+    end
+  end
+
+  describe "compute_signature" do
+    it "invokes proc" do
+      data = nil
+      Sigmund::Base.compute_signature(uri, Proc.new{ |d| data = d })
+      data.must_equal(uri.to_s)
+    end
+
+    it "returns proc result" do
+      sig = Sigmund::Base.compute_signature(uri, Proc.new{ |d| 'test' })
+      sig.must_equal('dGVzdA')
+    end
+  end
+
+  describe "append_signature" do
+    it "appends test signature" do
+      u = Sigmund::Base.append_signature(uri, 'test', 'sig')
+      u.to_s.must_equal('http://www.test.com/path?query&sig=test#fragment')
+    end
+
+    it "handles empty signature" do
+      u = Sigmund::Base.append_signature(uri, '', 'sig')
+      u.to_s.must_equal('http://www.test.com/path?query&sig=#fragment')
+    end
+  end
+
+  describe "extract_signature" do
+    it "extracts test signature" do
+      sig = Sigmund::Base.extract_signature(URI("http://www.test.com/path?query&sig=test#fragment"), 'sig')
+      sig.must_equal('test')
+    end
+  end
+
+  describe "encode_base64" do
+    it "encodes test string" do
+      Sigmund::Base.encode_base64('test').must_equal('dGVzdA')
+    end
+
+    it "handles empty string" do
+      Sigmund::Base.encode_base64('').must_equal('')
+    end
+  end
+
+  describe "encode_base64" do
+    it "encodes test string" do
+      Sigmund::Base.decode_base64('dGVzdA').must_equal('test')
+    end
+
+    it "handles empty string" do
+      Sigmund::Base.decode_base64('').must_equal('')
+    end
+  end
+
+end

data/test/lib/sigmund/version_test.rb

@@ -0,0 +1,10 @@
+require_relative '../../test_helper'
+
+describe Sigmund do
+
+	it "must be defined" do
+		Sigmund::VERSION.wont_be_nil
+	end
+
+end
+

data/test/lib/sigmund_test.rb

@@ -0,0 +1,57 @@
+require_relative '../test_helper'
+
+describe Sigmund do
+
+  let(:uri) { URI('http://www.test.com/path?query#fragment') }
+
+  describe "sign" do
+    it "signs with sha1" do
+      u = Sigmund.sign("http://www.test.com/path", 'test')
+      u.to_s.must_equal('http://www.test.com/path?sig=ZCqYKJiLS7WMZX7l5wEU016Mv1s')
+    end
+
+    it "signs with other key" do
+      u = Sigmund.sign("http://www.test.com/path", 'test' + 'Z')
+      u.to_s.must_equal('http://www.test.com/path?sig=TVQPBRB9DUagk9N7mf6z3YIIHaE')
+    end
+
+    it "signs with other url" do
+      u = Sigmund.sign("http://www.test.com/path?query#fragment", 'test')
+      u.to_s.must_equal('http://www.test.com/path?query&sig=fEpucXVmFSzkC6V4MMcXDmYEhk4#fragment')
+    end
+  end
+
+  describe "verify" do
+    it "verifies with sha1" do
+      v = Sigmund.verify("http://www.test.com/path?sig=ZCqYKJiLS7WMZX7l5wEU016Mv1s", 'test')
+      v.must_equal(true)
+    end
+
+    it "fails if sig incorrect" do
+      v = Sigmund.verify("http://www.test.com/path?sig=ZCqYKJiLS7WMZX7l5wEU016Mv1s" + 'Z', 'test')
+      v.must_equal(false)
+    end
+
+    it "fails if key incorrect" do
+      v = Sigmund.verify("http://www.test.com/path?sig=ZCqYKJiLS7WMZX7l5wEU016Mv1s", 'test' + 'Z')
+      v.must_equal(false)
+    end
+
+    it "fails if query incorrect" do
+      v = Sigmund.verify("http://www.test.com/path?sigg=ZCqYKJiLS7WMZX7l5wEU016Mv1s", 'test')
+      v.must_equal(false)
+    end
+
+    it "fails if sig missing" do
+      v = Sigmund.verify("http://www.test.com/path", 'test')
+      v.must_equal(false)
+    end
+  end
+
+  describe "verify" do
+    it "raises if sig incorrect" do
+      proc { Sigmund.verify!("http://www.test.com/path?sig=ZCqYKJiLS7WMZX7l5wEU016Mv1s" + 'Z', 'test') }.must_raise Sigmund::SignatureBrokenError
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require "minitest/autorun"
+require "minitest/pride"
+require File.expand_path('../../lib/sigmund.rb', __FILE__)
+

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: sigmund
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Leonard van Driel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Sign urls and verify signatures
+email:
+- leonardvandriel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sigmund.rb
+- lib/sigmund/base.rb
+- lib/sigmund/version.rb
+- sigmund.gemspec
+- test/lib/sigmund/base_test.rb
+- test/lib/sigmund/version_test.rb
+- test/lib/sigmund_test.rb
+- test/test_helper.rb
+homepage: https://github.com/leonardvandriel/sigmund
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.10
+signing_key: 
+specification_version: 4
+summary: Sign urls and verify signatures, easy!
+test_files:
+- test/lib/sigmund/base_test.rb
+- test/lib/sigmund/version_test.rb
+- test/lib/sigmund_test.rb
+- test/test_helper.rb
+has_rdoc: