scrypty 0.0.1

data/ext/extconf.rb

@@ -0,0 +1,32 @@
+require 'mkmf'
+
+have_library('rt', 'clock_gettime')
+have_library('crypto', 'AES_set_encrypt_key')
+%w{err.h fcntl.h inttypes.h memory.h stddef.h stdint.h stdlib.h string.h strings.h sys/endian.h sys/param.h sys/stat.h sys/time.h sys/types.h termios.h unistd.h}.each do |header|
+  have_header(header)
+end
+have_type('size_t')
+have_type('ssize_t')
+have_type('uint32_t')
+have_type('uint64_t')
+have_type('uint8_t')
+if have_header('sys/sysinfo.h')
+  if have_type('struct sysinfo', 'sys/sysinfo.h')
+    have_struct_member('struct sysinfo', 'mem_unit', 'sys/sysinfo.h')
+    have_struct_member('struct sysinfo', 'totalram', 'sys/sysinfo.h')
+  end
+end
+have_func('malloc')
+have_func('mmap')
+have_func('strtod')
+%w{clock_gettime gettimeofday memmove memset munmap posix_memalign strcspn strdup strerror strtoumax sysinfo}.each do |func|
+  have_func(func)
+end
+have_const('be64enc')
+
+system("sysctl hw.usermem >/dev/null 2>/dev/null")
+if $?.exitstatus == 0
+  $defs.push("-DHAVE_SYSCTL_HW_USERMEM=1")
+end
+create_header
+create_makefile('scrypty_ext')

data/ext/memlimit.c

@@ -0,0 +1,302 @@
+/*-
+ * Copyright 2009 Colin Percival
+ * 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.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``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 OR CONTRIBUTORS 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 file was originally written by Colin Percival as part of the Tarsnap
+ * online backup system.
+ */
+#include "scrypt_platform.h"
+
+#include <sys/types.h>
+#include <sys/resource.h>
+
+#ifdef HAVE_SYS_PARAM_H
+#include <sys/param.h>
+#endif
+#ifdef HAVE_SYSCTL_HW_USERMEM
+#include <sys/sysctl.h>
+#endif
+#ifdef HAVE_SYS_SYSINFO_H
+#include <sys/sysinfo.h>
+#endif
+
+#include <errno.h>
+#include <stddef.h>
+#include <stdint.h>
+#include <unistd.h>
+
+#ifdef DEBUG
+#include <stdio.h>
+#endif
+
+#include "memlimit.h"
+
+#ifdef HAVE_SYSCTL_HW_USERMEM
+static int
+memlimit_sysctl_hw_usermem(size_t * memlimit)
+{
+	int mib[2];
+	uint8_t usermembuf[8];
+	size_t usermemlen = 8;
+	uint64_t usermem;
+
+	/* Ask the kernel how much RAM we have. */
+	mib[0] = CTL_HW;
+	mib[1] = HW_USERMEM;
+	if (sysctl(mib, 2, usermembuf, &usermemlen, NULL, 0))
+		return (1);
+
+	/*
+	 * Parse as either a uint64_t or a uint32_t based on the length of
+	 * output the kernel reports having copied out.  It appears that all
+	 * systems providing a sysctl interface for reading integers copy
+	 * them out as system-endian values, so we don't need to worry about
+	 * parsing them.
+	 */
+	if (usermemlen == sizeof(uint64_t))
+		usermem = *(uint64_t *)usermembuf;
+	else if (usermemlen == sizeof(uint32_t))
+		usermem = *(uint32_t *)usermembuf;
+	else
+		return (1);
+
+	/* Return the sysctl value, but clamp to SIZE_MAX if necessary. */
+#if UINT64_MAX > SIZE_MAX
+	if (usermem > SIZE_MAX)
+		*memlimit = SIZE_MAX;
+	else
+		*memlimit = usermem;
+#else
+	*memlimit = usermem;
+#endif
+
+	/* Success! */
+	return (0);
+}
+#endif
+
+/* If we don't HAVE_STRUCT_SYSINFO, we can't use sysinfo. */
+#ifndef HAVE_STRUCT_SYSINFO
+#undef HAVE_SYSINFO
+#endif
+
+/* If we don't HAVE_STRUCT_SYSINFO_TOTALRAM, we can't use sysinfo. */
+#ifndef HAVE_STRUCT_SYSINFO_TOTALRAM
+#undef HAVE_SYSINFO
+#endif
+
+#ifdef HAVE_SYSINFO
+static int
+memlimit_sysinfo(size_t * memlimit)
+{
+	struct sysinfo info;
+	uint64_t totalmem;
+
+	/* Get information from the kernel. */
+	if (sysinfo(&info))
+		return (1);
+	totalmem = info.totalram;
+
+	/* If we're on a modern kernel, adjust based on mem_unit. */
+#ifdef HAVE_STRUCT_SYSINFO_MEM_UNIT
+	totalmem = totalmem * info.mem_unit;
+#endif
+
+	/* Return the value, but clamp to SIZE_MAX if necessary. */
+#if UINT64_MAX > SIZE_MAX
+	if (totalmem > SIZE_MAX)
+		*memlimit = SIZE_MAX;
+	else
+		*memlimit = totalmem;
+#else
+	*memlimit = totalmem;
+#endif
+
+	/* Success! */
+	return (0);
+}
+#endif /* HAVE_SYSINFO */
+
+static int
+memlimit_rlimit(size_t * memlimit)
+{
+	struct rlimit rl;
+	uint64_t memrlimit;
+
+	/* Find the least of... */
+	memrlimit = (uint64_t)(-1);
+
+	/* ... RLIMIT_AS... */
+#ifdef RLIMIT_AS
+	if (getrlimit(RLIMIT_AS, &rl))
+		return (1);
+	if ((rl.rlim_cur != RLIM_INFINITY) &&
+	    ((uint64_t)rl.rlim_cur < memrlimit))
+		memrlimit = rl.rlim_cur;
+#endif
+
+	/* ... RLIMIT_DATA... */
+	if (getrlimit(RLIMIT_DATA, &rl))
+		return (1);
+	if ((rl.rlim_cur != RLIM_INFINITY) &&
+	    ((uint64_t)rl.rlim_cur < memrlimit))
+		memrlimit = rl.rlim_cur;
+
+	/* ... and RLIMIT_RSS. */
+#ifdef RLIMIT_RSS
+	if (getrlimit(RLIMIT_RSS, &rl))
+		return (1);
+	if ((rl.rlim_cur != RLIM_INFINITY) &&
+	    ((uint64_t)rl.rlim_cur < memrlimit))
+		memrlimit = rl.rlim_cur;
+#endif
+
+	/* Return the value, but clamp to SIZE_MAX if necessary. */
+#if UINT64_MAX > SIZE_MAX
+	if (memrlimit > SIZE_MAX)
+		*memlimit = SIZE_MAX;
+	else
+		*memlimit = memrlimit;
+#else
+	*memlimit = memrlimit;
+#endif
+
+	/* Success! */
+	return (0);
+}
+
+#ifdef _SC_PHYS_PAGES
+
+/* Some systems define _SC_PAGESIZE instead of _SC_PAGE_SIZE. */
+#ifndef _SC_PAGE_SIZE
+#define _SC_PAGE_SIZE _SC_PAGESIZE
+#endif
+
+static int
+memlimit_sysconf(size_t * memlimit)
+{
+	long pagesize;
+	long physpages;
+	uint64_t totalmem;
+
+	/* Set errno to 0 in order to distinguish "no limit" from "error". */
+	errno = 0;
+
+	/* Read the two limits. */
+	if (((pagesize = sysconf(_SC_PAGE_SIZE)) == -1) ||
+	    ((physpages = sysconf(_SC_PHYS_PAGES)) == -1)) {
+		/* Did an error occur? */
+		if (errno != 0)
+			return (1);
+
+		/* If not, there is no limit. */
+		totalmem = (uint64_t)(-1);
+	} else {
+		/* Compute the limit. */
+		totalmem = (uint64_t)(pagesize) * (uint64_t)(physpages);
+	}
+
+	/* Return the value, but clamp to SIZE_MAX if necessary. */
+#if UINT64_MAX > SIZE_MAX
+	if (totalmem > SIZE_MAX)
+		*memlimit = SIZE_MAX;
+	else
+		*memlimit = totalmem;
+#else
+	*memlimit = totalmem;
+#endif
+
+	/* Success! */
+	return (0);
+}
+#endif
+
+int
+memtouse(size_t maxmem, double maxmemfrac, size_t * memlimit)
+{
+	size_t sysctl_memlimit, sysinfo_memlimit, rlimit_memlimit;
+	size_t sysconf_memlimit;
+	size_t memlimit_min;
+	size_t memavail;
+
+	/* Get memory limits. */
+#ifdef HAVE_SYSCTL_HW_USERMEM
+	if (memlimit_sysctl_hw_usermem(&sysctl_memlimit))
+		return (1);
+#else
+	sysctl_memlimit = (size_t)(-1);
+#endif
+#ifdef HAVE_SYSINFO
+	if (memlimit_sysinfo(&sysinfo_memlimit))
+		return (1);
+#else
+	sysinfo_memlimit = (size_t)(-1);
+#endif
+	if (memlimit_rlimit(&rlimit_memlimit))
+		return (1);
+#ifdef _SC_PHYS_PAGES
+	if (memlimit_sysconf(&sysconf_memlimit))
+		return (1);
+#else
+	sysconf_memlimit = (size_t)(-1);
+#endif
+
+#ifdef DEBUG
+	fprintf(stderr, "Memory limits are %zu %zu %zu %zu\n",
+	    sysctl_memlimit, sysinfo_memlimit, rlimit_memlimit,
+	    sysconf_memlimit);
+#endif
+
+	/* Find the smallest of them. */
+	memlimit_min = (size_t)(-1);
+	if (memlimit_min > sysctl_memlimit)
+		memlimit_min = sysctl_memlimit;
+	if (memlimit_min > sysinfo_memlimit)
+		memlimit_min = sysinfo_memlimit;
+	if (memlimit_min > rlimit_memlimit)
+		memlimit_min = rlimit_memlimit;
+	if (memlimit_min > sysconf_memlimit)
+		memlimit_min = sysconf_memlimit;
+
+	/* Only use the specified fraction of the available memory. */
+	if ((maxmemfrac > 0.5) || (maxmemfrac == 0.0))
+		maxmemfrac = 0.5;
+	memavail = maxmemfrac * memlimit_min;
+
+	/* Don't use more than the specified maximum. */
+	if ((maxmem > 0) && (memavail > maxmem))
+		memavail = maxmem;
+
+	/* But always allow at least 1 MiB. */
+	if (memavail < 1048576)
+		memavail = 1048576;
+
+#ifdef DEBUG
+	fprintf(stderr, "Allowing up to %zu memory to be used\n", memavail);
+#endif
+
+	/* Return limit via the provided pointer. */
+	*memlimit = memavail;
+	return (0);
+}

data/ext/memlimit.h

@@ -0,0 +1,42 @@
+/*-
+ * Copyright 2009 Colin Percival
+ * 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.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``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 OR CONTRIBUTORS 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 file was originally written by Colin Percival as part of the Tarsnap
+ * online backup system.
+ */
+#ifndef _MEMLIMIT_H_
+#define _MEMLIMIT_H_
+
+#include <stddef.h>
+
+/**
+ * memtouse(maxmem, maxmemfrac, memlimit):
+ * Examine the system and return via memlimit the amount of RAM which should
+ * be used -- the specified fraction of the available RAM, but no more than
+ * maxmem, and no less than 1MiB.
+ */
+int memtouse(size_t, double, size_t *);
+
+#endif /* !_MEMLIMIT_H_ */

data/ext/ruby_ext.c

@@ -0,0 +1,239 @@
+#include <ruby.h>
+#include <stdio.h>
+#include "scryptenc.h"
+
+VALUE mScrypty;
+
+VALUE eScryptyError;
+VALUE eMemoryLimitError;
+VALUE eClockTimeError;
+VALUE eDerivedKeyError;
+VALUE eSaltError;
+VALUE eOpenSSLError;
+/* Use NoMemoryError */
+VALUE eInvalidBlockError;
+VALUE eUnrecognizedFormatError;
+VALUE eNotEnoughMemoryError;
+VALUE eTooMuchTimeError;
+VALUE eIncorrectPasswordError;
+VALUE eWriteError;
+VALUE eReadError;
+
+/**
+ * Return codes from scrypt(enc|dec)_(buf|file):
+ * 0	success
+ * 1	getrlimit or sysctl(hw.usermem) failed
+ * 2	clock_getres or clock_gettime failed
+ * 3	error computing derived key
+ * 4	could not read salt from /dev/urandom
+ * 5	error in OpenSSL
+ * 6	malloc failed
+ * 7	data is not a valid scrypt-encrypted block
+ * 8	unrecognized scrypt format
+ * 9	decrypting file would take too much memory
+ * 10	decrypting file would take too long
+ * 11	password is incorrect
+ * 12	error writing output file
+ * 13	error reading input file
+ */
+static void
+raise_scrypty_error(errorcode)
+   int errorcode;
+{
+  switch (errorcode) {
+    case 1:
+      rb_raise(eMemoryLimitError, "couldn't get memory limit");
+      break;
+    case 2:
+      rb_raise(eClockTimeError, "couldn't determine CPU speed");
+      break;
+    case 3:
+      rb_raise(eDerivedKeyError, "couldn't compute derived key");
+      break;
+    case 4:
+      rb_raise(eSaltError, "couldn't read salt from /dev/urandom");
+      break;
+    case 5:
+      rb_raise(eOpenSSLError, "OpenSSL error");
+      break;
+    case 6:
+      rb_raise(rb_eNoMemError, "couldn't allocate memory");
+      break;
+    case 7:
+      rb_raise(eInvalidBlockError, "data is not a valid scrypt-encrypted block");
+      break;
+    case 8:
+      rb_raise(eUnrecognizedFormatError, "unrecognized scrypt format");
+      break;
+    case 9:
+      rb_raise(eNotEnoughMemoryError, "decrypting would take too much memory");
+      break;
+    case 10:
+      rb_raise(eTooMuchTimeError, "decrypting would take too long");
+      break;
+    case 11:
+      rb_raise(eIncorrectPasswordError, "password is incorrect");
+      break;
+    case 12:
+      rb_raise(eWriteError, "error writing output file");
+      break;
+    case 13:
+      rb_raise(eReadError, "error reading input file");
+      break;
+  }
+}
+
+VALUE
+scrypty_encrypt(rb_obj, rb_data, rb_password, rb_maxmem, rb_maxmemfrac, rb_maxtime)
+  VALUE rb_obj;
+  VALUE rb_data;
+  VALUE rb_password;
+  VALUE rb_maxmem;
+  VALUE rb_maxmemfrac;
+  VALUE rb_maxtime;
+{
+  VALUE rb_out;
+  char *data, *password, *out;
+  size_t data_len, password_len, out_len, maxmem;
+  double maxmemfrac, maxtime;
+  int errorcode;
+
+  if (TYPE(rb_data) == T_STRING) {
+    data = RSTRING_PTR(rb_data);
+    data_len = (size_t) RSTRING_LEN(rb_data);
+  }
+  else {
+    rb_raise(rb_eTypeError, "first argument (data) must be a String");
+  }
+
+  if (TYPE(rb_password) == T_STRING) {
+    password = RSTRING_PTR(rb_password);
+    password_len = (size_t) RSTRING_LEN(rb_password);
+  }
+  else {
+    rb_raise(rb_eTypeError, "second argument (password) must be a String");
+  }
+
+  if (TYPE(rb_maxmem) == T_FIXNUM) {
+    maxmem = FIX2INT(rb_maxmem);
+  }
+  else {
+    rb_raise(rb_eTypeError, "third argument (maxmem) must be a Fixnum");
+  }
+
+  if (FIXNUM_P(rb_maxmemfrac) || TYPE(rb_maxmemfrac) == T_FLOAT) {
+    maxmemfrac = NUM2DBL(rb_maxmemfrac);
+  }
+  else {
+    rb_raise(rb_eTypeError, "fourth argument (maxmemfrac) must be a Fixnum or Float");
+  }
+
+  if (FIXNUM_P(rb_maxtime) || TYPE(rb_maxtime) == T_FLOAT) {
+    maxtime = NUM2DBL(rb_maxtime);
+  }
+  else {
+    rb_raise(rb_eTypeError, "fifth argument (maxtime) must be a Fixnum or Float");
+  }
+
+  out_len = data_len + 128;
+  rb_out = rb_str_new(NULL, out_len);
+  out = RSTRING_PTR(rb_out);
+
+  errorcode = scryptenc_buf((const uint8_t *) data, data_len,
+      (uint8_t *) out, (const uint8_t *) password, password_len,
+      maxmem, maxmemfrac, maxtime);
+  if (errorcode) {
+    raise_scrypt_error(errorcode);
+  }
+  rb_str_set_len(rb_out, out_len);
+
+  return rb_out;
+}
+
+VALUE
+scrypty_decrypt(rb_obj, rb_data, rb_password, rb_maxmem, rb_maxmemfrac, rb_maxtime)
+  VALUE rb_obj;
+  VALUE rb_data;
+  VALUE rb_password;
+  VALUE rb_maxmem;
+  VALUE rb_maxmemfrac;
+  VALUE rb_maxtime;
+{
+  VALUE rb_out;
+  char *data, *password, *out;
+  size_t data_len, password_len, out_len, maxmem;
+  double maxmemfrac, maxtime;
+  int errorcode;
+
+  if (TYPE(rb_data) == T_STRING) {
+    data = RSTRING_PTR(rb_data);
+    data_len = (size_t) RSTRING_LEN(rb_data);
+  }
+  else {
+    rb_raise(rb_eTypeError, "first argument (data) must be a String");
+  }
+
+  if (TYPE(rb_password) == T_STRING) {
+    password = RSTRING_PTR(rb_password);
+    password_len = (size_t) RSTRING_LEN(rb_password);
+  }
+  else {
+    rb_raise(rb_eTypeError, "second argument (password) must be a String");
+  }
+
+  if (TYPE(rb_maxmem) == T_FIXNUM) {
+    maxmem = FIX2INT(rb_maxmem);
+  }
+  else {
+    rb_raise(rb_eTypeError, "third argument (maxmem) must be a Fixnum");
+  }
+
+  if (FIXNUM_P(rb_maxmemfrac) || TYPE(rb_maxmemfrac) == T_FLOAT) {
+    maxmemfrac = NUM2DBL(rb_maxmemfrac);
+  }
+  else {
+    rb_raise(rb_eTypeError, "fourth argument (maxmemfrac) must be a Fixnum or Float");
+  }
+
+  if (FIXNUM_P(rb_maxtime) || TYPE(rb_maxtime) == T_FLOAT) {
+    maxtime = NUM2DBL(rb_maxtime);
+  }
+  else {
+    rb_raise(rb_eTypeError, "fifth argument (maxtime) must be a Fixnum or Float");
+  }
+
+  rb_out = rb_str_new(NULL, data_len);
+  out = RSTRING_PTR(rb_out);
+
+  errorcode = scryptdec_buf((const uint8_t *) data, data_len,
+      (uint8_t *) out, &out_len, (const uint8_t *) password, password_len,
+      maxmem, maxmemfrac, maxtime);
+  if (errorcode) {
+    raise_scrypty_error(errorcode);
+  }
+  rb_str_set_len(rb_out, out_len);
+
+  return rb_out;
+}
+
+void
+Init_scrypty_ext(void)
+{
+  mScrypty = rb_define_module("Scrypty");
+  rb_define_singleton_method(mScrypty, "encrypt", scrypty_encrypt, 5);
+  rb_define_singleton_method(mScrypty, "decrypt", scrypty_decrypt, 5);
+
+  eScryptyError = rb_define_class_under(mScrypty, "Exception", rb_eException);
+  eMemoryLimitError = rb_define_class_under(mScrypty, "MemoryLimitError", eScryptyError);
+  eClockTimeError = rb_define_class_under(mScrypty, "ClockTimeError", eScryptyError);
+  eDerivedKeyError = rb_define_class_under(mScrypty, "DerivedKeyError", eScryptyError);
+  eSaltError = rb_define_class_under(mScrypty, "SaltError", eScryptyError);
+  eOpenSSLError = rb_define_class_under(mScrypty, "OpenSSLError", eScryptyError);
+  eInvalidBlockError = rb_define_class_under(mScrypty, "InvalidBlockError", eScryptyError);
+  eUnrecognizedFormatError = rb_define_class_under(mScrypty, "UnrecognizedFormatError", eScryptyError);
+  eNotEnoughMemoryError = rb_define_class_under(mScrypty, "NotEnoughMemoryError", eScryptyError);
+  eTooMuchTimeError = rb_define_class_under(mScrypty, "TooMuchTimeError", eScryptyError);
+  eIncorrectPasswordError = rb_define_class_under(mScrypty, "IncorrectPasswordError", eScryptyError);
+  eWriteError = rb_define_class_under(mScrypty, "WriteError", eScryptyError);
+  eReadError = rb_define_class_under(mScrypty, "ReadError", eScryptyError);
+}

data/ext/scrypt_platform.h

@@ -0,0 +1,6 @@
+#ifndef _SCRYPT_PLATFORM_H_
+#define	_SCRYPT_PLATFORM_H_
+
+#include "extconf.h"
+
+#endif /* !_SCRYPT_PLATFORM_H_ */