bcrypt-ruby 2.1.4 → 3.0.0

data/.gitignore

@@ -5,3 +5,4 @@ ext/mri/Makefile
 doc
 pkg
 *.class
+tmp/

data/CHANGELOG

@@ -37,4 +37,8 @@
   - JVM 1.4/1.5 compatibility [Hongli Lai]
 
 2.1.2  Sep 16 2009
-  - Fixed support for Solaris, OpenSolaris.
+  - Fixed support for Solaris, OpenSolaris.
+
+3.0.0 Aug 24, 2011
+  - Bcrypt C implementation replaced with a public domain implementation.
+  - License changed to MIT

data/COPYING

@@ -1,33 +1,28 @@
-Copyright 2007-2009 Coda Hale <coda.hale@gmail.com>
+(The MIT License)
 
-Original C implementation of the BCrypt algorithm by Niels Provos.
-jBCrypt is Copyright (c) 2006 Damien Miller <djm@mindrot.org>.
+Copyright 2007-2011:
+
+* Coda Hale <coda.hale@gmail.com>
 
-All rights reserved.
+C implementation of the BCrypt algorithm by Solar Designer and placed in the
+public domain.
+jBCrypt is Copyright (c) 2006 Damien Miller <djm@mindrot.org>.
 
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions
-are met:
-1. Redistributions of source code must retain the above copyright
-   notice, this list of conditions and the following disclaimer.
-2. Redistributions in binary form must reproduce the above copyright
-   notice, this list of conditions and the following disclaimer in the
-   documentation and/or other materials provided with the distribution.
-3. All advertising materials mentioning features or use of this software
-   must display the following acknowledgement:
+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:
 
-   This product includes software developed by Coda Hale.
-    
-4. The name of the author may not be used to endorse or promote products
-   derived from this software without specific prior written permission.
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
 
-THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
-IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
-OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
-IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
-INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
-NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
-THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+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/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: .
+  specs:
+    bcrypt-ruby (2.1.4)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    rake (0.8.7)
+    rake-compiler (0.7.5)
+      rake
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  bcrypt-ruby!
+  rake-compiler
+  rspec

data/README.md

@@ -0,0 +1,184 @@
+# bcrypt-ruby
+
+An easy way to keep your users' passwords secure.
+
+* http://bcrypt-ruby.rubyforge.org/
+* http://github.com/codahale/bcrypt-ruby/tree/master
+
+## Why you should use `bcrypt()`
+
+If you store user passwords in the clear, then an attacker who steals a copy of your database has a giant list of emails
+and passwords. Some of your users will only have one password -- for their email account, for their banking account, for
+your application. A simple hack could escalate into massive identity theft.
+
+It's your responsibility as a web developer to make your web application secure -- blaming your users for not being
+security experts is not a professional response to risk.
+
+`bcrypt()` allows you to easily harden your application against these kinds of attacks.
+
+*Note*: JRuby versions of bcrypt-ruby `<= 2.1.3` had a [security
+vulnerability](http://www.mindrot.org/files/jBCrypt/internat.adv) that
+was fixed in `>= 2.1.4`. If you used a vulnerable version to hash
+passwords with international characters in them, you will need to
+re-hash those passwords. This vulernability only affected the JRuby gem.
+
+## How to install bcrypt
+
+    sudo gem install bcrypt-ruby
+
+The bcrypt-ruby gem is available on the following ruby platforms:
+
+* JRuby
+* RubyInstaller 1.8 and 1.9 builds on win32
+* Any 1.8 or 1.9 ruby on a BSD/OSX/Linux system with a compiler
+
+## How to use `bcrypt()` in your Rails application
+
+### The _User_ model
+
+    require 'bcrypt'
+
+    class User < ActiveRecord::Base
+      # users.password_hash in the database is a :string
+      include BCrypt
+
+      def password
+        @password ||= Password.new(password_hash)
+      end
+
+      def password=(new_password)
+        @password = Password.create(new_password)
+        self.password_hash = @password
+      end
+    end
+
+### Creating an account
+
+    def create
+      @user = User.new(params[:user])
+      @user.password = params[:password]
+      @user.save!
+    end
+
+### Authenticating a user
+
+    def login
+      @user = User.find_by_email(params[:email])
+      if @user.password == params[:password]
+        give_token
+      else
+        redirect_to home_url
+      end
+    end
+
+### If a user forgets their password?
+
+    # assign them a random one and mail it to them, asking them to change it
+    def forgot_password
+      @user = User.find_by_email(params[:email])
+      random_password = Array.new(10).map { (65 + rand(58)).chr }.join
+      @user.password = random_password
+      @user.save!
+      Mailer.create_and_deliver_password_change(@user, random_password)
+    end
+
+## How to use bcrypt-ruby in general
+
+    require 'bcrypt'
+
+    my_password = BCrypt::Password.create("my password")
+      #=> "$2a$10$vI8aWBnW3fID.ZQ4/zo1G.q1lRps.9cGLcZEiGDMVr5yUP1KUOYTa"
+
+    my_password.version              #=> "2a"
+    my_password.cost                 #=> 10
+    my_password == "my password"     #=> true
+    my_password == "not my password" #=> false
+
+    my_password = BCrypt::Password.new("$2a$10$vI8aWBnW3fID.ZQ4/zo1G.q1lRps.9cGLcZEiGDMVr5yUP1KUOYTa")
+    my_password == "my password"     #=> true
+    my_password == "not my password" #=> false
+
+Check the rdocs for more details -- BCrypt, BCrypt::Password.
+
+## How `bcrypt()` works
+
+`bcrypt()` is a hashing algorithm designed by Niels Provos and David Mazières of the OpenBSD Project.
+
+### Background
+
+Hash algorithms take a chunk of data (e.g., your user's password) and create a "digital fingerprint," or hash, of it.
+Because this process is not reversible, there's no way to go from the hash back to the password.
+
+In other words:
+
+    hash(p) #=> <unique gibberish>
+
+You can store the hash and check it against a hash made of a potentially valid password:
+
+    <unique gibberish> =? hash(just_entered_password)
+
+### Rainbow Tables
+
+But even this has weaknesses -- attackers can just run lists of possible passwords through the same algorithm, store the
+results in a big database, and then look up the passwords by their hash:
+
+    PrecomputedPassword.find_by_hash(<unique gibberish>).password #=> "secret1"
+
+### Salts
+
+The solution to this is to add a small chunk of random data -- called a salt -- to the password before it's hashed:
+
+    hash(salt + p) #=> <really unique gibberish>
+
+The salt is then stored along with the hash in the database, and used to check potentially valid passwords:
+
+    <really unique gibberish> =? hash(salt + just_entered_password)
+
+bcrypt-ruby automatically handles the storage and generation of these salts for you.
+
+Adding a salt means that an attacker has to have a gigantic database for each unique salt -- for a salt made of 4
+letters, that's 456,976 different databases. Pretty much no one has that much storage space, so attackers try a
+different, slower method -- throw a list of potential passwords at each individual password:
+
+    hash(salt + "aadvark") =? <really unique gibberish>
+    hash(salt + "abacus")  =? <really unique gibberish>
+    etc.
+
+This is much slower than the big database approach, but most hash algorithms are pretty quick -- and therein lies the
+problem. Hash algorithms aren't usually designed to be slow, they're designed to turn gigabytes of data into secure
+fingerprints as quickly as possible. `bcrypt()`, though, is designed to be computationally expensive:
+
+    Ten thousand iterations:
+                 user     system      total        real
+    md5      0.070000   0.000000   0.070000 (  0.070415)
+    bcrypt  22.230000   0.080000  22.310000 ( 22.493822)
+
+If an attacker was using Ruby to check each password, they could check ~140,000 passwords a second with MD5 but only
+~450 passwords a second with `bcrypt()`.
+
+### Cost Factors
+
+In addition, `bcrypt()` allows you to increase the amount of work required to hash a password as computers get faster. Old
+passwords will still work fine, but new passwords can keep up with the times.
+
+The default cost factor used by bcrypt-ruby is 10, which is fine for session-based authentication. If you are using a
+stateless authentication architecture (e.g., HTTP Basic Auth), you will want to lower the cost factor to reduce your
+server load and keep your request times down. This will lower the security provided you, but there are few alternatives.
+
+## More Information
+
+`bcrypt()` is currently used as the default password storage hash in OpenBSD, widely regarded as the most secure operating
+system available.
+
+For a more technical explanation of the algorithm and its design criteria, please read Niels Provos and David Mazières'
+Usenix99 paper:
+http://www.usenix.org/events/usenix99/provos.html
+
+If you'd like more down-to-earth advice regarding cryptography, I suggest reading <i>Practical Cryptography</i> by Niels
+Ferguson and Bruce Schneier:
+http://www.schneier.com/book-practical.html
+
+# Etc
+
+* Author  :: Coda Hale <coda.hale@gmail.com>
+* Website :: http://blog.codahale.com

data/Rakefile

@@ -25,6 +25,7 @@ task :default => [:compile, :spec]
 desc "Run all specs"
 RSpec::Core::RakeTask.new do |t|
   t.pattern = 'spec/**/*_spec.rb'
+  t.ruby_opts = '-w'
 end
 
 desc "Run all specs, with coverage testing"

data/bcrypt-ruby.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'bcrypt-ruby'
-  s.version = '2.1.4'
+  s.version = '3.0.0'
 
   s.summary = "OpenBSD's bcrypt() password hashing algorithm."
   s.description = <<-EOF
@@ -16,8 +16,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec'
 
   s.has_rdoc = true
-  s.rdoc_options += ['--title', 'bcrypt-ruby', '--line-numbers', '--inline-source', '--main', 'README']
-  s.extra_rdoc_files += ['README', 'COPYING', 'CHANGELOG', *Dir['lib/**/*.rb']]
+  s.rdoc_options += ['--title', 'bcrypt-ruby', '--line-numbers', '--inline-source', '--main', 'README.md']
+  s.extra_rdoc_files += ['README.md', 'COPYING', 'CHANGELOG', *Dir['lib/**/*.rb']]
 
   s.extensions = 'ext/mri/extconf.rb'
 

data/ext/mri/bcrypt_ext.c

@@ -1,87 +1,89 @@
-#include "ruby.h"
-#include "bcrypt.h"
+#include <ruby.h>
+#include <ow-crypt.h>
 
 static VALUE mBCrypt;
 static VALUE cBCryptEngine;
 
-/* Define RSTRING_PTR for Ruby 1.8.5, ruby-core's idea of a point release is
-   insane. */
-#ifndef RSTRING_PTR
-#  define    RSTRING_PTR(s)  (RSTRING(s)->ptr)
-#endif
-
 #ifdef RUBY_VM
 #  define RUBY_1_9
 #endif
 
 #ifdef RUBY_1_9
 
-	/* When on Ruby 1.9+, we will want to unlock the GIL while performing
-	 * expensive calculations, for greater concurrency. Do not do this for
-	 * cheap calculations because locking/unlocking the GIL incurs some overhead as well.
-	 */
-	#define GIL_UNLOCK_COST_THRESHOLD 9
-	
-	typedef struct {
-		char       *output;
-		const char *key;
-		const char *salt;
-	} BCryptArguments;
-	
-	static VALUE bcrypt_wrapper(void *_args) {
-		BCryptArguments *args = (BCryptArguments *)_args;
-		return (VALUE)ruby_bcrypt(args->output, args->key, args->salt);
-	}
+/* When on Ruby 1.9+, we will want to unlock the GIL while performing
+ * expensive calculations, for greater concurrency. Do not do this for
+ * cheap calculations because locking/unlocking the GIL incurs some overhead as well.
+ */
+#define GIL_UNLOCK_COST_THRESHOLD 9
+
+typedef struct {
+    char       *output;
+    const char *key;
+    const char *salt;
+} BCryptArguments;
+
+static VALUE bcrypt_wrapper(void *_args) {
+    BCryptArguments *args = (BCryptArguments *)_args;
+    return (VALUE)ruby_bcrypt(args->output, args->key, args->salt);
+}
 
 #endif /* RUBY_1_9 */
 
 /* Given a logarithmic cost parameter, generates a salt for use with +bc_crypt+.
- */
-static VALUE bc_salt(VALUE self, VALUE cost, VALUE seed) {
-	int icost = NUM2INT(cost);
-	char salt[BCRYPT_SALT_OUTPUT_SIZE];
-	
-	ruby_bcrypt_gensalt(salt, icost, (uint8_t *)RSTRING_PTR(seed));
-	return rb_str_new2(salt);
+*/
+static VALUE bc_salt(VALUE self, VALUE prefix, VALUE count, VALUE input) {
+    char * salt;
+    VALUE str_salt;
+
+    salt = crypt_gensalt_ra(
+	    StringValuePtr(prefix),
+	    NUM2ULONG(count),
+	    NIL_P(input) ? NULL : StringValuePtr(input),
+	    NIL_P(input) ? 0 : RSTRING_LEN(input));
+
+    if(!salt) return Qnil;
+
+    str_salt = rb_str_new2(salt);
+    free(salt);
+
+    return str_salt;
 }
 
 /* Given a secret and a salt, generates a salted hash (which you can then store safely).
- */
-static VALUE bc_crypt(VALUE self, VALUE key, VALUE salt, VALUE cost) {
-	const char * safeguarded = RSTRING_PTR(key) ? RSTRING_PTR(key) : "";
-	char output[BCRYPT_OUTPUT_SIZE];
-	
-	#ifdef RUBY_1_9
-		int icost = NUM2INT(cost);
-		if (icost >= GIL_UNLOCK_COST_THRESHOLD) {
-			BCryptArguments args;
-			VALUE ret;
-		
-			args.output = output;
-			args.key    = safeguarded;
-			args.salt   = RSTRING_PTR(salt);
-			ret = rb_thread_blocking_region(bcrypt_wrapper, &args, RUBY_UBF_IO, 0);
-			if (ret != (VALUE) 0) {
-				return rb_str_new2(output);
-			} else {
-				return Qnil;
-			}
-		}
-		/* otherwise, fallback to the non-GIL-unlocking code, just like on Ruby 1.8 */
-	#endif
-	
-	if (ruby_bcrypt(output, safeguarded, (char *)RSTRING_PTR(salt)) != NULL) {
-		return rb_str_new2(output);
-	} else {
-		return Qnil;
-	}
+*/
+static VALUE bc_crypt(VALUE self, VALUE key, VALUE setting) {
+    char * value;
+    void * data;
+    int size;
+    VALUE out;
+
+    data = NULL;
+    size = 0xDEADBEEF;
+
+    if(NIL_P(key) || NIL_P(setting)) return Qnil;
+
+    value = crypt_ra(
+	    NIL_P(key) ? NULL : StringValuePtr(key),
+	    NIL_P(setting) ? NULL : StringValuePtr(setting),
+	    &data,
+	    &size);
+
+    if(!value) return Qnil;
+
+    out = rb_str_new(data, size - 1);
+
+    free(data);
+
+    return out;
 }
 
 /* Create the BCrypt and BCrypt::Engine modules, and populate them with methods. */
 void Init_bcrypt_ext(){
-	mBCrypt = rb_define_module("BCrypt");
-	cBCryptEngine = rb_define_class_under(mBCrypt, "Engine", rb_cObject);
-	
-	rb_define_singleton_method(cBCryptEngine, "__bc_salt", bc_salt, 2);
-	rb_define_singleton_method(cBCryptEngine, "__bc_crypt", bc_crypt, 3);
+    mBCrypt = rb_define_module("BCrypt");
+    cBCryptEngine = rb_define_class_under(mBCrypt, "Engine", rb_cObject);
+
+    rb_define_singleton_method(cBCryptEngine, "__bc_salt", bc_salt, 3);
+    rb_define_singleton_method(cBCryptEngine, "__bc_crypt", bc_crypt, 2);
 }
+
+/* vim: set noet sws=4 sw=4: */