%ents; ]>
Publishing Stream Initiation Requests This specification defines an XMPP protocol extension that enables an XMPP entity to advertise the fact that it is willing accept a particular Stream Initiation request. The protocol is used mainly to inform other entities that a particular file is available for transfer via the File Transfer protocol defined in XEP-0096. &LEGALNOTICE; 0137 Draft Standards Track Standards XMPP Core XEP-0030 XEP-0095 sipub http://www.xmpp.org/schemas/sipub.xsd &linuxwolf; &temas; 1.0 2005-08-26 psa Per a vote of the Jabber Council, advanced status to Draft. 0.3 2005-07-21 psa Corrected several errors in the text and examples. 0.2 2004-11-03 psa Editorial review: clarified text throughout and corrected several errors in the examples. 0.1 2004-06-16 lw/tjm Initial version.

&xep0095; defines a protocol to initiate a data stream between two Jabber/XMPP entities (e.g., for the purpose of &xep0096;). However, the sender is still responsible for informing potential receivers about the existence of a given stream. This document provides an automated way for a sender to announce the availability of a stream without initiating the data transfer. The purpose is to provide a "pull" protocol that enables a receiver to then request initiation of the stream from the sender.

This proposal addresses the following requirements:

A stream owner uses the <sipub/> element to announce that it can perform a specific SI request. This element can be sent to a publish-subscribe (XEP-0060) node, or sent directly to potential recipients within a &MESSAGE; stanza.

The format of the <sipub/> element is as follows:

... ]]>

This format is nearly identical to that for the stream initiation <si/> element (see XEP-0095). The major difference is the lack of the feature negotiation for the stream methods, and the addition of a 'from' attribute.

The 'from' attribute SHOULD be present, and MUST be present if the stanza containing the <sipub/> is not from the stream owner (e.g., if the stream is advertised at a publish-subscribe node). If present, this attribute MUST be the valid JID for the stream owner.

The 'id' attribute is an opaque identifier. This attribute MUST be present, and MUST be a valid non-empty string. It uniquely identifies the published request at the potential sender.

As with stream initiation, the 'profile' attribute MUST be present, and MUST be the namespace URI governing the profile information. It identifies the format for the SI profile.

As with stream initiation, the 'mime-type' attribute SHOULD be present, and MUST be an IANA-registered content type. The IANA registry of content types is located at <http://www.iana.org/assignments/media-types/>. It provides the receiver with additional information about what the data stream will be.

The <sipub/> element MUST contain an element qualified by the namespace specified by the 'profile' attribute (e.g., <file xmlns='http://jabber.org/protocol/si/profile/file-transfer'/> for file transfer). This is the additional information about the data stream.

The <sipub/> information is typically provided via pubsub:

All Shakespearean characters must sign and return this NDA ASAP ]]> All Shakespearean characters must sign and return this NDA ASAP ]]>

The <sipub/> element MAY also be included directly within a &MESSAGE; stanza sent to another entity (or multiple entities, e.g., in &xep0045; or via &xep0033;). This can be especially useful for informing an offline entity about an available stream.

All Shakespearean characters must sign and return this NDA ASAP ]]>

One of the goals of sipub is to integrate Stream Initiation with Data Forms to provide a "file upload" capability. This is accomplished via the datatypes specified in &xep0122;. Each datatype is specific to the profile desired.

For example the datatype "sipub:file-transfer" is used to identify the file upload field(s) corresponding to XEP-0096:

]]>

When submitting such a form, a field's value(s) MUST be the <sipub/> identifier(s). Also, the submitter MUST provide an <sipub/> element within the data form for each file to be uploaded:

publish-0123 ]]>

The form processor will use this to retrieve the file(s) to be uploaded.

A potential receiver starts the stream initiation session by sending an IQ-get to the sender, using the <start xmlns='http://jabber.org/protocol/sipub'/> element. This element contains the 'id' attribute to specify which published stream to retrieve:

]]>

If the sender accepts the request, it responds with an IQ-result containing a <starting/> element. This element indicates the stream initiation identifier to be used:

]]>

Then the sender begins the stream initiation negotiation:

A love letter ]]>

If the requested identifier is not valid, the sender SHOULD respond with a ¬acceptable; error:

publish-0123 ]]>

If the receiver does not have permission to request the data stream, the sender SHOULD respond with a &forbidden; error:

publish-0123 ]]>

When publishing a stream via the <sipub/> element, the identifier SHOULD NOT be used as-is for the <si/> element, since a single publication will likely result in multiple <si/> requests, possibly from the same receiver.

This document introduces no security concerns beyond those specified in XEP-0060 and the relevant Stream Initiation profile in use.

This document requires no interaction with &IANA;.

The ®ISTRAR; includes 'http://jabber.org/protocol/sipub' in its registry of protocol namespaces.

The XMPP Registrar includes 'sipub:' in its registry of Data Forms Validation Datatype Prefixes.

Normally, each SI profile that wishes to be considered for use with Data Forms MUST register its own datatype qualified by the "sipub:" prefix. However, this document provides an initial seed, based on the currently accepted SI profiles. The following datatypes shall be registered for use with Data Forms Validation:

sipub:file-transfer Datatype for publishing an SI using the File Transfer Profile XEP-0096 ]]>
The protocol documented by this schema is defined in XEP-0137: http://www.xmpp.org/extensions/xep-0137.html This is the root content element for advertising a stream. This is the element for requesting retrieval of a stream. This is the element for specifying the stream to be retrieved. ]]>