Mercurial > prosody-hg
annotate util-src/managed_pointer.h @ 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 | b001b0f42512 |
| children |
| rev | line source |
|---|---|
|
12692
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
1 /* managed_pointer.h |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
2 |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
3 These macros allow wrapping an allocator/deallocator into an object that is |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
4 owned and managed by the Lua garbage collector. |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
5 |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
6 Why? It is too easy to leak objects that need to be manually released, especially |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
7 when dealing with the Lua API which can throw errors from many operations. |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
8 |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
9 USAGE |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
10 ----- |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
11 |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
12 For example, given an object that can be created or released with the following |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
13 functions: |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
14 |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
15 fancy_buffer* new_buffer(); |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
16 void free_buffer(fancy_buffer* p_buffer) |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
17 |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
18 You could declare a managed version like so: |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
19 |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
20 MANAGED_POINTER_ALLOCATOR(new_managed_buffer, fancy_buffer*, new_buffer, free_buffer) |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
21 |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
22 And then, when you need to create a new fancy_buffer in your code: |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
23 |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
24 fancy_buffer *my_buffer = new_managed_buffer(L); |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
25 |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
26 NOTES |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
27 ----- |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
28 |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
29 Managed objects MUST NOT be freed manually. They will automatically be |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
30 freed during the next GC sweep after your function exits (even if via an error). |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
31 |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
32 The managed object is pushed onto the stack, but should generally be ignored, |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
33 but you'll need to bear this in mind when creating managed pointers in the |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
34 middle of a sequence of stack operations. |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
35 */ |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
36 |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
37 #define MANAGED_POINTER_MT(wrapped_type) #wrapped_type "_managedptr_mt" |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
38 |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
39 #define MANAGED_POINTER_ALLOCATOR(name, wrapped_type, wrapped_alloc, wrapped_free) \ |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
40 static int _release_ ## name(lua_State *L) { \ |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
41 wrapped_type *p = (wrapped_type*)lua_topointer(L, 1); \ |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
42 if(*p != NULL) { \ |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
43 wrapped_free(*p); \ |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
44 } \ |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
45 return 0; \ |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
46 } \ |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
47 static wrapped_type name(lua_State *L) { \ |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
48 wrapped_type *p = (wrapped_type*)lua_newuserdata(L, sizeof(wrapped_type)); \ |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
49 if(luaL_newmetatable(L, MANAGED_POINTER_MT(wrapped_type)) != 0) { \ |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
50 lua_pushcfunction(L, _release_ ## name); \ |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
51 lua_setfield(L, -2, "__gc"); \ |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
52 } \ |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
53 lua_setmetatable(L, -2); \ |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
54 *p = wrapped_alloc(); \ |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
55 if(*p == NULL) { \ |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
56 lua_pushliteral(L, "not enough memory"); \ |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
57 lua_error(L); \ |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
58 } \ |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
59 return *p; \ |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
60 } |
|
b001b0f42512
util-src: Add new utility header managed_pointer.h
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
61 |
