Mercurial > prosody-hg
comparison net/server_epoll.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 | ca041359c045 |
| children | 0bd65ed1fd10 |
comparison
equal
deleted
inserted
replaced
| 13651:b9d369f77121 | 13652:a08065207ef0 |
|---|---|
| 655 end | 655 end |
| 656 interface.send = interface.write; | 656 interface.send = interface.write; |
| 657 | 657 |
| 658 -- Close, possibly after writing is done | 658 -- Close, possibly after writing is done |
| 659 function interface:close() | 659 function interface:close() |
| 660 local status, err; | |
| 660 if self.writebuffer and #self.writebuffer ~= 0 then | 661 if self.writebuffer and #self.writebuffer ~= 0 then |
| 661 self._connected = false; | 662 self._connected = false; |
| 662 self:set(false, true); -- Flush final buffer contents | 663 self:set(false, true); -- Flush final buffer contents |
| 663 self:setreadtimeout(false); | 664 self:setreadtimeout(false); |
| 664 self:setwritetimeout(); | 665 self:setwritetimeout(); |
| 665 self.write, self.send = noop, noop; -- No more writing | 666 self.write, self.send = noop, noop; -- No more writing |
| 666 self:debug("Close after writing remaining buffered data"); | 667 self:debug("Close after writing remaining buffered data"); |
| 667 self.ondrain = interface.close; | 668 self.ondrain = interface.close; |
| 669 elseif self.conn.shutdown and self._tls then | |
| 670 status, err = self.conn:shutdown(); | |
| 671 self.onreadable = interface.close; | |
| 672 self.onwritable = interface.close; | |
| 673 if err == nil then | |
| 674 if status == true then | |
| 675 self._tls = false; | |
| 676 end | |
| 677 return self:close(); | |
| 678 elseif err == "wantread" then | |
| 679 self:set(true, nil); | |
| 680 self:setreadtimeout(); | |
| 681 elseif err == "wantwrite" then | |
| 682 self:set(nil, true); | |
| 683 self:setwritetimeout(); | |
| 684 else | |
| 685 self._tls = false; | |
| 686 end | |
| 668 else | 687 else |
| 669 self:debug("Closing now"); | 688 self:debug("Closing now"); |
| 670 self.write, self.send = noop, noop; | 689 self.write, self.send = noop, noop; |
| 671 self.close = noop; | 690 self.close = noop; |
| 672 self:on("disconnect"); | 691 self:on("disconnect"); |
| 673 self:destroy(); | 692 self:destroy(); |
| 674 end | 693 end |
| 675 end | 694 end |
| 676 | 695 |
| 677 function interface:destroy() | 696 function interface:destroy() |
| 697 -- make sure tls sockets aren't put in blocking mode | |
| 698 if self.conn.shutdown and self._tls then self.conn:shutdown(); end | |
| 678 self:del(); | 699 self:del(); |
| 679 self:setwritetimeout(false); | 700 self:setwritetimeout(false); |
| 680 self:setreadtimeout(false); | 701 self:setreadtimeout(false); |
| 681 self.onreadable = noop; | 702 self.onreadable = noop; |
| 682 self.onwritable = noop; | 703 self.onwritable = noop; |
