%ents; ]>
Mediated Information eXchange (MIX): MIX Administration This document defines an extension to Mediated Information eXchange (MIX) specified in XEP-0369. This specification defines a framework for MIX administration and administration operations. &LEGALNOTICE; 0406 Experimental Standards Track Standards Council XMPP Core XMPP IM XEP-0004 XEP-0030 XEP-0054 XEP-0060 XEP-0084 XEP-0128 XEP-0198 XEP-0292 XEP-0297 XEP-0313 XEP-0369 XEP-0372 XEP-0403 XEP-0404 MIX-ADMIN &ksmithisode; &skille; 0.2.0 2018-06-06 sek

Add Nick Mandatory option;

0.1.0 2018-05-21 sek

Split out from MIX 0.10.0;

The Mediated Information eXchange (MIX) protocol framework and core capabilities are specified in &xep0369; (MIX-CORE). This document defines a framework for administering a MIX service, including &xep0369;, &xep0403; and &xep0404;. It defines MIX channel configuration in a standardized manner, to enable consistent MIX administration using standard capabilities.

This specification defines three standard nodes to support configuration. The configuration node is required to support this specification and the other two nodes are optional:

Allowed'urn:xmpp:mix:nodes:allowed'For storing JIDs that are allowed to be channel participants.PubSubPubSub
Banned'urn:xmpp:mix:nodes:banned'For storing JIDs that are not allowed to be channel participants. PubSubPubSub
Configuration'urn:xmpp:mix:nodes:config'For storing channel configuration. PubSubPubSub

There are a number of MIX roles for each channel, listed in the following table. Rights will be assigned to the various roles in the channel configuration node.

RoleMembership and Rights
OwnersThese are owners of the channel, as specified in the channel configuration node. Only owners are allowed to modify the channel configuration node.
AdministratorsAdministrators are defined in the channel configuration node. Administrators have update rights to the Allowed Node and Banned Node, so they can control which users are allowed to participate in a channel.
ParticipantsParticipants are users listed by JID in the participants node.
AllowedAllowed is the set of JIDs that are participants or are allowed to become participants. A JID is allowed if it does not match an entry in the banned node and either it matches an entry in the allowed node or the allowed node is not present.
AnyoneAny user, including users in the banned node.

There MUST always be at least one Owner set for a Channel. Administrators are optional and do not need to be set. Administrators and Owners MAY be participants but are not required to be. Owners and Administrators are configured in the information node. Participants and Allowed are specified in separate nodes. Rights are defined in a strictly hierarchical manner following the order of this table, so that for example Owners will always have rights that Administrators have.

This node represents a list of JIDs that are allowed to become participants. If the Allowed node is not present, all JIDs are allowed. This node is accessed and managed using standard pubsub. The Allowed list is always considered in conjunction with the banned list, stored in the banned node. Only Administrators and Owners have write permission to the Allowed node and are also the only roles that are allowed to subscribe to this node. The Allowed node is a permanent node. Each item contains a real bare JID. The following example shows how the Allowed list can specify single JIDs and domains.

]]>

This node represents a list of JIDs that are explicitly not allowed to become participants. The values in this list take priority over values in the Allowed node. This node is accessed and managed using standard pubsub Only Administrators and Owners have write permission to the Banned node and are also the only roles that are allowed to subscribe to this node. Each item contains a real bare JID. The Banned node can contain bare JIDs and/or domains. The Banned node is a permanent node.

]]>

The Configuration node holds the configuration of the channel as a single item, named by the date-time of the last update to the configuration. The Configuration node is a permanent node with a maximum of one item. Previous configuration history MAY be accessed by MAM. Users with read access to the configuration node MAY subscribe to the configuration node to get notification of configuration change. This node is accessed and managed using standard pubsub. The configuration node is OPTIONAL for a MIX channel. For example, configuration choices could be fixed and not exposed. A subset of the defined configuration options MAY be used and additional non-standard configuration options MAY be added. JIDs in the configuration MUST be real bare JIDs and not proxy JIDs. If configuration options to control functionality of the nature described here are provided, the options defined in this standard MUST be used. The following configuration attributes are defined:

NameDescriptionField TypeValuesDefault
'Last Change Made By'Bare JID of the user making the last change.jid-single--
'Owner'Bare JIDs with Owner rights as defined in ACL node. When a channel is created, the JID creating the channel is configured as an owner, unless this attribute is explicitly configured to another value.jid-multi--
'Administrator'Bare JIDs with Administrator rights.jid-multi--
'End of Life'The date and time at which the channel will be automatically removed by the server. If this is not set, the channel is permanent.text-single--
'Nodes Present'Specifies which nodes are present. Presence of config nodes is implicit. Jidmap node MUST be present if participants node is present. 'avatar' means that both Avatar Data and Avatar Metadata nodes are present.list-multi'participants'; 'presence'; 'information'; 'allowed'; 'banned'; 'jidmap-visible'; 'avatar''participants'; 'presence'; 'information'; 'allowed'; 'banned'; 'jidmap-visible'; 'avatar'
'Messages Node Subscription'Controls who can subscribe to messages node.list-single'participants'; 'allowed'; 'anyone''participants'
'Presence Node Subscription'Controls who can subscribe to presence node.list-single'participants'; 'allowed'; 'anyone''participants'
'Participants Node Subscription'Controls who can subscribe to participants node.list-single'participants'; 'allowed'; 'anyone'; 'nobody'; 'admins'; 'owners''participants'
'Information Node Subscription'Controls who can subscribe to the information node.list-single'participants'; 'allowed'; 'anyone''participants'
'Allowed Node Subscription'Controls who can subscribe to allowed node.list-single'participants'; 'allowed'; 'nobody'; 'admins'; 'owners' 'admins'
'Banned Node Subscription'Controls who can subscribe to banned node.list-single'participants'; 'allowed'; 'nobody'; 'admins'; 'owners' 'admins'
'Configuration Node Access'Controls who can subscribe to configuration node and who has read access to it.list-single'participants'; 'allowed'; 'nobody'; 'admins'; 'owners' 'owners'
'Information Node Update Rights'Controls who can make changes to the information nodelist-single'participants'; 'admins'; 'owners' 'admins'
'Avatar Nodes Update Rights'Controls who can make changes to the avatar data and metadata nodeslist-single'participants'; 'admins'; 'owners' 'admins'
'Open Presence'If selected, any client MAY register presence. If not selected, only clients with bare JID in the participants list are allowed to register presence.boolean-false
'Participants Must Provide Presence'If selected, all channel participants are REQUIRED to share presence information with the channel.boolean-false
'User Message Retraction'If this option is selected users will be able to retract messages that they have sent to the MIX channel.boolean-false
'Administrator Message Retraction Rights'This controls which group is able to retract any message sent to the MIX channel.list-single'nobody'; 'admins'; 'owners''owners'
'Participation Addition by Invitation from Participant'This option extends a channel so that a channel participant has rights to invite and enable other users as participants.boolean-false
'Private Messages'If this option is selected, private messages MAY be used with the channel.boolean-true
'Mandatory Nicks'If this option is selected, every participant must have a Nick.boolean-true

The configuration node is in &xep0004; format and includes all of the options used by the channel, including values for options using default values. This means that the value in the form can be directly mapped with the form returned by configuration administration commands. Configuration nodes will typically have a large number of elements. The following short example is provided to illustrate the syntax of the configuration node.

urn:xmpp:mix:admin:0 hecate@shakespeare.example greymalkin@shakespeare.example allowed true ]]>

Authorized users, typically owners and sometimes administrators, MAY modify the channel information. The client MAY issue a pubsub get command to obtain a form that will facilitate update of the information node. The values in the form show current values, which be defaults or MAY have been explicitly set. In the following example, the channel name was previously set, but other values were not.

urn:xmpp:mix:core:0 Information Node Modification Witches Coven ]]>

Updating the information node is done using a pubsub set command. The MIX channel MUST update the fields with values provided, leaving other fields unchanged. The result returns the id used in the information node item, which is the date/time of the modification.

urn:xmpp:mix:core:0 Witches Coven A location not far from the blasted heath where the three witches meet greymalkin@shakespeare.example ]]>

Channel owners are allowed to modify the channel configuration. The client MAY issue a pubsub get command to obtain a form that will facilitate update of the configuration node. Other clients MAY be authorized to use this command to see the channel configuration, but only owners MAY update the configuration. The values in the form show current values, which MAY be defaults or MAY have been explicitly set. The following example shows a short form returned to illustrate the syntax. A typical configuration form will be much larger with many fields. Modifying channel configuration is done directly by a client. Note that an Owner MUST be specified. When the configuration node is modified, the server MUST set the 'Last Change Made By' attribute to the JID of the user making the change.

urn:xmpp:mix:admin:0 Configuration Node Modification ]]>

Updating the information node is done using a pubsub set command. The MIX channel MUST update the fields with values provided, leaving other fields unchanged. The result returns the id used in the configuration node item, which is the date/time of the modification.

urn:xmpp:mix:admin:0 hecate@shakespeare.example greymalkin@shakespeare.example allowed jid-mandatory-visible true ]]>

Owners and Administrators are allowed to control which users can participate in a channel by use of Allowed and Banned lists using PubSub. These operations follow &xep0060; which sets out detailed protocol use and error handling. Allowed and Banned lists MAY be read by PubSub get of the Banned and Allowed Nodes. This operation MAY be used by users as controlled by 'Allowed Node Subscription' and 'Banned Node Subscription' configuration node options (default Administrators).

]]>

JIDs can be added to the Allowed and Banned nodes by a pubsub set command. This is used to add one item to a node.

]]>

JIDs can be removed from the Allowed and Banned nodes by pubsub retract command.

]]>

When the MIX channel adds a JID to the banned node, other nodes in the MIX channel will be appropriately updated to reflect this change. In particular, the participants nodes and presence nodes will be updated to remove matching JIDs. This will have the effect of immediately removing the user from the channel. For this reason, there is no requirement to have the "kick" functionality of MUC, as this is achieved by banning the user.

See considerations in &xep0369;.

See considerations in &xep0369;.

None.

The urn:xmpp:mix namespace needs to be registered.

To be supplied when MIX progresses to proposed standard.

See &xep0369; for a list of contributors to the MIX Family of specifications.