prosody
a08065207ef0
spec/scansion/muc_create_destroy.scs

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody

File

spec/scansion/muc_create_destroy.scs @ 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
parent 10941:642773f3073b
line wrap: on
line source

# MUC creation, basic messages and destruction

[Client] Romeo
	jid: romeo@localhost/mK0dD6Ha
	password: password

[Client] Juliet
	jid: juliet@localhost/lVwkim_k
	password: password

[Client] Admin
	jid: admin@localhost/DfNgg9VE
	password: password

-----

Romeo connects

Romeo sends:
	<presence to="garden@conference.localhost/romeo">
		<x xmlns="http://jabber.org/protocol/muc"/>
	</presence>

Romeo receives:
	<presence from="garden@conference.localhost/romeo">
		<x xmlns="vcard-temp:x:update">
			<photo/>
		</x>
		<x xmlns="http://jabber.org/protocol/muc#user">
			<status code="201"/>
			<item affiliation="owner" jid="${Romeo's full JID}" role="moderator"/>
			<status code="110"/>
		</x>
	</presence>

Romeo receives:
	<message from="garden@conference.localhost" type="groupchat">
		<subject/>
	</message>

Romeo sends:
	<iq to="garden@conference.localhost" id="lx3" type="set">
		<query xmlns="http://jabber.org/protocol/muc#owner">
			<x type="submit" xmlns="jabber:x:data"/>
		</query>
	</iq>

Romeo receives:
	<iq id="lx3" type="result" from="garden@conference.localhost"/>

Juliet connects

Romeo sends:
	<message to="garden@conference.localhost" type="groupchat" id="rm1">
		<body>Where are thou my Juliet?</body>
	</message>

Romeo receives:
	<message type="groupchat" from="garden@conference.localhost/romeo" id="rm1">
		<body>Where are thou my Juliet?</body>
	</message>

Juliet sends:
	<presence to="garden@conference.localhost/juliet">
		<x xmlns="http://jabber.org/protocol/muc"/>
	</presence>

Juliet receives:
	<presence from="garden@conference.localhost/romeo">
		<x xmlns="vcard-temp:x:update">
			<photo/>
		</x>
		<x xmlns="http://jabber.org/protocol/muc#user">
			<item affiliation="owner" role="moderator"/>
		</x>
	</presence>

Juliet receives:
	<presence from="garden@conference.localhost/juliet">
		<x xmlns="vcard-temp:x:update">
			<photo/>
		</x>
		<x xmlns="http://jabber.org/protocol/muc#user">
			<item affiliation="none" jid="${Juliet's full JID}" role="participant"/>
			<status code="110"/>
		</x>
	</presence>

Juliet receives:
	<message from="garden@conference.localhost/romeo" id="rm1" type="groupchat">
		<body>Where are thou my Juliet?</body>
		<delay stamp="{scansion:any}" xmlns="urn:xmpp:delay" from="garden@conference.localhost"/>
	</message>

Juliet receives:
	<message from="garden@conference.localhost" type="groupchat">
		<subject/>
	</message>

Romeo receives:
	<presence from="garden@conference.localhost/juliet">
		<x xmlns="vcard-temp:x:update">
			<photo/>
		</x>
		<x xmlns="http://jabber.org/protocol/muc#user">
			<item affiliation="none" jid="${Juliet's full JID}" role="participant"/>
		</x>
	</presence>

Juliet sends:
	<message to="garden@conference.localhost" type="groupchat" id="jm1">
		<body>/me jumps out from behind a tree</body>
	</message>

Romeo receives:
	<message type="groupchat" id="jm1" from="garden@conference.localhost/juliet">
		<body>/me jumps out from behind a tree</body>
	</message>

Juliet receives:
	<message type="groupchat" id="jm1" from="garden@conference.localhost/juliet">
		<body>/me jumps out from behind a tree</body>
	</message>

Juliet sends:
	<message to="garden@conference.localhost" type="groupchat" id="jm2">
		<body>Here I am!</body>
	</message>

Romeo receives:
	<message type="groupchat" id="jm2" from="garden@conference.localhost/juliet">
		<body>Here I am!</body>
	</message>

Juliet receives:
	<message type="groupchat" id="jm2" from="garden@conference.localhost/juliet">
		<body>Here I am!</body>
	</message>

Romeo sends:
	<message to="garden@conference.localhost" type="groupchat" id="rm2">
		<body>What is this place?</body>
	</message>

Romeo receives:
	<message type="groupchat" id="rm2" from="garden@conference.localhost/romeo">
		<body>What is this place?</body>
	</message>

Juliet receives:
	<message type="groupchat" id="rm2" from="garden@conference.localhost/romeo">
		<body>What is this place?</body>
	</message>

Juliet sends:
	<message to="garden@conference.localhost" type="groupchat" id="jm3">
		<body>I think we&apos;re in a script!</body>
	</message>

Romeo receives:
	<message type="groupchat" id="jm3" from="garden@conference.localhost/juliet">
		<body>I think we&apos;re in a script!</body>
	</message>

Juliet receives:
	<message type="groupchat" id="jm3" from="garden@conference.localhost/juliet">
		<body>I think we&apos;re in a script!</body>
	</message>

Romeo sends:
	<message to="garden@conference.localhost" type="groupchat" id="rm3">
		<body>Oh no! Does that mean our love is not real?!</body>
	</message>

Romeo receives:
	<message type="groupchat" id="rm3" from="garden@conference.localhost/romeo">
		<body>Oh no! Does that mean our love is not real?!</body>
	</message>

Juliet receives:
	<message type="groupchat" id="rm3" from="garden@conference.localhost/romeo">
		<body>Oh no! Does that mean our love is not real?!</body>
	</message>

Juliet sends:
	<message to="garden@conference.localhost" type="groupchat" id="jm4">
		<body>I refuse to accept this! Let&apos;s burn this place to the ground!</body>
	</message>

Romeo receives:
	<message type="groupchat" id="jm4" from="garden@conference.localhost/juliet">
		<body>I refuse to accept this! Let&apos;s burn this place to the ground!</body>
	</message>

Juliet receives:
	<message type="groupchat" id="jm4" from="garden@conference.localhost/juliet">
		<body>I refuse to accept this! Let&apos;s burn this place to the ground!</body>
	</message>

Romeo sends:
	<message to="garden@conference.localhost" type="groupchat" id="rm4">
		<body>Yes!</body>
	</message>

Romeo receives:
	<message type="groupchat" id="rm4" from="garden@conference.localhost/romeo">
		<body>Yes!</body>
	</message>

Juliet receives:
	<message type="groupchat" id="rm4" from="garden@conference.localhost/romeo">
		<body>Yes!</body>
	</message>

Romeo sends:
	<iq to="garden@conference.localhost" id="lx4" type="set">
		<query xmlns="http://jabber.org/protocol/muc#owner">
			<destroy>
				<reason>We refuse to live in this fantasy!</reason>
			</destroy>
		</query>
	</iq>

Juliet receives:
	<presence from="garden@conference.localhost/juliet" type="unavailable">
		<x xmlns="http://jabber.org/protocol/muc#user">
			<destroy>
				<reason>We refuse to live in this fantasy!</reason>
			</destroy>
			<item affiliation="none" jid="${Juliet's full JID}" role="none"/>
			<status code="110"/>
		</x>
	</presence>

Romeo receives:
	<presence from="garden@conference.localhost/romeo" type="unavailable">
		<x xmlns="http://jabber.org/protocol/muc#user">
			<destroy>
				<reason>We refuse to live in this fantasy!</reason>
			</destroy>
			<item affiliation="owner" jid="${Romeo's full JID}" role="none"/>
			<status code="110"/>
		</x>
	</presence>

Romeo receives:
	<iq id="lx4" type="result" from="garden@conference.localhost"/>

Juliet disconnects

Romeo sends:
	<presence to="elsewhere@conference.localhost/romeo">
		<x xmlns="http://jabber.org/protocol/muc"/>
	</presence>

Romeo receives:
	<presence from="elsewhere@conference.localhost/romeo">
		<x xmlns="vcard-temp:x:update">
			<photo/>
		</x>
		<x xmlns="http://jabber.org/protocol/muc#user">
			<status code="201"/>
			<item affiliation="owner" jid="${Romeo's full JID}" role="moderator"/>
			<status code="110"/>
		</x>
	</presence>

Romeo receives:
	<message from="elsewhere@conference.localhost" type="groupchat">
		<subject/>
	</message>

Romeo sends:
	<iq to="elsewhere@conference.localhost" id="lx5" type="set">
		<query xmlns="http://jabber.org/protocol/muc#owner">
			<x type="submit" xmlns="jabber:x:data"/>
		</query>
	</iq>

Romeo receives:
	<iq id="lx5" type="result" from="elsewhere@conference.localhost"/>

Admin connects

Admin sends:
	<iq id="destroy" type="set" to="conference.localhost">
		<command xmlns="http://jabber.org/protocol/commands" node="http://prosody.im/protocol/muc#destroy">
			<x xmlns="jabber:x:data">
				<field var="rooms">
					<value>elsewhere@conference.localhost</value>
				</field>
			</x>
		</command>
	</iq>

Romeo receives:
	<presence from="elsewhere@conference.localhost/romeo" type="unavailable">
		<x xmlns="http://jabber.org/protocol/muc#user">
			<destroy/>
			<item affiliation="owner" jid="${Romeo's full JID}" role="none"/>
			<status code="110"/>
		</x>
	</presence>

Romeo disconnects

Admin receives:
	<iq id="destroy" type="result" from="conference.localhost">
		<command xmlns="http://jabber.org/protocol/commands" node="http://prosody.im/protocol/muc#destroy" status="completed" sessionid="{scansion:any}">
			<note type="info">The following rooms were destroyed:&#10;elsewhere@conference.localhost</note>
		</command>
	</iq>

Admin disconnects

# recording ended on 2019-08-31T13:45:32Z