annotate plugins/muc/name.lib.lua @ 13652:a08065207ef0

net.server_epoll: Call :shutdown() on TLS sockets when supported Comment from Matthew: This fixes a potential issue where the Prosody process gets blocked on sockets waiting for them to close. Unlike non-TLS sockets, closing a TLS socket sends layer 7 data, and this can cause problems for sockets which are in the process of being cleaned up. This depends on LuaSec changes which are not yet upstream. From Martijn's original email: So first my analysis of luasec. in ssl.c the socket is put into blocking mode right before calling SSL_shutdown() inside meth_destroy(). My best guess to why this is is because meth_destroy is linked to the __close and __gc methods, which can't exactly be called multiple times and luasec does want to make sure that a tls session is shutdown as clean as possible. I can't say I disagree with this reasoning and don't want to change this behaviour. My solution to this without changing the current behaviour is to introduce a shutdown() method. I am aware that this overlaps in a conflicting way with tcp's shutdown method, but it stays close to the OpenSSL name. This method calls SSL_shutdown() in the current (non)blocking mode of the underlying socket and returns a boolean whether or not the shutdown is completed (matching SSL_shutdown()'s 0 or 1 return values), and returns the familiar ssl_ioerror() strings on error with a false for completion. This error can then be used to determine if we have wantread/wantwrite to finalize things. Once meth_shutdown() has been called once a shutdown flag will be set, which indicates to meth_destroy() that the SSL_shutdown() has been handled by the application and it shouldn't be needed to set the socket to blocking mode. I've left the SSL_shutdown() call in the LSEC_STATE_CONNECTED to prevent TOCTOU if the application reaches a timeout for the shutdown code, which might allow SSL_shutdown() to clean up anyway at the last possible moment. Another thing I've changed to luasec is the call to socket_setblocking() right before calling close(2) in socket_destroy() in usocket.c. According to the latest POSIX[0]: Note that the requirement for close() on a socket to block for up to the current linger interval is not conditional on the O_NONBLOCK setting. Which I read to mean that removing O_NONBLOCK on the socket before close doesn't impact the behaviour and only causes noise in system call tracers. I didn't touch the windows bits of this, since I don't do windows. For the prosody side of things I've made the TLS shutdown bits resemble interface:onwritable(), and put it under a combined guard of self._tls and self.conn.shutdown. The self._tls bit is there to prevent getting stuck on this condition, and self.conn.shutdown is there to prevent the code being called by instances where the patched luasec isn't deployed. The destroy() method can be called from various places and is read by me as the "we give up" error path. To accommodate for these unexpected entrypoints I've added a single call to self.conn:shutdown() to prevent the socket being put into blocking mode. I have no expectations that there is any other use here. Same as previous, the self.conn.shutdown check is there to make sure it's not called on unpatched luasec deployments and self._tls is there to make sure we don't call shutdown() on tcp sockets. I wouldn't recommend logging of the conn:shutdown() error inside close(), since a lot of clients simply close the connection before SSL_shutdown() is done.
author Martijn van Duren <martijn@openbsd.org>
date Thu, 06 Feb 2025 15:04:38 +0000
parents 13eee48071c8
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6209
cc00e78e6a31 plugins/muc: Move name functions to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
1 -- Prosody IM
cc00e78e6a31 plugins/muc: Move name functions to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
2 -- Copyright (C) 2008-2010 Matthew Wild
cc00e78e6a31 plugins/muc: Move name functions to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
3 -- Copyright (C) 2008-2010 Waqas Hussain
cc00e78e6a31 plugins/muc: Move name functions to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
4 -- Copyright (C) 2014 Daurnimator
cc00e78e6a31 plugins/muc: Move name functions to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
5 --
cc00e78e6a31 plugins/muc: Move name functions to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
6 -- This project is MIT/X11 licensed. Please see the
cc00e78e6a31 plugins/muc: Move name functions to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
7 -- COPYING file in the source package for more information.
cc00e78e6a31 plugins/muc: Move name functions to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
8 --
cc00e78e6a31 plugins/muc: Move name functions to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
9
cc00e78e6a31 plugins/muc: Move name functions to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
10 local function get_name(room)
11057
13eee48071c8 MUC: Don't default room name to JID localpart (API breaking change)
Kim Alvefur <zash@zash.se>
parents: 9034
diff changeset
11 return room._data.name;
6209
cc00e78e6a31 plugins/muc: Move name functions to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
12 end
cc00e78e6a31 plugins/muc: Move name functions to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
13
cc00e78e6a31 plugins/muc: Move name functions to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
14 local function set_name(room, name)
8986
320ae6dbb2e8 MUC: Add roomconfig_roomname to disco#info, and ensure it's not auto-generated
Matthew Wild <mwild1@gmail.com>
parents: 7401
diff changeset
15 if name == "" then name = nil; end
6209
cc00e78e6a31 plugins/muc: Move name functions to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
16 if room._data.name == name then return false; end
cc00e78e6a31 plugins/muc: Move name functions to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
17 room._data.name = name;
cc00e78e6a31 plugins/muc: Move name functions to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
18 return true;
cc00e78e6a31 plugins/muc: Move name functions to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
19 end
cc00e78e6a31 plugins/muc: Move name functions to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
20
8988
d92b8bc6614c MUC: Remove empty statement [luacheck]
Kim Alvefur <zash@zash.se>
parents: 8986
diff changeset
21 local function insert_name_into_form(event)
6209
cc00e78e6a31 plugins/muc: Move name functions to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
22 table.insert(event.form, {
cc00e78e6a31 plugins/muc: Move name functions to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
23 name = "muc#roomconfig_roomname";
cc00e78e6a31 plugins/muc: Move name functions to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
24 type = "text-single";
9034
1c709e3d2e5e MUC: Improve labels of all config form items
Matthew Wild <mwild1@gmail.com>
parents: 8988
diff changeset
25 label = "Title";
8986
320ae6dbb2e8 MUC: Add roomconfig_roomname to disco#info, and ensure it's not auto-generated
Matthew Wild <mwild1@gmail.com>
parents: 7401
diff changeset
26 value = event.room._data.name;
6209
cc00e78e6a31 plugins/muc: Move name functions to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
27 });
8986
320ae6dbb2e8 MUC: Add roomconfig_roomname to disco#info, and ensure it's not auto-generated
Matthew Wild <mwild1@gmail.com>
parents: 7401
diff changeset
28 end
320ae6dbb2e8 MUC: Add roomconfig_roomname to disco#info, and ensure it's not auto-generated
Matthew Wild <mwild1@gmail.com>
parents: 7401
diff changeset
29
320ae6dbb2e8 MUC: Add roomconfig_roomname to disco#info, and ensure it's not auto-generated
Matthew Wild <mwild1@gmail.com>
parents: 7401
diff changeset
30 module:hook("muc-disco#info", function(event)
320ae6dbb2e8 MUC: Add roomconfig_roomname to disco#info, and ensure it's not auto-generated
Matthew Wild <mwild1@gmail.com>
parents: 7401
diff changeset
31 event.reply:tag("identity", {category="conference", type="text", name=get_name(event.room)}):up();
320ae6dbb2e8 MUC: Add roomconfig_roomname to disco#info, and ensure it's not auto-generated
Matthew Wild <mwild1@gmail.com>
parents: 7401
diff changeset
32 insert_name_into_form(event);
320ae6dbb2e8 MUC: Add roomconfig_roomname to disco#info, and ensure it's not auto-generated
Matthew Wild <mwild1@gmail.com>
parents: 7401
diff changeset
33 end);
320ae6dbb2e8 MUC: Add roomconfig_roomname to disco#info, and ensure it's not auto-generated
Matthew Wild <mwild1@gmail.com>
parents: 7401
diff changeset
34
320ae6dbb2e8 MUC: Add roomconfig_roomname to disco#info, and ensure it's not auto-generated
Matthew Wild <mwild1@gmail.com>
parents: 7401
diff changeset
35 module:hook("muc-config-form", insert_name_into_form, 100-1);
6209
cc00e78e6a31 plugins/muc: Move name functions to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
36
6991
84e01dbb739e MUC: Update all config form handlers to take advantage of the new per-option events
Matthew Wild <mwild1@gmail.com>
parents: 6209
diff changeset
37 module:hook("muc-config-submitted/muc#roomconfig_roomname", function(event)
84e01dbb739e MUC: Update all config form handlers to take advantage of the new per-option events
Matthew Wild <mwild1@gmail.com>
parents: 6209
diff changeset
38 if set_name(event.room, event.value) then
6209
cc00e78e6a31 plugins/muc: Move name functions to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
39 event.status_codes["104"] = true;
cc00e78e6a31 plugins/muc: Move name functions to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
40 end
cc00e78e6a31 plugins/muc: Move name functions to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
41 end);
cc00e78e6a31 plugins/muc: Move name functions to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
42
cc00e78e6a31 plugins/muc: Move name functions to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
43 return {
cc00e78e6a31 plugins/muc: Move name functions to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
44 get = get_name;
cc00e78e6a31 plugins/muc: Move name functions to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
45 set = set_name;
cc00e78e6a31 plugins/muc: Move name functions to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
46 };