mirror of https://github.com/moparisthebest/xeps
Remove proxy ID and add Stable Participant ID
This commit is contained in:
Steve Kille
parent
fb502cd5e4
commit
5c552188b2
79
xep-0369.xml
79
xep-0369.xml
|
|
@ -36,6 +36,14 @@
|
|||
&ksmithisode;
|
||||
&skille;
|
||||
<revision>
|
||||
<version>0.11.4</version>
|
||||
<date>2018-06-05</date>
|
||||
<initials>sek</initials>
|
||||
<remark><p>
|
||||
Remove Proxy JID;
|
||||
Add Stable Participant ID;
|
||||
</p></remark>
|
||||
</revision> <revision>
|
||||
<version>0.11.3</version>
|
||||
<date>2018-05-24</date>
|
||||
<initials>sek</initials>
|
||||
|
|
@ -432,7 +440,7 @@
|
|||
|
||||
<ol>
|
||||
<li>MIX-CORE. &xep0369;. This specification, which is the central mandatory MIX specification. This sets out requirements addressed by MIX and general MIX concepts and framework. It defines joining channels and associated participant management. It defines discovery and sharing of MIX channels and information about them. It defines use of MIX to share messages with channel participants. </li>
|
||||
<li>MIX-PRESENCE. &xep0403;. This optional specification adds the ability for MIX online clients to share presence, so that this can be seen by other MIX clients.</li>
|
||||
<li>MIX-PRESENCE. &xep0403;. This optional specification adds the ability for MIX online clients to share presence, so that this can be seen by other MIX clients. It also specifies relay of IQ stanzas through a channel.</li>
|
||||
<li>MIX-PAM. &xep0405;. This specification defines how a server supporting MIX clients behaves, to support servers implementing MIX-CORE and MIX-PRESENCE.</li>
|
||||
<li>MIX-ADMIN. &xep0406;. This specifies MIX configuration and administration of MIX.</li>
|
||||
<li>MIX-ANON. &xep0404;. This specifies a mechanism to hide real JIDs from MIX clients and related privacy controls. </li>
|
||||
|
|
@ -486,9 +494,7 @@
|
|||
|
||||
<li>In MIX, a Nick belongs to the user and not to each client.</li>
|
||||
|
||||
<li>
|
||||
Presence is exchanged in MIX by use of a proxy JID, which is a stable JID on the domain of the MIX channel that identifies the user. This proxy JID is used instead of the "Nick as a Resource" mechanism in MUC. To support this, the proxy JID is a primary part of defining a MIX channel participant. Proxy JIDs are also used in MIX-ANON to provide a "JID Hidden" mechanism, to give a service similar to MUC semi-anonymous, that will prevent JID harvesting (requirement 7).
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
</ol>
|
||||
|
|
@ -514,7 +520,9 @@
|
|||
<li>Presence is sent to participants using bare JID, whether or not the user has an online client. </li>
|
||||
<li>Online clients MAY register presence, which is then shared with participants who have subscribed to presence.</li>
|
||||
<li>MIX decouples addressing of channel participants from their nicknames, so that nickname changes do not affect addressing.</li>
|
||||
<li>Each participant is addressable by a single bare JID, which is a proxy JID (not the user's real JID) to make it straightforward to hide the user's real JID from other channel participants. Full JIDs comprised of this bare JID plus a resource (also anonymized) are then constructed, allowing visibility into the number of online resources participating in a channel.</li>
|
||||
<li>Each participant has a Stable Participant ID. This is used in some derived JIDs to provide a stable participant reference. It is used to hide JIDs in MIX-ANON.
|
||||
|
||||
</li>
|
||||
<li> Although some protocol is shared with MUC, MUC clients are not interoperable with a MIX service. </li>
|
||||
<li>MIX requires the server to which the MIX client connects to provide functionality to support MIX. This functionality is defined in this specification and referenced as "MIX Participant's Server Behaviour".</li>
|
||||
<li>MIX domains MUST NOT be used to host end user JIDs. </li>
|
||||
|
|
@ -531,17 +539,15 @@
|
|||
|
||||
|
||||
|
||||
<section2 topic="Proxy JIDs" anchor="proxy-jid">
|
||||
<section2 topic="Stable Participant ID" anchor="stable-id">
|
||||
|
||||
<p>
|
||||
The primary representation of a participant in a MIX channel is a proxy JID, which is an anonymized JID using the same domain as the channel and includes and encoding of the name of the channel and a random identifier. The primary reason for proxy JID is to support presence, as presence messages need to be sent from the domain of the MIX channel. MUC achieves this by using the resource to encode Nick, which does not work well. Proxy JIDs enable Nick changing and support of multiple clients (as the client resource can be shared). MIX provides a simple mechanism for clients to map the proxy JID to Nick and Real Jid, so that these are available to the MIX user. Proxy JIDs are also used to provide the "JID Hidden" mechanism, specified in MIX-ANON.
|
||||
Every channel participant is identified by a Stable Participant ID, which uniquely identifies a channel participant and never changes. The Stable Participant ID MUST NOT contain the '#', '/' or '@' characters.
|
||||
|
||||
</p>
|
||||
|
||||
<p>
|
||||
Proxy JIDs are encoded, using the format "<generated identifier>#<channel>@<mix domain>". The generated identifier MUST NOT contain the '#', '/' or '@' characters. The Channel name MAY contain the '#' character. For example in the channel 'coven@mix.shakespeare.example', the user 'hag66@shakespeare.example' might have a proxy JID of '123456#coven@mix.shakespeare.example'. Servers and clients MUST determine that a JID is a proxy JID from context and MUST NOT infer that a JID is a proxy JID because it contains the '#' character.
|
||||
</p>
|
||||
<p>
|
||||
The mapping of real bare JID to proxy JID is defined when a participant joins a channel. While a user is a participant in a Channel, the mapping between real JID and proxy JID MUST NOT be changed. This mapping must be maintained after the user leaves the channel. Proxy JID values MUST NOT be re-used. If a JID that left a channel joins the channel again, the same proxy JID MAY be used again or a different new proxy JID MAY be assigned.
|
||||
A Participant's Stable Participant ID is defined when a participant joins a channel. While a user is a participant in a Channel, the Stable Participant ID MUST NOT be changed. This mapping between Participant and Stable Participant ID MUST be maintained after the participant leaves the channel. Stable Participant ID values MUST NOT be re-used. If a participant that left a channel joins the channel again, the same Stable Participant ID MAY be used again or a different Stable Participant ID MAY be assigned.
|
||||
</p>
|
||||
|
||||
|
||||
|
|
@ -580,7 +586,7 @@
|
|||
</section3>
|
||||
|
||||
<section3 topic="Participants Node" anchor="participants-node">
|
||||
<p>Each channel participant is represented as an item of the 'urn:xmpp:mix:nodes:participants' channel node. Each item is named by the bare proxy JID of the participant. For example '123456#coven@mix.shakespeare.example' might name the node item associated with participant 'hag66@shakespeare.example'. Information is stored in a <participant/> element qualified by the 'urn:xmpp:mix:core:0' namespace. The nick associated with the user is optional and is stored in a <nick/> child element of the <participant/> element. The nick for each channel participant MUST be different to the nick of other participants.
|
||||
<p>Each channel participant is represented as an item of the 'urn:xmpp:mix:nodes:participants' channel node. Each item is named by the Stable Participant ID of the participant. For example '123456' might name the node item associated with participant 'hag66@shakespeare.example'. Information is stored in a <participant/> element qualified by the 'urn:xmpp:mix:core:0' namespace. The nick associated with the user is optional and is stored in a <nick/> child element of the <participant/> element. The nick for each channel participant MUST be different to the nick of other participants.
|
||||
</p>
|
||||
<p>
|
||||
A Nick MAY be associated with a participant. The nick associated with the user is stored in a <nick/> child element of the <participant/> element. The nick for each channel participant MUST be different to the nick of other participants.
|
||||
|
|
@ -590,18 +596,18 @@
|
|||
The user's JID is stored in a <jid/> child element of the <participant/> element.
|
||||
</p>
|
||||
<p>
|
||||
When a user joins a channel, the user's bare proxy JID is added to the participants node by the MIX service. When a user leaves a channel, the user's bare proxy JID is removed from the participants node. The participants node MUST NOT be directly modified using pubsub.
|
||||
When a user joins a channel, an item representing the is added to the participants node by the MIX service. When a user leaves a channel, the user's item is removed from the participants node. The participants node MUST NOT be directly modified using pubsub.
|
||||
</p>
|
||||
<p>
|
||||
Clients will need to read the Participants node to provide useful display of presence information. For this reason, it is anticipated that Participants will be able to read the Participants node. However, for the message distribution specified in MIX-CORE, it is not necessary for clients to be able to read the Participants node.
|
||||
It may be useful for clients to read the participants list. However it is not necessary for message and presence display, as both messages and presence contain sufficient information to enable display.
|
||||
</p>
|
||||
<p>
|
||||
Users MAY subscribe to and read information this node, when permitted by the channel. Standard PubSub access will allow a full list of participants and associated nicks to be determined. By subscribing to the node, a user will be informed of changes to the Participants Node.
|
||||
</p>
|
||||
<p>The participants node is OPTIONAL. If the Participants Node is not used, information on channel participants is not shared. If there is no participants node, the access control value 'participants' MUST NOT be used. The Participants node is a permanent node with one item per participant.</p>
|
||||
<p>The participants node is MANDATORY. The Participants node is a permanent node with one item per participant.</p>
|
||||
<example caption="Value of Participants Node"><![CDATA[
|
||||
<items node='urn:xmpp:mix:nodes:participants'>
|
||||
<item id='123456#coven@mix.shakespeare.example'>
|
||||
<item id='123456'>
|
||||
<participant xmlns='urn:xmpp:mix:core:0'>
|
||||
<nick>thirdwitch</nick>
|
||||
<jid>hag66@shakespeare.example</jid>
|
||||
|
|
@ -668,7 +674,7 @@
|
|||
<ol>
|
||||
<li>IQ. All of the IQ errors of &rfc6120; MUST be supported.</li>
|
||||
<li>Messages. If a message is received and an error situation is encountered, a message of type error MUST be sent back to the message sender. This message format is specified in &rfc6121; containing an error defined in &rfc6120;, which is the same error set as for IQs.</li>
|
||||
<li>Presence. Any responses to presence messages MUST follow the rules of &rfc6121;.</li>
|
||||
<li>Presence. If MIX-PRESENCE is supported, any responses to presence messages MUST follow the rules of &rfc6121;.</li>
|
||||
<li>PubSub. Where MIX protocol messages use PubSub protocol, the errors defined in &xep0060; MUST be used and supported.</li>
|
||||
</ol>
|
||||
</section1>
|
||||
|
|
@ -853,7 +859,8 @@
|
|||
</section2>
|
||||
<section2 topic='Determining the Participants in a Channel' anchor='find-channel-participants'>
|
||||
<p>
|
||||
Participants in the channel are determined using PubSub retrieval of the Participants Node which will give proxy JID, real JID and nick. It is anticipated that clients using a channel will often determine participants on start-up, to enable display of participants and presence. </p>
|
||||
Participants in the channel are determined using PubSub retrieval of the Participants Node which will give Stable Participant
|
||||
ID, JID and nick. Clients using a channel MAY determine participants on start-up, to enable display of participants. </p>
|
||||
<example caption='User's Client Requests Participant List'><![CDATA[
|
||||
<iq from='hag66@shakespeare.example/UUID-c8y/1573'
|
||||
id='kl2fax27'
|
||||
|
|
@ -871,13 +878,13 @@
|
|||
type='result'>
|
||||
<pubsub xlns='http://jabber.org/protocol/pubsub'>
|
||||
<items node='urn:xmpp:mix:nodes:participants'>
|
||||
<item id='123456#coven@mix.shakespeare.example'>
|
||||
<item id='123456'>
|
||||
<participant xmlns='urn:xmpp:mix:core:0'>
|
||||
<nick>thirdwitch</nick>
|
||||
<jid>hag66@shakespeare.example</jid>
|
||||
</participant>
|
||||
</item>
|
||||
<item id='87123#coven@mix.shakespeare.example'>
|
||||
<item id='87123'>
|
||||
<participant xmlns='urn:xmpp:mix:core:0'>
|
||||
<nick>top witch</nick>
|
||||
<jid>hecate@shakespeare.example</jid>
|
||||
|
|
@ -944,14 +951,15 @@
|
|||
</iq>
|
||||
]]></example>
|
||||
|
||||
<p>The channel responds to the user's sever with an IQ-result addressed to the user's bare JID, which will be processed as specified in MIX-PAM. This stanza includes the nodes to which the user has been successfully subscribed, as well as the bare JID that will be used for the user in this channel and added to the participant list. The JID returned in the join is the user's bare proxy JID. The following example shows the result of the above request when the request is completed in full. </p>
|
||||
<p>The channel responds to the user's sever with an IQ-result addressed to the user's bare JID, which will be processed as specified in MIX-PAM. This stanza includes the nodes to which the user has been successfully subscribed, as well as the bare JID that will be used for the user in this channel and added to the participant list. The user's Stable Participant ID is returned as an 'id' attribute in the join.
|
||||
The following example shows the result of the above request when the request is completed in full. </p>
|
||||
<example caption="Channel responds to User's Server"><![CDATA[
|
||||
<iq type='result'
|
||||
from='coven@mix.shakespeare.example'
|
||||
to='hag66@shakespeare.example'
|
||||
id='E6E10350-76CF-40C6-B91B-1EA08C332FC7'>
|
||||
<join xmlns='urn:xmpp:mix:core:0'
|
||||
jid='123456#coven@mix.shakespeare.example'>
|
||||
id='123456'>
|
||||
<subscribe node='urn:xmpp:mix:nodes:messages'/>
|
||||
<subscribe node='urn:xmpp:mix:nodes:presence'/>
|
||||
<subscribe node='urn:xmpp:mix:nodes:participants'/>
|
||||
|
|
@ -988,7 +996,7 @@
|
|||
id='5A9C7398-DB13-4BFA-A091-2D466C710AAF'>
|
||||
<event xmlns='http://jabber.org/protocol/pubsub#event'>
|
||||
<items node='urn:xmpp:mix:nodes:participants'>
|
||||
<item id='123456#coven@mix.shakespeare.example'>
|
||||
<item id='123456'>
|
||||
<participant xmlns='urn:xmpp:mix:core:0'>
|
||||
<jid>hag66@shakespeare.example</jid>
|
||||
</participant>
|
||||
|
|
@ -997,7 +1005,7 @@
|
|||
</event>
|
||||
</message>
|
||||
]]></example>
|
||||
<p>The user that has been added to the channel is identified by the item id of the item added to the Participants node, which is the proxy JID of the new channel participant. The <participant> element MUST include a <jid> element with the JID of the participant, unless MIX-ANON is being followed to hide participant JIDs. The <nick> element will not be included at this point, unless it is automatically generated by the channel. In the likely event that a Nick is subsequently added, an update with the <nick> element will be distributed.
|
||||
<p>The user that has been added to the channel is identified by the item id of the item added to the Participants node, which is the Stable Participant ID of the new channel participant. The <participant> element MUST include a <jid> element with the JID of the participant, unless MIX-ANON is being followed to hide participant JIDs. The <nick> element will not be included at this point, unless it is automatically generated by the channel. In the likely event that a Nick is subsequently added, an update with the <nick> element will be distributed.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
|
|
@ -1132,9 +1140,11 @@
|
|||
</p>
|
||||
<ol>
|
||||
<li>A <nick> element that contains the Nick of the message sender, taken from the Participants Node. This MUST be present if a Nick is defined for the user.</li>
|
||||
<li>A <jid> element containing the real JID of the sender. This MUST be present, unless following the "JID Hidden" model defined in MIX-ANON. If this element is omitted, the <nick> and <proxy-jid> elements MUST be present.</li>
|
||||
<li>A <proxy-jid> element contains the sender's proxy JID. This MUST be present if <jid> is omitted and MUST not be present if <jid> is present.</li>
|
||||
<li>A <jid> element containing the real JID of the sender. This MUST be present, unless following the "JID Hidden" model defined in MIX-ANON. If this element is omitted, the <nick> element MUST be present.</li>
|
||||
</ol>
|
||||
<p>
|
||||
MIX messages are distributed by the channel with the from using the JID of the channel, with the Stable Participant ID of the sender in the resource. This enables a receiving system to distinguish messages based on sender using on the JID.
|
||||
</p>
|
||||
<p>The MIX channel then puts a copy of the message into the MAM archive for the channel and sends a copy of the message to each participant in
|
||||
standard groupchat format. These messages sent by the channel are addressed to the bare JID of each participant and this will be handled by the participant's local server as specified in MIX-PAM. The message 'from' attribute is the JID of the channel. The id of the message is the ID from the MAM archive and NOT the id used by the sender. The message placed in the MAM archive is the reflected message without a 'to' attribute.</p>
|
||||
|
||||
|
|
@ -1152,7 +1162,7 @@
|
|||
]]></example>
|
||||
|
||||
<example caption="Channel Reflects Message to Participants"><![CDATA[
|
||||
<message from='coven@mix.shakespeare.example'
|
||||
<message from='coven@mix.shakespeare.example/123456'
|
||||
to='hecate@shakespeare.example'
|
||||
id='77E07BB0-55CF-4BD4-890E-3F7C0E686BBD'
|
||||
type='groupchat'>
|
||||
|
|
@ -1164,18 +1174,7 @@
|
|||
</message>
|
||||
]]></example>
|
||||
|
||||
<example caption="Channel Reflects Message to Participants with Proxy JID"><![CDATA[
|
||||
<message from='coven@mix.shakespeare.example'
|
||||
to='hecate@shakespeare.example'
|
||||
id='77E07BB0-55CF-4BD4-890E-3F7C0E686BBD'
|
||||
type='groupchat'>
|
||||
<body>Harpier cries: 'tis time, 'tis time.</body>
|
||||
<mix xmlns='urn:xmpp:mix:core:0'>
|
||||
<nick>thirdwitch</nick>
|
||||
<proxy-jid>123456#coven@mix.shakespeare.example</proxy-jid>
|
||||
</mix>
|
||||
</message>
|
||||
]]></example>
|
||||
|
||||
<p>
|
||||
The messages sent to participants have a different message id to the originally submitted message. This does not impact most recipients, but it does not allow the message originator to correlate the message with the submitted message. To address this the MIX channel MUST include an additional <submission-id> element in the <mix> element of the message copy going back to the originator's bare JID. The <submission-id> element holds the original id provided by the sender. This enables the originator to correlate the received message with the message submitted.
|
||||
</p>
|
||||
|
|
@ -1362,7 +1361,7 @@
|
|||
|
||||
<section1 topic='Security Considerations' anchor='security'>
|
||||
<p>MIX is built over MAM and PubSub and the security considerations of &xep0313; and &xep0060; MUST be considered. These services protect MIX channel information, which can be sensitive and needs appropriate protection.</p>
|
||||
<p>MIX channels MAY be JID Hidden, in order to hide the JIDs of channel participants from those accessing the channel. Care MUST be taken to ensure that JIDs are fully hidden. In particular when proxy JIDs are prepared, this MUST be done in a manner which ensure that the real JIDs cannot be determined. Where nicks are assigned by a channel, this MUST be done in a way that does not expose the JID.</p>
|
||||
|
||||
<p>
|
||||
There is no MIX equivalent to &xep0045; password controlled rooms, which avoids a number of security issues.
|
||||
</p>
|
||||
|
|
|
|||
Loading…
Reference in New Issue