mod_auth_cyrus: Print some diagnostic log messages about the available mechanisms.
[prosody.git] / plugins / mod_auth_cyrus.lua
1 -- Prosody IM
2 -- Copyright (C) 2008-2010 Matthew Wild
3 -- Copyright (C) 2008-2010 Waqas Hussain
4 --
5 -- This project is MIT/X11 licensed. Please see the
6 -- COPYING file in the source package for more information.
7 --
8
9 local log = require "util.logger".init("auth_cyrus");
10
11 local usermanager_user_exists = require "core.usermanager".user_exists;
12
13 local cyrus_service_realm = module:get_option("cyrus_service_realm");
14 local cyrus_service_name = module:get_option("cyrus_service_name");
15 local cyrus_application_name = module:get_option("cyrus_application_name");
16 local require_provisioning = module:get_option("cyrus_require_provisioning") or false;
17
18 prosody.unlock_globals(); --FIXME: Figure out why this is needed and
19                                                   -- why cyrussasl isn't caught by the sandbox
20 local cyrus_new = require "util.sasl_cyrus".new;
21 prosody.lock_globals();
22 local new_sasl = function(realm)
23         return cyrus_new(
24                 cyrus_service_realm or realm,
25                 cyrus_service_name or "xmpp",
26                 cyrus_application_name or "prosody"
27         );
28 end
29
30 do -- diagnostic
31         local realm = module:get_option("sasl_realm") or module.host;
32         local list;
33         for mechanism in pairs(new_sasl(realm):mechanisms()) do
34                 list = (not(list) and mechanism) or (list..", "..mechanism);
35         end
36         if not list then
37                 module:log("error", "No Cyrus SASL mechanisms available");
38         else
39                 module:log("debug", "Available Cyrus SASL mechanisms: %s", list);
40         end
41 end
42
43 function new_default_provider(host)
44         local provider = { name = "cyrus" };
45         log("debug", "initializing default authentication provider for host '%s'", host);
46
47         function provider.test_password(username, password)
48                 return nil, "Legacy auth not supported with Cyrus SASL.";
49         end
50
51         function provider.get_password(username)
52                 return nil, "Passwords unavailable for Cyrus SASL.";
53         end
54         
55         function provider.set_password(username, password)
56                 return nil, "Passwords unavailable for Cyrus SASL.";
57         end
58
59         function provider.user_exists(username)
60                 if require_provisioning then
61                         return usermanager_user_exists(username, module.host);
62                 end
63                 return true;
64         end
65
66         function provider.create_user(username, password)
67                 return nil, "Account creation/modification not available with Cyrus SASL.";
68         end
69
70         function provider.get_sasl_handler()
71                 local realm = module:get_option("sasl_realm") or module.host;
72                 local handler = new_sasl(realm);
73                 if require_provisioning then
74                         function handler.require_provisioning(username)
75                                 return usermanager_user_exists(username, module.host);
76                         end
77                 end
78                 return handler;
79         end
80
81         return provider;
82 end
83
84 module:add_item("auth-provider", new_default_provider(module.host));
85