Mercurial > prosody-hg
annotate plugins/mod_turn_external.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 | 50324f66ca2a |
| children | 7fd6feb86dbe |
| rev | line source |
|---|---|
|
12977
74b9e05af71e
plugins: Prefix module imports with prosody namespace
Kim Alvefur <zash@zash.se>
parents:
12437
diff
changeset
|
1 local set = require "prosody.util.set"; |
|
12282
fe5a87b5972f
mod_turn_external: Simplify configuration
Kim Alvefur <zash@zash.se>
parents:
11599
diff
changeset
|
2 |
|
11599
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
3 local secret = module:get_option_string("turn_external_secret"); |
|
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
4 local host = module:get_option_string("turn_external_host", module.host); |
|
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
5 local user = module:get_option_string("turn_external_user"); |
|
13213
50324f66ca2a
plugins: Use integer config API with interval specification where sensible
Kim Alvefur <zash@zash.se>
parents:
13209
diff
changeset
|
6 local port = module:get_option_integer("turn_external_port", 3478, 1, 65535); |
|
13209
c8d949cf6b09
plugins: Switch to :get_option_period() for time range options
Kim Alvefur <zash@zash.se>
parents:
12977
diff
changeset
|
7 local ttl = module:get_option_period("turn_external_ttl", "1 day"); |
|
12282
fe5a87b5972f
mod_turn_external: Simplify configuration
Kim Alvefur <zash@zash.se>
parents:
11599
diff
changeset
|
8 local tcp = module:get_option_boolean("turn_external_tcp", false); |
|
13213
50324f66ca2a
plugins: Use integer config API with interval specification where sensible
Kim Alvefur <zash@zash.se>
parents:
13209
diff
changeset
|
9 local tls_port = module:get_option_integer("turn_external_tls_port", nil, 1, 65535); |
|
11599
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
10 |
|
12437
9f5d0b77e3df
mod_turn_external: Update status and friendlier handling of missing secret option (fixes #1727)
Matthew Wild <mwild1@gmail.com>
parents:
12290
diff
changeset
|
11 if not secret then |
|
9f5d0b77e3df
mod_turn_external: Update status and friendlier handling of missing secret option (fixes #1727)
Matthew Wild <mwild1@gmail.com>
parents:
12290
diff
changeset
|
12 module:log_status("error", "Failed to initialize: the 'turn_external_secret' option is not set in your configuration"); |
|
9f5d0b77e3df
mod_turn_external: Update status and friendlier handling of missing secret option (fixes #1727)
Matthew Wild <mwild1@gmail.com>
parents:
12290
diff
changeset
|
13 return; |
|
9f5d0b77e3df
mod_turn_external: Update status and friendlier handling of missing secret option (fixes #1727)
Matthew Wild <mwild1@gmail.com>
parents:
12290
diff
changeset
|
14 end |
|
11599
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
15 |
|
12282
fe5a87b5972f
mod_turn_external: Simplify configuration
Kim Alvefur <zash@zash.se>
parents:
11599
diff
changeset
|
16 local services = set.new({ "stun-udp"; "turn-udp" }); |
|
fe5a87b5972f
mod_turn_external: Simplify configuration
Kim Alvefur <zash@zash.se>
parents:
11599
diff
changeset
|
17 if tcp then |
|
fe5a87b5972f
mod_turn_external: Simplify configuration
Kim Alvefur <zash@zash.se>
parents:
11599
diff
changeset
|
18 services:add("stun-tcp"); |
|
fe5a87b5972f
mod_turn_external: Simplify configuration
Kim Alvefur <zash@zash.se>
parents:
11599
diff
changeset
|
19 services:add("turn-tcp"); |
|
fe5a87b5972f
mod_turn_external: Simplify configuration
Kim Alvefur <zash@zash.se>
parents:
11599
diff
changeset
|
20 end |
|
12283
b5686debb497
mod_turn_external: Add option to enable TURN over TLS
Kim Alvefur <zash@zash.se>
parents:
12282
diff
changeset
|
21 if tls_port then |
|
b5686debb497
mod_turn_external: Add option to enable TURN over TLS
Kim Alvefur <zash@zash.se>
parents:
12282
diff
changeset
|
22 services:add("turns-tcp"); |
|
b5686debb497
mod_turn_external: Add option to enable TURN over TLS
Kim Alvefur <zash@zash.se>
parents:
12282
diff
changeset
|
23 end |
|
12282
fe5a87b5972f
mod_turn_external: Simplify configuration
Kim Alvefur <zash@zash.se>
parents:
11599
diff
changeset
|
24 |
|
11599
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
25 module:depends "external_services"; |
|
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
26 |
|
12283
b5686debb497
mod_turn_external: Add option to enable TURN over TLS
Kim Alvefur <zash@zash.se>
parents:
12282
diff
changeset
|
27 for _, type in ipairs({ "stun"; "turn"; "turns" }) do |
|
11599
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
28 for _, transport in ipairs({"udp"; "tcp"}) do |
|
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
29 if services:contains(type .. "-" .. transport) then |
|
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
30 module:add_item("external_service", { |
|
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
31 type = type; |
|
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
32 transport = transport; |
|
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
33 host = host; |
|
12283
b5686debb497
mod_turn_external: Add option to enable TURN over TLS
Kim Alvefur <zash@zash.se>
parents:
12282
diff
changeset
|
34 port = type == "turns" and tls_port or port; |
|
11599
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
35 |
|
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
36 username = type == "turn" and user or nil; |
|
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
37 secret = type == "turn" and secret or nil; |
|
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
38 ttl = type == "turn" and ttl or nil; |
|
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
39 }) |
|
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
40 end |
|
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
41 end |
|
ed405b6357a8
mod_turn_external: Simple module to offer TURN(+STUN) via mod_external_services
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
42 end |
