Mercurial > prosody-hg
annotate plugins/muc/hats.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 | 365212120b82 |
| children | 18bc411d61fe |
| rev | line source |
|---|---|
|
12977
74b9e05af71e
plugins: Prefix module imports with prosody namespace
Kim Alvefur <zash@zash.se>
parents:
11245
diff
changeset
|
1 local st = require "prosody.util.stanza"; |
|
10714
9ecad2304297
MUC: Switch hats to new presence APIs
Matthew Wild <mwild1@gmail.com>
parents:
10693
diff
changeset
|
2 local muc_util = module:require "muc/util"; |
|
10693
76bb806cdd4b
MUC: Add initial hats support (broadcast only)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
3 |
|
13468
98806cac64c3
MUC: Switch to official XEP-0317 namespace for Hats (including compat) (thanks nicoco)
Kim Alvefur <zash@zash.se>
parents:
12977
diff
changeset
|
4 local hats_compat = module:get_option_boolean("muc_hats_compat", true); -- COMPAT for pre-XEP namespace, TODO reconsider default for next release |
|
98806cac64c3
MUC: Switch to official XEP-0317 namespace for Hats (including compat) (thanks nicoco)
Kim Alvefur <zash@zash.se>
parents:
12977
diff
changeset
|
5 |
|
98806cac64c3
MUC: Switch to official XEP-0317 namespace for Hats (including compat) (thanks nicoco)
Kim Alvefur <zash@zash.se>
parents:
12977
diff
changeset
|
6 local xmlns_hats_legacy = "xmpp:prosody.im/protocol/hats:1"; |
|
98806cac64c3
MUC: Switch to official XEP-0317 namespace for Hats (including compat) (thanks nicoco)
Kim Alvefur <zash@zash.se>
parents:
12977
diff
changeset
|
7 local xmlns_hats = "urn:xmpp:hats:0"; |
|
10693
76bb806cdd4b
MUC: Add initial hats support (broadcast only)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
8 |
|
10714
9ecad2304297
MUC: Switch hats to new presence APIs
Matthew Wild <mwild1@gmail.com>
parents:
10693
diff
changeset
|
9 -- Strip any hats claimed by the client (to prevent spoofing) |
|
9ecad2304297
MUC: Switch hats to new presence APIs
Matthew Wild <mwild1@gmail.com>
parents:
10693
diff
changeset
|
10 muc_util.add_filtered_namespace(xmlns_hats); |
|
10693
76bb806cdd4b
MUC: Add initial hats support (broadcast only)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
11 |
|
11245
43b43e7156b8
MUC: Add support for presence probes (fixes #1535)
JC Brand <jc@opkode.com>
parents:
10714
diff
changeset
|
12 |
|
10714
9ecad2304297
MUC: Switch hats to new presence APIs
Matthew Wild <mwild1@gmail.com>
parents:
10693
diff
changeset
|
13 module:hook("muc-build-occupant-presence", function (event) |
|
11245
43b43e7156b8
MUC: Add support for presence probes (fixes #1535)
JC Brand <jc@opkode.com>
parents:
10714
diff
changeset
|
14 local bare_jid = event.occupant and event.occupant.bare_jid or event.bare_jid; |
|
43b43e7156b8
MUC: Add support for presence probes (fixes #1535)
JC Brand <jc@opkode.com>
parents:
10714
diff
changeset
|
15 local aff_data = event.room:get_affiliation_data(bare_jid); |
|
10693
76bb806cdd4b
MUC: Add initial hats support (broadcast only)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
16 local hats = aff_data and aff_data.hats; |
|
76bb806cdd4b
MUC: Add initial hats support (broadcast only)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
17 if not hats then return; end |
|
76bb806cdd4b
MUC: Add initial hats support (broadcast only)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
18 local hats_el; |
|
13469
f9171624fd03
MUC: Fix legacy hats (thanks nicoco)
Kim Alvefur <zash@zash.se>
parents:
13468
diff
changeset
|
19 local legacy_hats_el; |
|
10693
76bb806cdd4b
MUC: Add initial hats support (broadcast only)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
20 for hat_id, hat_data in pairs(hats) do |
|
76bb806cdd4b
MUC: Add initial hats support (broadcast only)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
21 if hat_data.active then |
|
76bb806cdd4b
MUC: Add initial hats support (broadcast only)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
22 if not hats_el then |
|
76bb806cdd4b
MUC: Add initial hats support (broadcast only)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
23 hats_el = st.stanza("hats", { xmlns = xmlns_hats }); |
|
76bb806cdd4b
MUC: Add initial hats support (broadcast only)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
24 end |
|
76bb806cdd4b
MUC: Add initial hats support (broadcast only)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
25 hats_el:tag("hat", { uri = hat_id, title = hat_data.title }):up(); |
|
13469
f9171624fd03
MUC: Fix legacy hats (thanks nicoco)
Kim Alvefur <zash@zash.se>
parents:
13468
diff
changeset
|
26 |
|
13468
98806cac64c3
MUC: Switch to official XEP-0317 namespace for Hats (including compat) (thanks nicoco)
Kim Alvefur <zash@zash.se>
parents:
12977
diff
changeset
|
27 if hats_compat then |
|
13523
365212120b82
MUC: Fix error with nonlegacy hats.
Aidan Epstein <aidan@jmad.org>
parents:
13469
diff
changeset
|
28 if not legacy_hats_el then |
|
13469
f9171624fd03
MUC: Fix legacy hats (thanks nicoco)
Kim Alvefur <zash@zash.se>
parents:
13468
diff
changeset
|
29 legacy_hats_el = st.stanza("hats", { xmlns = xmlns_hats_legacy }); |
|
13468
98806cac64c3
MUC: Switch to official XEP-0317 namespace for Hats (including compat) (thanks nicoco)
Kim Alvefur <zash@zash.se>
parents:
12977
diff
changeset
|
30 end |
|
13469
f9171624fd03
MUC: Fix legacy hats (thanks nicoco)
Kim Alvefur <zash@zash.se>
parents:
13468
diff
changeset
|
31 legacy_hats_el:tag("hat", { uri = hat_id, title = hat_data.title }):up(); |
|
13468
98806cac64c3
MUC: Switch to official XEP-0317 namespace for Hats (including compat) (thanks nicoco)
Kim Alvefur <zash@zash.se>
parents:
12977
diff
changeset
|
32 end |
|
10693
76bb806cdd4b
MUC: Add initial hats support (broadcast only)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
33 end |
|
76bb806cdd4b
MUC: Add initial hats support (broadcast only)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
34 end |
|
76bb806cdd4b
MUC: Add initial hats support (broadcast only)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
35 if not hats_el then return; end |
|
76bb806cdd4b
MUC: Add initial hats support (broadcast only)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
36 event.stanza:add_direct_child(hats_el); |
|
13469
f9171624fd03
MUC: Fix legacy hats (thanks nicoco)
Kim Alvefur <zash@zash.se>
parents:
13468
diff
changeset
|
37 |
|
f9171624fd03
MUC: Fix legacy hats (thanks nicoco)
Kim Alvefur <zash@zash.se>
parents:
13468
diff
changeset
|
38 if legacy_hats_el then |
|
f9171624fd03
MUC: Fix legacy hats (thanks nicoco)
Kim Alvefur <zash@zash.se>
parents:
13468
diff
changeset
|
39 event.stanza:add_direct_child(legacy_hats_el); |
|
f9171624fd03
MUC: Fix legacy hats (thanks nicoco)
Kim Alvefur <zash@zash.se>
parents:
13468
diff
changeset
|
40 end |
|
10693
76bb806cdd4b
MUC: Add initial hats support (broadcast only)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
41 end); |
