Mercurial > prosody-hg
annotate plugins/muc/persistent.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 | 082c7d856e61 |
| children |
| rev | line source |
|---|---|
|
6222
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
1 -- Prosody IM |
|
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
2 -- Copyright (C) 2008-2010 Matthew Wild |
|
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
3 -- Copyright (C) 2008-2010 Waqas Hussain |
|
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
4 -- Copyright (C) 2014 Daurnimator |
|
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
5 -- |
|
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
6 -- This project is MIT/X11 licensed. Please see the |
|
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
7 -- COPYING file in the source package for more information. |
|
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
8 -- |
|
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
9 |
|
9053
ea9e1f8f3013
MUC: Allow restricting public/persistent room options to service admins (muc_room_allow_public/muc_room_allow_persistent)
Matthew Wild <mwild1@gmail.com>
parents:
9035
diff
changeset
|
10 local restrict_persistent = not module:get_option_boolean("muc_room_allow_persistent", true); |
|
12732
f731eda8a873
Backed out changeset 73a45ba6e3f1 in favour of 427dd01f0864
Matthew Wild <mwild1@gmail.com>
parents:
12729
diff
changeset
|
11 module:default_permission( |
|
13170
082c7d856e61
core, plugins: Split prosody:user role into prosody:{guest,registered,member}
Matthew Wild <mwild1@gmail.com>
parents:
12732
diff
changeset
|
12 restrict_persistent and "prosody:admin" or "prosody:registered", |
|
12732
f731eda8a873
Backed out changeset 73a45ba6e3f1 in favour of 427dd01f0864
Matthew Wild <mwild1@gmail.com>
parents:
12729
diff
changeset
|
13 ":create-persistent-room" |
|
f731eda8a873
Backed out changeset 73a45ba6e3f1 in favour of 427dd01f0864
Matthew Wild <mwild1@gmail.com>
parents:
12729
diff
changeset
|
14 ); |
|
9053
ea9e1f8f3013
MUC: Allow restricting public/persistent room options to service admins (muc_room_allow_public/muc_room_allow_persistent)
Matthew Wild <mwild1@gmail.com>
parents:
9035
diff
changeset
|
15 |
|
6222
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
16 local function get_persistent(room) |
|
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
17 return room._data.persistent; |
|
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
18 end |
|
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
19 |
|
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
20 local function set_persistent(room, persistent) |
|
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
21 persistent = persistent and true or nil; |
|
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
22 if get_persistent(room) == persistent then return false; end |
|
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
23 room._data.persistent = persistent; |
|
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
24 return true; |
|
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
25 end |
|
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
26 |
|
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
27 module:hook("muc-config-form", function(event) |
|
12732
f731eda8a873
Backed out changeset 73a45ba6e3f1 in favour of 427dd01f0864
Matthew Wild <mwild1@gmail.com>
parents:
12729
diff
changeset
|
28 if not module:may(":create-persistent-room", event.actor) then |
|
12642
9061f9621330
Switch to a new role-based authorization framework, removing is_admin()
Matthew Wild <mwild1@gmail.com>
parents:
9053
diff
changeset
|
29 -- Hide config option if this user is not allowed to create persistent rooms |
|
9053
ea9e1f8f3013
MUC: Allow restricting public/persistent room options to service admins (muc_room_allow_public/muc_room_allow_persistent)
Matthew Wild <mwild1@gmail.com>
parents:
9035
diff
changeset
|
30 return; |
|
ea9e1f8f3013
MUC: Allow restricting public/persistent room options to service admins (muc_room_allow_public/muc_room_allow_persistent)
Matthew Wild <mwild1@gmail.com>
parents:
9035
diff
changeset
|
31 end |
|
6222
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
32 table.insert(event.form, { |
|
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
33 name = "muc#roomconfig_persistentroom"; |
|
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
34 type = "boolean"; |
|
9034
1c709e3d2e5e
MUC: Improve labels of all config form items
Matthew Wild <mwild1@gmail.com>
parents:
9014
diff
changeset
|
35 label = "Persistent (room should remain even when it is empty)"; |
|
1c709e3d2e5e
MUC: Improve labels of all config form items
Matthew Wild <mwild1@gmail.com>
parents:
9014
diff
changeset
|
36 desc = "Rooms are automatically deleted when they are empty, unless this option is enabled"; |
|
6222
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
37 value = get_persistent(event.room); |
|
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
38 }); |
|
9035
173c0e16e704
MUC: Add sections in room config form
Matthew Wild <mwild1@gmail.com>
parents:
9034
diff
changeset
|
39 end, 100-5); |
|
6222
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
40 |
|
6991
84e01dbb739e
MUC: Update all config form handlers to take advantage of the new per-option events
Matthew Wild <mwild1@gmail.com>
parents:
6222
diff
changeset
|
41 module:hook("muc-config-submitted/muc#roomconfig_persistentroom", function(event) |
|
12732
f731eda8a873
Backed out changeset 73a45ba6e3f1 in favour of 427dd01f0864
Matthew Wild <mwild1@gmail.com>
parents:
12729
diff
changeset
|
42 if not module:may(":create-persistent-room", event.actor) then |
|
9053
ea9e1f8f3013
MUC: Allow restricting public/persistent room options to service admins (muc_room_allow_public/muc_room_allow_persistent)
Matthew Wild <mwild1@gmail.com>
parents:
9035
diff
changeset
|
43 return; -- Not allowed |
|
ea9e1f8f3013
MUC: Allow restricting public/persistent room options to service admins (muc_room_allow_public/muc_room_allow_persistent)
Matthew Wild <mwild1@gmail.com>
parents:
9035
diff
changeset
|
44 end |
|
6991
84e01dbb739e
MUC: Update all config form handlers to take advantage of the new per-option events
Matthew Wild <mwild1@gmail.com>
parents:
6222
diff
changeset
|
45 if set_persistent(event.room, event.value) then |
|
6222
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
46 event.status_codes["104"] = true; |
|
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
47 end |
|
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
48 end); |
|
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
49 |
|
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
50 module:hook("muc-disco#info", function(event) |
|
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
51 event.reply:tag("feature", {var = get_persistent(event.room) and "muc_persistent" or "muc_temporary"}):up(); |
|
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
52 end); |
|
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
53 |
|
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
54 module:hook("muc-room-destroyed", function(event) |
|
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
55 set_persistent(event.room, false); |
|
9014
326fedc1d3c6
MUC: Unset persistence of destroyed rooms later in event chain
Kim Alvefur <zash@zash.se>
parents:
7401
diff
changeset
|
56 end, -100); |
|
6222
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
57 |
|
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
58 return { |
|
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
59 get = get_persistent; |
|
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
60 set = set_persistent; |
|
355b29881117
plugins/muc: Move persistent room configuration to own module
daurnimator <quae@daurnimator.com>
parents:
diff
changeset
|
61 }; |
