Make this library drop-in replacement for other erlang implementations (#4)

* Make this library drop-in replacement for other erlang implementations

* Update README

Author: kpy3

README.md

@@ -1,12 +1,13 @@
-erlscrypt
-=========
+Erlang NIF for scrypt
+=====================
 
 [![Build Status](https://github.com/kpy3/erlscrypt/workflows/Test/badge.svg)](https://github.com/kpy3/erlscrypt/actions?query=branch%3Amaster+workflow%3A"Test") [![Erlang Versions](https://img.shields.io/badge/Supported%20Erlang%2FOTP-21.0%20to%2023.0-blue)](http://www.erlang.org)
 
 
-An Erlang NIF for Colin Percival's "scrypt" function.
+An Erlang NIF for Colin Percival's "scrypt" function. It uses dirty CPU schedulers for
+generating hash, leaving main schedulers for Erlang applications.   
 
-General information can be found in [these slides (PDF)](http://www.tarsnap.com/scrypt/scrypt-slides.pdf)
+General information about scrypt can be found in [these slides (PDF)](http://www.tarsnap.com/scrypt/scrypt-slides.pdf)
 and [Colin Percival's page on scrypt](http://www.tarsnap.com/scrypt.html).
 
 This library uses code from scrypt [1.3.1](https://github.com/Tarsnap/scrypt/tree/1.3.1).
@@ -20,15 +21,15 @@ Add library as dependency in `rebar.config`
         ...
     ]}.
 
-Add `erlscrypt` as application dependency
+Add `scrypt` as application dependency
 
     {application, app,
          [
           {applications, [
                           ...
-                          erlscrypt
+                          scrypt
                          ]},
           ...
          ]}. 
 
-Use `erlscrypt:scrypt/6` for encrypting data.
+Use `scrypt:scrypt/6` for encrypting data.

c_src/Makefile

@@ -3,8 +3,7 @@
 CURDIR := $(shell pwd)
 BASEDIR := $(abspath $(CURDIR)/..)
 
-PROJECT ?= $(notdir $(BASEDIR))
-PROJECT := $(strip $(PROJECT))
+PROJECT := scrypt
 
 ERTS_INCLUDE_DIR ?= $(shell erl -noshell -s init stop -eval "io:format(\"~ts/erts-~ts/include/\", [code:root_dir(), erlang:system_info(version)]).")
 ERL_INTERFACE_INCLUDE_DIR ?= $(shell erl -noshell -s init stop -eval "io:format(\"~ts\", [code:lib_dir(erl_interface, include)]).")

c_src/scrypt_nif.c

@@ -14,12 +14,6 @@ static ERL_NIF_TERM mk_atom(ErlNifEnv *env, const char *atom) {
   return ret;
 }
 
-static ERL_NIF_TERM report_bad_param(ErlNifEnv *env, const char *param) {
-  return enif_raise_exception(
-      env, enif_make_tuple2(env, mk_atom(env, "bad_param"),
-                            enif_make_string(env, param, ERL_NIF_LATIN1)));
-}
-
 static ERL_NIF_TERM report_allocation_error(ErlNifEnv *env) {
   return enif_raise_exception(env, mk_atom(env, "allocation_error"));
 }
@@ -39,27 +33,27 @@ static ERL_NIF_TERM scrypt(ErlNifEnv *env, int argc,
   }
 
   if (!enif_inspect_binary(env, argv[0], &passwd)) {
-    return report_bad_param(env, "Passwd");
+    return enif_make_badarg(env);
   }
 
   if (!enif_inspect_binary(env, argv[1], &salt)) {
-    return report_bad_param(env, "Salt");
+    return enif_make_badarg(env);
   }
 
   if (!enif_get_uint(env, argv[2], &N)) {
-    return report_bad_param(env, "N");
+    return enif_make_badarg(env);
   }
 
   if (!enif_get_uint(env, argv[3], &r)) {
-    return report_bad_param(env, "R");
+    return enif_make_badarg(env);
   }
 
   if (!enif_get_uint(env, argv[4], &p)) {
-    return report_bad_param(env, "P");
+    return enif_make_badarg(env);
   }
 
   if (!enif_get_ulong(env, argv[5], &buf_len)) {
-    return report_bad_param(env, "Buflen");
+    return enif_make_badarg(env);
   }
 
   if (!enif_alloc_binary(buf_len, &result)) {
@@ -77,4 +71,4 @@ static ERL_NIF_TERM scrypt(ErlNifEnv *env, int argc,
 static ErlNifFunc nif_funcs[] = {
     {"scrypt", 6, scrypt, ERL_NIF_DIRTY_JOB_CPU_BOUND}};
 
-ERL_NIF_INIT(erlscrypt, nif_funcs, NULL, NULL, NULL, NULL);
+ERL_NIF_INIT(scrypt, nif_funcs, NULL, NULL, NULL, NULL);

src/erlscrypt.app.src src/scrypt.app.srcsrc/erlscrypt.app.src renamed to src/scrypt.app.src

@@ -1,6 +1,6 @@
-{application, erlscrypt,
+{application, scrypt,
  [{description, "Erlang NIF for scrypt"},
-  {vsn, "1.1.0"},
+  {vsn, "2.0.0"},
   {registered, []},
   {mod, {scrypt, []}},
   {applications,

src/erlscrypt.erl src/scrypt.erlsrc/erlscrypt.erl renamed to src/scrypt.erl

@@ -1,4 +1,4 @@
--module(erlscrypt).
+-module(scrypt).
 -on_load(init/0).
 
 -behaviour(application).
@@ -7,7 +7,7 @@
 -export([scrypt/6]).
 
 -define(APPNAME, scrypt_nif).
--define(LIBNAME, erlscrypt).
+-define(LIBNAME, scrypt).
 
 %%%-------------------------------------------------------------------
 %%% Application callbacks
@@ -105,21 +105,21 @@ testvec4_test() ->
          = scrypt(<<"pleaseletmein">>, <<"SodiumChloride">>, 1048576, 8, 1, 64).
 
 check_bad_param_passwd_test() ->
-    ?assertException(error, {bad_param, "Passwd"}, scrypt(1, <<"">>, 1048576, 8, 1, 64)).
+    ?assertException(error, badarg, scrypt(1, <<"">>, 1048576, 8, 1, 64)).
 
 check_bad_param_salt_test() ->
-    ?assertException(error, {bad_param, "Salt"}, scrypt(<<"">>, 2, 1048576, 8, 1, 64)).
+    ?assertException(error, badarg, scrypt(<<"">>, 2, 1048576, 8, 1, 64)).
 
 check_bad_param_N_test() ->
-    ?assertException(error, {bad_param, "N"}, scrypt(<<"">>, <<"">>, "1048576", 8, 1, 64)).
+    ?assertException(error, badarg, scrypt(<<"">>, <<"">>, "1048576", 8, 1, 64)).
 
 check_bad_param_P_test() ->
-    ?assertException(error, {bad_param, "R"}, scrypt(<<"">>, <<"">>, 1048576, "8", 1, 64)).
+    ?assertException(error, badarg, scrypt(<<"">>, <<"">>, 1048576, "8", 1, 64)).
 
 check_bad_param_R_test() ->
-    ?assertException(error, {bad_param, "P"}, scrypt(<<"">>, <<"">>, 1048576, 8, "1", 64)).
+    ?assertException(error, badarg, scrypt(<<"">>, <<"">>, 1048576, 8, "1", 64)).
 
 check_bad_param_Buflen_test() ->
-    ?assertException(error, {bad_param, "Buflen"}, scrypt(<<"">>, <<"">>, 1048576, 8, 1, "64")).
+    ?assertException(error, badarg, scrypt(<<"">>, <<"">>, 1048576, 8, 1, "64")).
 
 -endif.