Mercurial > prosody-hg
annotate plugins/mod_offline.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 | 74b9e05af71e |
| children | 30d457b2b0c4 |
| rev | line source |
|---|---|
|
2680
1b267876246a
Backed out changeset e7b09424b486 (not removing mod_offline for trunk)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
1 -- Prosody IM |
|
1b267876246a
Backed out changeset e7b09424b486 (not removing mod_offline for trunk)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
2 -- Copyright (C) 2008-2009 Matthew Wild |
|
1b267876246a
Backed out changeset e7b09424b486 (not removing mod_offline for trunk)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
3 -- Copyright (C) 2008-2009 Waqas Hussain |
|
5776
bd0ff8ae98a8
Remove all trailing whitespace
Florian Zeitz <florob@babelmonkeys.de>
parents:
3973
diff
changeset
|
4 -- |
|
2680
1b267876246a
Backed out changeset e7b09424b486 (not removing mod_offline for trunk)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
5 -- This project is MIT/X11 licensed. Please see the |
|
1b267876246a
Backed out changeset e7b09424b486 (not removing mod_offline for trunk)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
6 -- COPYING file in the source package for more information. |
|
1b267876246a
Backed out changeset e7b09424b486 (not removing mod_offline for trunk)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
7 -- |
|
1b267876246a
Backed out changeset e7b09424b486 (not removing mod_offline for trunk)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
8 |
|
2737
2251f8898900
mod_offline: Convert to Unix line endings.
Waqas Hussain <waqas20@gmail.com>
parents:
2680
diff
changeset
|
9 |
|
12977
74b9e05af71e
plugins: Prefix module imports with prosody namespace
Kim Alvefur <zash@zash.se>
parents:
10296
diff
changeset
|
10 local datetime = require "prosody.util.datetime"; |
|
74b9e05af71e
plugins: Prefix module imports with prosody namespace
Kim Alvefur <zash@zash.se>
parents:
10296
diff
changeset
|
11 local jid_split = require "prosody.util.jid".split; |
|
2737
2251f8898900
mod_offline: Convert to Unix line endings.
Waqas Hussain <waqas20@gmail.com>
parents:
2680
diff
changeset
|
12 |
|
8024
8eec715c13a6
mod_offline: Switch to using archive store via the storagemanager API
Kim Alvefur <zash@zash.se>
parents:
6834
diff
changeset
|
13 local offline_messages = module:open_store("offline", "archive"); |
|
8eec715c13a6
mod_offline: Switch to using archive store via the storagemanager API
Kim Alvefur <zash@zash.se>
parents:
6834
diff
changeset
|
14 |
|
2737
2251f8898900
mod_offline: Convert to Unix line endings.
Waqas Hussain <waqas20@gmail.com>
parents:
2680
diff
changeset
|
15 module:add_feature("msgoffline"); |
|
2251f8898900
mod_offline: Convert to Unix line endings.
Waqas Hussain <waqas20@gmail.com>
parents:
2680
diff
changeset
|
16 |
|
3972
a05cf5d9c7ab
mod_message, mod_offline: Change message/offline/store -> message/offline/handle
Robert Hoelz <rob@hoelz.ro>
parents:
3971
diff
changeset
|
17 module:hook("message/offline/handle", function(event) |
|
2737
2251f8898900
mod_offline: Convert to Unix line endings.
Waqas Hussain <waqas20@gmail.com>
parents:
2680
diff
changeset
|
18 local origin, stanza = event.origin, event.stanza; |
|
2251f8898900
mod_offline: Convert to Unix line endings.
Waqas Hussain <waqas20@gmail.com>
parents:
2680
diff
changeset
|
19 local to = stanza.attr.to; |
|
8024
8eec715c13a6
mod_offline: Switch to using archive store via the storagemanager API
Kim Alvefur <zash@zash.se>
parents:
6834
diff
changeset
|
20 local node; |
|
2737
2251f8898900
mod_offline: Convert to Unix line endings.
Waqas Hussain <waqas20@gmail.com>
parents:
2680
diff
changeset
|
21 if to then |
|
8024
8eec715c13a6
mod_offline: Switch to using archive store via the storagemanager API
Kim Alvefur <zash@zash.se>
parents:
6834
diff
changeset
|
22 node = jid_split(to) |
|
2737
2251f8898900
mod_offline: Convert to Unix line endings.
Waqas Hussain <waqas20@gmail.com>
parents:
2680
diff
changeset
|
23 else |
|
8024
8eec715c13a6
mod_offline: Switch to using archive store via the storagemanager API
Kim Alvefur <zash@zash.se>
parents:
6834
diff
changeset
|
24 node = origin.username; |
|
2737
2251f8898900
mod_offline: Convert to Unix line endings.
Waqas Hussain <waqas20@gmail.com>
parents:
2680
diff
changeset
|
25 end |
|
5776
bd0ff8ae98a8
Remove all trailing whitespace
Florian Zeitz <florob@babelmonkeys.de>
parents:
3973
diff
changeset
|
26 |
|
10296
7072569044d4
mod_offline: Log a debug message when message is stored
Kim Alvefur <zash@zash.se>
parents:
10242
diff
changeset
|
27 local ok = offline_messages:append(node, nil, stanza, os.time(), ""); |
|
7072569044d4
mod_offline: Log a debug message when message is stored
Kim Alvefur <zash@zash.se>
parents:
10242
diff
changeset
|
28 if ok then |
|
7072569044d4
mod_offline: Log a debug message when message is stored
Kim Alvefur <zash@zash.se>
parents:
10242
diff
changeset
|
29 module:log("debug", "Saved to offline storage: %s", stanza:top_tag()); |
|
7072569044d4
mod_offline: Log a debug message when message is stored
Kim Alvefur <zash@zash.se>
parents:
10242
diff
changeset
|
30 end |
|
7072569044d4
mod_offline: Log a debug message when message is stored
Kim Alvefur <zash@zash.se>
parents:
10242
diff
changeset
|
31 return ok; |
|
6834
750a97b45f88
mod_offline: Decrease priority of event handlers so 3rd party hooks fire first by default
Kim Alvefur <zash@zash.se>
parents:
5776
diff
changeset
|
32 end, -1); |
|
2737
2251f8898900
mod_offline: Convert to Unix line endings.
Waqas Hussain <waqas20@gmail.com>
parents:
2680
diff
changeset
|
33 |
|
2251f8898900
mod_offline: Convert to Unix line endings.
Waqas Hussain <waqas20@gmail.com>
parents:
2680
diff
changeset
|
34 module:hook("message/offline/broadcast", function(event) |
|
2251f8898900
mod_offline: Convert to Unix line endings.
Waqas Hussain <waqas20@gmail.com>
parents:
2680
diff
changeset
|
35 local origin = event.origin; |
|
10242
7e5d2a6c9390
mod_offline: Add some debug logging to reduce confusion
Kim Alvefur <zash@zash.se>
parents:
8030
diff
changeset
|
36 origin.log("debug", "Broadcasting offline messages"); |
|
3520
dc94193ec942
Alter mod_offline to respect negative priority resources
Robert Hoelz <rob@hoelz.ro>
parents:
2737
diff
changeset
|
37 |
|
3973
f5416372350d
Don't check priority in mod_offline
Robert Hoelz <rob@hoelz.ro>
parents:
3972
diff
changeset
|
38 local node, host = origin.username, origin.host; |
|
3540
bc139431830b
Monster whitespace commit (beware the whitespace monster).
Waqas Hussain <waqas20@gmail.com>
parents:
3520
diff
changeset
|
39 |
|
8024
8eec715c13a6
mod_offline: Switch to using archive store via the storagemanager API
Kim Alvefur <zash@zash.se>
parents:
6834
diff
changeset
|
40 local data = offline_messages:find(node); |
|
3973
f5416372350d
Don't check priority in mod_offline
Robert Hoelz <rob@hoelz.ro>
parents:
3972
diff
changeset
|
41 if not data then return true; end |
|
8024
8eec715c13a6
mod_offline: Switch to using archive store via the storagemanager API
Kim Alvefur <zash@zash.se>
parents:
6834
diff
changeset
|
42 for _, stanza, when in data do |
|
8eec715c13a6
mod_offline: Switch to using archive store via the storagemanager API
Kim Alvefur <zash@zash.se>
parents:
6834
diff
changeset
|
43 stanza:tag("delay", {xmlns = "urn:xmpp:delay", from = host, stamp = datetime.datetime(when)}):up(); -- XEP-0203 |
|
3973
f5416372350d
Don't check priority in mod_offline
Robert Hoelz <rob@hoelz.ro>
parents:
3972
diff
changeset
|
44 origin.send(stanza); |
|
3540
bc139431830b
Monster whitespace commit (beware the whitespace monster).
Waqas Hussain <waqas20@gmail.com>
parents:
3520
diff
changeset
|
45 end |
|
10242
7e5d2a6c9390
mod_offline: Add some debug logging to reduce confusion
Kim Alvefur <zash@zash.se>
parents:
8030
diff
changeset
|
46 local ok = offline_messages:delete(node); |
|
7e5d2a6c9390
mod_offline: Add some debug logging to reduce confusion
Kim Alvefur <zash@zash.se>
parents:
8030
diff
changeset
|
47 if type(ok) == "number" and ok > 0 then |
|
7e5d2a6c9390
mod_offline: Add some debug logging to reduce confusion
Kim Alvefur <zash@zash.se>
parents:
8030
diff
changeset
|
48 origin.log("debug", "%d offline messages consumed"); |
|
7e5d2a6c9390
mod_offline: Add some debug logging to reduce confusion
Kim Alvefur <zash@zash.se>
parents:
8030
diff
changeset
|
49 end |
|
3973
f5416372350d
Don't check priority in mod_offline
Robert Hoelz <rob@hoelz.ro>
parents:
3972
diff
changeset
|
50 return true; |
|
6834
750a97b45f88
mod_offline: Decrease priority of event handlers so 3rd party hooks fire first by default
Kim Alvefur <zash@zash.se>
parents:
5776
diff
changeset
|
51 end, -1); |
