File

spec/scansion/muc_password.scs @ 11040:c560531d9a6e

mod_external_services: Validate services added via events While writing developer documentation it became obvious that i was silly to have one item format for config and items API, and another format for the event API. Then there's the stanza format, but that's a common pattern. This change reduces the possible input formats to two and allows other modules the benefit of the processing and validation performed on items from the config.
author Kim Alvefur <zash@zash.se>
date Mon, 17 Aug 2020 00:24:11 +0200
parent 10447:b5fd1637f15c
child 12027:5fb16f41f861
line wrap: on
line source

# MUC: Password-protected rooms

[Client] Romeo
	jid: user@localhost
	password: password

[Client] Juliet
	jid: user2@localhost
	password: password

-----

Romeo connects

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

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

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

# Submit config form
Romeo sends:
	<iq id='config1' to='room@conference.localhost' type='set'>
		<query xmlns='http://jabber.org/protocol/muc#owner'>
			<x xmlns='jabber:x:data' type='submit'>
				<field var='FORM_TYPE'>
					<value>http://jabber.org/protocol/muc#roomconfig</value>
				</field>
				<field var='muc#roomconfig_roomsecret'>
					<value>cauldronburn</value>
				</field>
			</x>
		</query>
	</iq>

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

# Juliet connects, and tries to join the room (password-protected)
Juliet connects

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

Juliet receives:
	<presence from="room@conference.localhost/Juliet" type="error">
		<error type="auth" code="401" by="room@conference.localhost">
			<not-authorized xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/>
		</error>
	</presence>

# Retry with the correct password
Juliet sends:
	<presence to="room@conference.localhost/Juliet">
		<x xmlns="http://jabber.org/protocol/muc">
			<password>cauldronburn</password>
		</x>
	</presence>

Juliet receives:
	<presence from="room@conference.localhost/Romeo" />

Juliet receives:
	<presence from="room@conference.localhost/Juliet" />

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

Romeo receives:
	<presence from="room@conference.localhost/Juliet" />

# Ok, now Juliet leaves, and Romeo unsets the password

Juliet sends:
	<presence type="unavailable" to="room@conference.localhost"/>

Romeo receives:
	<presence type="unavailable" from="room@conference.localhost/Juliet"/>

Juliet receives:
	<presence type="unavailable" from="room@conference.localhost/Juliet"/>

# Remove room password
Romeo sends:
	<iq id='config2' to='room@conference.localhost' type='set'>
		<query xmlns='http://jabber.org/protocol/muc#owner'>
			<x xmlns='jabber:x:data' type='submit'>
				<field var='FORM_TYPE'>
					<value>http://jabber.org/protocol/muc#roomconfig</value>
				</field>
				<field var='muc#roomconfig_roomsecret'>
				</field>
			</x>
		</query>
	</iq>

# Config change success
Romeo receives:
	<iq id="config2" from="room@conference.localhost" type="result">
	</iq>

# Notification of room configuration update
Romeo receives:
	<message type='groupchat' from='room@conference.localhost'>
		<x xmlns='http://jabber.org/protocol/muc#user'>
			<status code='104'/>
		</x>
	</message>

# Juliet tries to join (should succeed)
Juliet sends:
	<presence to="room@conference.localhost/Juliet">
		<x xmlns="http://jabber.org/protocol/muc"/>
	</presence>

# Notification of Romeo's presence in the room
Juliet receives:
	<presence from="room@conference.localhost/Romeo" />

Juliet receives:
	<presence from="room@conference.localhost/Juliet" />

# Room topic
Juliet receives:
	<message type='groupchat' from='room@conference.localhost'><subject/></message>

Romeo receives:
	<presence from="room@conference.localhost/Juliet" />