plugins/mod_register.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
  10 local st = require "util.stanza";
  11 local dataform_new = require "util.dataforms".new;
  12 local usermanager_user_exists = require "core.usermanager".user_exists;
  13 local usermanager_create_user = require "core.usermanager".create_user;
  14 local usermanager_set_password = require "core.usermanager".set_password;
  15 local usermanager_delete_user = require "core.usermanager".delete_user;
  16 local os_time = os.time;
  17 local nodeprep = require "util.encodings".stringprep.nodeprep;
  18 local jid_bare = require "util.jid".bare;
  19
  20 local compat = module:get_option_boolean("registration_compat", true);
  21 local allow_registration = module:get_option_boolean("allow_registration", false);
  22 local additional_fields = module:get_option("additional_registration_fields", {});
  23
  24 local account_details = module:open_store("account_details");
  25
  26 local field_map = {
  27         username = { name = "username", type = "text-single", label = "Username", required = true };
  28         password = { name = "password", type = "text-private", label = "Password", required = true };
  29         nick = { name = "nick", type = "text-single", label = "Nickname" };
  30         name = { name = "name", type = "text-single", label = "Full Name" };
  31         first = { name = "first", type = "text-single", label = "Given Name" };
  32         last = { name = "last", type = "text-single", label = "Family Name" };
  33         email = { name = "email", type = "text-single", label = "Email" };
  34         address = { name = "address", type = "text-single", label = "Street" };
  35         city = { name = "city", type = "text-single", label = "City" };
  36         state = { name = "state", type = "text-single", label = "State" };
  37         zip = { name = "zip", type = "text-single", label = "Postal code" };
  38         phone = { name = "phone", type = "text-single", label = "Telephone number" };
  39         url = { name = "url", type = "text-single", label = "Webpage" };
  40         date = { name = "date", type = "text-single", label = "Birth date" };
  41 };
  42
  43 local registration_form = dataform_new{
  44         title = "Creating a new account";
  45         instructions = "Choose a username and password for use with this service.";
  46
  47         field_map.username;
  48         field_map.password;
  49 };
  50
  51 local registration_query = st.stanza("query", {xmlns = "jabber:iq:register"})
  52         :tag("instructions"):text("Choose a username and password for use with this service."):up()
  53         :tag("username"):up()
  54         :tag("password"):up();
  55
  56 for _, field in ipairs(additional_fields) do
  57         if type(field) == "table" then
  58                 registration_form[#registration_form + 1] = field;
  59         else
  60                 if field:match("%+$") then
  61                         field = field:sub(1, #field - 1);
  62                         field_map[field].required = true;
  63                 end
  64
  65                 registration_form[#registration_form + 1] = field_map[field];
  66                 registration_query:tag(field):up();
  67         end
  68 end
  69 registration_query:add_child(registration_form:form());
  70
  71 module:add_feature("jabber:iq:register");
  72
  73 local register_stream_feature = st.stanza("register", {xmlns="http://jabber.org/features/iq-register"}):up();
  74 module:hook("stream-features", function(event)
  75         local session, features = event.origin, event.features;
  76
  77         -- Advertise registration to unauthorized clients only.
  78         if not(allow_registration) or session.type ~= "c2s_unauthed" then
  79                 return
  80         end
  81
  82         features:add_child(register_stream_feature);
  83 end);
  84
  85 local function handle_registration_stanza(event)
  86         local session, stanza = event.origin, event.stanza;
  87
  88         local query = stanza.tags[1];
  89         if stanza.attr.type == "get" then
  90                 local reply = st.reply(stanza);
  91                 reply:tag("query", {xmlns = "jabber:iq:register"})
  92                         :tag("registered"):up()
  93                         :tag("username"):text(session.username):up()
  94                         :tag("password"):up();
  95                 session.send(reply);
  96         else -- stanza.attr.type == "set"
  97                 if query.tags[1] and query.tags[1].name == "remove" then
  98                         local username, host = session.username, session.host;
  99
 100                         local old_session_close = session.close;
 101                         session.close = function(session, ...)
 102                                 session.send(st.reply(stanza));
 103                                 return old_session_close(session, ...);
 104                         end
 105
 106                         local ok, err = usermanager_delete_user(username, host);
 107
 108                         if not ok then
 109                                 module:log("debug", "Removing user account %s@%s failed: %s", username, host, err);
 110                                 session.close = old_session_close;
 111                                 session.send(st.error_reply(stanza, "cancel", "service-unavailable", err));
 112                                 return true;
 113                         end
 114
 115                         module:log("info", "User removed their account: %s@%s", username, host);
 116                         module:fire_event("user-deregistered", { username = username, host = host, source = "mod_register", session = session });
 117                 else
 118                         local username = nodeprep(query:get_child_text("username"));
 119                         local password = query:get_child_text("password");
 120                         if username and password then
 121                                 if username == session.username then
 122                                         if usermanager_set_password(username, password, session.host) then
 123                                                 session.send(st.reply(stanza));
 124                                         else
 125                                                 -- TODO unable to write file, file may be locked, etc, what's the correct error?
 126                                                 session.send(st.error_reply(stanza, "wait", "internal-server-error"));
 127                                         end
 128                                 else
 129                                         session.send(st.error_reply(stanza, "modify", "bad-request"));
 130                                 end
 131                         else
 132                                 session.send(st.error_reply(stanza, "modify", "bad-request"));
 133                         end
 134                 end
 135         end
 136         return true;
 137 end
 138
 139 module:hook("iq/self/jabber:iq:register:query", handle_registration_stanza);
 140 if compat then
 141         module:hook("iq/host/jabber:iq:register:query", function (event)
 142                 local session, stanza = event.origin, event.stanza;
 143                 if session.type == "c2s" and jid_bare(stanza.attr.to) == session.host then
 144                         return handle_registration_stanza(event);
 145                 end
 146         end);
 147 end
 148
 149 local function parse_response(query)
 150         local form = query:get_child("x", "jabber:x:data");
 151         if form then
 152                 return registration_form:data(form);
 153         else
 154                 local data = {};
 155                 local errors = {};
 156                 for _, field in ipairs(registration_form) do
 157                         local name, required = field.name, field.required;
 158                         if field_map[name] then
 159                                 data[name] = query:get_child_text(name);
 160                                 if (not data[name] or #data[name] == 0) and required then
 161                                         errors[name] = "Required value missing";
 162                                 end
 163                         end
 164                 end
 165                 if next(errors) then
 166                         return data, errors;
 167                 end
 168                 return data;
 169         end
 170 end
 171
 172 local recent_ips = {};
 173 local min_seconds_between_registrations = module:get_option("min_seconds_between_registrations");
 174 local whitelist_only = module:get_option("whitelist_registration_only");
 175 local whitelisted_ips = module:get_option("registration_whitelist") or { "127.0.0.1" };
 176 local blacklisted_ips = module:get_option("registration_blacklist") or {};
 177
 178 for _, ip in ipairs(whitelisted_ips) do whitelisted_ips[ip] = true; end
 179 for _, ip in ipairs(blacklisted_ips) do blacklisted_ips[ip] = true; end
 180
 181 module:hook("stanza/iq/jabber:iq:register:query", function(event)
 182         local session, stanza = event.origin, event.stanza;
 183
 184         if not(allow_registration) or session.type ~= "c2s_unauthed" then
 185                 session.send(st.error_reply(stanza, "cancel", "service-unavailable"));
 186         else
 187                 local query = stanza.tags[1];
 188                 if stanza.attr.type == "get" then
 189                         local reply = st.reply(stanza);
 190                         reply:add_child(registration_query);
 191                         session.send(reply);
 192                 elseif stanza.attr.type == "set" then
 193                         if query.tags[1] and query.tags[1].name == "remove" then
 194                                 session.send(st.error_reply(stanza, "auth", "registration-required"));
 195                         else
 196                                 local data, errors = parse_response(query);
 197                                 if errors then
 198                                         session.send(st.error_reply(stanza, "modify", "not-acceptable"));
 199                                 else
 200                                         -- Check that the user is not blacklisted or registering too often
 201                                         if not session.ip then
 202                                                 module:log("debug", "User's IP not known; can't apply blacklist/whitelist");
 203                                         elseif blacklisted_ips[session.ip] or (whitelist_only and not whitelisted_ips[session.ip]) then
 204                                                 session.send(st.error_reply(stanza, "cancel", "not-acceptable", "You are not allowed to register an account."));
 205                                                 return true;
 206                                         elseif min_seconds_between_registrations and not whitelisted_ips[session.ip] then
 207                                                 if not recent_ips[session.ip] then
 208                                                         recent_ips[session.ip] = { time = os_time(), count = 1 };
 209                                                 else
 210                                                         local ip = recent_ips[session.ip];
 211                                                         ip.count = ip.count + 1;
 212
 213                                                         if os_time() - ip.time < min_seconds_between_registrations then
 214                                                                 ip.time = os_time();
 215                                                                 session.send(st.error_reply(stanza, "wait", "not-acceptable"));
 216                                                                 return true;
 217                                                         end
 218                                                         ip.time = os_time();
 219                                                 end
 220                                         end
 221                                         local username, password = nodeprep(data.username), data.password;
 222                                         data.username, data.password = nil, nil;
 223                                         local host = module.host;
 224                                         if not username or username == "" then
 225                                                 session.send(st.error_reply(stanza, "modify", "not-acceptable", "The requested username is invalid."));
 226                                                 return true;
 227                                         end
 228                                         local user = { username = username , host = host, allowed = true }
 229                                         module:fire_event("user-registering", user);
 230                                         if not user.allowed then
 231                                                 session.send(st.error_reply(stanza, "modify", "not-acceptable", "The requested username is forbidden."));
 232                                         elseif usermanager_user_exists(username, host) then
 233                                                 session.send(st.error_reply(stanza, "cancel", "conflict", "The requested username already exists."));
 234                                         else
 235                                                 -- TODO unable to write file, file may be locked, etc, what's the correct error?
 236                                                 local error_reply = st.error_reply(stanza, "wait", "internal-server-error", "Failed to write data to disk.");
 237                                                 if usermanager_create_user(username, password, host) then
 238                                                         if next(data) and not account_details:set(username, data) then
 239                                                                 usermanager_delete_user(username, host);
 240                                                                 session.send(error_reply);
 241                                                                 return true;
 242                                                         end
 243                                                         session.send(st.reply(stanza)); -- user created!
 244                                                         module:log("info", "User account created: %s@%s", username, host);
 245                                                         module:fire_event("user-registered", {
 246                                                                 username = username, host = host, source = "mod_register",
 247                                                                 session = session });
 248                                                 else
 249                                                         session.send(error_reply);
 250                                                 end
 251                                         end
 252                                 end
 253                         end
 254                 end
 255         end
 256         return true;
 257 end);