Move to emqx/emqx-auth-ldap

README.md

@@ -1,8 +1,8 @@
 
 emqx_auth_ldap
-=============
+==============
 
-LDAP Authentication Plugin for EMQ X Broker
+EMQ X LDAP Authentication Plugin
 
 Build
 -----

priv/emqx_auth_ldap.schema

@@ -1,5 +1,6 @@
 %%-*- mode: erlang -*-
 %% emqx_auth_ldap config mapping
+
 {mapping, "auth.ldap.servers", "emqx_auth_ldap.ldap", [
   {default, "127.0.0.1"},
   {datatype, string}

src/emqx_acl_ldap.erl

@@ -1,8 +1,16 @@
+%% Copyright (c) 2018 EMQ Technologies Co., Ltd. All Rights Reserved.
 %%
-%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. All Rights Reserved.
+%% 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
 %%
-%% @doc ACL with OpenLDAP
+%%     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.
 
 -module(emqx_acl_ldap).
 
@@ -25,7 +33,7 @@ init(AclDn) ->
     {ok, #state{acl_dn = AclDn}}.
 
 check_acl({#mqtt_client{username = <<$$, _/binary>>}, _PubSub, _Topic}, _State) ->
-    ignore; 
+    ignore;
 
 check_acl({Client, PubSub, Topic}, #state{acl_dn = AclDn}) ->
     Filter = gen_filter(Client, AclDn),
@@ -58,7 +66,7 @@ compile(Attributes) ->
 
 filter(PubSub, Rules) ->
     [Term || Term = {_, _, Access, _} <- Rules, Access =:= PubSub orelse Access =:= pubsub].
-    
+
 
 allow(<<"1">>)  -> allow;
 allow(<<"0">>)  -> deny.
@@ -77,3 +85,4 @@ reload_acl(_State) ->
 
 description() ->
     "ACL with LDAP".
+

src/emqx_auth_ldap.erl

@@ -1,5 +1,4 @@
-%%--------------------------------------------------------------------
-%% Copyright (c) 2013-2018 EMQ Enterprise, Inc. (http://emqtt.io)
+%% Copyright (c) 2018 EMQ Technologies Co., Ltd. All Rights Reserved.
 %%
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
@@ -12,15 +11,11 @@
 %% 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.
-%%--------------------------------------------------------------------
 
 -module(emqx_auth_ldap).
 
--author("Feng Lee <feng@emqtt.io>").
-
--include_lib("eldap/include/eldap.hrl").
-
 -include_lib("emqx/include/emqx.hrl").
+-include_lib("eldap/include/eldap.hrl").
 
 -import(proplists, [get_value/2, get_value/3]).
 

src/emqx_auth_ldap_app.erl

@@ -1,5 +1,4 @@
-%%--------------------------------------------------------------------
-%% Copyright (c) 2013-2018 EMQ Enterprise, Inc. (http://emqtt.io)
+%% Copyright (c) 2018 EMQ Technologies Co., Ltd. All Rights Reserved.
 %%
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
@@ -12,20 +11,15 @@
 %% 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.
-%%--------------------------------------------------------------------
 
 -module(emqx_auth_ldap_app).
 
 -behaviour(application).
 
-%% Application callbacks
--export([start/2, prep_stop/1, stop/1]).
-
 -include("emqx_auth_ldap.hrl").
 
-%%--------------------------------------------------------------------
 %% Application callbacks
-%%--------------------------------------------------------------------
+-export([start/2, prep_stop/1, stop/1]).
 
 start(_StartType, _StartArgs) ->
     {ok, Sup} = emqx_auth_ldap_sup:start_link(),
@@ -51,13 +45,6 @@ reg_authmod(AuthDn) ->
 reg_aclmod(AclDn) ->
     emqx_access_control:register_mod(acl, emqx_acl_ldap, AclDn).
 
-%%--------------------------------------------------------------------
-%% Internal function
-%%--------------------------------------------------------------------
-
 if_enabled(Cfg, Fun) ->
-    case application:get_env(?APP, Cfg) of
-        {ok, Dn} -> Fun(Dn);
-        undefined   -> ok
-    end.
+    case application:get_env(?APP, Cfg) of {ok, Dn} -> Fun(Dn); undefined -> ok end.
 

src/emqx_auth_ldap_cfg.erl

@@ -1,5 +1,4 @@
-%%--------------------------------------------------------------------
-%% Copyright (c) 2013-2018 EMQ Enterprise, Inc. (http://emqtt.io)
+%% Copyright (c) 2018 EMQ Technologies Co., Ltd. All Rights Reserved.
 %%
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
@@ -12,7 +11,6 @@
 %% 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.
-%%--------------------------------------------------------------------
 
 -module(emqx_auth_ldap_cfg).
 
@@ -71,3 +69,4 @@ keys() ->
      "auth.ldap.timeout",
      "auth.ldap.auth_dn",
      "auth.ldap.password_hash"].
+

src/emqx_auth_ldap_cli.erl

@@ -1,5 +1,4 @@
-%%--------------------------------------------------------------------
-%% Copyright (c) 2013-2018 EMQ Enterprise, Inc. (http://emqtt.io)
+%% Copyright (c) 2018 EMQ Technologies Co., Ltd. All Rights Reserved.
 %%
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
@@ -12,7 +11,6 @@
 %% 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.
-%%--------------------------------------------------------------------
 
 -module(emqx_auth_ldap_cli).
 
@@ -44,16 +42,17 @@ gen_filter(Client, Dn) ->
     end.
 
 %%--------------------------------------------------------------------
-%% ldap Connect/Search
+%% LDAP Connect/Search
 %%--------------------------------------------------------------------
+
 connect(Opts) ->
     Servers      = get_value(servers, Opts, ["localhost"]),
     Port         = get_value(port, Opts, 389),
     Timeout      = get_value(timeout, Opts, 30),
     BindDn       = get_value(bind_dn, Opts),
     BindPassword = get_value(bind_password, Opts),
     LdapOpts = case get_value(ssl, Opts, false) of
-        true -> 
+        true ->
             SslOpts = get_value(sslopts, Opts),
             [{port, Port}, {timeout, Timeout}, {sslopts, SslOpts}];
         false ->
@@ -63,8 +62,7 @@ connect(Opts) ->
     case eldap:open(Servers, LdapOpts) of
         {ok, LDAP} ->
             case catch eldap:simple_bind(LDAP, BindDn, BindPassword) of
-                ok ->
-                    {ok, LDAP};
+                ok -> {ok, LDAP};
                 {error, Error} ->
                     {error, Error};
                 {'EXIT', Reason} ->
@@ -76,4 +74,4 @@ connect(Opts) ->
 
 search(Base, Filter) ->
     ecpool:with_client(?APP, fun(C) -> eldap:search(C, [{base, Base}, {filter, Filter}]) end).
-    
+

src/emqx_auth_ldap_sup.erl

@@ -1,5 +1,4 @@
-%%--------------------------------------------------------------------
-%% Copyright (c) 2013-2018 EMQ Enterprise, Inc. (http://emqtt.io)
+%% Copyright (c) 2018 EMQ Technologies Co., Ltd. All Rights Reserved.
 %%
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
@@ -12,7 +11,6 @@
 %% 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.
-%%--------------------------------------------------------------------
 
 -module(emqx_auth_ldap_sup).
 
@@ -21,15 +19,13 @@
 -include("emqx_auth_ldap.hrl").
 
 -export([start_link/0]).
-
-%% Supervisor callbacks
 -export([init/1]).
 
 start_link() ->
     supervisor:start_link({local, ?MODULE}, ?MODULE, []).
 
 init([]) ->
-    %% ldap Connection Pool.
+    %% LDAP Connection Pool.
     {ok, Server} = application:get_env(?APP, ldap),
     PoolSpec = ecpool:pool_spec(?APP, ?APP, emqx_auth_ldap_cli, Server),
     {ok, {{one_for_one, 10, 100}, [PoolSpec]}}.