argon2 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a7a9392b4bb8cdc56418814da31cafecd75a4541
-  data.tar.gz: 3f3bb552897de92e5ef3f0633a24608b1fb36e2f
+  metadata.gz: 4679e5dd53222a5799fac835361a04a77ae696ae
+  data.tar.gz: f53efbb7d825c9e271a6812a03340dc951b58c9b
 SHA512:
-  metadata.gz: 9cd94e1f77f4fab2eab9e4365e5e7381006eb718d24bdb6da0263c370a685cea685518488b5e13290dd6b0955b8e781f1f078bf73b2d9a1907a84244701919a4
-  data.tar.gz: 4c2b3f6cac4ba08e2fdfa2f3e09c98fdb493e82e57a0631aa9c52c3a9086953fe4dd5b87531f89535db72d72367026dcc423e613dc9e5ebe0935ee76591cbcf3
+  metadata.gz: bd1070534755d5f6582e6030b2b2e8907deca141553a1f767827ada8816321a16418ac245aa3e5c7453534ae93a649b5173bfe96cc1c3742f380d7194f22328b
+  data.tar.gz: 9e912c470b069e3b45a3253b7ad7761138d695468e8a5c65aa8495a98f7bcddf0c0cb1d708ee1165c87b9619e655bcf7ff29b1727e83f9190a46ce22a2d497c3

data/.gitignore

@@ -7,3 +7,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/vendor
+/ext/argon2_wrap/libargon2_wrap.so
+/ext/argon2_wrap/tests
+argon2-0.0.2.gem

data/.travis.yml

@@ -1,4 +1,6 @@
 language: ruby
 rvm:
   - 2.2.3
+  - jruby-9000
 before_install: gem install bundler -v 1.10.5
+install: bin/setup

data/README.md

@@ -1,23 +1,39 @@
 # Argon2
 
-An FFI binding for Argon2.
-This gem is unfinished.
+This Ruby Gem provides FFI bindings, and a simplified interface, to the Argon2 algorithm. [Argon2](https://github.com/P-H-C/phc-winner-argon2) is the official winner of the Password Hashing Competition, a several year project to identify a successor to bcrypt/PBKDF/scrypt methods of securely storing passwords. This is an independant project and not official from the PHC team.
 
+*This gem is still in early development* and at this point is not recommended for use, even in testing.
 
-TODO: Delete this and the text above, and describe your gem
+For early documentation, please see the test cases, which currently demonstrate low level hashing capabilities.
 
-## Installation
+[![Build Status](https://travis-ci.org/technion/ruby-argon2.svg?branch=master)](https://travis-ci.org/technion/ruby-argon2)
 
-Add this line to your application's Gemfile:
+## Design
 
-```ruby
-gem 'argon2'
-```
+This project has several key tenants to its design:
 
+* The reference Argon2 implementation is to be used "unaltered". To ensure this does not occur, and encourage regular updates from upstream, this is implemented as a git submodule, and is intended to stay that way.
+* The FFI interface is kept as slim as possible, with wrapper classes preferred to implementing context structs in FFI
+* Security and maintainability take top priority. This can have an impact on platform support. A PR that contains platform specific code paths is unlikely to be accepted.
+* Errors from the C interface are raised as Exceptions. There are a lot of exception classes, but they tend to relate to things like very broken input, and code bugs. Calls to this library should generally not require a rescue.
+* Test suits are aimed to be very comprehensive.
+
+## FAQ
+### Don't roll your own crypto!
+
+This gets its own section because someone will raise it. I did not invent or alter this algorithm, or implement it directly.
+
+### "Secure wipe is useless"
+
+Although the low level C contains support for "secure memory wipe", any code hitting that layer has copied your password to a dozen places in memory. It should be assumed that such functionality does not exist.
+
+### Work maximums may be tighter than reference
+
+The reference implementation is aimed to provide secure hashing for many years. This implementation doesn't want you to DoS yourself in the meantime. Accordingly, some limits artificial limits exist on work powers. This gem can be much more agile in raising these as technology progresses.
 
 ## Contributing
 
-Not yet - the code is in a high state of flux.
+Not yet - the code is in a high state of flux. If you feel you have identified a security issue, please email me directly. For any other bugs, it is too early to review them.
 
 ## License
 

data/argon2.gemspec

@@ -15,12 +15,20 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+#  submodule_path = 'ext/phc-winner-argon2/src'
+#  `ls #{submodule_path}`.split.each do |filename|
+#    spec.files << "#{submodule_path}/#{filename}"
+#  end
+  spec.files << `find ext`.split
+  
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  spec.add_dependency 'ffi-compiler'
+  spec.add_dependency 'ffi', '~> 1.9'
+  spec.add_dependency 'ffi-compiler', '~> 0.1'
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest", '~> 5'
+  spec.extensions << 'ext/argon2_wrap/extconf.rb'
 end

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "ruby/argon2"
+require "argon2"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/bin/setup

@@ -3,5 +3,8 @@ set -euo pipefail
 IFS=$'\n\t'
 
 bundle install
+cd ext/argon2_wrap/
+make
+cd ../..
 
 # Do any other automated setup that you need to do here

data/ext/argon2_wrap/Makefile

@@ -0,0 +1,72 @@
+# Argon Wrapper Makefile
+# This file is based on the original Argon2 reference
+# Argon2 source code package
+# 
+# This work is licensed under a Creative Commons CC0 1.0 License/Waiver.
+# 
+# You should have received a copy of the CC0 Public Domain Dedication along with
+# this software. If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
+#
+
+DIST_SRC = ../phc-winner-argon2/src
+CC = gcc
+SRC = $(DIST_SRC)/argon2.c $(DIST_SRC)/core.c $(DIST_SRC)/blake2/blake2b.c $(DIST_SRC)/thread.c argon_wrap.c
+OBJ = $(SRC:.c=.o)
+
+CFLAGS = -std=c89 -pthread -O3 -Wall -g
+
+OPT=TRUE
+ifeq ($(OPT), TRUE)
+	CFLAGS += -march=native
+	SRC += $(DIST_SRC)/opt.c
+else
+	SRC += $(DIST_SRC)/ref.c
+endif
+
+BUILD_PATH := $(shell pwd)
+KERNEL_NAME := $(shell uname -s)
+
+LIB_NAME=argon2_wrap
+ifeq ($(KERNEL_NAME), Linux)
+	LIB_EXT := so
+	LIB_CFLAGS := -shared -fPIC
+	LIB_PATH := -Wl,-rpath=$(BUILD_PATH)
+endif
+ifeq ($(KERNEL_NAME), NetBSD)
+	LIB_EXT := so
+	LIB_CFLAGS := -shared -fPIC
+	LIB_PATH := -Wl,-rpath=$(BUILD_PATH)
+endif
+ifeq ($(KERNEL_NAME), Darwin)
+	LIB_EXT := dylib
+	LIB_CFLAGS := -dynamiclib -install_name @rpath/lib$(LIB_NAME).$(LIB_EXT)
+	LIB_PATH := -Xlinker -rpath -Xlinker $(BUILD_PATH)
+endif
+ifeq ($(findstring MINGW, $(KERNEL_NAME)), MINGW)
+	LIB_EXT := dll
+	LIB_CFLAGS := -shared -Wl,--out-implib,lib$(LIB_NAME).$(LIB_EXT).a
+	LIB_PATH := -Wl,-rpath=$(BUILD_PATH)
+endif
+ifeq ($(KERNEL_NAME), $(filter $(KERNEL_NAME),OpenBSD FreeBSD))
+	LIB_EXT := so
+	LIB_CFLAGS := -shared -fPIC
+	LIB_PATH := -Wl,-rpath=$(BUILD_PATH)
+endif
+
+LIB_SH := lib$(LIB_NAME).$(LIB_EXT)
+
+all: libs 
+libs: $(SRC)
+		$(CC) $(CFLAGS) $(LIB_CFLAGS) $^ -o libargon2_wrap.so
+
+#Deliberately avoiding the CFLAGS for our test cases - disable optimise and
+#C89
+test: $(SRC) test.c
+		$(CC) -pthread -O3 -Wall -g $^ -o tests
+		./tests
+
+clean:
+	rm -rf tests libargon2_wrap.so
+
+install:
+	echo none

data/ext/argon2_wrap/argon_wrap.c

@@ -0,0 +1,65 @@
+/* Wrapper for argon Ruby bindings
+ * lolware.net
+ * Much of this code is based on run.c from the reference implementation
+ */
+
+#include <stdio.h>
+#include <stdint.h>
+#include <inttypes.h>
+#include <stdlib.h>
+#include <string.h>
+#include <time.h>
+
+#include "../phc-winner-argon2/src/argon2.h"
+#include "../phc-winner-argon2/src/core.h"
+
+#define T_COST_DEF 3
+#define LOG_M_COST_DEF 12 /* 2^12 = 4 MiB */
+#define LANES_DEF 1
+#define THREADS_DEF 1
+#define OUT_LEN 32
+#define SALT_LEN 16
+
+unsigned int argon2_wrap(char *out, char *pwd, uint8_t *salt, uint32_t t_cost,
+                uint32_t m_cost, uint32_t lanes)
+{
+    unsigned pwd_length;
+    uint8_t hash[OUT_LEN];
+    argon2_context context;
+
+    if (!pwd) {
+        return ARGON2_PWD_PTR_MISMATCH;
+    }
+
+    if (!salt) {
+        return ARGON2_PWD_PTR_MISMATCH;
+    }
+
+    pwd_length = strlen(pwd);
+
+    context.out = hash;
+    context.outlen = OUT_LEN;
+    context.pwd = (uint8_t *)pwd;
+    context.pwdlen = pwd_length;
+    context.salt = salt;
+    context.saltlen = SALT_LEN;
+    context.secret = NULL;
+    context.secretlen = 0;
+    context.ad = NULL;
+    context.adlen = 0;
+    context.t_cost = t_cost;
+    context.m_cost = m_cost;
+    context.lanes = lanes;
+    context.threads = lanes;
+    context.allocate_cbk = NULL;
+    context.free_cbk = NULL;
+    context.flags = 0;
+
+    int result = argon2i(&context);
+    if (result != ARGON2_OK)
+        return result;
+
+    encode_string(out, 300, &context);
+    return ARGON2_OK;
+}
+ 

data/ext/argon2_wrap/extconf.rb

@@ -0,0 +1 @@
+#I must admit I have no understanding of why this empty file works.

data/ext/argon2_wrap/test.c

@@ -0,0 +1,67 @@
+/* Wrapper for argon Ruby bindings
+ * lolware.net
+ * Much of this code is based on run.c from the reference implementation
+ */
+#include <stdio.h>
+#include <stdint.h>
+#include <inttypes.h>
+#include <stdlib.h>
+#include <string.h>
+#include <time.h>
+
+#include "../phc-winner-argon2/src/argon2.h"
+
+#define OUT_LEN 32
+#define SALT_LEN 16
+
+
+
+void argon2_wrap(char *out, char *pwd, uint8_t *salt, uint32_t t_cost,
+    uint32_t m_cost, uint32_t lanes);
+ 
+int main()
+{
+    unsigned char out[OUT_LEN];
+    char out2[300];
+    char *pwd = NULL;
+    uint8_t salt[SALT_LEN];
+    int i;
+
+    pwd = strdup("password");
+    memset(salt, 0x00, SALT_LEN); /* pad with null bytes */
+    memcpy(salt, "somesalt", 8);
+
+
+    /* ./argon2 password somesalt -t 2 -m 16
+     *  Hash: 894af4ff2e2d26f3ce15f77a7e1c25db45b4e20439e9961772ba199caddb001e
+     * ./argon2 password somesalt -t 2 -m 20
+     * Hash: 58d4d929aeeafa40cc049f032035784fb085e8e0d0c5a51ea067341a93d6d286
+     * ./argon2 password somesalt -t 2 -m 18
+     * Hash: 55292398cce8fc78685e610d004ca9bda5c325a0a2e6285a0de5f816df139aa6
+     * ./argon2 password somesalt -t 2 -m 8
+     * Hash: e346b1e1aa7ca58c9bb862e223ba5604064398d4394e49e90972c6b54cef43ed
+     * ./argon2 password somesalt -t 1 -m 16
+     * Hash: b49199e4ecb0f6659e6947f945e391c940b17106e1d0b0a9888006c7f87a789b
+     * ./argon2 password somesalt -t 4 -m 16
+     * Hash: 72207b3312d79995fbe7b30664837ae1246f9a98e07eac34835ca3498e705f85
+     * ./argon2 differentpassword somesalt -t 2 -m 16 -p 1
+     * Hash: 8e286f605ed7383987a4aac25a28a04808593b6e17613bc31457146c4f3f4361
+     * ./argon2 password diffsalt -t 2 -m 16 -p 1
+     * Hash: 8f65b47d902fb2aee5e0b2bdc9041b249fc11f06f35551e0bee52716b41e8311
+     */
+    hash_argon2i( out, OUT_LEN, pwd, strlen(pwd), salt, SALT_LEN, 2, 1<<16 );
+    for(i=0; i<32; ++i )
+        printf( "%02x", out[i] );
+    printf( "\n" );
+
+    strcpy(pwd, "password"); /* hash_argon2i wipes password content */
+    argon2_wrap(out2, pwd, salt, 2, 1<<16, 1);
+    printf("%s\n", out2);
+    free(pwd);;
+
+
+    return 0;
+
+
+}
+

data/ext/phc-winner-argon2/.gitignore

@@ -0,0 +1,7 @@
+argon2
+libargon2.a
+libargon2.so
+libargon2.dylib
+.DS_Store
+src/*.o
+src/blake2/*.o

data/ext/phc-winner-argon2/LICENSE

@@ -0,0 +1,31 @@
+     CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED HEREUNDER. 
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer exclusive Copyright and Related Rights (defined below) upon the creator and subsequent owner(s) (each and all, an "owner") of an original work of authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for the purpose of contributing to a commons of creative, cultural and scientific works ("Commons") that the public can reliably and without fear of later claims of infringement build upon, modify, incorporate in other works, reuse and redistribute as freely as possible in any form whatsoever and for any purposes, including without limitation commercial purposes. These owners may contribute to the Commons to promote the ideal of a free culture and the further production of creative, cultural and scientific works, or to gain reputation or greater distribution for their Work in part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any expectation of additional consideration or compensation, the person associating CC0 with a Work (the "Affirmer"), to the extent that he or she is an owner of Copyright and Related Rights in the Work, voluntarily elects to apply CC0 to the Work and publicly distribute the Work under its terms, with knowledge of his or her Copyright and Related Rights in the Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be protected by copyright and related or neighboring rights ("Copyright and Related Rights"). Copyright and Related Rights include, but are not limited to, the following:
+
+    the right to reproduce, adapt, distribute, perform, display, communicate, and translate a Work;
+    moral rights retained by the original author(s) and/or performer(s);
+    publicity and privacy rights pertaining to a person's image or likeness depicted in a Work;
+    rights protecting against unfair competition in regards to a Work, subject to the limitations in paragraph 4(a), below;
+    rights protecting the extraction, dissemination, use and reuse of data in a Work;
+    database rights (such as those arising under Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, and under any national implementation thereof, including any amended or successor version of such directive); and
+    other similar, equivalent or corresponding rights throughout the world based on applicable law or treaty, and any national implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention of, applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and unconditionally waives, abandons, and surrenders all of Affirmer's Copyright and Related Rights and associated claims and causes of action, whether now known or unknown (including existing as well as future claims and causes of action), in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each member of the public at large and to the detriment of Affirmer's heirs and successors, fully intending that such Waiver shall not be subject to revocation, rescission, cancellation, termination, or any other legal or equitable action to disrupt the quiet enjoyment of the Work by the public as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason be judged legally invalid or ineffective under applicable law, then the Waiver shall be preserved to the maximum extent permitted taking into account Affirmer's express Statement of Purpose. In addition, to the extent the Waiver is so judged Affirmer hereby grants to each affected person a royalty-free, non transferable, non sublicensable, non exclusive, irrevocable and unconditional license to exercise Affirmer's Copyright and Related Rights in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "License"). The License shall be deemed effective as of the date CC0 was applied by Affirmer to the Work. Should any part of the License for any reason be judged legally invalid or ineffective under applicable law, such partial invalidity or ineffectiveness shall not invalidate the remainder of the License, and in such case Affirmer hereby affirms that he or she will not (i) exercise any of his or her remaining Copyright and Related Rights in the Work or (ii) assert any associated claims and causes of action with respect to the Work, in either case contrary to Affirmer's express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+    No trademark or patent rights held by Affirmer are waived, abandoned, surrendered, licensed or otherwise affected by this document.
+    Affirmer offers the Work as-is and makes no representations or warranties of any kind concerning the Work, express, implied, statutory or otherwise, including without limitation warranties of title, merchantability, fitness for a particular purpose, non infringement, or the absence of latent or other defects, accuracy, or the present or absence of errors, whether or not discoverable, all to the greatest extent permissible under applicable law.
+    Affirmer disclaims responsibility for clearing rights of other persons that may apply to the Work or any use thereof, including without limitation any person's Copyright and Related Rights in the Work. Further, Affirmer disclaims responsibility for obtaining any necessary consents, permissions or other rights required for any use of the Work.
+    Affirmer understands and acknowledges that Creative Commons is not a party to this document and has no duty or obligation with respect to this CC0 or use of the Work.
+

data/ext/phc-winner-argon2/Makefile

@@ -0,0 +1,102 @@
+#
+# Argon2 source code package
+# 
+# This work is licensed under a Creative Commons CC0 1.0 License/Waiver.
+# 
+# You should have received a copy of the CC0 Public Domain Dedication along with
+# this software. If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
+#
+
+RUN = argon2
+BENCH = bench
+GENKAT = genkat
+
+DIST = phc-winner-argon2
+
+CC = gcc
+SRC = src/argon2.c src/core.c src/blake2/blake2b.c src/thread.c
+SRC_RUN = src/run.c
+SRC_BENCH = src/bench.c
+SRC_GENKAT = src/genkat.c
+OBJ = $(SRC:.c=.o)
+
+CFLAGS = -std=c89 -pthread -O3 -Wall -g
+
+#OPT=TRUE
+ifeq ($(OPT), TRUE)
+	CFLAGS += -march=native
+	SRC += src/opt.c
+else
+	SRC += src/ref.c
+endif
+
+BUILD_PATH := $(shell pwd)
+KERNEL_NAME := $(shell uname -s)
+
+LIB_NAME=argon2
+ifeq ($(KERNEL_NAME), Linux)
+	LIB_EXT := so
+	LIB_CFLAGS := -shared -fPIC
+	LIB_PATH := -Wl,-rpath=$(BUILD_PATH)
+endif
+ifeq ($(KERNEL_NAME), NetBSD)
+	LIB_EXT := so
+	LIB_CFLAGS := -shared -fPIC
+	LIB_PATH := -Wl,-rpath=$(BUILD_PATH)
+endif
+ifeq ($(KERNEL_NAME), Darwin)
+	LIB_EXT := dylib
+	LIB_CFLAGS := -dynamiclib -install_name @rpath/lib$(LIB_NAME).$(LIB_EXT)
+	LIB_PATH := -Xlinker -rpath -Xlinker $(BUILD_PATH)
+endif
+ifeq ($(findstring MINGW, $(KERNEL_NAME)), MINGW)
+	LIB_EXT := dll
+	LIB_CFLAGS := -shared -Wl,--out-implib,lib$(LIB_NAME).$(LIB_EXT).a
+	LIB_PATH := -Wl,-rpath=$(BUILD_PATH)
+endif
+ifeq ($(KERNEL_NAME), $(filter $(KERNEL_NAME),OpenBSD FreeBSD))
+	LIB_EXT := so
+	LIB_CFLAGS := -shared -fPIC
+	LIB_PATH := -Wl,-rpath=$(BUILD_PATH)
+endif
+
+LIB_SH := lib$(LIB_NAME).$(LIB_EXT)
+LIB_ST := lib$(LIB_NAME).a
+
+.PHONY: clean dist format $(GENKAT)
+
+all: clean $(RUN) libs 
+libs: $(LIB_SH) $(LIB_ST)
+
+$(RUN):	        $(SRC) $(SRC_RUN)
+		$(CC) $(CFLAGS) $^ -Isrc  -o $@
+
+$(BENCH):       $(SRC) $(SRC_BENCH)
+		$(CC) $(CFLAGS) $^ -Isrc  -o $@
+
+$(GENKAT):      $(SRC) $(SRC_GENKAT)
+		$(CC) $(CFLAGS) $^ -Isrc  -o $@ -DGENKAT
+
+$(LIB_SH): 	$(SRC)
+		$(CC) $(CFLAGS) $(LIB_CFLAGS) $^ -Isrc -o $@
+
+$(LIB_ST): 	$(OBJ)
+		ar rcs $@ $^
+
+clean:
+		rm -f $(RUN) $(BENCH) $(GENKAT)
+		rm -f $(LIB_SH) $(LIB_ST) kat-argon2* 
+		rm -rf *.dSYM
+		cd src/ && rm -f *.o
+		cd src/blake2/ && rm -f *.o
+		cd kats/ &&  rm -f kat-* diff* run_* make_*
+
+dist:
+		cd ..; \
+		tar -c --exclude='.??*' -z -f $(DIST)-`date "+%Y%m%d"`.tgz $(DIST)/*
+
+test:
+		@sh kats/test.sh
+
+format:
+		clang-format -style="{BasedOnStyle: llvm, IndentWidth: 4}" -i src/*.c src/*.h src/blake2/*.c src/blake2/*.h