refactor(emqx_password): move the module to emqx application

Future plugins will require emqx as a dependency.
This commit also brings back bcrypt to the system which was temporary
removed when converting to umbrella project

apps/emqx_auth_ldap/src/emqx_auth_ldap.app.src

@@ -3,7 +3,7 @@
   {vsn, "4.3.0"}, % strict semver, bump manually!
   {modules, []},
   {registered, [emqx_auth_ldap_sup]},
-  {applications, [kernel,stdlib,eldap2,ecpool,emqx_passwd]},
+  {applications, [kernel,stdlib,eldap2,ecpool]},
   {mod, {emqx_auth_ldap_app,[]}},
   {env, []},
   {licenses, ["Apache-2.0"]},

apps/emqx_auth_mongo/src/emqx_auth_mongo.app.src

@@ -3,7 +3,7 @@
   {vsn, "4.3.0"}, % strict semver, bump manually!
   {modules, []},
   {registered, [emqx_auth_mongo_sup]},
-  {applications, [kernel,stdlib,mongodb,ecpool,emqx_passwd]},
+  {applications, [kernel,stdlib,mongodb,ecpool,emqx]},
   {mod, {emqx_auth_mongo_app,[]}},
   {env, []},
   {licenses, ["Apache-2.0"]},

apps/emqx_auth_mysql/src/emqx_auth_mysql.app.src

@@ -3,7 +3,7 @@
   {vsn, "4.3.0"}, % strict semver, bump manually!
   {modules, []},
   {registered, [emqx_auth_mysql_sup]},
-  {applications, [kernel,stdlib,mysql,ecpool,emqx_passwd]},
+  {applications, [kernel,stdlib,mysql,ecpool]},
   {mod, {emqx_auth_mysql_app,[]}},
   {env, []},
   {licenses, ["Apache-2.0"]},

apps/emqx_auth_pgsql/src/emqx_auth_pgsql.app.src

@@ -3,7 +3,7 @@
   {vsn, "4.3.0"}, % strict semver, bump manually!
   {modules, []},
   {registered, [emqx_auth_pgsql_sup]},
-  {applications, [kernel,stdlib,epgsql,ecpool,emqx_passwd]},
+  {applications, [kernel,stdlib,epgsql,ecpool,emqx]},
   {mod, {emqx_auth_pgsql_app,[]}},
   {env, []},
   {licenses, ["Apache-2.0"]},

apps/emqx_auth_redis/src/emqx_auth_redis.app.src

@@ -3,7 +3,7 @@
   {vsn, "4.3.0"}, % strict semver, bump manually!
   {modules, []},
   {registered, [emqx_auth_redis_sup]},
-  {applications, [kernel,stdlib,eredis,eredis_cluster,ecpool,emqx_passwd]},
+  {applications, [kernel,stdlib,eredis,eredis_cluster,ecpool,emqx]},
   {mod, {emqx_auth_redis_app, []}},
   {env, []},
   {licenses, ["Apache-2.0"]},

apps/emqx_passwd/.gitignore

@@ -1,19 +0,0 @@
-.eunit
-deps
-*.o
-*.beam
-*.plt
-erl_crash.dump
-ebin/
-rel/example_project
-.concrete/DEV_MODE
-.rebar
-.erlang.mk/
-emqx_passwd.d
-logs/
-_build/
-rebar.lock
-erlang.mk
-rebar3.crashdump
-.erlang.mk/
-.rebar3/

apps/emqx_passwd/LICENSE

@@ -1,201 +0,0 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.

apps/emqx_passwd/README.md

@@ -1,23 +0,0 @@
-# emqx-passwd
-
-The password hash library for emq x broker.
-
-## Hash types
-
-- plain
-- md5
-- sha
-- sha256
-- pbkdf2
-- bcrypt
-
-License
--------
-
-Apache License Version 2.0
-
-Author
-------
-
-EMQ X Team.
-

apps/emqx_passwd/rebar.config

@@ -1,22 +0,0 @@
-{deps,
- [{pbkdf2, {git, "https://github.com/emqx/erlang-pbkdf2.git", {branch, "2.0.3"}}}
- ]}.
-
-{plugins, [
- {pc, {git, "https://github.com/emqx/port_compiler.git", {tag, "v1.11.1"}}}
- ]}.
-
-{edoc_opts, [{preprocess, true}]}.
-{erl_opts, [warn_unused_vars,
-            warn_shadow_vars,
-            warn_unused_import,
-            warn_obsolete_guard,
-            debug_info,
-            {parse_transform}]}.
-
-{xref_checks, [undefined_function_calls, undefined_functions,
-               locals_not_used, deprecated_function_calls,
-               warnings_as_errors, deprecated_functions]}.
-{cover_enabled, true}.
-{cover_opts, [verbose]}.
-{cover_export_enabled, true}.

apps/emqx_passwd/src/emqx_passwd.app.src

@@ -1,13 +0,0 @@
-{application, emqx_passwd,
- [{description, "Password Hash Library for EMQ X Broker"},
-  {vsn, "0.1.1"}, % strict semver, bump manually!
-  {modules, ['emqx_passwd']},
-  {registered, []},
-  {applications, [kernel,stdlib,ssl,pbkdf2,emqx]},
-  {env, []},
-  {licenses, ["Apache-2.0"]},
-  {maintainers, ["EMQ X Team <contact@emqx.io>"]},
-  {links, [{"Homepage", "https://emqx.io/"},
-           {"Github", "https://github.com/emqx/emqx-passwd"}
-          ]}
- ]}.

rebar.config.erl

@@ -3,7 +3,18 @@
 -export([do/2]).
 
 do(_Dir, CONFIG) ->
-    maybe_dump(CONFIG ++ config()).
+    dump(deps(CONFIG) ++ config()).
+
+bcrypt() ->
+    {bcrypt, {git, "https://github.com/emqx/erlang-bcrypt.git", {branch, "0.6.0"}}}.
+
+deps(Config) ->
+    {deps, OldDpes} = lists:keyfind(deps, 1, Config),
+    MoreDeps = case provide_bcrypt_dep() of
+        true -> [bcrypt()];
+        false -> []
+    end,
+    lists:keystore(deps, 1, Config, {deps, OldDpes ++ MoreDeps}).
 
 config() ->
     [ {plugins, plugins()}
@@ -22,11 +33,17 @@ test_deps() ->
     ].
 
 profiles() ->
-    [ {'emqx',          [{relx, relx('emqx')}]}
+    [ {'emqx',          [ {relx, relx('emqx')}
-    , {'emqx-pkg',      [{relx, relx('emqx-pkg')}]}
+                        ]}
-    , {'emqx-edge',     [{relx, relx('emqx-edge')}]}
+    , {'emqx-pkg',      [ {relx, relx('emqx-pkg')}
-    , {'emqx-edge-pkg', [{relx, relx('emqx-edge-pkg')}]}
+                        ]}
-    , {test,            [{deps, test_deps()}, {erl_opts, [debug_info]}]}
+    , {'emqx-edge',     [ {relx, relx('emqx-edge')}
+                        ]}
+    , {'emqx-edge-pkg', [ {relx, relx('emqx-edge-pkg')}
+                        ]}
+    , {test,            [ {deps, test_deps()}
+                        , {erl_opts, [debug_info]}
+                        ]}
     ].
 
 relx(Profile) ->
@@ -91,7 +108,7 @@ relx_apps(ReleaseType) ->
     , {emqx_rule_engine, load}
     , {emqx_sasl, load}
     , {emqx_telemetry, load}
-    ] ++ do_relx_apps(ReleaseType).
+    ] ++ do_relx_apps(ReleaseType) ++ [bcrypt || provide_bcrypt_release(ReleaseType)].
 
 do_relx_apps(cloud) ->
     [ {emqx_lwm2m, load}
@@ -155,10 +172,15 @@ get_vsn() ->
     Vsn2 = re:replace(PkgVsn, "v", "", [{return ,list}]),
     re:replace(Vsn2, "\n", "", [{return ,list}]).
 
-maybe_dump(Config) ->
+dump(Config) ->
-    case os:getenv("DEBUG") of
+    file:write_file("rebar.config.rendered", [io_lib:format("~p.\n", [I]) || I <- Config]),
-        "" -> ok;
-        false -> ok;
-        _ -> file:write_file("rebar.config.rendered", [io_lib:format("~p.\n", [I]) || I <- Config])
-    end,
     Config.
+
+provide_bcrypt_dep() ->
+    case os:type() of
+        {win32, _} -> false;
+        _ -> true
+    end.
+
+provide_bcrypt_release(ReleaseType) ->
+    provide_bcrypt_dep() andalso ReleaseType =:= cloud.

sync-apps.sh

@@ -55,7 +55,6 @@ download_zip() {
 }
 
 default_vsn="dev/v4.3.0"
-download_zip "emqx_passwd" "v1.1.1"
 download_zip "emqx_auth_mnesia" "e4.2.2"
 for app in ${apps[@]}; do
     download_zip "$app" "$default_vsn"
@@ -78,7 +77,6 @@ extract_zip(){
     mv "apps/${repo}-${vsn}/" "apps/$app/"
 }
 
-extract_zip "emqx_passwd" "v1.1.1" "1.1.1"
 extract_zip "emqx_auth_mnesia" "e4.2.2" "e4.2.2"
 for app in ${apps[@]}; do
     extract_zip "$app" "$default_vsn"
@@ -94,7 +92,7 @@ cleanup_app(){
     popd
 }
 
-apps+=( "emqx_passwd" "emqx_auth_mnesia" )
+apps+=( "emqx_auth_mnesia" )
 for app in ${apps[@]}; do
     cleanup_app $app
 done

test/emqx_passwd_SUITE.erl

@@ -28,4 +28,3 @@ t_hash(_) ->
     _ = emqx_passwd:hash(sha256, Password),
     _ = emqx_passwd:hash(bcrypt, {Salt, Password}),
     _ = emqx_passwd:hash(pbkdf2, {Salt, Password, sha256, 1000, 20}).
-