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         local log = session.log or module._log;
  88
  89         local query = stanza.tags[1];
  90         if stanza.attr.type == "get" then
  91                 local reply = st.reply(stanza);
  92                 reply:tag("query", {xmlns = "jabber:iq:register"})
  93                         :tag("registered"):up()
  94                         :tag("username"):text(session.username):up()
  95                         :tag("password"):up();
  96                 session.send(reply);
  97         else -- stanza.attr.type == "set"
  98                 if query.tags[1] and query.tags[1].name == "remove" then
  99                         local username, host = session.username, session.host;
 100
 101                         local old_session_close = session.close;
 102                         session.close = function(session, ...)
 103                                 session.send(st.reply(stanza));
 104                                 return old_session_close(session, ...);
 105                         end
 106
 107                         local ok, err = usermanager_delete_user(username, host);
 108
 109                         if not ok then
 110                                 log("debug", "Removing user account %s@%s failed: %s", username, host, err);
 111                                 session.close = old_session_close;
 112                                 session.send(st.error_reply(stanza, "cancel", "service-unavailable", err));
 113                                 return true;
 114                         end
 115
 116                         log("info", "User removed their account: %s@%s", username, host);
 117                         module:fire_event("user-deregistered", { username = username, host = host, source = "mod_register", session = session });
 118                 else
 119                         local username = nodeprep(query:get_child_text("username"));
 120                         local password = query:get_child_text("password");
 121                         if username and password then
 122                                 if username == session.username then
 123                                         if usermanager_set_password(username, password, session.host) then
 124                                                 session.send(st.reply(stanza));
 125                                         else
 126                                                 -- TODO unable to write file, file may be locked, etc, what's the correct error?
 127                                                 session.send(st.error_reply(stanza, "wait", "internal-server-error"));
 128                                         end
 129                                 else
 130                                         session.send(st.error_reply(stanza, "modify", "bad-request"));
 131                                 end
 132                         else
 133                                 session.send(st.error_reply(stanza, "modify", "bad-request"));
 134                         end
 135                 end
 136         end
 137         return true;
 138 end
 139
 140 module:hook("iq/self/jabber:iq:register:query", handle_registration_stanza);
 141 if compat then
 142         module:hook("iq/host/jabber:iq:register:query", function (event)
 143                 local session, stanza = event.origin, event.stanza;
 144                 if session.type == "c2s" and jid_bare(stanza.attr.to) == session.host then
 145                         return handle_registration_stanza(event);
 146                 end
 147         end);
 148 end
 149
 150 local function parse_response(query)
 151         local form = query:get_child("x", "jabber:x:data");
 152         if form then
 153                 return registration_form:data(form);
 154         else
 155                 local data = {};
 156                 local errors = {};
 157                 for _, field in ipairs(registration_form) do
 158                         local name, required = field.name, field.required;
 159                         if field_map[name] then
 160                                 data[name] = query:get_child_text(name);
 161                                 if (not data[name] or #data[name] == 0) and required then
 162                                         errors[name] = "Required value missing";
 163                                 end
 164                         end
 165                 end
 166                 if next(errors) then
 167                         return data, errors;
 168                 end
 169                 return data;
 170         end
 171 end
 172
 173 local recent_ips = {};
 174 local min_seconds_between_registrations = module:get_option_number("min_seconds_between_registrations");
 175 local whitelist_only = module:get_option_boolean("whitelist_registration_only");
 176 local whitelisted_ips = module:get_option_set("registration_whitelist", { "127.0.0.1" })._items;
 177 local blacklisted_ips = module:get_option_set("registration_blacklist", {})._items;
 178
 179 module:hook("stanza/iq/jabber:iq:register:query", function(event)
 180         local session, stanza = event.origin, event.stanza;
 181         local log = session.log or module._log;
 182
 183         if not(allow_registration) or session.type ~= "c2s_unauthed" then
 184                 session.send(st.error_reply(stanza, "cancel", "service-unavailable"));
 185         else
 186                 local query = stanza.tags[1];
 187                 if stanza.attr.type == "get" then
 188                         local reply = st.reply(stanza);
 189                         reply:add_child(registration_query);
 190                         session.send(reply);
 191                 elseif stanza.attr.type == "set" then
 192                         if query.tags[1] and query.tags[1].name == "remove" then
 193                                 session.send(st.error_reply(stanza, "auth", "registration-required"));
 194                         else
 195                                 local data, errors = parse_response(query);
 196                                 if errors then
 197                                         session.send(st.error_reply(stanza, "modify", "not-acceptable"));
 198                                 else
 199                                         -- Check that the user is not blacklisted or registering too often
 200                                         if not session.ip then
 201                                                 log("debug", "User's IP not known; can't apply blacklist/whitelist");
 202                                         elseif blacklisted_ips[session.ip] or (whitelist_only and not whitelisted_ips[session.ip]) then
 203                                                 session.send(st.error_reply(stanza, "cancel", "not-acceptable", "You are not allowed to register an account."));
 204                                                 return true;
 205                                         elseif min_seconds_between_registrations and not whitelisted_ips[session.ip] then
 206                                                 if not recent_ips[session.ip] then
 207                                                         recent_ips[session.ip] = { time = os_time(), count = 1 };
 208                                                 else
 209                                                         local ip = recent_ips[session.ip];
 210                                                         ip.count = ip.count + 1;
 211
 212                                                         if os_time() - ip.time < min_seconds_between_registrations then
 213                                                                 ip.time = os_time();
 214                                                                 session.send(st.error_reply(stanza, "wait", "not-acceptable"));
 215                                                                 return true;
 216                                                         end
 217                                                         ip.time = os_time();
 218                                                 end
 219                                         end
 220                                         local username, password = nodeprep(data.username), data.password;
 221                                         data.username, data.password = nil, nil;
 222                                         local host = module.host;
 223                                         if not username or username == "" then
 224                                                 session.send(st.error_reply(stanza, "modify", "not-acceptable", "The requested username is invalid."));
 225                                                 return true;
 226                                         end
 227                                         local user = { username = username , host = host, allowed = true }
 228                                         module:fire_event("user-registering", user);
 229                                         if not user.allowed then
 230                                                 session.send(st.error_reply(stanza, "modify", "not-acceptable", "The requested username is forbidden."));
 231                                         elseif usermanager_user_exists(username, host) then
 232                                                 session.send(st.error_reply(stanza, "cancel", "conflict", "The requested username already exists."));
 233                                         else
 234                                                 -- TODO unable to write file, file may be locked, etc, what's the correct error?
 235                                                 local error_reply = st.error_reply(stanza, "wait", "internal-server-error", "Failed to write data to disk.");
 236                                                 if usermanager_create_user(username, password, host) then
 237                                                         if next(data) and not account_details:set(username, data) then
 238                                                                 usermanager_delete_user(username, host);
 239                                                                 session.send(error_reply);
 240                                                                 return true;
 241                                                         end
 242                                                         session.send(st.reply(stanza)); -- user created!
 243                                                         log("info", "User account created: %s@%s", username, host);
 244                                                         module:fire_event("user-registered", {
 245                                                                 username = username, host = host, source = "mod_register",
 246                                                                 session = session });
 247                                                 else
 248                                                         session.send(error_reply);
 249                                                 end
 250                                         end
 251                                 end
 252                         end
 253                 end
 254         end
 255         return true;
 256 end);