annotate plugins/mod_vcard.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 74b9e05af71e
children 39c35f7e6cfa
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1523
841d61be198f Remove version number from copyright headers
Matthew Wild <mwild1@gmail.com>
parents: 1042
diff changeset
1 -- Prosody IM
2923
b7049746bd29 Update copyright headers for 2010
Matthew Wild <mwild1@gmail.com>
parents: 2344
diff changeset
2 -- Copyright (C) 2008-2010 Matthew Wild
b7049746bd29 Update copyright headers for 2010
Matthew Wild <mwild1@gmail.com>
parents: 2344
diff changeset
3 -- Copyright (C) 2008-2010 Waqas Hussain
5776
bd0ff8ae98a8 Remove all trailing whitespace
Florian Zeitz <florob@babelmonkeys.de>
parents: 5500
diff changeset
4 --
758
b1885732e979 GPL->MIT!
Matthew Wild <mwild1@gmail.com>
parents: 615
diff changeset
5 -- This project is MIT/X11 licensed. Please see the
b1885732e979 GPL->MIT!
Matthew Wild <mwild1@gmail.com>
parents: 615
diff changeset
6 -- COPYING file in the source package for more information.
519
cccd610a0ef9 Insert copyright/license headers
Matthew Wild <mwild1@gmail.com>
parents: 438
diff changeset
7 --
cccd610a0ef9 Insert copyright/license headers
Matthew Wild <mwild1@gmail.com>
parents: 438
diff changeset
8
12977
74b9e05af71e plugins: Prefix module imports with prosody namespace
Kim Alvefur <zash@zash.se>
parents: 10552
diff changeset
9 local st = require "prosody.util.stanza"
74b9e05af71e plugins: Prefix module imports with prosody namespace
Kim Alvefur <zash@zash.se>
parents: 10552
diff changeset
10 local jid_split = require "prosody.util.jid".split;
5500
eeea0eb2602a mod_auth_internal_hashed, mod_auth_internal_plain, mod_privacy, mod_private, mod_register, mod_vcard, mod_muc: Use module:open_store()
Kim Alvefur <zash@zash.se>
parents: 5017
diff changeset
11
eeea0eb2602a mod_auth_internal_hashed, mod_auth_internal_plain, mod_privacy, mod_private, mod_register, mod_vcard, mod_muc: Use module:open_store()
Kim Alvefur <zash@zash.se>
parents: 5017
diff changeset
12 local vcards = module:open_store();
86
a2085854c72c Added: vCard plugin: mod_vcard
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
13
2004
5033348feba8 mod_vcard: Cleaned up unused variables and global accesses.
Waqas Hussain <waqas20@gmail.com>
parents: 2003
diff changeset
14 module:add_feature("vcard-temp");
86
a2085854c72c Added: vCard plugin: mod_vcard
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
15
2004
5033348feba8 mod_vcard: Cleaned up unused variables and global accesses.
Waqas Hussain <waqas20@gmail.com>
parents: 2003
diff changeset
16 local function handle_vcard(event)
2001
2f73fe2b3edd mod_vcard: Moved completely to new event based hooks.
Waqas Hussain <waqas20@gmail.com>
parents: 2000
diff changeset
17 local session, stanza = event.origin, event.stanza;
2002
fa71261d8a15 mod_vcard: Refactoring and cleanup.
Waqas Hussain <waqas20@gmail.com>
parents: 2001
diff changeset
18 local to = stanza.attr.to;
fa71261d8a15 mod_vcard: Refactoring and cleanup.
Waqas Hussain <waqas20@gmail.com>
parents: 2001
diff changeset
19 if stanza.attr.type == "get" then
fa71261d8a15 mod_vcard: Refactoring and cleanup.
Waqas Hussain <waqas20@gmail.com>
parents: 2001
diff changeset
20 local vCard;
fa71261d8a15 mod_vcard: Refactoring and cleanup.
Waqas Hussain <waqas20@gmail.com>
parents: 2001
diff changeset
21 if to then
10552
f1cf8c08a09d mod_vcard: Remove unused variable [luacheck]
Kim Alvefur <zash@zash.se>
parents: 9228
diff changeset
22 local node = jid_split(to);
5500
eeea0eb2602a mod_auth_internal_hashed, mod_auth_internal_plain, mod_privacy, mod_private, mod_register, mod_vcard, mod_muc: Use module:open_store()
Kim Alvefur <zash@zash.se>
parents: 5017
diff changeset
23 vCard = st.deserialize(vcards:get(node)); -- load vCard for user or server
2002
fa71261d8a15 mod_vcard: Refactoring and cleanup.
Waqas Hussain <waqas20@gmail.com>
parents: 2001
diff changeset
24 else
5500
eeea0eb2602a mod_auth_internal_hashed, mod_auth_internal_plain, mod_privacy, mod_private, mod_register, mod_vcard, mod_muc: Use module:open_store()
Kim Alvefur <zash@zash.se>
parents: 5017
diff changeset
25 vCard = st.deserialize(vcards:get(session.username));-- load user's own vCard
2002
fa71261d8a15 mod_vcard: Refactoring and cleanup.
Waqas Hussain <waqas20@gmail.com>
parents: 2001
diff changeset
26 end
fa71261d8a15 mod_vcard: Refactoring and cleanup.
Waqas Hussain <waqas20@gmail.com>
parents: 2001
diff changeset
27 if vCard then
fa71261d8a15 mod_vcard: Refactoring and cleanup.
Waqas Hussain <waqas20@gmail.com>
parents: 2001
diff changeset
28 session.send(st.reply(stanza):add_child(vCard)); -- send vCard!
fa71261d8a15 mod_vcard: Refactoring and cleanup.
Waqas Hussain <waqas20@gmail.com>
parents: 2001
diff changeset
29 else
fa71261d8a15 mod_vcard: Refactoring and cleanup.
Waqas Hussain <waqas20@gmail.com>
parents: 2001
diff changeset
30 session.send(st.error_reply(stanza, "cancel", "item-not-found"));
fa71261d8a15 mod_vcard: Refactoring and cleanup.
Waqas Hussain <waqas20@gmail.com>
parents: 2001
diff changeset
31 end
9228
e2e2aa76ea31 mod_private, mod_vcard: Use the usual comment on non-get received iqs.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 9219
diff changeset
32 else -- stanza.attr.type == "set"
2002
fa71261d8a15 mod_vcard: Refactoring and cleanup.
Waqas Hussain <waqas20@gmail.com>
parents: 2001
diff changeset
33 if not to then
5500
eeea0eb2602a mod_auth_internal_hashed, mod_auth_internal_plain, mod_privacy, mod_private, mod_register, mod_vcard, mod_muc: Use module:open_store()
Kim Alvefur <zash@zash.se>
parents: 5017
diff changeset
34 if vcards:set(session.username, st.preserialize(stanza.tags[1])) then
2002
fa71261d8a15 mod_vcard: Refactoring and cleanup.
Waqas Hussain <waqas20@gmail.com>
parents: 2001
diff changeset
35 session.send(st.reply(stanza));
1956
ec04b571fa86 mod_vcard: Add vcard_compatibility option to handle vcard stanzas routed to the full JID by ejabberd MUC rooms
Matthew Wild <mwild1@gmail.com>
parents: 1779
diff changeset
36 else
2002
fa71261d8a15 mod_vcard: Refactoring and cleanup.
Waqas Hussain <waqas20@gmail.com>
parents: 2001
diff changeset
37 -- TODO unable to write file, file may be locked, etc, what's the correct error?
fa71261d8a15 mod_vcard: Refactoring and cleanup.
Waqas Hussain <waqas20@gmail.com>
parents: 2001
diff changeset
38 session.send(st.error_reply(stanza, "wait", "internal-server-error"));
1956
ec04b571fa86 mod_vcard: Add vcard_compatibility option to handle vcard stanzas routed to the full JID by ejabberd MUC rooms
Matthew Wild <mwild1@gmail.com>
parents: 1779
diff changeset
39 end
2002
fa71261d8a15 mod_vcard: Refactoring and cleanup.
Waqas Hussain <waqas20@gmail.com>
parents: 2001
diff changeset
40 else
fa71261d8a15 mod_vcard: Refactoring and cleanup.
Waqas Hussain <waqas20@gmail.com>
parents: 2001
diff changeset
41 session.send(st.error_reply(stanza, "auth", "forbidden"));
1956
ec04b571fa86 mod_vcard: Add vcard_compatibility option to handle vcard stanzas routed to the full JID by ejabberd MUC rooms
Matthew Wild <mwild1@gmail.com>
parents: 1779
diff changeset
42 end
ec04b571fa86 mod_vcard: Add vcard_compatibility option to handle vcard stanzas routed to the full JID by ejabberd MUC rooms
Matthew Wild <mwild1@gmail.com>
parents: 1779
diff changeset
43 end
2002
fa71261d8a15 mod_vcard: Refactoring and cleanup.
Waqas Hussain <waqas20@gmail.com>
parents: 2001
diff changeset
44 return true;
1956
ec04b571fa86 mod_vcard: Add vcard_compatibility option to handle vcard stanzas routed to the full JID by ejabberd MUC rooms
Matthew Wild <mwild1@gmail.com>
parents: 1779
diff changeset
45 end
ec04b571fa86 mod_vcard: Add vcard_compatibility option to handle vcard stanzas routed to the full JID by ejabberd MUC rooms
Matthew Wild <mwild1@gmail.com>
parents: 1779
diff changeset
46
2001
2f73fe2b3edd mod_vcard: Moved completely to new event based hooks.
Waqas Hussain <waqas20@gmail.com>
parents: 2000
diff changeset
47 module:hook("iq/bare/vcard-temp:vCard", handle_vcard);
2f73fe2b3edd mod_vcard: Moved completely to new event based hooks.
Waqas Hussain <waqas20@gmail.com>
parents: 2000
diff changeset
48 module:hook("iq/host/vcard-temp:vCard", handle_vcard);