securecompare 1.0.0

data/.gemspec.rb

@@ -0,0 +1,51 @@
+class Readme < String
+  attr_reader :path
+
+  def initialize(path)
+    @path = path
+    super(File.read(self.path))
+  end
+
+  def summary
+    if self =~ /^# (?:\S+)\s+(.+?)\s{2,}/m
+      scrub $1
+    else
+      raise "could not find summary in #{path}"
+    end
+  end
+
+  def description
+    if self =~ /^## Description\s+(.+?)\s{2,}/m
+      scrub $1
+    else
+      raise "could not find description in #{path}"
+    end
+  end
+
+  private
+    def scrub(string)
+      string.delete("\\`").gsub(/\[([^\]]+)\]\([^)]*\)/, "\\1").tr("\n", " ").to_s
+    end
+end
+
+class Files < Array
+  def executables
+    grep(%r{^bin/}) { |f| File.basename(f) }
+  end
+
+  def requires
+    ["lib"]
+  end
+
+  def tests
+    grep(%r{^(test|spec|features)/})
+  end
+end
+
+def files
+  @files ||= Files.new(`git ls-files`.split($/))
+end
+
+def readme(path = File.expand_path("./README.md"))
+  (@readmes ||= {})[path] ||= Readme.new(path)
+end

data/.gitignore

@@ -0,0 +1,2 @@
+/Gemfile.lock
+/pkg

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-19mode
+script: bundle exec rake test

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Samuel Kadolph
+
+MIT License
+
+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,77 @@
+[![Build Status](https://secure.travis-ci.org/samuelkadolph/securecompare.png?branch=master)](http://travis-ci.org/samuelkadolph/securecompare)
+[![Gem Version](https://badge.fury.io/rb/securecompare.png)](http://badge.fury.io/rb/securecompare)
+[![Dependency Status](https://gemnasium.com/samuelkadolph/securecompare.png)](https://gemnasium.com/samuelkadolph/securecompare)
+[![Code Climate](https://codeclimate.com/github/samuelkadolph/securecompare.png)](https://codeclimate.com/github/samuelkadolph/securecompare)
+
+# securecompare
+
+securecompare is a gem that implements a constant time string comparison method safe for use in cryptographic functions.
+
+## Description
+
+securecompare borrows the `secure_compare` private method from `ActiveSupport::MessageVerifier` which lets you do safely compare strings without being vulnerable to timing attacks. Useful for Basic HTTP Authentication in your rack/rails application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "securecompare"
+```
+
+And then execute:
+
+```
+$ bundle install
+```
+
+Or install it yourself as:
+
+```
+$ gem install securecompare
+```
+
+## Usage
+
+```ruby
+require "securecompare"
+
+SecureCompare.compare("password", "password") # => true
+SecureCompare.compare("password", "passw0rd") # => false
+```
+
+```ruby
+require "securecompare"
+
+class Password < String
+  include SecureCompare
+
+  def ==(other)
+    secure_compare(self, other)
+  end
+end
+
+Password.new("password") == "password" # => true
+Password.new("password") == "passw0rd" # => false
+```
+
+```ruby
+require "securecompare"
+
+class ApplicationController < ActionController::Base
+  include SecureCompare
+
+  before_filter :authenticate
+
+  proctected
+  def authenticate
+    authenticate_or_request_with_http_basic("My Rails App") do |username, password|
+      secure_compare(username, "username") & secure_compare(password, "password")
+    end
+  end
+end
+```
+
+## Contributing
+
+Fork, branch & pull request.

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |task|
+  task.libs << "test"
+  task.test_files = Dir["test/**/*_test.rb"]
+  task.verbose = true
+end

data/lib/securecompare.rb

@@ -0,0 +1,19 @@
+module SecureCompare
+  require "securecompare/version"
+
+  # constant-time comparison algorithm to prevent timing attacks; borrowed from ActiveSupport::MessageVerifier
+  def secure_compare(a, b)
+    return false unless a.bytesize == b.bytesize
+
+    l = a.unpack("C#{a.bytesize}")
+
+    res = 0
+    b.each_byte { |byte| res |= byte ^ l.shift }
+    res == 0
+  end
+  module_function :secure_compare
+
+  class << self
+    alias_method :compare, :secure_compare
+  end
+end

data/lib/securecompare/version.rb

@@ -0,0 +1,3 @@
+module SecureCompare
+  VERSION = "1.0.0"
+end

data/securecompare.gemspec

@@ -0,0 +1,23 @@
+require File.expand_path("../.gemspec", __FILE__)
+require File.expand_path("../lib/securecompare/version", __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = "securecompare"
+  spec.version       = SecureCompare::VERSION
+  spec.authors       = ["Samuel Kadolph"]
+  spec.email         = ["samuel@kadolph.com"]
+  spec.description   = readme.description
+  spec.summary       = readme.summary
+  spec.homepage      = "https://github.com/samuelkadolph/securecompare"
+  spec.license       = "MIT"
+
+  spec.files         = files
+  spec.executables   = files.executables
+  spec.test_files    = files.tests
+  spec.require_paths = files.requires
+
+  spec.required_ruby_version = ">= 1.9.3"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/test/securecompare_test.rb

@@ -0,0 +1,27 @@
+require "test_helper"
+
+describe SecureCompare do
+  it "should return true for equal strings" do
+    SecureCompare.secure_compare("abc", "abc").must_equal(true)
+  end
+
+  it "should return false for not equal strings" do
+    SecureCompare.secure_compare("abc", "def").must_equal(false)
+  end
+
+  it "should respond to compare" do
+    SecureCompare.must_respond_to(:compare)
+  end
+
+  it "should add secure_compare to anything that includes it" do
+    klass = Class.new
+    klass.send(:include, SecureCompare)
+    klass.private_instance_methods.include?(:secure_compare).must_equal(true)
+  end
+
+  it "should add secure_compare to anything that extends it" do
+    klass = Class.new
+    klass.send(:extend, SecureCompare)
+    klass.private_methods.include?(:secure_compare).must_equal(true)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require "minitest/autorun"
+require "minitest/benchmark"
+require "minitest/spec"
+require "securecompare"

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: securecompare
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Samuel Kadolph
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: securecompare borrows the secure_compare private method from ActiveSupport::MessageVerifier
+  which lets you do safely compare strings without being vulnerable to timing attacks.
+  Useful for Basic HTTP Authentication in your rack/rails application.
+email:
+- samuel@kadolph.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gemspec.rb
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/securecompare.rb
+- lib/securecompare/version.rb
+- securecompare.gemspec
+- test/securecompare_test.rb
+- test/test_helper.rb
+homepage: https://github.com/samuelkadolph/securecompare
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 612519151303698657
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: securecompare is a gem that implements a constant time string comparison
+  method safe for use in cryptographic functions.
+test_files:
+- test/securecompare_test.rb
+- test/test_helper.rb