bcrypt-ruby 2.1.3-java

data/ext/mri/bcrypt.c

@@ -0,0 +1,297 @@
+/*	$OpenBSD: bcrypt.c,v 1.22 2007/02/20 01:44:16 ray Exp $	*/
+
+/* 
+ * Modified by <coda.hale@gmail.com> on 2009-09-16:
+ *
+ *   - Standardized on stdint.h's numerical types and removed some debug cruft.
+ *
+ * Modified by <hongli@phusion.nl> on 2009-08-05:
+ *
+ *   - Got rid of the global variables; they're not thread-safe.
+ *     Modified the functions to accept local buffers instead.
+ *
+ * Modified by <coda.hale@gmail.com> on 2007-02-27:
+ *
+ *   - Changed bcrypt_gensalt to accept a random seed as a parameter,
+ *     to remove the code's dependency on arc4random(), which isn't
+ *     available on Linux. 
+ */
+
+/*
+ * Copyright 1997 Niels Provos <provos@physnet.uni-hamburg.de>
+ * All rights reserved.
+ *
+ * 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:
+ *      This product includes software developed by Niels Provos.
+ * 4. The name of the author may not be used to endorse or promote products
+ *    derived from this software without specific prior written permission.
+ *
+ * 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.
+ */
+
+/* This password hashing algorithm was designed by David Mazieres
+ * <dm@lcs.mit.edu> and works as follows:
+ *
+ * 1. state := InitState ()
+ * 2. state := ExpandKey (state, salt, password) 3.
+ * REPEAT rounds:
+ *	state := ExpandKey (state, 0, salt)
+ *      state := ExpandKey(state, 0, password)
+ * 4. ctext := "OrpheanBeholderScryDoubt"
+ * 5. REPEAT 64:
+ * 	ctext := Encrypt_ECB (state, ctext);
+ * 6. RETURN Concatenate (salt, ctext);
+ *
+ */
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include "blf.h"
+#include "bcrypt.h"
+
+/* This implementation is adaptable to current computing power.
+ * You can have up to 2^31 rounds which should be enough for some
+ * time to come.
+ */
+
+static void encode_salt(char *, uint8_t *, uint16_t, uint8_t);
+static void encode_base64(uint8_t *, uint8_t *, uint16_t);
+static void decode_base64(uint8_t *, uint16_t, uint8_t *);
+
+static const uint8_t Base64Code[] =
+"./ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
+
+static const uint8_t index_64[128] = {
+	255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
+	255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
+	255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
+	255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
+	255, 255, 255, 255, 255, 255, 0, 1, 54, 55,
+	56, 57, 58, 59, 60, 61, 62, 63, 255, 255,
+	255, 255, 255, 255, 255, 2, 3, 4, 5, 6,
+	7, 8, 9, 10, 11, 12, 13, 14, 15, 16,
+	17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27,
+	255, 255, 255, 255, 255, 255, 28, 29, 30,
+	31, 32, 33, 34, 35, 36, 37, 38, 39, 40,
+	41, 42, 43, 44, 45, 46, 47, 48, 49, 50,
+	51, 52, 53, 255, 255, 255, 255, 255
+};
+#define CHAR64(c)  ( (c) > 127 ? 255 : index_64[(c)])
+
+static void
+decode_base64(uint8_t *buffer, uint16_t len, uint8_t *data)
+{
+	uint8_t *bp = buffer;
+	uint8_t *p = data;
+	uint8_t c1, c2, c3, c4;
+	while (bp < buffer + len) {
+		c1 = CHAR64(*p);
+		c2 = CHAR64(*(p + 1));
+
+		/* Invalid data */
+		if (c1 == 255 || c2 == 255)
+			break;
+
+		*bp++ = (c1 << 2) | ((c2 & 0x30) >> 4);
+		if (bp >= buffer + len)
+			break;
+
+		c3 = CHAR64(*(p + 2));
+		if (c3 == 255)
+			break;
+
+		*bp++ = ((c2 & 0x0f) << 4) | ((c3 & 0x3c) >> 2);
+		if (bp >= buffer + len)
+			break;
+
+		c4 = CHAR64(*(p + 3));
+		if (c4 == 255)
+			break;
+		*bp++ = ((c3 & 0x03) << 6) | c4;
+
+		p += 4;
+	}
+}
+
+static void
+encode_salt(char *salt, uint8_t *csalt, uint16_t clen, uint8_t logr)
+{
+	salt[0] = '$';
+	salt[1] = BCRYPT_VERSION;
+	salt[2] = 'a';
+	salt[3] = '$';
+
+	snprintf(salt + 4, 4, "%2.2u$", logr);
+
+	encode_base64((uint8_t *) salt + 7, csalt, clen);
+}
+/* Generates a salt for this version of crypt.
+   Since versions may change. Keeping this here
+   seems sensible.
+ */
+
+char   *
+ruby_bcrypt_gensalt(char *output, uint8_t log_rounds, uint8_t *rseed)
+{
+	if (log_rounds < 4)
+		log_rounds = 4;
+	else if (log_rounds > 31)
+		log_rounds = 31;
+
+	encode_salt(output, rseed, BCRYPT_MAXSALT, log_rounds);
+	return output;
+}
+/* We handle $Vers$log2(NumRounds)$salt+passwd$
+   i.e. $2$04$iwouldntknowwhattosayetKdJ6iFtacBqJdKe6aW7ou */
+
+char   *
+ruby_bcrypt(char *output, const char *key, const char *salt)
+{
+	blf_ctx state;
+	uint32_t rounds, i, k;
+	uint16_t j;
+	uint8_t key_len, salt_len, logr, minor;
+	uint8_t ciphertext[4 * BCRYPT_BLOCKS] = "OrpheanBeholderScryDoubt";
+	uint8_t csalt[BCRYPT_MAXSALT];
+	uint32_t cdata[BCRYPT_BLOCKS];
+	int n;
+
+	/* Discard "$" identifier */
+	salt++;
+
+	if (*salt > BCRYPT_VERSION) {
+		return NULL;
+	}
+
+	/* Check for minor versions */
+	if (salt[1] != '$') {
+		 switch (salt[1]) {
+		 case 'a':
+			 /* 'ab' should not yield the same as 'abab' */
+			 minor = salt[1];
+			 salt++;
+			 break;
+		 default:
+			 return NULL;
+		 }
+	} else
+		 minor = 0;
+
+	/* Discard version + "$" identifier */
+	salt += 2;
+
+	if (salt[2] != '$')
+		/* Out of sync with passwd entry */
+		return NULL;
+
+	/* Computer power doesn't increase linear, 2^x should be fine */
+	n = atoi(salt);
+	if (n > 31 || n < 0)
+		return NULL;
+	logr = (uint8_t)n;
+	if ((rounds = (uint32_t) 1 << logr) < BCRYPT_MINROUNDS)
+		return NULL;
+
+	/* Discard num rounds + "$" identifier */
+	salt += 3;
+
+	if (strlen(salt) * 3 / 4 < BCRYPT_MAXSALT)
+		return NULL;
+
+	/* We dont want the base64 salt but the raw data */
+	decode_base64(csalt, BCRYPT_MAXSALT, (uint8_t *) salt);
+	salt_len = BCRYPT_MAXSALT;
+	key_len = strlen(key) + (minor >= 'a' ? 1 : 0);
+
+	/* Setting up S-Boxes and Subkeys */
+	Blowfish_initstate(&state);
+	Blowfish_expandstate(&state, csalt, salt_len,
+	    (uint8_t *) key, key_len);
+	for (k = 0; k < rounds; k++) {
+		Blowfish_expand0state(&state, (uint8_t *) key, key_len);
+		Blowfish_expand0state(&state, csalt, salt_len);
+	}
+
+	/* This can be precomputed later */
+	j = 0;
+	for (i = 0; i < BCRYPT_BLOCKS; i++)
+		cdata[i] = Blowfish_stream2word(ciphertext, 4 * BCRYPT_BLOCKS, &j);
+
+	/* Now do the encryption */
+	for (k = 0; k < 64; k++)
+		blf_enc(&state, cdata, BCRYPT_BLOCKS / 2);
+
+	for (i = 0; i < BCRYPT_BLOCKS; i++) {
+		ciphertext[4 * i + 3] = cdata[i] & 0xff;
+		cdata[i] = cdata[i] >> 8;
+		ciphertext[4 * i + 2] = cdata[i] & 0xff;
+		cdata[i] = cdata[i] >> 8;
+		ciphertext[4 * i + 1] = cdata[i] & 0xff;
+		cdata[i] = cdata[i] >> 8;
+		ciphertext[4 * i + 0] = cdata[i] & 0xff;
+	}
+
+
+	i = 0;
+	output[i++] = '$';
+	output[i++] = BCRYPT_VERSION;
+	if (minor)
+		output[i++] = minor;
+	output[i++] = '$';
+
+	snprintf(output + i, 4, "%2.2u$", logr);
+
+	encode_base64((uint8_t *) output + i + 3, csalt, BCRYPT_MAXSALT);
+	encode_base64((uint8_t *) output + strlen(output), ciphertext,
+	    4 * BCRYPT_BLOCKS - 1);
+	return output;
+}
+
+static void
+encode_base64(uint8_t *buffer, uint8_t *data, uint16_t len)
+{
+	uint8_t *bp = buffer;
+	uint8_t *p = data;
+	uint8_t c1, c2;
+	while (p < data + len) {
+		c1 = *p++;
+		*bp++ = Base64Code[(c1 >> 2)];
+		c1 = (c1 & 0x03) << 4;
+		if (p >= data + len) {
+			*bp++ = Base64Code[c1];
+			break;
+		}
+		c2 = *p++;
+		c1 |= (c2 >> 4) & 0x0f;
+		*bp++ = Base64Code[c1];
+		c1 = (c2 & 0x0f) << 2;
+		if (p >= data + len) {
+			*bp++ = Base64Code[c1];
+			break;
+		}
+		c2 = *p++;
+		c1 |= (c2 >> 6) & 0x03;
+		*bp++ = Base64Code[c1];
+		*bp++ = Base64Code[c2 & 0x3f];
+	}
+	*bp = '\0';
+}

data/ext/mri/bcrypt.h

@@ -0,0 +1,67 @@
+/*
+ * Copyright 1997 Niels Provos <provos@physnet.uni-hamburg.de>
+ * All rights reserved.
+ *
+ * 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:
+ *      This product includes software developed by Niels Provos.
+ * 4. The name of the author may not be used to endorse or promote products
+ *    derived from this software without specific prior written permission.
+ *
+ * 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.
+ */
+
+#ifndef _BCRYPT_H_
+#define _BCRYPT_H_
+
+#include <stdint.h>
+
+#define BCRYPT_VERSION '2'
+#define BCRYPT_MAXSALT 16	/* Precomputation is just so nice */
+#define BCRYPT_BLOCKS 6		/* Ciphertext blocks */
+#define BCRYPT_MINROUNDS 16	/* we have log2(rounds) in salt */
+#define BCRYPT_SALT_OUTPUT_SIZE  (7 + (BCRYPT_MAXSALT * 4 + 2) / 3 + 1)
+#define BCRYPT_OUTPUT_SIZE 128
+
+/*
+ * Given a logarithmic cost parameter, generates a salt for use with bcrypt().
+ *
+ * output: the computed salt will be stored here. This buffer must be
+ *         at least BCRYPT_SALT_OUTPUT_SIZE bytes. The result will be
+ *         null-terminated.
+ * log_rounds: the logarithmic cost.
+ * rseed: a seed of BCRYPT_MAXSALT bytes. Should be obtained from a
+ *        cryptographically secure random source.
+ * Returns: output
+ */
+char *ruby_bcrypt_gensalt(char *output, uint8_t log_rounds, uint8_t *rseed);
+
+/*
+ * Given a secret and a salt, generates a salted hash (which you can then store safely).
+ *
+ * output: the computed salted hash will be stored here. This buffer must
+ *         be at least BCRYPT_OUTPUT_SIZE bytes, and will become null-terminated.
+ * key: A null-terminated secret.
+ * salt: The salt, as generated by bcrypt_gensalt().
+ * Returns: output on success, NULL on error.
+ */
+char *ruby_bcrypt(char *output, const char *key, const char *salt);
+
+#endif /* _BCRYPT_H_ */

data/ext/mri/bcrypt_ext.c

@@ -0,0 +1,87 @@
+#include "ruby.h"
+#include "bcrypt.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);
+	}
+
+#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);
+}
+
+/* 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;
+	}
+}
+
+/* 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);
+}