Mercurial > prosody-hg
annotate plugins/mod_version.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 | b9267ce1b183 |
| children |
| rev | line source |
|---|---|
|
1523
841d61be198f
Remove version number from copyright headers
Matthew Wild <mwild1@gmail.com>
parents:
1312
diff
changeset
|
1 -- Prosody IM |
|
2923
b7049746bd29
Update copyright headers for 2010
Matthew Wild <mwild1@gmail.com>
parents:
1646
diff
changeset
|
2 -- Copyright (C) 2008-2010 Matthew Wild |
|
b7049746bd29
Update copyright headers for 2010
Matthew Wild <mwild1@gmail.com>
parents:
1646
diff
changeset
|
3 -- Copyright (C) 2008-2010 Waqas Hussain |
|
5776
bd0ff8ae98a8
Remove all trailing whitespace
Florian Zeitz <florob@babelmonkeys.de>
parents:
4793
diff
changeset
|
4 -- |
| 758 | 5 -- This project is MIT/X11 licensed. Please see the |
| 6 -- COPYING file in the source package for more information. | |
|
519
cccd610a0ef9
Insert copyright/license headers
Matthew Wild <mwild1@gmail.com>
parents:
517
diff
changeset
|
7 -- |
|
cccd610a0ef9
Insert copyright/license headers
Matthew Wild <mwild1@gmail.com>
parents:
517
diff
changeset
|
8 |
|
12977
74b9e05af71e
plugins: Prefix module imports with prosody namespace
Kim Alvefur <zash@zash.se>
parents:
9436
diff
changeset
|
9 local st = require "prosody.util.stanza"; |
| 188 | 10 |
|
1646
21bcc7b8b4d8
mod_version: Rewritten to use new API. Added reply caching, and fixed some issues.
Waqas Hussain <waqas20@gmail.com>
parents:
1645
diff
changeset
|
11 module:add_feature("jabber:iq:version"); |
|
421
63be85693710
Modules now sending disco replies
Waqas Hussain <waqas20@gmail.com>
parents:
314
diff
changeset
|
12 |
|
3421
d3852a4d37e2
mod_version: Leave out the os element if hide_os_type is set
Kim Alvefur <zash@zash.se>
parents:
3420
diff
changeset
|
13 local query = st.stanza("query", {xmlns = "jabber:iq:version"}) |
| 9433 | 14 :text_tag("name", "Prosody") |
| 15 :text_tag("version", prosody.version); | |
|
3421
d3852a4d37e2
mod_version: Leave out the os element if hide_os_type is set
Kim Alvefur <zash@zash.se>
parents:
3420
diff
changeset
|
16 |
|
7977
01d6298de991
plugins/various: Use type-specific config API
Kim Alvefur <zash@zash.se>
parents:
5776
diff
changeset
|
17 if not module:get_option_boolean("hide_os_type") then |
|
9436
a950f9fa9137
mod_version: Reduce scope of variable
Kim Alvefur <zash@zash.se>
parents:
9435
diff
changeset
|
18 local platform; |
|
803
5a64649f4b94
mod_version: Operating system detection. Disable with hide_os_type = true in config
Matthew Wild <mwild1@gmail.com>
parents:
760
diff
changeset
|
19 if os.getenv("WINDIR") then |
|
9435
33301038d3e4
mod_version: Rename confusingly named variable
Kim Alvefur <zash@zash.se>
parents:
9434
diff
changeset
|
20 platform = "Windows"; |
|
803
5a64649f4b94
mod_version: Operating system detection. Disable with hide_os_type = true in config
Matthew Wild <mwild1@gmail.com>
parents:
760
diff
changeset
|
21 else |
|
7977
01d6298de991
plugins/various: Use type-specific config API
Kim Alvefur <zash@zash.se>
parents:
5776
diff
changeset
|
22 local os_version_command = module:get_option_string("os_version_command"); |
|
12977
74b9e05af71e
plugins: Prefix module imports with prosody namespace
Kim Alvefur <zash@zash.se>
parents:
9436
diff
changeset
|
23 local ok, pposix = pcall(require, "prosody.util.pposix"); |
|
3483
443139c396c5
mod_version: Use pposix.uname() if available and os_version_command not set
Matthew Wild <mwild1@gmail.com>
parents:
3421
diff
changeset
|
24 if not os_version_command and (ok and pposix and pposix.uname) then |
|
13476
b9267ce1b183
mod_version: Fix uname result style (thanks riau)
Kim Alvefur <zash@zash.se>
parents:
13474
diff
changeset
|
25 local uname, err = pposix.uname(); |
|
b9267ce1b183
mod_version: Fix uname result style (thanks riau)
Kim Alvefur <zash@zash.se>
parents:
13474
diff
changeset
|
26 if not uname then |
|
b9267ce1b183
mod_version: Fix uname result style (thanks riau)
Kim Alvefur <zash@zash.se>
parents:
13474
diff
changeset
|
27 module:log("debug", "Could not retrieve OS name: %s", err); |
|
13474
05c1098084cd
mod_version: Handle access denied from uname()
Kim Alvefur <zash@zash.se>
parents:
12977
diff
changeset
|
28 else |
|
05c1098084cd
mod_version: Handle access denied from uname()
Kim Alvefur <zash@zash.se>
parents:
12977
diff
changeset
|
29 platform = uname.sysname; |
|
05c1098084cd
mod_version: Handle access denied from uname()
Kim Alvefur <zash@zash.se>
parents:
12977
diff
changeset
|
30 end |
|
3483
443139c396c5
mod_version: Use pposix.uname() if available and os_version_command not set
Matthew Wild <mwild1@gmail.com>
parents:
3421
diff
changeset
|
31 end |
|
9435
33301038d3e4
mod_version: Rename confusingly named variable
Kim Alvefur <zash@zash.se>
parents:
9434
diff
changeset
|
32 if not platform then |
|
3483
443139c396c5
mod_version: Use pposix.uname() if available and os_version_command not set
Matthew Wild <mwild1@gmail.com>
parents:
3421
diff
changeset
|
33 local uname = io.popen(os_version_command or "uname"); |
|
443139c396c5
mod_version: Use pposix.uname() if available and os_version_command not set
Matthew Wild <mwild1@gmail.com>
parents:
3421
diff
changeset
|
34 if uname then |
|
9435
33301038d3e4
mod_version: Rename confusingly named variable
Kim Alvefur <zash@zash.se>
parents:
9434
diff
changeset
|
35 platform = uname:read("*a"); |
|
3483
443139c396c5
mod_version: Use pposix.uname() if available and os_version_command not set
Matthew Wild <mwild1@gmail.com>
parents:
3421
diff
changeset
|
36 end |
|
443139c396c5
mod_version: Use pposix.uname() if available and os_version_command not set
Matthew Wild <mwild1@gmail.com>
parents:
3421
diff
changeset
|
37 uname:close(); |
|
803
5a64649f4b94
mod_version: Operating system detection. Disable with hide_os_type = true in config
Matthew Wild <mwild1@gmail.com>
parents:
760
diff
changeset
|
38 end |
|
5a64649f4b94
mod_version: Operating system detection. Disable with hide_os_type = true in config
Matthew Wild <mwild1@gmail.com>
parents:
760
diff
changeset
|
39 end |
|
9435
33301038d3e4
mod_version: Rename confusingly named variable
Kim Alvefur <zash@zash.se>
parents:
9434
diff
changeset
|
40 if platform then |
|
33301038d3e4
mod_version: Rename confusingly named variable
Kim Alvefur <zash@zash.se>
parents:
9434
diff
changeset
|
41 platform = platform:match("^%s*(.-)%s*$") or platform; |
|
33301038d3e4
mod_version: Rename confusingly named variable
Kim Alvefur <zash@zash.se>
parents:
9434
diff
changeset
|
42 query:text_tag("os", platform); |
|
3483
443139c396c5
mod_version: Use pposix.uname() if available and os_version_command not set
Matthew Wild <mwild1@gmail.com>
parents:
3421
diff
changeset
|
43 end |
|
803
5a64649f4b94
mod_version: Operating system detection. Disable with hide_os_type = true in config
Matthew Wild <mwild1@gmail.com>
parents:
760
diff
changeset
|
44 end |
|
5a64649f4b94
mod_version: Operating system detection. Disable with hide_os_type = true in config
Matthew Wild <mwild1@gmail.com>
parents:
760
diff
changeset
|
45 |
|
9227
c0e058633d9a
mod_version: Simplify iq handling by hooking on iq-get/ instead of iq/.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
7977
diff
changeset
|
46 module:hook("iq-get/host/jabber:iq:version:query", function(event) |
|
9434
b502766a10d7
mod_version: Make 'origin' variable local for consistency
Kim Alvefur <zash@zash.se>
parents:
9433
diff
changeset
|
47 local origin, stanza = event.origin, event.stanza; |
|
b502766a10d7
mod_version: Make 'origin' variable local for consistency
Kim Alvefur <zash@zash.se>
parents:
9433
diff
changeset
|
48 origin.send(st.reply(stanza):add_child(query)); |
| 9229 | 49 return true; |
|
704
ef8d0d339172
mod_version: Removed and rearranged some code
Waqas Hussain <waqas20@gmail.com>
parents:
615
diff
changeset
|
50 end); |
