annotate plugins/mod_lastactivity.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
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2018
418c04834017 mod_lastactivity: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
1 -- Prosody IM
2923
b7049746bd29 Update copyright headers for 2010
Matthew Wild <mwild1@gmail.com>
parents: 2029
diff changeset
2 -- Copyright (C) 2008-2010 Matthew Wild
b7049746bd29 Update copyright headers for 2010
Matthew Wild <mwild1@gmail.com>
parents: 2029
diff changeset
3 -- Copyright (C) 2008-2010 Waqas Hussain
5776
bd0ff8ae98a8 Remove all trailing whitespace
Florian Zeitz <florob@babelmonkeys.de>
parents: 2923
diff changeset
4 --
2018
418c04834017 mod_lastactivity: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
5 -- This project is MIT/X11 licensed. Please see the
418c04834017 mod_lastactivity: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
6 -- COPYING file in the source package for more information.
418c04834017 mod_lastactivity: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
7 --
418c04834017 mod_lastactivity: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
8
12977
74b9e05af71e plugins: Prefix module imports with prosody namespace
Kim Alvefur <zash@zash.se>
parents: 10750
diff changeset
9 local st = require "prosody.util.stanza";
74b9e05af71e plugins: Prefix module imports with prosody namespace
Kim Alvefur <zash@zash.se>
parents: 10750
diff changeset
10 local is_contact_subscribed = require "prosody.core.rostermanager".is_contact_subscribed;
74b9e05af71e plugins: Prefix module imports with prosody namespace
Kim Alvefur <zash@zash.se>
parents: 10750
diff changeset
11 local jid_bare = require "prosody.util.jid".bare;
74b9e05af71e plugins: Prefix module imports with prosody namespace
Kim Alvefur <zash@zash.se>
parents: 10750
diff changeset
12 local jid_split = require "prosody.util.jid".split;
2018
418c04834017 mod_lastactivity: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
13
418c04834017 mod_lastactivity: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
14 module:add_feature("jabber:iq:last");
418c04834017 mod_lastactivity: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
15
418c04834017 mod_lastactivity: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
16 local map = {};
418c04834017 mod_lastactivity: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
17
418c04834017 mod_lastactivity: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
18 module:hook("pre-presence/bare", function(event)
418c04834017 mod_lastactivity: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
19 local stanza = event.stanza;
418c04834017 mod_lastactivity: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
20 if not(stanza.attr.to) and stanza.attr.type == "unavailable" then
418c04834017 mod_lastactivity: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
21 local t = os.time();
6302
76699a0ae4c4 mod_lastactivity, mod_legacyauth, mod_presence, mod_saslauth, mod_tls: Use the newer stanza:get_child APIs and optimize away some table lookups
Kim Alvefur <zash@zash.se>
parents: 5776
diff changeset
22 local s = stanza:get_child_text("status");
2018
418c04834017 mod_lastactivity: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
23 map[event.origin.username] = {s = s, t = t};
418c04834017 mod_lastactivity: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
24 end
2029
d2363643a5c0 mod_lastactivity: Gave a positive priority to the presence event hook.
Waqas Hussain <waqas20@gmail.com>
parents: 2026
diff changeset
25 end, 10);
2018
418c04834017 mod_lastactivity: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
26
9224
a84dbd2e08bc mod_lastactivity: Simplify iq handling by hooking on iq-get/ instead of iq/.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 6302
diff changeset
27 module:hook("iq-get/bare/jabber:iq:last:query", function(event)
2018
418c04834017 mod_lastactivity: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
28 local origin, stanza = event.origin, event.stanza;
9224
a84dbd2e08bc mod_lastactivity: Simplify iq handling by hooking on iq-get/ instead of iq/.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 6302
diff changeset
29 local username = jid_split(stanza.attr.to) or origin.username;
a84dbd2e08bc mod_lastactivity: Simplify iq handling by hooking on iq-get/ instead of iq/.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 6302
diff changeset
30 if not stanza.attr.to or is_contact_subscribed(username, module.host, jid_bare(stanza.attr.from)) then
a84dbd2e08bc mod_lastactivity: Simplify iq handling by hooking on iq-get/ instead of iq/.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 6302
diff changeset
31 local seconds, text = "0", "";
a84dbd2e08bc mod_lastactivity: Simplify iq handling by hooking on iq-get/ instead of iq/.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 6302
diff changeset
32 if map[username] then
10750
ff087f2d4cb6 mod_lastactivity: Encode seconds as decimal, not float
Kim Alvefur <zash@zash.se>
parents: 9224
diff changeset
33 seconds = string.format("%d", os.difftime(os.time(), map[username].t));
9224
a84dbd2e08bc mod_lastactivity: Simplify iq handling by hooking on iq-get/ instead of iq/.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 6302
diff changeset
34 text = map[username].s;
2018
418c04834017 mod_lastactivity: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
35 end
9224
a84dbd2e08bc mod_lastactivity: Simplify iq handling by hooking on iq-get/ instead of iq/.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 6302
diff changeset
36 origin.send(st.reply(stanza):tag('query', {xmlns='jabber:iq:last', seconds=seconds}):text(text));
a84dbd2e08bc mod_lastactivity: Simplify iq handling by hooking on iq-get/ instead of iq/.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 6302
diff changeset
37 else
a84dbd2e08bc mod_lastactivity: Simplify iq handling by hooking on iq-get/ instead of iq/.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 6302
diff changeset
38 origin.send(st.error_reply(stanza, 'auth', 'forbidden'));
2018
418c04834017 mod_lastactivity: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
39 end
9224
a84dbd2e08bc mod_lastactivity: Simplify iq handling by hooking on iq-get/ instead of iq/.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 6302
diff changeset
40 return true;
2018
418c04834017 mod_lastactivity: Initial commit.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
41 end);
2026
97b17187b29d mod_lastactivity: Persist data across reloads.
Waqas Hussain <waqas20@gmail.com>
parents: 2025
diff changeset
42
97b17187b29d mod_lastactivity: Persist data across reloads.
Waqas Hussain <waqas20@gmail.com>
parents: 2025
diff changeset
43 module.save = function()
97b17187b29d mod_lastactivity: Persist data across reloads.
Waqas Hussain <waqas20@gmail.com>
parents: 2025
diff changeset
44 return {map = map};
97b17187b29d mod_lastactivity: Persist data across reloads.
Waqas Hussain <waqas20@gmail.com>
parents: 2025
diff changeset
45 end
97b17187b29d mod_lastactivity: Persist data across reloads.
Waqas Hussain <waqas20@gmail.com>
parents: 2025
diff changeset
46 module.restore = function(data)
97b17187b29d mod_lastactivity: Persist data across reloads.
Waqas Hussain <waqas20@gmail.com>
parents: 2025
diff changeset
47 map = data.map or {};
97b17187b29d mod_lastactivity: Persist data across reloads.
Waqas Hussain <waqas20@gmail.com>
parents: 2025
diff changeset
48 end
97b17187b29d mod_lastactivity: Persist data across reloads.
Waqas Hussain <waqas20@gmail.com>
parents: 2025
diff changeset
49