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. This XMPP Extension Protocol is copyright © 1999 – 2024 by the XMPP Standards Foundation (XSF). Permission is hereby granted, free of charge, to any person obtaining a copy of this specification (the "Specification"), to make use of the Specification without restriction, including without limitation the rights to implement the Specification in a software program, deploy the Specification in a network service, and copy, modify, merge, publish, translate, distribute, sublicense, or sell copies of the Specification, and to permit persons to whom the Specification is furnished to do so, subject to the condition that the foregoing copyright notice and this permission notice shall be included in all copies or substantial portions of the Specification. Unless separate permission is granted, modified works that are redistributed shall not contain misleading information regarding the authors, title, number, or publisher of the Specification, and shall not claim endorsement of the modified works by the authors, any organization or project to which the authors belong, or the XMPP Standards Foundation. ## NOTE WELL: This Specification is provided on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. ## In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall the XMPP Standards Foundation or any author of this Specification be liable for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising from, out of, or in connection with the Specification or the implementation, deployment, or other use of the Specification (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if the XMPP Standards Foundation or such author has been advised of the possibility of such damages. This XMPP Extension Protocol has been contributed in full conformance with the XSF's Intellectual Property Rights Policy (a copy of which can be found at <https://xmpp.org/about/xsf/ipr-policy> or obtained by writing to XMPP Standards Foundation, P.O. Box 787, Parker, CO 80134 USA). 0137 Deprecated Standards Track Standards Council XMPP Core XEP-0030 XEP-0095 sipub http://www.xmpp.org/schemas/sipub.xsd Matthew Miller linuxwolf@outer-planes.net linuxwolf@outer-planes.net Thomas Muldowney temas@jabber.org temas@jabber.org 1.1 2018-02-28 XEP Editor (ssw)

Deprecated per a vote of the XMPP Council.

 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.

Stream Initiation (XEP-0095) XEP-0095: Stream Initiation <https://xmpp.org/extensions/xep-0095.html>. defines a protocol to initiate a data stream between two Jabber/XMPP entities (e.g., for the purpose of SI File Transfer (XEP-0096) XEP-0096: SI File Transfer <https://xmpp.org/extensions/xep-0096.html>.). 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 Stream Initiation (XEP-0095) XEP-0095: Stream Initiation <https://xmpp.org/extensions/xep-0095.html>.). 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 Multi-User Chat (XEP-0045) XEP-0045: Multi-User Chat <https://xmpp.org/extensions/xep-0045.html>. or via Extended Stanza Addressing (XEP-0033) XEP-0033: Extended Stanza Addressing <https://xmpp.org/extensions/xep-0033.html>.). 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 Data Forms Validation (XEP-0122) XEP-0122: Data Forms Validation <https://xmpp.org/extensions/xep-0122.html>.. 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 SI File Transfer (XEP-0096) XEP-0096: SI File Transfer <https://xmpp.org/extensions/xep-0096.html>.:

]]>

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 <not-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 Publish-Subscribe (XEP-0060) XEP-0060: Publish-Subscribe <https://xmpp.org/extensions/xep-0060.html>. and the relevant Stream Initiation profile in use.

This document requires no interaction with the Internet Assigned Numbers Authority (IANA) The Internet Assigned Numbers Authority (IANA) is the central coordinator for the assignment of unique parameter values for Internet protocols, such as port numbers and URI schemes. For further information, see <http://www.iana.org/>..

The XMPP Registrar The XMPP Registrar maintains a list of reserved protocol namespaces as well as registries of parameters used in the context of XMPP extension protocols approved by the XMPP Standards Foundation. For further information, see <https://xmpp.org/registrar/>. 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. ]]>