annotate core/features.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 4e908958660e
children 404d3644ac4a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
12972
ead41e25ebc0 core: Prefix module imports with prosody namespace
Kim Alvefur <zash@zash.se>
parents: 12957
diff changeset
1 local set = require "prosody.util.set";
12252
4bfe658415a0 core.features: New module to track and expose the features supported by Prosody
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
2
4bfe658415a0 core.features: New module to track and expose the features supported by Prosody
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
3 return {
4bfe658415a0 core.features: New module to track and expose the features supported by Prosody
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
4 available = set.new{
4bfe658415a0 core.features: New module to track and expose the features supported by Prosody
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
5 -- mod_bookmarks bundled
4bfe658415a0 core.features: New module to track and expose the features supported by Prosody
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
6 "mod_bookmarks";
13438
0a0dd2505baa features: Add mod_server_info
Matthew Wild <mwild1@gmail.com>
parents: 13425
diff changeset
7 -- mod_server_info bundled
0a0dd2505baa features: Add mod_server_info
Matthew Wild <mwild1@gmail.com>
parents: 13425
diff changeset
8 "mod_server_info";
13583
e77ef9a4604f mod_flags: New module to view and manage flags on user accounts via shell/API
Matthew Wild <mwild1@gmail.com>
parents: 13455
diff changeset
9 -- mod_flags bundled
e77ef9a4604f mod_flags: New module to view and manage flags on user accounts via shell/API
Matthew Wild <mwild1@gmail.com>
parents: 13455
diff changeset
10 "mod_flags";
13622
4e908958660e features: Add feature for bundled mod_cloud_notify
Matthew Wild <mwild1@gmail.com>
parents: 13583
diff changeset
11 -- mod_cloud_notify bundled
4e908958660e features: Add feature for bundled mod_cloud_notify
Matthew Wild <mwild1@gmail.com>
parents: 13583
diff changeset
12 "mod_cloud_notify";
12655
a5a0783e9241 features: Add "permissions" feature for role-auth
Matthew Wild <mwild1@gmail.com>
parents: 12252
diff changeset
13 -- Roles, module.may and per-session authz
a5a0783e9241 features: Add "permissions" feature for role-auth
Matthew Wild <mwild1@gmail.com>
parents: 12252
diff changeset
14 "permissions";
12955
d32926897ca4 core.features: Add feature for prosody.loader
Kim Alvefur <zash@zash.se>
parents: 12655
diff changeset
15 -- prosody.* namespace
d32926897ca4 core.features: Add feature for prosody.loader
Kim Alvefur <zash@zash.se>
parents: 12655
diff changeset
16 "loader";
12957
e625ad5a9889 features: Add "keyval+"
Matthew Wild <mwild1@gmail.com>
parents: 12955
diff changeset
17 -- "keyval+" store
e625ad5a9889 features: Add "keyval+"
Matthew Wild <mwild1@gmail.com>
parents: 12955
diff changeset
18 "keyval+";
13110
d5f322dd424b mod_s2s: Add event where resolver for s2sout can be tweaked
Kim Alvefur <zash@zash.se>
parents: 12252
diff changeset
19
d5f322dd424b mod_s2s: Add event where resolver for s2sout can be tweaked
Kim Alvefur <zash@zash.se>
parents: 12252
diff changeset
20 "s2sout-pre-connect-event";
13170
082c7d856e61 core, plugins: Split prosody:user role into prosody:{guest,registered,member}
Matthew Wild <mwild1@gmail.com>
parents: 13111
diff changeset
21
082c7d856e61 core, plugins: Split prosody:user role into prosody:{guest,registered,member}
Matthew Wild <mwild1@gmail.com>
parents: 13111
diff changeset
22 -- prosody:guest, prosody:registered, prosody:member
082c7d856e61 core, plugins: Split prosody:user role into prosody:{guest,registered,member}
Matthew Wild <mwild1@gmail.com>
parents: 13111
diff changeset
23 "split-user-roles";
13201
65fb0d7a2312 moduleapi: Add enum config option method
Kim Alvefur <zash@zash.se>
parents: 13170
diff changeset
24
65fb0d7a2312 moduleapi: Add enum config option method
Kim Alvefur <zash@zash.se>
parents: 13170
diff changeset
25 -- new moduleapi methods
65fb0d7a2312 moduleapi: Add enum config option method
Kim Alvefur <zash@zash.se>
parents: 13170
diff changeset
26 "getopt-enum";
13203
aa6c2692a4be core.moduleapi: Allow specifying an acceptable range for number options
Kim Alvefur <zash@zash.se>
parents: 13201
diff changeset
27 "getopt-interval";
13204
c9ef35fab0b1 core.moduleapi: Add :get_option_period for parsing time intervals
Kim Alvefur <zash@zash.se>
parents: 13203
diff changeset
28 "getopt-period";
13211
4d4f9e42bcf8 moduleapi: Add :get_option_integer()
Kim Alvefur <zash@zash.se>
parents: 13204
diff changeset
29 "getopt-integer";
13425
3cebb30e7503 features: Add module-ready (for commit e20949a10118)
Matthew Wild <mwild1@gmail.com>
parents: 13211
diff changeset
30
3cebb30e7503 features: Add module-ready (for commit e20949a10118)
Matthew Wild <mwild1@gmail.com>
parents: 13211
diff changeset
31 -- new module.ready()
3cebb30e7503 features: Add module-ready (for commit e20949a10118)
Matthew Wild <mwild1@gmail.com>
parents: 13211
diff changeset
32 "module-ready";
13455
2a001cd7f99a core.features: Advertise that events are fired for SIGUSR1/2
Kim Alvefur <zash@zash.se>
parents: 13438
diff changeset
33
2a001cd7f99a core.features: Advertise that events are fired for SIGUSR1/2
Kim Alvefur <zash@zash.se>
parents: 13438
diff changeset
34 -- SIGUSR1 and 2 events
2a001cd7f99a core.features: Advertise that events are fired for SIGUSR1/2
Kim Alvefur <zash@zash.se>
parents: 13438
diff changeset
35 "signal-events";
12252
4bfe658415a0 core.features: New module to track and expose the features supported by Prosody
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
36 };
4bfe658415a0 core.features: New module to track and expose the features supported by Prosody
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
37 };