annotate plugins/mod_uptime.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
1523
841d61be198f Remove version number from copyright headers
Matthew Wild <mwild1@gmail.com>
parents: 1495
diff changeset
1 -- Prosody IM
2923
b7049746bd29 Update copyright headers for 2010
Matthew Wild <mwild1@gmail.com>
parents: 2017
diff changeset
2 -- Copyright (C) 2008-2010 Matthew Wild
b7049746bd29 Update copyright headers for 2010
Matthew Wild <mwild1@gmail.com>
parents: 2017
diff changeset
3 -- Copyright (C) 2008-2010 Waqas Hussain
5776
bd0ff8ae98a8 Remove all trailing whitespace
Florian Zeitz <florob@babelmonkeys.de>
parents: 4345
diff changeset
4 --
758
b1885732e979 GPL->MIT!
Matthew Wild <mwild1@gmail.com>
parents: 615
diff changeset
5 -- This project is MIT/X11 licensed. Please see the
b1885732e979 GPL->MIT!
Matthew Wild <mwild1@gmail.com>
parents: 615
diff changeset
6 -- COPYING file in the source package for more information.
519
cccd610a0ef9 Insert copyright/license headers
Matthew Wild <mwild1@gmail.com>
parents: 438
diff changeset
7 --
cccd610a0ef9 Insert copyright/license headers
Matthew Wild <mwild1@gmail.com>
parents: 438
diff changeset
8
12977
74b9e05af71e plugins: Prefix module imports with prosody namespace
Kim Alvefur <zash@zash.se>
parents: 10749
diff changeset
9 local st = require "prosody.util.stanza";
1494
bdfa5274e111 mod_uptime: Convert to unix line endings
Matthew Wild <mwild1@gmail.com>
parents: 896
diff changeset
10
1495
6c745a108e68 mod_uptime: Use time of server start rather than module load
Matthew Wild <mwild1@gmail.com>
parents: 1494
diff changeset
11 local start_time = prosody.start_time;
4345
f6d694b1cdb3 mod_uptime: Use module:hook_global()
Matthew Wild <mwild1@gmail.com>
parents: 3540
diff changeset
12 module:hook_global("server-started", function() start_time = prosody.start_time end);
1524
a89fec6d76d2 mod_uptime: Fix bad uptime if module is loaded at startup
Matthew Wild <mwild1@gmail.com>
parents: 1523
diff changeset
13
3232
c47bfd62701c mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents: 2923
diff changeset
14 -- XEP-0012: Last activity
1494
bdfa5274e111 mod_uptime: Convert to unix line endings
Matthew Wild <mwild1@gmail.com>
parents: 896
diff changeset
15 module:add_feature("jabber:iq:last");
bdfa5274e111 mod_uptime: Convert to unix line endings
Matthew Wild <mwild1@gmail.com>
parents: 896
diff changeset
16
9226
affd84be3fc3 mod_uptime: Simplify iq handling by hooking on iq-get/ instead of iq/.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 8962
diff changeset
17 module:hook("iq-get/host/jabber:iq:last:query", function(event)
2015
2140c994671e mod_uptime: Updated to use events (which also fixes a few minor issues).
Waqas Hussain <waqas20@gmail.com>
parents: 1524
diff changeset
18 local origin, stanza = event.origin, event.stanza;
10749
abbdf72b0710 mod_uptime: Encode uptime as decimal, fix #1536 (thanks Martin)
Kim Alvefur <zash@zash.se>
parents: 10565
diff changeset
19 origin.send(st.reply(stanza):tag("query", {xmlns = "jabber:iq:last", seconds = tostring(("%d"):format(os.difftime(os.time(), start_time)))}));
9226
affd84be3fc3 mod_uptime: Simplify iq handling by hooking on iq-get/ instead of iq/.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 8962
diff changeset
20 return true;
2015
2140c994671e mod_uptime: Updated to use events (which also fixes a few minor issues).
Waqas Hussain <waqas20@gmail.com>
parents: 1524
diff changeset
21 end);
3232
c47bfd62701c mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents: 2923
diff changeset
22
c47bfd62701c mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents: 2923
diff changeset
23 -- Ad-hoc command
8962
6c06bd455bbf mod_uptime: Depend on mod_adhoc
Kim Alvefur <zash@zash.se>
parents: 8344
diff changeset
24 module:depends "adhoc";
3232
c47bfd62701c mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents: 2923
diff changeset
25 local adhoc_new = module:require "adhoc".new;
c47bfd62701c mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents: 2923
diff changeset
26
c47bfd62701c mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents: 2923
diff changeset
27 function uptime_text()
c47bfd62701c mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents: 2923
diff changeset
28 local t = os.time()-prosody.start_time;
c47bfd62701c mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents: 2923
diff changeset
29 local seconds = t%60;
c47bfd62701c mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents: 2923
diff changeset
30 t = (t - seconds)/60;
c47bfd62701c mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents: 2923
diff changeset
31 local minutes = t%60;
c47bfd62701c mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents: 2923
diff changeset
32 t = (t - minutes)/60;
c47bfd62701c mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents: 2923
diff changeset
33 local hours = t%24;
c47bfd62701c mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents: 2923
diff changeset
34 t = (t - hours)/24;
c47bfd62701c mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents: 2923
diff changeset
35 local days = t;
3540
bc139431830b Monster whitespace commit (beware the whitespace monster).
Waqas Hussain <waqas20@gmail.com>
parents: 3232
diff changeset
36 return string.format("This server has been running for %d day%s, %d hour%s and %d minute%s (since %s)",
bc139431830b Monster whitespace commit (beware the whitespace monster).
Waqas Hussain <waqas20@gmail.com>
parents: 3232
diff changeset
37 days, (days ~= 1 and "s") or "", hours, (hours ~= 1 and "s") or "",
3232
c47bfd62701c mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents: 2923
diff changeset
38 minutes, (minutes ~= 1 and "s") or "", os.date("%c", prosody.start_time));
c47bfd62701c mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents: 2923
diff changeset
39 end
c47bfd62701c mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents: 2923
diff changeset
40
8344
071c0523c4cb mod_uptime: Remove unused arguments [luacheck]
Kim Alvefur <zash@zash.se>
parents: 5776
diff changeset
41 function uptime_command_handler ()
3232
c47bfd62701c mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents: 2923
diff changeset
42 return { info = uptime_text(), status = "completed" };
c47bfd62701c mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents: 2923
diff changeset
43 end
c47bfd62701c mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents: 2923
diff changeset
44
10565
421b2f8369fd mod_adhoc: Improve permission setting (fix #1482) BC
Kim Alvefur <zash@zash.se>
parents: 9572
diff changeset
45 local descriptor = adhoc_new("Get uptime", "uptime", uptime_command_handler, "any");
3232
c47bfd62701c mod_uptime: Add ad-hoc command
Matthew Wild <mwild1@gmail.com>
parents: 2923
diff changeset
46
9572
867e40b82409 mod_ping, mod_uptime: Use module:provides
Kim Alvefur <zash@zash.se>
parents: 9226
diff changeset
47 module:provides("adhoc", descriptor);