mirror of https://github.com/moparisthebest/xeps
1152 lines
100 KiB
XML
1152 lines
100 KiB
XML
<?xml version='1.0' encoding='UTF-8'?>
|
|
<!DOCTYPE xep SYSTEM 'xep.dtd' [
|
|
<!ENTITY % ents SYSTEM 'xep.ent'>
|
|
%ents;
|
|
]>
|
|
<?xml-stylesheet type='text/xsl' href='xep.xsl'?>
|
|
<xep>
|
|
<header>
|
|
<title>Bidirectional-streams Over Synchronous HTTP (BOSH)</title>
|
|
<abstract>This specification defines a transport protocol that emulates a bidirectional stream between two entities (such as a client and a server) by efficiently using multiple synchronous HTTP request/response pairs without requiring the use of polling or asynchronous chunking.</abstract>
|
|
&LEGALNOTICE;
|
|
<number>0124</number>
|
|
<status>Draft</status>
|
|
<type>Standards Track</type>
|
|
<jig>Standards</jig>
|
|
<dependencies>
|
|
<spec>RFC 1945</spec>
|
|
<spec>RFC 2616</spec>
|
|
<spec>RFC 3174</spec>
|
|
</dependencies>
|
|
<supersedes/>
|
|
<supersededby/>
|
|
<shortname>bosh</shortname>
|
|
<schemaloc>
|
|
<url>http://www.xmpp.org/schemas/httpbind.xsd</url>
|
|
</schemaloc>
|
|
&ianpaterson;
|
|
&dizzyd;
|
|
&stpeter;
|
|
<revision>
|
|
<version>1.6</version>
|
|
<date>2007-02-21</date>
|
|
<initials>ip</initials>
|
|
<remark><p>Multiple clarifications and restructuring without changes to protocol itself; changed title to BOSH; added section that fully explores the technique underlying the protocol; separated XMPP-specific features into new XEP-0206; added optional new Script Syntax and session pauses; added Acknowledgements section; added from and ver attributes; added hold attribute to session creation response; clarified polling too-frequently error; recommended clients use HTTP Pipelining.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>1.5</version>
|
|
<date>2006-04-28</date>
|
|
<initials>ip/psa</initials>
|
|
<remark><p>Added optional Multiple Streams section; added security considerations about encrypted HTTP connections; recommended use of SSL rather than HTTP over TLS; specified that request ID values must not exceed 9007199254740991; corrected datatypes of inactivity, polling, rid, and wait attributes in the schema; added <any/> and <anyAttribute/> elements to schema to optionally support non-XMPP XML elements and attributes; deprecated HTTP error codes in favor of new terminal binding conditions.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>1.4</version>
|
|
<date>2005-12-14</date>
|
|
<initials>psa</initials>
|
|
<remark><p>Modified syntax of route attribute to be proto:host:port rather than XMPP URI/IRI.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>1.3</version>
|
|
<date>2005-11-02</date>
|
|
<initials>ip</initials>
|
|
<remark><p>Corrected stream:features namespace and the Recoverable Binding Conditions section; recommended that connection manager shall return secure attribute to client; recommended end-to-end encryption through proxy connection managers.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>1.2</version>
|
|
<date>2005-06-16</date>
|
|
<initials>ip</initials>
|
|
<remark><p>Specified optional use of route and secure attributes in session request. Minor correction: the stream features element should be included in the response that contains the authid attribute (this is not necessarily the session creation response).</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>1.1</version>
|
|
<date>2005-06-02</date>
|
|
<initials>ip</initials>
|
|
<remark><p>Specified optional use of HTTP Accept-Encoding and Content-Encoding headers for compression at HTTP binding level.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>1.0</version>
|
|
<date>2005-03-03</date>
|
|
<initials>psa</initials>
|
|
<remark><p>Per a vote of the Jabber Council, advanced status to Draft.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.10</version>
|
|
<date>2004-11-08</date>
|
|
<initials>ip</initials>
|
|
<remark><p>Changed HTTP 401 errors to HTTP 404.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.9</version>
|
|
<date>2004-10-26</date>
|
|
<initials>ip/psa</initials>
|
|
<remark><p>Added charset attribute.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.8</version>
|
|
<date>2004-10-26</date>
|
|
<initials>ip</initials>
|
|
<remark><p>Specified that wait attribute must be included in the session creation response.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.7</version>
|
|
<date>2004-08-12</date>
|
|
<initials>psa/ip</initials>
|
|
<remark><p>Defined appropriate XMPP stanza error conditions.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.6</version>
|
|
<date>2004-07-19</date>
|
|
<initials>ip</initials>
|
|
<remark><p>Added xml:lang attribute to the session request; added recoverable binding error conditions.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.5</version>
|
|
<date>2004-05-07</date>
|
|
<initials>ip/psa</initials>
|
|
<remark><p>Protocol refactored to enable simultaneous requests (request identifier attribute, wait attribute, hold attribute, requests attribute) and recovery of broken connections; added content attribute; removed all wrapper types except 'terminate'; updated error handling; made key mechanism optional (should use SSL/TLS instead).</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.4</version>
|
|
<date>2004-02-23</date>
|
|
<initials>psa/ip</initials>
|
|
<remark><p>Fixed typos; removed "resource-constraint" binding error; added HTTP 403 error to table.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.3</version>
|
|
<date>2004-02-19</date>
|
|
<initials>psa/ip</initials>
|
|
<remark><p>Added 'authid' attribute to enable communication of XMPP stream ID (used in digest authentication); specified that Content-Types other than "text/xml" are allowed to support older HTTP clients; specified business rule for connection manager queueing of client requests; changed <packet/> to <body/> to support older HTTP clients; changed 'to' attribute on initialization element from MAY to SHOULD; recommended inclusion of unavailable presence in termination element sent from client; described architectural assumptions; specified binding-specific error handling.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.2</version>
|
|
<date>2004-01-13</date>
|
|
<initials>dss/psa/ip</initials>
|
|
<remark><p>Added 'to' attribute on the initialization element; specified that 'text/html' is allowable for backwards-compatibility.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.1</version>
|
|
<date>2003-11-06</date>
|
|
<initials>dss/psa</initials>
|
|
<remark><p>Initial version.</p></remark>
|
|
</revision>
|
|
</header>
|
|
<section1 topic="Introduction" anchor='intro'>
|
|
<p>Certain applications often find that arbitrary TCP connections (see &rfc0793;) cannot be established (e.g., applications that are restricted either by their runtime environments or by firewalls permitting only Web browsing). BOSH, the protocol described in this document, may be used as a "drop-in" alternative to a bidirectional TCP connection. It is a mature, fully-featured protocol that has been in use for many years with many open source and commercial implementations. It overcomes common communication constraints by employing fully-compliant "cookie-free" <note>Enabling communications via &rfc2965; is sub-optimal since several significant computing platforms provide only limited access to underlying HTTP requests/responses; worse, some platforms hide or remove cookie-related headers.</note> HTTP 1.0 or HTTP 1.1 as a transport (see &rfc1945; and &rfc2616;).</p>
|
|
<p>BOSH can transport any data efficiently and with minimal latency in both directions. For applications that require both "push" and "pull" communications, BOSH is significantly more bandwidth-efficient and responsive than most other bidirectional HTTP-based transport protocols (e.g. &xep0025;) and techniques now commonly known as AJAX.</p>
|
|
<p>BOSH achieves this efficiency and low-latency by avoiding polling without resorting to chunked HTTP responses (i.e. without using the technique which is now commonly known as "Comet"). The protocol employs multiple synchronous HTTP request/response pairs. This technique allows it to pass through even those proxies that buffer partial HTTP responses before forwarding the full responses only once they are available.</p>
|
|
<p>Note: Although the XML being transported in the examples herein is XMPP (see &rfc3920;), this transport is not part of XMPP. In fact, from its conception the intention of the primary author was that it could be used to implement any bidirectional XML stream transporting a mixture of elements qualified by namespaces defined by different protocols (e.g., both XMPP and JSON). This mix is necessary since some connection managers may not support <link url="#multi">Multiple Streams</link> and constrained clients often have no access to HTTP Pipelining (which limits them to one BOSH session at a time). BOSH connection managers are generally not required to understand anything about the XML content that they transport beyond perhaps ensuring that each XML stanza is qualified by the correct namespace. &xep0206; documents some XMPP-specific extensions of this protocol that were formerly included in this document.</p>
|
|
<p>Note: This document inherits terminology regarding the Hypertext Transport Protocol from <cite>RFC 1945</cite> and <cite>RFC 2616</cite>.</p>
|
|
</section1>
|
|
<section1 topic='Requirements' anchor='reqs'>
|
|
<p>The following design requirements reflect the need to offer performance as close as possible to a standard TCP connection.</p>
|
|
<ol>
|
|
<li>Compatible with constrained runtime environments** (e.g., mobile and browser-based clients).</li>
|
|
<li>Enable browser-based clients to make bidirectional cross-domain connections.*</li>
|
|
<li>Compatible with proxies that buffer partial HTTP responses.*</li>
|
|
<li>Efficient through proxies that limit the duration of HTTP responses.*</li>
|
|
<li>Fully-compatible with HTTP/1.0.*</li>
|
|
<li>Compatible with restricted network connections (e.g., firewalls, proxies, and gateways).</li>
|
|
<li>Fault tolerant (e.g., session recovers after an underlying TCP connection breaks at any stage during an HTTP request).</li>
|
|
<li>Extensible.</li>
|
|
<li>Consume significantly less bandwidth than polling-based protocols.</li>
|
|
<li>Significantly more responsive (lower latency) than polling-based protocols.</li>
|
|
<li>Support for polling (for clients that are limited to a single HTTP connection at a time).</li>
|
|
<li>In-order delivery of data.</li>
|
|
<li>Guard against unauthorized users interjecting HTTP requests into a session.</li>
|
|
<li>Protect against denial of service attacks.</li>
|
|
<li>Multiplexing of data streams</li>
|
|
</ol>
|
|
<p>*Not possible to fulfill these requirements with the Comet technique.</p>
|
|
<p>**Compatibility with constrained runtime environments implies the following restrictions:</p>
|
|
<ol>
|
|
<li>Clients should not be required to have programmatic access to the headers of each HTTP request and response (e.g., cookies or status codes).</li>
|
|
<li>The body of each HTTP request and response may be parsable XML with a single root element.</li>
|
|
<li>Clients should be able to specify the Content-Type of the HTTP responses they receive.</li>
|
|
</ol>
|
|
</section1>
|
|
<section1 topic="Architectural Assumptions" anchor='arch'>
|
|
<p>This document assumes that most implementations will utilize a specialized "connection manager" to handle HTTP connections rather than the usual TCP connections. Effectively, such a connection manager will be a specialized HTTP server that translates between the HTTP requests and responses defined herein and the data streams (or API) implemented by the server or servers with which it communicates, thus enabling an HTTP client to connect to a server. We can illustrate this graphically as follows:</p>
|
|
<code><![CDATA[
|
|
Server
|
|
|
|
|
| [unwrapped data streams]
|
|
|
|
|
Connection Manager
|
|
|
|
|
| [HTTP + <body/> wrapper]
|
|
|
|
|
HTTP Client
|
|
]]></code>
|
|
<p>BOSH addresses communications between an HTTP client and the connection manager only. It does not address communications between the connection manager and the server, since such communications are implementation-specific (e.g., the server may natively support this HTTP binding, in which case the connection manager will be a logical entity rather than a physical entity; alternatively the connection manager may be an independant translating proxy such that the server may believe it is talking directly to the client over TCP; or the connection manager and the server may use a component protocol or an API defined by the server implementation).</p>
|
|
<p>Furthermore, no aspect of this protocol limits its use to client-to-server communications. It could be used for server-to-server or component-to-server communications as well. However, this document focuses exclusively on use of the transport by clients that cannot maintain arbitrary persistent TCP connections with a server. We assume that servers and components are under no such restrictions and thus would use TCP.</p>
|
|
</section1>
|
|
<section1 topic="The BOSH Technique" anchor='technique'>
|
|
<p>Since HTTP is a synchronous request/response protocol, the traditional solution to emulating a bidirectional-stream over HTTP involved the client intermittently polling the connection manager to discover if it has any data queued for delivery to the client. This naive approach wastes a lot of network bandwidth by polling when no data is available. It also reduces the responsiveness of the application since the data spends time queued waiting until the connection manager receives the next poll (HTTP request) from the client. This results in an inevitable trade-off between responsiveness and bandwidth, since increasing the polling frequency will decrease latency but simultaneously increase bandwidth consumption (or vice versa if polling frequency is decreased).</p>
|
|
<p>The technique employed by this protocol achieves both low latency and low bandwidth consumption by encouraging the connection manager not to respond to a request until it actually has data to send to the client. As soon as the client receives a response from the connection manager it sends another request, thereby ensuring that the connection manager is (almost) always holding a request that it can use to "push" data to the client.</p>
|
|
<p>If the client needs to send some data to the connection manager then it simply sends a second request containing the data. Unfortunately most constrained clients do not support HTTP Pipelining (concurrent requests over a single connection), so the client typically needs to send the data over a second HTTP connection. The connection manager always responds to the request it has been holding on the first connection as soon as it receives a new request from the client - even if it has no data to send the client. It does that to make sure the client can send more data immediately if necessary. (The client SHOULD NOT open more than two HTTP connections to the connection manager at the same time, <note>In order to reduce network congestion, <cite>RFC 2616</cite> recommends that clients SHOULD NOT keep more than two HTTP connections to the same HTTP server open at the same time. Clients running in constrained enviroments typically have no choice but to abide by that recommendation.</note> so it would otherwise have to wait until the connection manager responds to one of the requests.)</p>
|
|
<p>BOSH works reliably even if network conditions force every HTTP request to be made over a different TCP connection. However, if as is usually the case, the client is able to use HTTP/1.1, then (assuming reliable network conditions) all requests during a session will pass over the same two persistent TCP connections. Almost all of the time (see below) the client is able to push data on one of the connections, while the connection manager is able to "push" data on the other (so latency is as low as a standard TCP connection). It's interesting to note that the roles of the two connections typically switch whenever the client sends data to the connection manager.</p>
|
|
<p>If there is no traffic in either direction for an agreed amount of time (typically a couple of minutes), then the connection manager responds to the client with no data, and that response immediately triggers a fresh client request. The connection manager does that to ensure that if a network connection is broken then both parties will realise within a reasonable amount of time. This exchange is similar to the "keep-alive" or "ping" that is common practice over most persistent TCP connections. Since the BOSH technique involves no polling, bandwidth consumption is not significantly greater than a standard TCP connection. <note>If there is no traffic other than the "pings" then bandwidth consumption will be double that of a TCP connection (although double nothing is still nothing). If data is sent in large packets then bandwidth consumption will be almost identical.</note></p>
|
|
<p>Most of the time data can be pushed immediately. However, if one of the endpoints has just pushed some data then it will usually have to wait for a network round trip until it is able to push again. If HTTP Pipelining is available to the client then multiple concurrent requests are possible. So the client can always push data immediately. It can also ensure the connection manager is always holding enough requests such that even during bursts of activity it will never have to wait before pushing data. Furthermore, if the pool of requests being held by the connection manager is large enough, then the client will not be under pressure to send a new empty request immediately after receiving data from the connection manager. It can instead wait until it needs to send data. So, if over time the traffic to and from the client is balanced, bandwidth consumption will be about the same as if a standard TCP connection was being used.</p>
|
|
<p>Each block of data pushed by the connection manager is a complete HTTP response. So, unlike the Comet technique, the BOSH technique works through intermediate proxies that buffer partial HTTP responses. It is also fully compliant with HTTP/1.0 - which does not provide for chunked transfer encoding. Also unlike Comet, Web clients can use BOSH to make cross-domain connections.</p>
|
|
</section1>
|
|
<section1 topic="HTTP Overview" anchor='overview'>
|
|
<p>All information is encoded in the body of standard HTTP POST requests and responses. Each HTTP body contains a single <body/> wrapper which encapsulates the XML elements being transferred (see <link url="#wrapper"><body/> Wrapper Element</link>).</p>
|
|
<p>Clients SHOULD send all HTTP requests over a single persistent HTTP/1.1 connection using HTTP Pipelining. However, a client MAY deliver its POST requests in any way permited by <cite>RFC 1945</cite> or <cite>RFC 2616</cite>. For example, constrained clients can be expected to open more than one persistent connection instead of using Pipelining, or in some cases to open a new HTTP/1.0 connection to send each request. However, clients and connection managers SHOULD NOT use Chunked Transfer Coding, since intermediaries may buffer each partial HTTP request or response and only forward the full request or reponse once it is available.</p>
|
|
<p>Clients MAY include an HTTP Accept-Encoding header in any request. If the connection manager receives a request with an Accept-Encoding header, it MAY include an HTTP Content-Encoding header in the response (indicating one of the encodings specified in the request) and compress the response body accordingly.</p>
|
|
<p>Requests and responses MAY include HTTP headers not specified herein. The receiver SHOULD ignore any such headers.</p>
|
|
<p>Each BOSH session MAY share the HTTP connection(s) it uses with other HTTP traffic, including other BOSH sessions and HTTP requests and responses completely unrelated to this protocol (e.g., web page downloads). However, the responses to requests that are not part of the session sent over the same connection using HTTP pipelining (or queued to be sent over the same connection) may be delayed if they were sent while a request that is part of the session is being held (since the connection manager MUST send its responses in the same order that the requests were received, and the connection manager typically delays its responses).</p>
|
|
<p>The HTTP Content-Type header of all client requests SHOULD be "text/xml; charset=utf-8". However, clients MAY specify another value if they are constrained to do so (e.g., "application/x-www-form-urlencoded" or "text/plain"). The client and connection manager SHOULD ignore all HTTP Content-Type headers they receive.</p>
|
|
</section1>
|
|
<section1 topic="<body/> Wrapper Element" anchor='wrapper'>
|
|
<p>The body of each HTTP request and response contains a single <body/> wrapper element qualified by the 'http://jabber.org/protocol/httpbind' namespace. The content of the wrapper is the data being transfered. The <body/> element and it's content together MUST conform to the specifications set out in &w3xml;. They SHOULD also conform to &w3xmlnamespaces;. The content MUST NOT contain any of the following (all defined in <cite>XML 1.0</cite>):</p>
|
|
<ul>
|
|
<li><p>Partial XML elements</p></li>
|
|
<li><p>XML comments</p></li>
|
|
<li><p>XML processing instructions</p></li>
|
|
<li><p>Internal or external DTD subsets</p></li>
|
|
<li><p>Internal or external entity references (with the exception of predefined entities)</p></li>
|
|
<li><p>Character data or attribute values containing unescaped characters that map to the predefined entities (such characters MUST be escaped)</p></li>
|
|
</ul>
|
|
<p>The <body/> wrapper MUST NOT contain any XML character data, although its child elements MAY contain character data. The <body/> wrapper MUST contain zero or more complete XML immediate child elements (called "stanzas" in this document, e.g., XMPP stanzas, or elements containing XML character data that represents objects using the JSON data interchange format - see &rfc4627;). Each <body/> wrapper MAY contain stanzas qualified under a wide variety of different namespaces.</p>
|
|
<p>The <body/> element of every client request MUST possess a sequential request ID encapsulated via the 'rid' attribute; For details, refer to the <link url="#rids">Request IDs</link> section of this document.</p>
|
|
</section1>
|
|
<section1 topic="Initiating a BOSH Session" anchor='session'>
|
|
<section2 topic="Session Creation Request" anchor='session-request'>
|
|
<p>The first request from the client to the connection manager requests a new session.</p>
|
|
<p>The <body/> element of the first request SHOULD possess the following attributes (they SHOULD NOT be included in any other requests except as specified in <link url="#multi-add">Adding Streams To A Session</link>):</p>
|
|
<ul>
|
|
<li><strong>'to'</strong> -- This attribute specifies the target domain of the first stream.</li>
|
|
<li><strong>'xml:lang'</strong> -- This attribute (as defined in Section 2.12 of &w3xml;) specifies the default language of any human-readable XML character data sent or received during the session.</li>
|
|
<li><strong>'ver'</strong> -- This attribute specifies the highest version of the BOSH protocol that the client supports. The numbering scheme is "<major>.<minor>" (where the minor number MAY be incremented higher than a single digit, so it MUST be treated as a separate integer). Note: The 'ver' attribute should not be confused with the version of any protocol being transported.</li>
|
|
<li><strong>'wait'</strong> -- This attribute specifies the longest time (in seconds) that the connection manager is allowed to wait before responding to any request during the session. This enables the client to limit the delay before it discovers any network failure, and to prevent its HTTP/TCP connection from expiring due to inactivity.</li>
|
|
<li><strong>'hold'</strong> -- This attribute specifies the maximum number of requests the connection manager is allowed to keep waiting at any one time during the session. If the client is not able to use HTTP Pipelining then this SHOULD be set to "1".</li>
|
|
</ul>
|
|
<p>Note: Clients that only support <link url="#poll">Polling Sessions</link> MAY prevent the connection manager from waiting by setting 'wait' or 'hold' to "0". However, polling is NOT RECOMMENDED since the associated increase in bandwidth consumption and the decrease in responsiveness are both typically one or two orders of magnitude!</p>
|
|
<p>A connection manager MAY be configured to enable sessions with more than one server in different domains. When requesting a session with such a 'proxy' connection manager, a client SHOULD include a <strong>'route'</strong> attribute that specifies the protocol, hostname, and port of the server with which it wants to communicate, formatted as "proto:host:port" (e.g., "xmpp:jabber.org:9999"). <note>Although the syntax of the 'route' attribute bears a superficial resemblance to a URI or IRI, it is not a URI/IRI and MUST NOT be processed in accordance with the rules specified in <cite>RFC 3986</cite>, <cite>RFC 3987</cite>, or <cite>draft-saintandre-xmpp-iri</cite>.</note> A connection manager that is configured to work only with a single server (or only with a defined list of domains and the associated list of hostnames and ports that are serving those domains) MAY ignore the 'route' attribute. (Note that the 'to' attribute specifies the domain being served, not the hostame of the machine that is serving the domain.)</p>
|
|
<p>A client MAY include a <strong>'from'</strong> attribute to enable the connection manager to forward its identity to the server.</p>
|
|
<p>A client MAY include an <strong>'ack'</strong> attribute (set to "1") to indicate that it will be using acknowledgements throughout the session and that the absence of an 'ack' attribute in any request is meaningful (see <link url="#ack">Acknowledgements</link>).</p>
|
|
<p>A client MAY include a <strong>'secure'</strong> attribute to specify that communications between the connection manager and the server must be "secure". (Note: The 'secure' attribute is of type xs:boolean (see &w3xmlschema2;) and the default value is "false". &BOOLEANNOTE;) If a connection manager receives a session request with the 'secure' attribute set to "true" or "1", then it MUST respond to the client with a <link url="#errorstatus-terminal">remote-connection-failed</link> error as soon as it determines that it cannot communicate in a secure way with the server. A connection manager SHOULD consider communications with the server to be "secure" if they are encrypted using SSL or TLS with verified certificates, or if it is running on the same physical machine as the server. A connection manager MAY consider communications over a "private" network to be secure, even without SSL or TLS; however, a network SHOULD be considered "private" only if the administrator of the connection manager is sure that unknown individuals or processes do not have access to the network (i.e., individuals or processes who do not have access to either the connection manager or the server). The connection manager SHOULD try to establish a secure connection with the server even if the client does not specifically require it.</p>
|
|
<p>Some clients are constrained to only accept HTTP responses with specific Content-Types (e.g., "text/html"). The <body/> element of the first request MAY possess a <strong>'content'</strong> attribute. This specifies the value of the HTTP Content-Type header that MUST appear in all the connection manager's responses during the session. If the client request does not possess a 'content' attribute, then the HTTP Content-Type header of responses MUST be "text/xml; charset=utf-8".</p>
|
|
<example caption="Requesting a BOSH session">
|
|
<![CDATA[POST /webclient HTTP/1.1
|
|
Host: httpcm.jabber.org
|
|
Accept-Encoding: gzip, deflate
|
|
Content-Type: text/xml; charset=utf-8
|
|
Content-Length: 104
|
|
|
|
<body content='text/xml; charset=utf-8'
|
|
hold='1'
|
|
rid='1573741820'
|
|
to='jabber.org'
|
|
route='xmpp:jabber.org:9999'
|
|
secure='true'
|
|
ver='1.6'
|
|
wait='60'
|
|
ack='1'
|
|
xml:lang='en'
|
|
xmlns='http://jabber.org/protocol/httpbind'/>]]></example>
|
|
<p>Note: All requests after the first one MUST include a valid 'sid' attribute (provided by the connection manager in the <link url="#session-create">Session Creation Response</link>). The initialization request is unique in that the <body/> element MUST NOT possess a 'sid' attribute.</p>
|
|
</section2>
|
|
<section2 topic="Session Creation Response" anchor='session-create'>
|
|
<p>After receiving a new session request, the connection manager MUST generate an opaque, unpredictable session identifier (or SID). The SID MUST be unique within the context of the connection manager application. The <body/> element of the connection manager's response to the client's session creation request MUST possess the following attributes (they SHOULD NOT be included in any other responses):</p>
|
|
<ul>
|
|
<li><strong>'sid'</strong> -- This attribute specifies the SID</li>
|
|
<li><strong>'wait'</strong> -- This is the longest time (in seconds) that it will wait before responding to any request during the session. The time MUST be less than or equal to the value specified in the session request.</li>
|
|
</ul>
|
|
<p>The <body/> element SHOULD also include the following attributes (they SHOULD NOT be included in any other responses):</p>
|
|
<ul>
|
|
<li><strong>'ver'</strong> -- This attribute specifies the highest version of the BOSH protocol that the connection manager supports, or the version specified by the client in its request, whichever is lower.</li>
|
|
<li><strong>'polling'</strong> -- This attribute specifies the shortest allowable polling interval (in seconds). This enables the client to not send empty request elements more often than desired (see <link url="#poll">Polling Sessions</link> and <link url="#overactive">Overactivity</link>).</li>
|
|
<li><strong>'inactivity'</strong> -- This attribute specifies the longest allowable inactivity period (in seconds). This enables the client to ensure that the periods with no requests pending are never too long (see <link url="#poll">Polling Sessions</link> and <link url="#inactive">Inactivity</link>).</li>
|
|
<li><strong>'requests'</strong> -- This attribute enables the connection manager to limit the number of simultaneous requests the client makes (see <link url="#overactive">Overactivity</link> and <link url="#poll">Polling Sessions</link>). The RECOMMENDED values are either "2" or one more than the value of the 'hold' attribute specified in the session request.</li>
|
|
<li><strong>'hold'</strong> -- This attribute informs the client about the maximum number of requests the connection manager may keep waiting at any one time during the session. This value MUST NOT be greater than the value specified by the client in the session request.</li>
|
|
</ul>
|
|
<p>The connection manager MAY include an <strong>'accept'</strong> attribute in the session creation response element, to specify the content encodings it can decompress. After receiving a session creation response with an 'accept' attribute, clients MAY include an HTTP Content-Encoding header in subsequent requests (indicating one of the encodings specified in the 'accept' attribute) and compress the bodies of the requests accordingly.</p>
|
|
<p>A connection manager MAY include an <strong>'ack'</strong> attribute (set to the value of the 'rid' attribute of the session creation request) to indicate that it will be using acknowledgements throughout the session and that the absence of an 'ack' attribute in any response is meaningful (see <link url="#ack">Acknowledgements</link>).</p>
|
|
<p>If the connection manager supports session pausing (see <link url="#inactive">Inactivity</link>) then it SHOULD advertise that to the client by including a <strong>'maxpause'</strong> attribute in the session creation response element. The value of the attribute indicates the maximum length of a temporary session pause (in seconds) that a client MAY request.</p>
|
|
<p>For both requests and responses, the <body/> element and its content SHOULD be UTF-8 encoded. If the HTTP Content-Type header of a request/response specifies a character encoding other than UTF-8, then the connection manager MAY convert between UTF-8 and the other character encoding. However, even in this case, it is OPTIONAL for the connection manager to convert between encodings. The connection manager MAY inform the client which encodings it can convert by setting the optional <strong>'charsets'</strong> attribute in the session creation response element to a space-separated list of encodings. <note>Each character set name (or character encoding name -- we use the terms interchangeably) SHOULD be of type NMTOKEN, where the names are separated by the white space character #x20, resulting in a tokenized attribute type of NMTOKENS (see Section 3.3.1 of &w3xml;). Strictly speaking, the Character Sets registry maintained by the Internet Assigned Numbers Authority (see <<link url='http://www.iana.org/assignments/character-sets'>http://www.iana.org/assignments/character-sets</link>>) allows a character set name to contain any printable US-ASCII character, which might include characters not allowed by the NMTOKEN construction of XML 1.0; however, the only existing character set name which includes such a character is "NF_Z_62-010_(1973)".</note></p>
|
|
<p>As soon as the connection manager has established a connection to the server and discovered its identity, it MAY forward the identity to the client by including a <strong>'from'</strong> attribute in a response, either in its session creation response, or (if it has not received the identity from the server by that time) in any subsequent response to the client. If it established a secure connection to the server (as defined in <link url='#session'>Initiating a BOSH Session</link>), then in the same response the connection manager SHOULD also include the <strong>'secure'</strong> attribute set to "true" or "1".</p>
|
|
<example caption="Session creation response">
|
|
<![CDATA[HTTP/1.1 200 OK
|
|
Content-Type: text/xml; charset=utf-8
|
|
Content-Length: 128
|
|
|
|
<body wait='60'
|
|
inactivity='30'
|
|
polling='5'
|
|
requests='2'
|
|
hold='1'
|
|
ack='1573741820'
|
|
accept='deflate,gzip'
|
|
maxpause='120'
|
|
sid='SomeSID'
|
|
charsets='ISO_8859-1 ISO-2022-JP'
|
|
ver='1.6'
|
|
from='jabber.org'
|
|
secure='true'
|
|
xmlns='http://jabber.org/protocol/httpbind'/>]]></example>
|
|
|
|
|
|
<example caption="Subsequent response with 'from' and 'secure' attributes">
|
|
<![CDATA[HTTP/1.1 200 OK
|
|
Content-Type: text/xml; charset=utf-8
|
|
Content-Length: 128
|
|
|
|
<body from='jabber.org'
|
|
secure='true'
|
|
xmlns='http://jabber.org/protocol/httpbind'/>]]></example>
|
|
</section2>
|
|
</section1>
|
|
<section1 topic="Sending and Receiving XML Stanzas" anchor='stanzas'>
|
|
<p>After the client has successfully completed all required preconditions, it can send and receive XML stanzas via the HTTP binding.</p>
|
|
<example caption="Transmitting stanzas">
|
|
<![CDATA[POST /webclient HTTP/1.1
|
|
Host: httpcm.jabber.org
|
|
Accept-Encoding: gzip, deflate
|
|
Content-Type: text/xml; charset=utf-8
|
|
Content-Length: 188
|
|
|
|
<body rid='1249243562'
|
|
sid='SomeSID'
|
|
xmlns='http://jabber.org/protocol/httpbind'>
|
|
<message to='contact@example.com'
|
|
xmlns='jabber:client'>
|
|
<body>I said "Hi!"</body>
|
|
</message>
|
|
<message to='friend@example.com'
|
|
xmlns='jabber:client'>
|
|
<body>I said "Hi!"</body>
|
|
</message>
|
|
</body>]]></example>
|
|
<p>Upon receipt of a request, the connection manager SHOULD forward the content of the <body/> element to the server as soon as possible. In any case it MUST forward the content from different requests in the order specified by their 'rid' attributes.</p>
|
|
<p>The connection manager MUST also return an HTTP 200 OK response with a <body/> element to the client. Note: This does not indicate that the stanzas have been successfully delivered to the server.</p>
|
|
<p>It is RECOMMENDED that the connection manager not return an HTTP result until a stanza has arrived from the server for delivery to the client. However, the connection manager SHOULD NOT wait longer than the time specified by the client in the 'wait' attribute of its <link url="#session-request">Session Creation Request</link>, and it SHOULD NOT keep more HTTP requests waiting at a time than the number specified in the 'hold' attribute of the session creation request. In any case it MUST respond to requests in the order specified by their 'rid' attributes.</p>
|
|
<p>If there are no stanzas waiting or ready to be delivered within the waiting period, then the connection manager SHOULD include an empty <body/> element in the HTTP result:</p>
|
|
<example caption="Empty response">
|
|
<![CDATA[HTTP/1.1 200 OK
|
|
Content-Type: text/xml; charset=utf-8
|
|
Content-Length: 64
|
|
|
|
<body xmlns='http://jabber.org/protocol/httpbind'/>]]></example>
|
|
<p>If the connection manager has received one or more stanzas from the server for delivery to the client, then it SHOULD return the stanzas in the body of its response as soon as possible after receiving them from the server. The example below includes stanzas qualified by different namespaces:</p>
|
|
<example caption="Response with queued stanza">
|
|
<![CDATA[HTTP/1.1 200 OK
|
|
Content-Type: text/xml; charset=utf-8
|
|
Content-Length: 185
|
|
|
|
<body xmlns='http://jabber.org/protocol/httpbind'
|
|
xmlns:json='http://json.org/'>
|
|
<message from='contact@example.com'
|
|
to='user@example.com'
|
|
xmlns='jabber:client'>
|
|
<body>Hi yourself!</body>
|
|
</message>
|
|
<message from='friend@example.com'
|
|
to='user@example.com'
|
|
xmlns='jabber:client'>
|
|
<body>Hi yourself!</body>
|
|
</message>
|
|
<json:json>
|
|
[
|
|
{
|
|
"precision": "zip",
|
|
"Latitude": 37.7668,
|
|
"Longitude": -122.3959,
|
|
"Address": "",
|
|
"City": "SAN FRANCISCO",
|
|
"State": "CA",
|
|
"Zip": "94107",
|
|
"Country": "US"
|
|
},
|
|
{
|
|
"precision": "zip",
|
|
"Latitude": 37.371991,
|
|
"Longitude": -122.026020,
|
|
"Address": "",
|
|
"City": "SUNNYVALE",
|
|
"State": "CA",
|
|
"Zip": "94085",
|
|
"Country": "US"
|
|
}
|
|
]
|
|
</json:json>
|
|
</body>]]></example>
|
|
<p>The client MAY poll the connection manager for incoming stanzas by sending an empty <body/> element.</p>
|
|
<example caption="Requesting XML Stanzas">
|
|
<![CDATA[POST /webclient HTTP/1.1
|
|
Host: httpcm.jabber.org
|
|
Accept-Encoding: gzip, deflate
|
|
Content-Type: text/xml; charset=utf-8
|
|
Content-Length: 88
|
|
|
|
<body rid='1249243563'
|
|
sid='SomeSID'
|
|
xmlns='http://jabber.org/protocol/httpbind'/>]]></example>
|
|
<p>The connection manager MUST wait and respond in the same way as it does after receiving stanzas from the client.</p>
|
|
</section1>
|
|
<section1 topic='Acknowledgements' anchor='ack'>
|
|
<section2 topic='Request Acknowledgements' anchor='ack-request'>
|
|
<p>When responding to a request that it has been holding, if the connection manager finds it has already received another request with a higher 'rid' attribute (typically while it was holding the first request), then it MAY acknowledge the reception to the client. The connection manager MAY set the 'ack' attribute of any response to the value of the highest 'rid' attribute it has received where it has also received all requests with lower 'rid' values.</p>
|
|
<example caption="Response with request acknowledgement">
|
|
<![CDATA[HTTP/1.1 200 OK
|
|
Content-Type: text/xml; charset=utf-8
|
|
Content-Length: 64
|
|
|
|
<body ack='1249243564'
|
|
xmlns='http://jabber.org/protocol/httpbind'/>]]></example>
|
|
<p>If the connection manager will be including 'ack' attributes on responses during a session then it MUST include an 'ack' attribute in its session creation response, and set the 'ack' attribute of responses throughout the session. Except that, after its session creation response, the connection manager SHOULD NOT include an 'ack' attribute in any response if the value would be the 'rid' of the request being responded to.</p>
|
|
<p>If the connection manager is permitted to hold more than one request at a time, then the reception of a lower-than-expected 'ack' value from the connection manager (or the unexpected abscence of an 'ack' attribute) can give the client an early warning that a network failure might have occurred (e.g., if the client believes the connection manager should have received the another request by the time it responded).</p>
|
|
</section2>
|
|
<section2 topic='Response Acknowledgements' anchor='ack-response'>
|
|
<p>The client MAY similarly inform the connection manager about the responses it has received by setting the 'ack' attribute of any request to the value of the highest 'rid' of a request for which it has already received a response where it has also received all responses associated with lower 'rid' values. If the client will be including 'ack' attributes on requests during a session then it MUST include an 'ack' attribute (set to '1') in its session creation request, and set the 'ack' attribute of requests throughout the session. Except that, after its session creation request, the client SHOULD NOT include an 'ack' attribute in any request if it has received responses to all its previous requests.</p>
|
|
<example caption="Request with response acknowledgement">
|
|
<![CDATA[POST /webclient HTTP/1.1
|
|
Host: httpcm.jabber.org
|
|
Accept-Encoding: gzip, deflate
|
|
Content-Type: text/xml; charset=utf-8
|
|
Content-Length: 88
|
|
|
|
<body rid='1249243566'
|
|
sid='SomeSID'
|
|
ack='1249243564'
|
|
xmlns='http://jabber.org/protocol/httpbind'/>]]></example>
|
|
<p>After receiving a request with an 'ack' value less than the 'rid' of the last request that it has already responded to, the connection manager MAY inform the client of the situation by sending its next response immediately instead of waiting until it has stanzas to send to the client (e.g., if some time has passed since it responded). In this case it SHOULD include a 'report' attribute set to one greater than the 'ack' attribute it received from the client, and a 'time' attribute set to the number of milliseconds since it sent the response associated with the 'report' attribute.</p>
|
|
<example caption="Response with report">
|
|
<![CDATA[HTTP/1.1 200 OK
|
|
Content-Type: text/xml; charset=utf-8
|
|
Content-Length: 64
|
|
|
|
<body report='1249243565'
|
|
time='852'
|
|
xmlns='http://jabber.org/protocol/httpbind'/>]]></example>
|
|
<p>Upon reception of a response with 'report' and 'time' attributes, if the client has still not received the response associated with the request identifier (RID) specified by the 'report' attribute, then it MAY choose to resend the request associated with the missing response (see <link url="#rids-broken">Broken Connections</link>).</p>
|
|
</section2>
|
|
</section1>
|
|
<section1 topic='Inactivity' anchor='inactive'>
|
|
<p>After receiving a response from the connection manager, if none of the client's requests are still being held by the connection manager (and if the session is not a <link url="#poll">Polling Session</link>), the client SHOULD make a new request as soon as possible. In any case, if no requests are being held, the client MUST make a new request before the maximum inactivity period has expired. The length of this period in seconds is specified by the 'inactivity' attribute in the session creation response.</p>
|
|
<p>If the connection manager has responded to all the requests it has received within a session and the time since its last response is longer than the maximum inactivity period, then it SHOULD assume the client has been disconnected and terminate the session without informing the client. If the client subsequently makes another request, then the connection manager SHOULD respond as if the session does not exist.</p>
|
|
<p>If the connection manager did not specify a maximum inactivity period in the session creation response, then it SHOULD allow the client to be inactive for as long as it chooses.</p>
|
|
<p>If the session is not a polling session then the connection manager SHOULD specify a relatively short inactivity period to ensure disconnections are discovered as early as possible. The RECOMMENDED time would be a little more than the number of seconds for a comfortable network round trip between the connection manager and the client under difficult network conditions (since the client can be expected to make a new request immediately - see above).</p>
|
|
<p>If a client encounters an exceptional temporary situation during which it will be unable to send requests to the connection manager for a period of time greater than the maximum inactivity period (e.g., while a runtime environment changes from one web page to another), and if the connection manager included a 'maxpause' attribute in its <link url="#session-create">Session Creation Response</link>, then the client MAY request a temporary increase to the maximum inactivity period by including a 'pause' attribute in a request. Note: If the connection manager did not specify a 'maxpause' attribute at the start of the session then the client MUST NOT send a 'pause' attribute during the session.</p>
|
|
<example caption="Requesting a Session Pause">
|
|
<![CDATA[POST /webclient HTTP/1.1
|
|
Host: httpcm.jabber.org
|
|
Accept-Encoding: gzip, deflate
|
|
Content-Type: text/xml; charset=utf-8
|
|
Content-Length: 98
|
|
|
|
<body rid='1249243564'
|
|
sid='SomeSID'
|
|
pause='60'
|
|
xmlns='http://jabber.org/protocol/httpbind'/>]]></example>
|
|
<p>Upon reception of a session pause request, if the requested period is not greater than the maximum permitted time, then the connection manager SHOULD respond immediately to all pending requests (including the pause request) and <em>temporarily</em> increase the maximum inactivity period to the requested time. Note: The response to the pause request MUST NOT contain any stanzas.</p>
|
|
<p>Note: If the client simply wants the connection manager to return all the requests it is holding then it MAY set the value of the 'pause' attribute to be the value of the 'inactivity' attribute in the connection manager's session creation response. (If the client believes it is in danger of becoming disconnected indefinitely then it MAY even request a temporary reduction of the maximum inactivity period by specifying a 'pause' value less than the 'inactivity' value, thus enabling the connection manager to discover any subsequent disconnection more quickly.)</p>
|
|
<p>The connection manager SHOULD set the maximum inactivity period back to normal upon reception of the next request from the client (assuming the connection manager hasn't already terminated the session).</p>
|
|
</section1>
|
|
<section1 topic='Overactivity' anchor='overactive'>
|
|
<p>The client SHOULD NOT make more simultaneous requests than specified by the 'requests' attribute in the connection manager's <link url="#session-create">Session Creation Response</link>. However the client MAY make one additional request if it is to <link url="#inactive">pause</link> or <link url="#terminate">terminate</link> a session.</p>
|
|
<p>If during any period the client sends a sequence of new requests (i.e. requests with incremented rid attributes, not repeat requests) longer than the number specified by the 'requests' attribute, and if the connection manager has not yet responded to any of the requests, and if the last request did not include either a 'pause' attribute or a 'type' attribute set to "terminate", then the connection manager SHOULD consider that the client is making too many simultaneous requests and terminate the HTTP session and return a 'policy-violation' terminal binding error to the client. Note: This behavior applies to equally to normal and polling sessions.</p>
|
|
<example caption="Too many simultaneous requests response">
|
|
<![CDATA[HTTP/1.1 200 OK
|
|
Content-Type: text/xml; charset=utf-8
|
|
Content-Length: 68
|
|
|
|
<body type='terminate'
|
|
condition='policy-violation'
|
|
xmlns='http://jabber.org/protocol/httpbind'/>]]></example>
|
|
<p>Note: If the connection manager did not specify a 'requests' attribute in the session creation response, then it MUST allow the client to send as many simultaneous requests as it chooses.</p>
|
|
<p>If during any period the client sends a sequence of new requests equal in length to the number specified by the 'requests' attribute, and if the connection manager has not yet responded to any of the requests, and if the last request was empty and did not include either a 'pause' attribute or a 'type' attribute set to "terminate", and if the last two requests arrived within a period shorter than the number of seconds specified by the 'polling' attribute in the session creation response, then the connection manager SHOULD consider that the client is making requests more frequently than it was permitted and terminate the HTTP session and return a 'policy-violation' terminal binding error to the client. Note: the behavior for <link url="#poll">Polling Sessions</link> is slightly different.</p>
|
|
<example caption="Too frequent requests response">
|
|
<![CDATA[HTTP/1.1 200 OK
|
|
Content-Type: text/xml; charset=utf-8
|
|
Content-Length: 68
|
|
|
|
<body type='terminate'
|
|
condition='policy-violation'
|
|
xmlns='http://jabber.org/protocol/httpbind'/>]]></example>
|
|
<p>Note: If the connection manager did not specify a 'polling' attribute in the session creation response, then it MUST allow the client to send requests as frequently as it chooses.</p>
|
|
</section1>
|
|
<section1 topic='Polling Sessions' anchor='poll'>
|
|
<p>It may not be possible for a constrained client to either use HTTP Pipelining or open more than one HTTP connection with the connection manager at a time. In this case the client SHOULD inform the connection manager by setting the values of the 'wait' and/or 'hold' attributes in its session creation request to "0", and then "poll" the connection manager at regular intervals throughout the session for stanzas it may have received from the server. Note: Even if the client does not request a polling session then the connection manager MAY require a client to use polling by setting the 'requests' attribute (which specifies the number of simultaneous requests the client may make) of its <link url="#session-create">Session Creation Response</link> to "1", however this is NOT RECOMMENDED.</p>
|
|
<p>If a session will use polling the connection manager SHOULD specify a higher than normal value for the 'inactivity' attribute (see <link url="#inactive">Inactivity</link>) in its session creation response. The increase SHOULD be greater than the value it specifies for the 'polling' attribute.</p>
|
|
<p>If the client sends two consecutive empty new requests (i.e. requests with incremented rid attributes, not repeat requests) within a period shorter than the number of seconds specified by the 'polling' attribute (the shortest allowable polling interval) in the session creation response, and if the connection manager's response to the first request contained no stanzas, then upon reception of the second request the connection manager SHOULD terminate the HTTP session and return a 'policy-violation' terminal binding error to the client.</p>
|
|
<example caption="Too frequent polling response">
|
|
<![CDATA[HTTP/1.1 200 OK
|
|
Content-Type: text/xml; charset=utf-8
|
|
Content-Length: 68
|
|
|
|
<body type='terminate'
|
|
condition='policy-violation'
|
|
xmlns='http://jabber.org/protocol/httpbind'/>]]></example>
|
|
<p>Note: If the connection manager did not specify a 'polling' attribute in the session creation response, then it MUST allow the client to poll as frequently as it chooses.</p>
|
|
</section1>
|
|
<section1 topic='Terminating the HTTP Session' anchor='terminate'>
|
|
<p>At any time, the client MAY gracefully terminate the session by sending a <body/> element with a 'type' attribute set to "terminate". The termination request MAY include one or more stanzas that the connection manager MUST forward to the server to ensure graceful logoff.</p>
|
|
<example caption="Session termination by client">
|
|
<![CDATA[POST /webclient HTTP/1.1
|
|
Host: httpcm.jabber.org
|
|
Accept-Encoding: gzip, deflate
|
|
Content-Type: text/xml; charset=utf-8
|
|
Content-Length: 153
|
|
|
|
<body rid='1249243565'
|
|
sid='SomeSID'
|
|
type='terminate'
|
|
xmlns='http://jabber.org/protocol/httpbind'>
|
|
<presence type='unavailable'
|
|
xmlns='jabber:client'/>
|
|
</body>]]></example>
|
|
<p>The connection manager SHOULD return to the client an HTTP 200 OK response with an empty <body/> element.</p>
|
|
<example caption="Recoverable error">
|
|
<![CDATA[HTTP/1.1 200 OK
|
|
Content-Type: text/xml; charset=utf-8
|
|
Content-Length: 72
|
|
|
|
<body type='terminate'
|
|
xmlns='http://jabber.org/protocol/httpbind'/>]]></example>
|
|
<p>Upon receiving the response, the client MUST consider the HTTP session to have been terminated.</p>
|
|
</section1>
|
|
<section1 topic="Request IDs" anchor='rids'>
|
|
<section2 topic='Generation' anchor='rids-syntax'>
|
|
<p>The client MUST generate a large, random, positive integer for the initial 'rid' (see <link url="#security">Security Considerations</link>, this also prevents non-compliant proxies from caching <link url="#script">Script Syntax</link> responses) and then increment that value by one for each subsequent request. The client MUST take care to choose an initial 'rid' that will never be incremented above 9007199254740991 <note>9007199254740991 is 2<span class='super'>53</span>-1. Some weakly typed languages use IEEE Standard 754 Doubles to represent all numbers. These Doubles cannot represent integers above 2<span class='super'>53</span> accurately.</note> within the session. In practice, a session would have to be extraordinarily long (or involve the exchange of an extraordinary number of packets) to exceed the defined limit.</p>
|
|
</section2>
|
|
<section2 topic='In-Order Message Forwarding' anchor='rids-order'>
|
|
<p>When a client makes simultaneous requests, the connection manager may receive them out of order. The connection manager MUST forward the stanzas to the server and respond to the client requests in the order specified by the 'rid' attributes. The client MUST process responses received from the connection manager in the order the requests were made.</p>
|
|
<p>The connection manager SHOULD expect the 'rid' attribute to be within a window of values greater than the 'rid' of the previous request. The size of the window is equal to the maximum number of simultaneous requests allowed by the connection manager. If it receives a request with a 'rid' greater than the values in the window, then the connection manager MUST terminate the session with an error:</p>
|
|
<example caption="Unexpected rid error">
|
|
<![CDATA[HTTP/1.1 200 OK
|
|
Content-Type: text/xml; charset=utf-8
|
|
Content-Length: 68
|
|
|
|
<body type='terminate'
|
|
condition='item-not-found'
|
|
xmlns='http://jabber.org/protocol/httpbind'/>]]></example>
|
|
</section2>
|
|
<section2 topic='Broken Connections' anchor='rids-broken'>
|
|
<p>Unreliable network communications or client constraints can result in broken connections. The connection manager SHOULD remember the 'rid' and the associated HTTP response body of the client's most recent requests which were not session pause requests (see <link url="#inactive">Inactivity</link>) and which did not result in an HTTP or binding error. The number of responses to non-pause requests kept in the buffer SHOULD be either the same as the maximum number of simultaneous requests allowed by the connection manager or, if <link url="#ack">Acknowledgements</link> are being used, the number of responses that have not yet been acknowledged.</p>
|
|
<p>If the network connection is broken or closed before the client receives a response to a request from the connection manager, then the client MAY resend an exact copy of the original request. Whenever the connection manager receives a request with a 'rid' that it has already received, it SHOULD return an HTTP 200 (OK) response that includes the buffered copy of the original XML response to the client (i.e., a <body/> wrapper possessing appropriate attributes and optionally containing one or more XML stanzas or other allowable XML elements). If the original response is not available (e.g., it is no longer in the buffer), then the connection manager MUST return an 'item-not-found' terminal binding error:</p>
|
|
<example caption="Response not in buffer error">
|
|
<![CDATA[HTTP/1.1 200 OK
|
|
Content-Type: text/xml; charset=utf-8
|
|
Content-Length: 68
|
|
|
|
<body type='terminate'
|
|
condition='item-not-found'
|
|
xmlns='http://jabber.org/protocol/httpbind'/>]]></example>
|
|
<p>Note: The error is the same whether the 'rid' is too large or too small. This makes it more difficult for an attacker to discover an acceptable value.</p>
|
|
</section2>
|
|
</section1>
|
|
<section1 topic="Protecting Insecure Sessions" anchor='keys'>
|
|
<section2 topic="Applicability" anchor='keys-applic'>
|
|
<p>The OPTIONAL key sequencing mechanism described here MAY be used if the client's session with the connection manager is not secure. The session should be considered secure only if all client requests are made via SSL (or TLS) HTTP connections and the connection manager generates an unpredictable session ID. If the session is secure, it is not necessary to use this key sequencing mechanism.</p>
|
|
<p>Even if the session is not secure, the unpredictable session and request IDs specified in the preceding sections of this document already provide a level of protection similar to that provided by a connection bound to a single pair of persistent TCP/IP connections, and thus provide sufficient protection against a 'blind' attacker. However, in some circumstances, the key sequencing mechanism defined below helps to protect against a more determined and knowledgeable attacker.</p>
|
|
<p>It is important to recognize that the key sequencing mechanism defined below helps to protect only against an attacker who is able to view the contents of all requests or responses in an insecure session but who is not able to alter the contents of those requests (in this case, the mechanism prevents the attacker from interjecting HTTP requests into the session, e.g., termination requests or responses). However, the key sequencing mechanism does not provide any protection when the attacker is able to alter the contents of insecure requests or responses.</p>
|
|
</section2>
|
|
<section2 topic="Introduction" anchor='keys-intro'>
|
|
<p>The HTTP requests of each session MAY be spread across a series of different socket connections. This would enable an unauthorized user that obtains the session ID and request ID of a session and then use their own socket connection to interject <body/> request elements into the session and receive the corresponding responses.</p>
|
|
<p>The key sequencing mechanism below protects against such attacks by enabling a connection manager to detect <body/> request elements interjected by a third party.</p>
|
|
</section2>
|
|
<section2 topic="Generating the Key Sequence" anchor='keys-generate'>
|
|
<p>Prior to requesting a new session, the client MUST select an unpredictable counter ("n") and an unpredictable value ("seed"). The client then processes the "seed" through a cryptographic hash and converts the resulting 160 bits to a hexadecimal string K(1). It does this "n" times to arrive at the initial key K(n). The hashing algorithm MUST be SHA-1 as defined in &rfc3174;.</p>
|
|
<example caption="Creating the key sequence">
|
|
K(1) = hex(SHA-1(seed))
|
|
K(2) = hex(SHA-1(K(1)))
|
|
...
|
|
K(n) = hex(SHA-1(K(n-1)))
|
|
</example>
|
|
</section2>
|
|
<section2 topic="Use of Keys" anchor='keys-use'>
|
|
<p>The client MUST set the 'newkey' attribute of the first request in the session to the value K(n).</p>
|
|
<example caption="Session Request with Initial Key">
|
|
<![CDATA[POST /webclient HTTP/1.1
|
|
Host: httpcm.jabber.org
|
|
Accept-Encoding: gzip, deflate
|
|
Content-Type: text/xml; charset=utf-8
|
|
Content-Length: 104
|
|
|
|
<body content='text/xml; charset=utf-8'
|
|
hold='1'
|
|
rid='1573741820'
|
|
to='jabber.org'
|
|
wait='60'
|
|
xml:lang='en'
|
|
newkey='ca393b51b682f61f98e7877d61146407f3d0a770'
|
|
xmlns='http://jabber.org/protocol/httpbind'/>]]></example>
|
|
<p>The client MUST set the 'key' attribute of all subsequent requests to the value of the next key in the generated sequence (decrementing from K(n-1) towards K(1) with each request sent).</p>
|
|
<example caption="Request with Key">
|
|
<![CDATA[POST /webclient HTTP/1.1
|
|
Host: httpcm.jabber.org
|
|
Accept-Encoding: gzip, deflate
|
|
Content-Type: text/xml; charset=utf-8
|
|
Content-Length: 88
|
|
|
|
<body rid='1573741821'
|
|
sid='SomeSID'
|
|
key='bfb06a6f113cd6fd3838ab9d300fdb4fe3da2f7d'
|
|
xmlns='http://jabber.org/protocol/httpbind'/>]]></example>
|
|
<p>The connection manager MAY verify the key by calculating the SHA-1 hash of the key and comparing it to the 'newkey' attribute of the previous request (or the 'key' attribute if the 'newkey' attribute was not set). If the values do not match (or if it receives a request without a 'key' attribute and the 'newkey' or 'key' attribute of the previous request was set), then the connection manager MUST NOT process the element, MUST terminate the session, and MUST return an 'item-not-found' terminal binding error.</p>
|
|
<example caption="Invalid Key Sequence Error">
|
|
<![CDATA[HTTP/1.1 200 OK
|
|
Content-Type: text/xml; charset=utf-8
|
|
Content-Length: 68
|
|
|
|
<body type='terminate'
|
|
condition='item-not-found'
|
|
xmlns='http://jabber.org/protocol/httpbind'/>]]></example>
|
|
</section2>
|
|
<section2 topic="Switching to Another Key Sequence" anchor='keys-switch'>
|
|
<p>A client SHOULD choose a high value for "n" when generating the key sequence. However, if the session lasts long enough that the client arrives at the last key in the sequence K(1) then the client MUST switch to a new key sequence.</p>
|
|
<p>The client MUST:</p>
|
|
<ol>
|
|
<li>Choose new values for "seed" and "n".</li>
|
|
<li>Generate a new key sequence using the algorithm defined above.</li>
|
|
<li>Set the 'key' attribute of the request to the next value in the old sequence (i.e. K(1), the last value).</li>
|
|
<li>Set the 'newkey' attribute of the request to the value K(n) from the new sequence.</li>
|
|
</ol>
|
|
<example caption="New Key Sequence">
|
|
<![CDATA[POST /webclient HTTP/1.1
|
|
Host: httpcm.jabber.org
|
|
Accept-Encoding: gzip, deflate
|
|
Content-Type: text/xml; charset=utf-8
|
|
Content-Length: 188
|
|
|
|
<body rid='1573741822'
|
|
sid='SomeSID'
|
|
key='6f825e81f4532b2c5fa2d12457d8a1f22e8f838e'
|
|
newkey='113f58a37245ec9637266cf2fb6e48bfeaf7964e'
|
|
xmlns='http://jabber.org/protocol/httpbind'>
|
|
<message to='contact@example.com'
|
|
xmlns='jabber:client'>
|
|
<body>I said "Hi!"</body>
|
|
</message>
|
|
</body>]]></example>
|
|
</section2>
|
|
</section1>
|
|
|
|
<section1 topic='Multiple Streams' anchor='multi'>
|
|
<section2 topic="Introduction" anchor='multi-intro'>
|
|
<p>The OPTIONAL feature described in this section enables multiple XML streams to be contained within a single HTTP session. This feature is essential in runtime environments that prevent HTTP Pipelining, thereby constraining the number of simultaneous HTTP requests a client may make to each connection manager, since clients running in such environments need multi-stream sessions if they are to connect using more than one account at the same time. This feature also reduces network traffic for any client that needs to establish parallel streams over HTTP.</p>
|
|
</section2>
|
|
<section2 topic="Discovery" anchor='multi-discover'>
|
|
<p>If a connection manager supports the multi-streams feature, it MUST include a 'stream' attribute in its <link url="#session-create">Session Creation Response</link>. If a client does not receive the 'stream' attribute then it MUST assume that the connection manager does not support the feature. <note>Therefore a client and a connection manager will be compatible even if one or the other offers no support for multi-stream sessions.</note></p>
|
|
<p>The 'stream' attribute identifies the first stream to be opened for the session. The value of each 'stream' attribute MUST be an opaque and unpredictable name that is unique within the context of the connection manager application.</p>
|
|
<example caption="Session creation response with stream name">
|
|
<![CDATA[HTTP/1.1 200 OK
|
|
Content-Type: text/xml; charset=utf-8
|
|
Content-Length: 128
|
|
|
|
<body wait='60'
|
|
inactivity='30'
|
|
polling='5'
|
|
requests='2'
|
|
hold='1'
|
|
accept='deflate,gzip'
|
|
stream='firstStreamName'
|
|
maxpause='120'
|
|
sid='SomeSID'
|
|
charsets='ISO_8859-1 ISO-2022-JP'
|
|
ver='1.6'
|
|
from='jabber.org'
|
|
secure='true'
|
|
xmlns='http://jabber.org/protocol/httpbind'/>]]></example>
|
|
</section2>
|
|
<section2 topic="Adding Streams To A Session" anchor='multi-add'>
|
|
<p>If the connection manager included a 'stream' attribute in its session creation response then the client MAY ask it to open another stream at any time by sending it an empty <body/> element with a 'to' attribute. The request MUST include valid 'sid' and 'rid' <note>The 'rid' attribute is always incremented normally without reference to any 'stream' attribute.</note> attributes, it SHOULD also include an 'xml:lang' attribute. The request MAY include 'route', 'from' and 'secure' attributes (see <link url="#session-request">Session Creation Request</link>), but it SHOULD NOT include 'ver', 'content', 'hold' or 'wait' attributes (since a new session is not being created).</p>
|
|
<example caption="Requesting another stream">
|
|
<![CDATA[POST /webclient HTTP/1.1
|
|
Host: httpcm.jabber.org
|
|
Accept-Encoding: gzip, deflate
|
|
Content-Type: text/xml; charset=utf-8
|
|
Content-Length: 104
|
|
|
|
<body sid='SomeSID'
|
|
rid='1573741820'
|
|
to='jabber.org'
|
|
route='xmpp:jabber.org:9999'
|
|
secure='true'
|
|
xml:lang='en'
|
|
xmlns='http://jabber.org/protocol/httpbind'/>]]></example>
|
|
<p>If the connection manager did not indicate its support for multiple streams at the start of the session then it MUST ignore the extra attributes and treat the request as a normal empty request for stanzas (see <link url="#stanzas">Sending and Receiving XML Stanzas</link>). <note>This helps to ensure backwards-compatibility with older implementations.</note> Otherwise it MUST open a new stream with the specified server (see <link url="#session-create">Session Creation Response</link>), generate a new stream name and respond to the client with the name. The response MAY also include 'from' and 'secure' attributes, but it SHOULD NOT include 'sid', 'requests', 'polling', 'hold', 'inactivity', 'maxpause', 'accept', 'charsets', 'ver' or 'wait' attributes.</p>
|
|
<example caption="Add stream response">
|
|
<![CDATA[HTTP/1.1 200 OK
|
|
Content-Type: text/xml; charset=utf-8
|
|
Content-Length: 128
|
|
|
|
<body stream='secondStreamName'
|
|
from='jabber.org'
|
|
secure='true'
|
|
xmlns='http://jabber.org/protocol/httpbind'/>]]></example>
|
|
<p>Note: If the response did not include either 'from' or 'secure' attributes then they MAY be sent in a subsequent response instead (see <link url="#session-create">Session Creation Response</link>). In that case the 'stream' attribute MUST also be specified.</p>
|
|
</section2>
|
|
<section2 topic="Transmitting Stanzas" anchor='multi-transmit'>
|
|
<p>If more than one stream has been opened within a session, then all non-empty <body/> elements sent by the connection manager MUST include a 'stream' attribute that specifies which stream <em>all</em> the stanzas it contains belong to. The client SHOULD include a 'stream' attribute for the same purpose. The client MAY omit the 'stream' attribute if it wants the connection manager to broadcast the stanzas over all open streams. Note: A <body/> element MUST NOT contain different stanzas for different streams.</p>
|
|
<p>If a stream name does not correspond to one of the session's open streams, then the receiving connection manager SHOULD return an 'item-not-found' terminal binding error, or the receiving client SHOULD terminate the session. However, if the receiving entity has only just closed the stream (and the sender may not have been aware of that when it sent the stanzas), then it MAY instead simply silently ignore any stanzas the <body/> element contains.</p>
|
|
<p>Note: Empty <body/> elements that do not include a 'from' or 'secure' attribute SHOULD NOT include a 'stream' attribute (since nothing is being transmitted for any stream). If such a <body/> element does include a 'stream' attribute then the receiving entity SHOULD ignore the attribute.</p>
|
|
<example caption="Client sends stanza with a stream name">
|
|
<![CDATA[POST /webclient HTTP/1.1
|
|
Host: httpcm.jabber.org
|
|
Accept-Encoding: gzip, deflate
|
|
Content-Type: text/xml; charset=utf-8
|
|
Content-Length: 188
|
|
|
|
<body rid='1249243562'
|
|
sid='SomeSID'
|
|
stream='secondStreamName'
|
|
xmlns='http://jabber.org/protocol/httpbind'>
|
|
<message to='contact@example.com'
|
|
xmlns='jabber:client'>
|
|
<body>I said "Hi!"</body>
|
|
</message>
|
|
</body>]]></example>
|
|
<p>Note: The value of the 'stream' attribute of the response MAY be different to the corresponding request. <note>Each HTTP response MUST belong to the same session as the request that triggered it, but not necessarily to the same stream.</note></p>
|
|
<example caption="Connection manager responds with a different stream name">
|
|
<![CDATA[HTTP/1.1 200 OK
|
|
Content-Type: text/xml; charset=utf-8
|
|
Content-Length: 185
|
|
|
|
<body stream='firstStreamName'
|
|
xmlns='http://jabber.org/protocol/httpbind'>
|
|
<message from='contact@example.com'
|
|
to='user@example.com'
|
|
xmlns='jabber:client'>
|
|
<body>Hi yourself!</body>
|
|
</message>
|
|
</body>]]></example>
|
|
<p>If no stream name is specified by the connection manager then the client MUST assume the stanzas are associated with the first stream (even if the first stream has been closed).</p>
|
|
<p>If no stream name is specified by the client then the connection manager MUST broadcast the stanzas over all open streams. <note>The broadcast stanzas may be of any type.</note></p>
|
|
<example caption="Client asks for a stanza to be broadcast">
|
|
<![CDATA[POST /webclient HTTP/1.1
|
|
Host: httpcm.jabber.org
|
|
Accept-Encoding: gzip, deflate
|
|
Content-Type: text/xml; charset=utf-8
|
|
Content-Length: 188
|
|
|
|
<body rid='1249243562'
|
|
sid='SomeSID'
|
|
xmlns='http://jabber.org/protocol/httpbind'>
|
|
<presence xmlns='jabber:client'>
|
|
<show>away</show>
|
|
</presence>
|
|
</body>]]></example>
|
|
</section2>
|
|
<section2 topic='Closing a Stream' anchor='multi-close'>
|
|
<p>If more than one stream is open within a session, the client MAY close one open stream at any time using the procedure described in the section <link url="#terminate">Terminating the HTTP Session</link> above, taking care to specify the stream name with a 'stream' attribute. If the client closes the last stream the connection manager MUST terminate the session. If the client does not specify a stream name then the connection manager MUST close all open streams (sending any stanzas the terminate request contains to all streams), and terminate the session.</p>
|
|
<example caption="Client closes one stream">
|
|
<![CDATA[POST /webclient HTTP/1.1
|
|
Host: httpcm.jabber.org
|
|
Accept-Encoding: gzip, deflate
|
|
Content-Type: text/xml; charset=utf-8
|
|
Content-Length: 153
|
|
|
|
<body rid='1249243564'
|
|
sid='SomeSID'
|
|
stream='secondStreamName'
|
|
type='terminate'
|
|
xmlns='http://jabber.org/protocol/httpbind'>
|
|
<presence type='unavailable'
|
|
xmlns='jabber:client'/>
|
|
</body>]]></example>
|
|
</section2>
|
|
<section2 topic='Error Conditions' anchor='multi-error'>
|
|
<p>If more than one stream is open within a session, the connection manager MAY include a 'stream' attribute in a fatal binding error (see <link url="#errorstatus-terminal">Terminal Binding Conditions</link>). If a 'stream' attribute is specified then the stream MUST be closed by both entities but the session SHOULD NOT be terminated.</p>
|
|
<example caption="Fatal stream error">
|
|
<![CDATA[HTTP/1.1 200 OK
|
|
Content-Type: text/xml; charset=utf-8
|
|
Content-Length: 68
|
|
|
|
<body type='terminate'
|
|
condition='remote-connection-failed'
|
|
stream='secondStreamName'
|
|
xmlns='http://jabber.org/protocol/httpbind'/>]]></example>
|
|
<p>Note: If the connection manager does not include a 'stream' attribute in a fatal binding error then all the session's open streams MUST be closed by both entities and the session MUST be terminated.</p>
|
|
</section2>
|
|
</section1>
|
|
|
|
<section1 topic='Error and Status Codes' anchor='errorstatus'>
|
|
<p>There are four types of error and status reporting in HTTP responses:</p>
|
|
<table caption='Error Condition Types'>
|
|
<tr><th>Condition Type</th><th>Description</th></tr>
|
|
<tr><td><strong>HTTP Conditions</strong> <em>(Deprecated)</em></td><td>The connection manager responds to an invalid request from a <em>legacy</em> client with a standard HTTP error. These are used for binding syntax errors, possible attacks, etc. Note that constrained clients are unable to differentiate between HTTP errors.</td></tr>
|
|
<tr><td><strong>Terminal Binding Conditions</strong></td><td>These error conditions may be read by constrained clients. They are used for connection manager problems, abstracting stream errors, communication problems between the connection manager and the server, and invalid client requests (binding syntax errors, possible attacks, etc.)</td></tr>
|
|
<tr><td><strong>Recoverable Binding Conditions</strong></td><td>These report communication problems between the connection manager and the client. They do not terminate the session. Clients recover from these errors by resending all the preceding <body/> wrappers that have not received responses.</td></tr>
|
|
<tr><td><strong>Transported Protocol Conditions</strong></td><td>Errors relating to the XML stanzas <em>within</em> <body/> wrappers are, in general, defined in the documentation of the protocol being transported. They do not terminate the session.</td></tr>
|
|
</table>
|
|
<p>Full descriptions are provided below.</p>
|
|
<section2 topic='HTTP Conditions' anchor='errorstatus-http'>
|
|
<p><em>Note: All HTTP codes except 200 have been superseded by Terminal Binding Conditions to allow clients to determine whether the source of errors is the connection manager application or an HTTP intermediary.</em></p>
|
|
<p>A legacy client (or connection manager) is a client (or connection manager) that did not include a 'ver' attribute in its session creation request (or response). A legacy client (or connection manager) will interpret (or respond with) HTTP error codes according to the table below. Non-legacy connection managers SHOULD NOT send HTTP error codes unless they are communicating with a legacy client. Upon receiving an HTTP error (400, 403, 404), a legacy client or any client that is communicating with a legacy connection manager MUST consider the HTTP session to be null and void. A non-legacy client that is communicating with a non-legacy connection manager MAY consider that the session is still active.</p>
|
|
<table caption='HTTP Error and Status Codes'>
|
|
<tr>
|
|
<th>Code</th>
|
|
<th>Name</th>
|
|
<th>Superseded by</th>
|
|
<th>Purpose</th>
|
|
</tr>
|
|
<tr>
|
|
<td>200</td>
|
|
<td>OK</td>
|
|
<td>-</td>
|
|
<td>Response to valid client request.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>400</td>
|
|
<td>Bad Request</td>
|
|
<td>bad-request</td>
|
|
<td>Inform client that the format of an HTTP header or binding element is unacceptable (e.g., syntax error).</td>
|
|
</tr>
|
|
<tr>
|
|
<td>403</td>
|
|
<td>Forbidden</td>
|
|
<td>policy-violation</td>
|
|
<td>Inform client that it has broken the session rules (polling too frequently, requesting too frequently, too many simultaneous requests).</td>
|
|
</tr>
|
|
<tr>
|
|
<td>404</td>
|
|
<td>Not Found</td>
|
|
<td>item-not-found</td>
|
|
<td>Inform client that (1) 'sid' is not valid, (2) 'stream' is not valid, (3) 'rid' is larger than the upper limit of the expected window, (4) connection manager is unable to resend response, (5) 'key' sequence is invalid.</td>
|
|
</tr>
|
|
</table>
|
|
<p>No other HTTP error and status codes were defined.</p>
|
|
<p>Note: Any connection manager (not only legacy connection managers) MAY indicate that it does not support <link url="#script">Script Syntax</link> by sending an HTTP 404 error code (instead of sending a bad-request error using Scrypt Syntax).</p>
|
|
<example caption="Script Syntax not supported error">
|
|
<![CDATA[HTTP/1.1 404 Not Found
|
|
Content-Length: 0]]></example>
|
|
</section2>
|
|
<section2 topic='Terminal Binding Conditions' anchor='errorstatus-terminal'>
|
|
<p>In any response it sends to the client, the connection manager MAY return a fatal error by setting a 'type' attribute of the <body/> element to "terminate". These binding errors imply that the HTTP session is terminated (unless a 'stream' attribute is specified - see <link url="#multi-error">Multiple Stream Error Conditions</link>).</p>
|
|
<p>Note: Although many of these conditions are similar to the XMPP stream error conditions specified in <cite>RFC 3920</cite>, they should not be confused with XMPP stream errors. In cases where this protocol is being used to transport XMPP, any fatal XMPP stream error conditions experienced between the connection manager and the XMPP server SHOULD only be reported using the "remote-stream-error" condition as described below.</p>
|
|
<example caption="Remote connection failed error">
|
|
<![CDATA[HTTP/1.1 200 OK
|
|
Content-Type: text/xml; charset=utf-8
|
|
Content-Length: 68
|
|
|
|
<body type='terminate'
|
|
condition='remote-connection-failed'
|
|
xmlns='http://jabber.org/protocol/httpbind'/>]]></example>
|
|
<p>The following values of the 'condition' attribute are defined:</p>
|
|
<table caption='Terminal Binding Error Conditions'>
|
|
<tr>
|
|
<th>Condition</th>
|
|
<th>Purpose</th>
|
|
</tr>
|
|
<tr>
|
|
<td>bad-request*</td>
|
|
<td>The format of an HTTP header or binding element received from the client is unacceptable (e.g., syntax error), or Script Syntax is not supported.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>host-gone</td>
|
|
<td>The target domain specified in the 'to' attribute or the target host or port specified in the 'route' attribute is no longer serviced by the connection manager.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>host-unknown</td>
|
|
<td>The target domain specified in the 'to' attribute or the target host or port specified in the 'route' attribute is unknown to the connection manager.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>improper-addressing</td>
|
|
<td>The initialization element lacks a 'to' or 'route' attribute (or the attribute has no value) but the connection manager requires one.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>internal-server-error</td>
|
|
<td>The connection manager has experienced an internal error that prevents it from servicing the request.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>item-not-found*</td>
|
|
<td>(1) 'sid' is not valid, (2) 'stream' is not valid, (3) 'rid' is larger than the upper limit of the expected window, (4) connection manager is unable to resend response, (5) 'key' sequence is invalid</td>
|
|
</tr>
|
|
<tr>
|
|
<td>other-request</td>
|
|
<td>Another request being processed at the same time as this request caused the session to terminate.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>policy-violation*</td>
|
|
<td>The client has broken the session rules (polling too frequently, requesting too frequently, too many simultaneous requests).</td>
|
|
</tr>
|
|
<tr>
|
|
<td>remote-connection-failed</td>
|
|
<td>The connection manager was unable to connect to, or unable to connect securely to, or has lost its connection to, the server.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>remote-stream-error</td>
|
|
<td>Encapsulates an error in the protocol being transported.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>see-other-uri</td>
|
|
<td>The connection manager does not operate at this URI (e.g., the connection manager accepts only SSL or TLS connections at some https: URI rather than the http: URI requested by the client). The client may try POSTing to the URI in the content of the <uri/> child element.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>system-shutdown</td>
|
|
<td>The connection manager is being shut down. All active HTTP sessions are being terminated. No new sessions can be created.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>undefined-condition</td>
|
|
<td>The error is not one of those defined herein; the connection manager SHOULD include application-specific information in the content of the <body/> wrapper.</td>
|
|
</tr>
|
|
</table>
|
|
<p>* If the client did not include a 'ver' attribute in its session creation request then the connection manager SHOULD send a <em>deprecated</em> <link url="#errorstatus-http">HTTP Error Condition</link> instead of this terminal binding condition. If the connection manager did not include a 'ver' attribute in its session creation response then the client SHOULD expect it to send a <em>deprecated</em> HTTP Error Condition instead of this terminal binding condition.</p>
|
|
<p>The following is an example of a "see-other-uri" condition:</p>
|
|
<example caption="See other URI error">
|
|
<![CDATA[HTTP/1.1 200 OK
|
|
Content-Type: text/xml; charset=utf-8
|
|
Content-Length: 68
|
|
|
|
<body condition='see-other-uri'
|
|
type='terminate'
|
|
xmlns='http://jabber.org/protocol/httpbind'>
|
|
<uri>https://secure.jabber.org/xmppcm</uri>
|
|
</body>]]></example>
|
|
<p>The following is an example including a "remote-stream-error" condition:</p>
|
|
<example caption="Remote error">
|
|
<![CDATA[HTTP/1.1 200 OK
|
|
Content-Type: text/xml; charset=utf-8
|
|
Content-Length: 68
|
|
|
|
<body condition='remote-stream-error'
|
|
type='terminate'
|
|
xmlns='http://jabber.org/protocol/httpbind'
|
|
xmlns:stream='http://etherx.jabber.org/streams'>
|
|
<message from='contact@example.com'
|
|
to='user@example.com'
|
|
xmlns='jabber:client'>
|
|
<body>Hi yourself!</body>
|
|
</message>
|
|
<stream:error>
|
|
<xml-not-well-formed xmlns='urn:ietf:params:xml:ns:xmpp-streams'/>
|
|
<text xmlns='urn:ietf:params:xml:ns:xmpp-streams'
|
|
xml:lang='en'>
|
|
Some special application diagnostic information!
|
|
</text>
|
|
<escape-your-data xmlns='application-ns'/>
|
|
</stream:error>
|
|
</body>]]></example>
|
|
<p>Naturally, the client MAY report binding errors to the connection manager as well, although this is unlikely.</p>
|
|
</section2>
|
|
<section2 topic='Recoverable Binding Conditions' anchor='errorstatus-recover'>
|
|
<p>In any response it sends to the client, the connection manager MAY return a recoverable error by setting a 'type' attribute of the <body/> element to "error". These errors do not imply that the HTTP session is terminated.</p>
|
|
<p>If it decides to recover from the error, then the client MUST repeat the HTTP request and all the preceding HTTP requests that have not received responses. The content of these requests MUST be identical to the &BODY; elements of the original requests. This allows the connection manager to recover a session after the previous request was lost due to a communication failure.</p>
|
|
<example caption="Recoverable error">
|
|
<![CDATA[HTTP/1.1 200 OK
|
|
Content-Type: text/xml; charset=utf-8
|
|
Content-Length: 68
|
|
|
|
<body type='error'
|
|
xmlns='http://jabber.org/protocol/httpbind'/>]]></example>
|
|
</section2>
|
|
<section2 topic='XML Stanza Conditions' anchor='errorstatus-stanza'>
|
|
<p>Application-level error conditions described in the documentation of the protocol being transported are routed to the client through the connection manager. They are transparent to the connection manager, and therefore out of scope for the transport binding defined herein.</p>
|
|
</section2>
|
|
</section1>
|
|
<section1 topic='Alternative Script Syntax' anchor='script'>
|
|
<section2 topic='Introduction' anchor='script-intro'>
|
|
<p>The cross domain security restrictions of some runtime environments permit clients to access pure XML text only if it was received from a specific server (e.g., the hostname a Web client was downloaded from). Astonishingly the same environments typically permit clients to receive and execute scripts from any server! <note>This security hole is unlikely to be closed by browser vendors since it facilitates online advertising.</note> The <link url="#security">Security Considerations</link> section below describes the significant risks of deploying Script Syntax.</p>
|
|
<p>To enable domain-restricted clients to use BOSH with any connection manager, this section proposes an <em>optional</em> alternative to the standard "BOSH Pure Syntax" seen in the other sections of this document. The "BOSH Script Syntax" defined here essentially inserts each <body/> element sent by the client into an HTTP GET header instead of into the body of a POST request. Each <body/> element sent by the connection manager is wrapped inside an &ecma262; string and function call. No changes to the <body/> element or to any other aspects of the protocol are required.</p>
|
|
<p>If, and only if, a client is <em>unable</em> to use the Pure Syntax, then it MAY send a session request to a BOSH connection manager using Script Syntax instead. If the connection manager supports Script Syntax then it MUST send its <link url="#session-create">Session Creation Response</link> using Script Syntax, and all subsequent client requests and connection manager responses within the session MUST be sent using Script Syntax. If the connection manager does not support the "BOSH Script" syntax then it SHOULD return either an 'item-not-found' terminal binding error (in Script Syntax) or an HTTP 404 (Not Found) error in response to the client's session request:</p>
|
|
<p>Note: The line break in the body of the HTTP response in the following example is included only to improve readability. In practice there MUST be no line breaks.</p>
|
|
<example caption="Script Syntax not supported binding error">
|
|
<![CDATA[HTTP/1.1 200 OK
|
|
Content-Type: text/javascript; charset=utf-8
|
|
Cache-Control: no-store
|
|
Cache-Control: no-cache
|
|
Pragma: no-cache
|
|
Content-Length: 212
|
|
|
|
_BOSH_("<body type='terminate' condition='item-not-found'
|
|
xmlns='http://jabber.org/protocol/httpbind'/>")]]></example>
|
|
<example caption="Script Syntax not supported HTTP error">
|
|
<![CDATA[HTTP/1.1 404 Not Found
|
|
Content-Length: 0]]></example>
|
|
</section2>
|
|
<section2 topic='Changes to the Request Syntax' anchor='script-request'>
|
|
<p>Clients MUST make the following changes to convert their requests to Script Syntax:</p>
|
|
<ol>
|
|
<li><p>Certain octets within the UTF-8 encoded <body/> element SHOULD be replaced according to the rules for escaping octets within URIs defined by &rfc3986;. Therefore all octets except those representing 7-bit alphanumeric characters or the characters -._~!$&'()*+,;=:@/? should be substituted with a character triplet, consisting of the percent character "%" followed by the two hexadecimal digits that represent the value of the octet.</p></li>
|
|
<li><p>A '?' character and the URI-encoded <body/> element MUST be appended to the URI at which the connection manager is operating within its server.</p></li>
|
|
<li><p>The resulting URI MUST be sent to the connection manager within an HTTP GET request.</p></li>
|
|
<li><p>Include extra HTTP headers to prevent request/response caching or storage by any intermediary.</p></li>
|
|
</ol>
|
|
<p>Note: All whitespace between "GET " and " HTTP/1.1" in the HTTP GET header lines in the following two examples is included only to improve readability. In practice there MUST be no whitespace.</p>
|
|
<example caption="Requesting a BOSH session in Script Syntax"><![CDATA[
|
|
GET /webclient?%3Cbody%20content='text/xml;%20charset=utf-8'%20
|
|
hold='1'%20rid='1573741820'%20to='jabber.org'%20
|
|
route='xmpp:jabber.org:9999'%20secure='true'%20ver='1.6'%20
|
|
wait='60'%20xml:lang='en'%20
|
|
xmlns='http://jabber.org/protocol/httpbind'/%3E
|
|
HTTP/1.1
|
|
Host: httpcm.jabber.org
|
|
Accept-Encoding: gzip, deflate
|
|
Cache-Control: no-store
|
|
Cache-Control: no-cache
|
|
Pragma: no-cache
|
|
Content-Length: 0]]></example>
|
|
<example caption="Transmitting stanzas in Script Syntax"><![CDATA[
|
|
GET /webclient?%3Cbody%20rid='1249243562'%20sid='SomeSID'%20
|
|
xmlns='http://jabber.org/protocol/httpbind'%3E%3C
|
|
message%20to='friend@example.com'%20xmlns='jabber:client'%3E%3C
|
|
body%3EI%20said%20%22Hi!%22%3C/body%3E%3C/message%3E%3C/body%3E
|
|
HTTP/1.1
|
|
Host: httpcm.jabber.org
|
|
Accept-Encoding: gzip, deflate
|
|
Cache-Control: no-store
|
|
Cache-Control: no-cache
|
|
Pragma: no-cache
|
|
Content-Length: 0]]></example>
|
|
<p>Although <cite>RFC 2616</cite> does not limit the length of HTTP URIs, the runtime environment of the client might restrict the length of the URI that it can include in each GET request. <note>Internet Explorer versions 4.0 thru 7.0 have a maximum <em>path</em> length of 2048 characters and a maximum URL length of 2083 characters. Other popular browsers appear to have no limit.</note> In these cases the client MUST reduce the content of the <body/> element accordingly and send the remaining content in subsequent HTTP GET requests wrapped in new <body/> elements (with incremented 'rid' attributes). This is possible since, unlike Pure Syntax, with Script Syntax the connection manager MUST treat the string of characters between the opening and closing <body> tags of each request as part of an octet stream instead of as a set of complete XML stanzas. The content of any one <body/> element MUST NOT be parsed in isolation from the rest of the stream.</p>
|
|
</section2>
|
|
<section2 topic='Changes to the Response Syntax' anchor='script-response'>
|
|
<p>Connection managers MUST make the following changes to convert their responses to Script Syntax:</p>
|
|
<ol>
|
|
<li><p>Certain characters within the <body/> element MUST be replaced according to the rules for escaping characters within strings defined by <cite>ECMAScript</cite>. The necessary substitutions are summarised in the table below.</p>
|
|
<table caption='Character Substitutions'>
|
|
<tr><th>Character</th><th>Unicode Code Point Value</th><th>Escape sequence</th></tr>
|
|
<tr><td>"</td><td>U+0022</td><td>\"</td></tr>
|
|
<tr><td>Line Feed (New Line)</td><td>U+000A</td><td>\n</td></tr>
|
|
<tr><td>Carriage Return</td><td>U+000D</td><td>\r</td></tr>
|
|
<tr><td>Line Separator</td><td>U+2028</td><td>\u2028</td></tr>
|
|
<tr><td>Paragraph Separator</td><td>U+2029</td><td>\u2029</td></tr>
|
|
<tr><td>\</td><td>U+005C</td><td>\\</td></tr>
|
|
</table>
|
|
<p>Each Unicode format-control character (i.e., the characters in category "Cf" in the Unicode Character Database, e.g., LEFT-TO-RIGHT MARK or RIGHT-TO-LEFT MARK) MUST also be substituted by its Unicode escape sequence (e.g. \u200e or \u200f).</p></li>
|
|
<li><p>The following eight characters MUST be prepended to the <body/> element: <code>_BOSH_("</code></p></li>
|
|
<li><p>The following two characters MUST be appended to the <body/> element: <code>")</code></p></li>
|
|
<li><p>If the client request does not possess a 'content' attribute, then the HTTP Content-Type header of responses MUST be either "text/javascript; charset=utf-8" or "application/x-javascript; charset=utf-8".</p></li>
|
|
<li><p>Include extra HTTP headers to prevent caching or storage by any intermediary.</p></li>
|
|
</ol>
|
|
<p>Note: All line breaks in the bodies of the HTTP responses in the following two examples are included only to improve readability. In practice there MUST be no line breaks.</p>
|
|
<example caption="Session creation response in Script Syntax">
|
|
<![CDATA[HTTP/1.1 200 OK
|
|
Content-Type: text/javascript; charset=utf-8
|
|
Cache-Control: no-store
|
|
Cache-Control: no-cache
|
|
Pragma: no-cache
|
|
Content-Length: 233
|
|
|
|
_BOSH_("<body wait='60' inactivity='30' polling='5' requests='2' hold='1'
|
|
ack='1573741820' accept='deflate,gzip' maxpause='120' sid='SomeSID'
|
|
charsets='ISO_8859-1 ISO-2022-JP' ver='1.6' from='jabber.org'
|
|
secure='true' xmlns='http://jabber.org/protocol/httpbind'/>")
|
|
]]></example>
|
|
<example caption="Receiving stanzas in Script Syntax">
|
|
<![CDATA[HTTP/1.1 200 OK
|
|
Content-Type: text/javascript; charset=utf-8
|
|
Cache-Control: no-store
|
|
Cache-Control: no-cache
|
|
Pragma: no-cache
|
|
Content-Length: 212
|
|
|
|
_BOSH_("<body rid='1249243562' sid='SomeSID'
|
|
xmlns='http://jabber.org/protocol/httpbind'>\n
|
|
<message to='contact@example.com' xmlns='jabber:client'>\n
|
|
<body>I said \"Hi!\"</body>\n</message>\n</body>")
|
|
]]></example>
|
|
<p>Note: As with Pure Syntax, each <body/> element sent to the client MUST encapsulate zero or more complete XML stanzas.</p>
|
|
</section2>
|
|
</section1>
|
|
<section1 topic='Security Considerations' anchor='security'>
|
|
<section2 topic='Encryption' anchor='security-crypt'>
|
|
<p>All communications SHOULD occur over encrypted HTTP connections. Negotiation of encryption between the client and the connection manager SHOULD occur at the transport layer or the HTTP layer, not the application layer; such negotiation SHOULD follow the HTTP/SSL protocol defined in &ssl;, it MAY follow the HTTP/TLS protocol defined in &rfc2818; or the TLS Within HTTP protocol defined in &rfc2817;.</p>
|
|
<p>If the HTTP connection used to send the initial session request is encrypted, then all the other HTTP connections used within the session MUST also be encrypted. Furthermore, if authentication certificates are exchanged when establishing the encrypted connection that is used to send the initial session request, then the client and/or connection manager SHOULD ensure that the same authentication certificates are employed for all subsequent connections used by the session. Once such a 'secure session' has been established:</p>
|
|
<ul>
|
|
<li>If the connection manager refuses to establish an encrypted connection or offers a different certificate, then the client SHOULD close the connection and terminate the session without sending any more requests.</li>
|
|
<li>If the client sends a wrapper element that is part of a 'secure session' over a connection that either is not encrypted or uses a different certificate then the connection manager SHOULD simply close the connection. The connection manager SHOULD NOT terminate the session since that would facilitate denial of service attacks.</li>
|
|
</ul>
|
|
<p>In cases where the connection manager acts as a 'translating proxy' independent of the server, it creates another security vulnerability in addition to those on the servers. It is RECOMMENDED that clients ensure the security of stanzas sent through the connection manager (and servers) in both directions by encrypting them end-to-end (e.g., by establishing &xep0116;).</p>
|
|
</section2>
|
|
<section2 topic='Unpredictable SID and RID' anchor='security-sidrid'>
|
|
<p>The session identifier (SID) and initial request identifier (RID) are security-critical and therefore MUST be both unpredictable and nonrepeating (see &rfc1750; for recommendations regarding randomness of SIDs and initial RIDs for security purposes).</p>
|
|
</section2>
|
|
<section2 topic='Script Syntax' anchor='security-script'>
|
|
<p>To avoid the storage of private communications by third parties, when using the alternative <link url="#script">Script Syntax</link> connection managers MUST (and clients SHOULD) include all the appropriate HTTP/1.0 and/or HTTP/1.1 headers necessary to ensure as far as possible that no request or response will ever be cached or stored by any intermediary.</p>
|
|
<p>The alternative Script Syntax returns code for the client to execute. This code is typically executed immediately without any validation and with the same rights as the code of the client itself. This vulnerability could be exploited to steal passwords and private keys, or to fabricate messages sent from and received by the client, or to forward or modify priviledged information on the servers to which the client has access, or to interfere with any aspect of the client's functionality - limited only by the extent of the runtime environment ("sandbox"), by the extent that naive users may be tricked into doing things outside that environment, and by the attacker's fertile imagination. Therefore, although the client could use Script Syntax with any connection manager on the network, in practice it MUST take care to employ it only with connection managers that the client's user trusts (as much as the server from which the client was downloaded). To prevent a-man-in-the-middle from manipulating the code clients SHOULD only use Script Syntax over encrypted connections (see above). If the client was downloaded over an encrypted connection then it MUST NOT use Script Syntax over connections that are not encrypted.</p>
|
|
</section2>
|
|
</section1>
|
|
<section1 topic='IANA Considerations' anchor='iana'>
|
|
<p>This document requires no interaction with &IANA;.</p>
|
|
</section1>
|
|
<section1 topic='XMPP Registrar Considerations' anchor='registrar'>
|
|
<section2 topic='Protocol Namespaces' anchor='registrar-ns'>
|
|
<p>The ®ISTRAR; includes 'http://jabber.org/protocol/httpbind' in its registry of protocol namespaces.</p>
|
|
</section2>
|
|
</section1>
|
|
<section1 topic='XML Schema' anchor='schema'>
|
|
<code><![CDATA[
|
|
<?xml version='1.0' encoding='UTF-8'?>
|
|
|
|
<xs:schema
|
|
xmlns:xs='http://www.w3.org/2001/XMLSchema'
|
|
xmlns:stream='http://etherx.jabber.org/streams'
|
|
targetNamespace='http://jabber.org/protocol/httpbind'
|
|
xmlns='http://jabber.org/protocol/httpbind'
|
|
elementFormDefault='qualified'>
|
|
|
|
<xs:annotation>
|
|
<xs:documentation>
|
|
The protocol documented by this schema is defined in
|
|
XEP-0124: http://www.xmpp.org/extensions/xep-0124.html
|
|
</xs:documentation>
|
|
</xs:annotation>
|
|
|
|
<xs:element name='body'>
|
|
<xs:complexType>
|
|
<xs:choice>
|
|
<xs:any namespace='##any'
|
|
minOccurs='0'
|
|
maxOccurs='unbounded'
|
|
processContents='lax'/>
|
|
</xs:choice>
|
|
<xs:attribute name='accept' type='xs:string' use='optional'/>
|
|
<xs:attribute name='ack' type='xs:positiveInteger' use='optional'/>
|
|
<xs:attribute name='authid' type='xs:string' use='optional'/>
|
|
<xs:attribute name='charsets' type='xs:NMTOKENS' use='optional'/>
|
|
<xs:attribute name='condition' use='optional'>
|
|
<xs:simpleType>
|
|
<xs:restriction base='xs:NCName'>
|
|
<xs:enumeration value='host-gone'/>
|
|
<xs:enumeration value='host-unknown'/>
|
|
<xs:enumeration value='improper-addressing'/>
|
|
<xs:enumeration value='internal-server-error'/>
|
|
<xs:enumeration value='remote-connection-failed'/>
|
|
<xs:enumeration value='remote-stream-error'/>
|
|
<xs:enumeration value='see-other-uri'/>
|
|
<xs:enumeration value='system-shutdown'/>
|
|
<xs:enumeration value='undefined-condition'/>
|
|
</xs:restriction>
|
|
</xs:simpleType>
|
|
</xs:attribute>
|
|
<xs:attribute name='content' type='xs:string' use='optional'/>
|
|
<xs:attribute name='from' type='xs:string' use='optional'/>
|
|
<xs:attribute name='hold' type='xs:byte' use='optional'/>
|
|
<xs:attribute name='inactivity' type='xs:short' use='optional'/>
|
|
<xs:attribute name='key' type='xs:string' use='optional'/>
|
|
<xs:attribute name='maxpause' type='xs:short' use='optional'/>
|
|
<xs:attribute name='newkey' type='xs:string' use='optional'/>
|
|
<xs:attribute name='pause' type='xs:short' use='optional'/>
|
|
<xs:attribute name='polling' type='xs:short' use='optional'/>
|
|
<xs:attribute name='report' type='xs:positiveInteger' use='optional'/>
|
|
<xs:attribute name='requests' type='xs:byte' use='optional'/>
|
|
<xs:attribute name='rid' type='xs:positiveInteger' use='optional'/>
|
|
<xs:attribute name='route' type='xs:string' use='optional'/>
|
|
<xs:attribute name='secure' type='xs:boolean' use='optional' default='false'/>
|
|
<xs:attribute name='sid' type='xs:string' use='optional'/>
|
|
<xs:attribute name='stream' type='xs:string' use='optional'/>
|
|
<xs:attribute name='time' type='xs:short' use='optional'/>
|
|
<xs:attribute name='to' type='xs:string' use='optional'/>
|
|
<xs:attribute name='type' type='xs:string' use='optional'>
|
|
<xs:simpleType>
|
|
<xs:restriction base='xs:NCName'>
|
|
<xs:enumeration value='error'/>
|
|
<xs:enumeration value='terminate'/>
|
|
</xs:restriction>
|
|
</xs:simpleType>
|
|
</xs:attribute>
|
|
<xs:attribute name='ver' type='xs:string' use='optional'/>
|
|
<xs:attribute name='wait' type='xs:short' use='optional'/>
|
|
<xs:attribute name='xml:lang' type='xs:string' use='optional'/>
|
|
<xs:anyAttribute namespace='##any' processContents='lax'/>
|
|
</xs:complexType>
|
|
</xs:element>
|
|
|
|
</xs:schema>
|
|
]]></code>
|
|
</section1>
|
|
</xep>
|