Debian Codegraph @

rfc5839.html

raw
1 <pre>Internet Engineering Task Force (IETF) A. Niemi
2 Request for Comments: 5839 Nokia
3 Category: Standards Track D. Willis, Ed.
4 ISSN: 2070-1721 Softarmor Systems
5 May 2010
6
7
8 <span class="h1">An Extension to Session Initiation Protocol (SIP) Events</span>
9 <span class="h1">for Conditional Event Notification</span>
10
11 Abstract
12
13 The Session Initiation Protocol (SIP) events framework enables
14 receiving asynchronous notification of various events from other SIP
15 user agents. This framework defines the procedures for creating,
16 refreshing, and terminating subscriptions, as well as fetching and
17 periodic polling of resource state. These procedures provide no
18 tools to avoid replaying event notifications that have already been
19 received by a user agent. This memo defines an extension to SIP
20 events that allows the subscriber to condition the subscription
21 request to whether the state has changed since the previous
22 notification was received. When such a condition is true, either the
23 body of a resulting event notification or the entire notification
24 message is suppressed.
25
26 Status of This Memo
27
28 This is an Internet Standards Track document.
29
30 This document is a product of the Internet Engineering Task Force
31 (IETF). It represents the consensus of the IETF community. It has
32 received public review and has been approved for publication by the
33 Internet Engineering Steering Group (IESG). Further information on
34 Internet Standards is available in <a href="./rfc5741#section-2">Section&nbsp;2 of RFC 5741</a>.
35
36 Information about the current status of this document, any errata,
37 and how to provide feedback on it may be obtained at
38 <a href="http://www.rfc-editor.org/info/rfc5839">http://www.rfc-editor.org/info/rfc5839</a>.
39
40
41
42
43
44
45
46
47
48
49
50
51
52 <span class="grey">Niemi &amp; Willis Standards Track [Page 1]</span></pre>
53 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span>
54 <span class="grey"><a href="./rfc5839">RFC 5839</a> Entity-Tags for SIP Events May 2010</span>
55
56
57 Copyright Notice
58
59 Copyright (c) 2010 IETF Trust and the persons identified as the
60 document authors. All rights reserved.
61
62 This document is subject to <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> and the IETF Trust's Legal
63 Provisions Relating to IETF Documents
64 (<a href="http://trustee.ietf.org/license-info">http://trustee.ietf.org/license-info</a>) in effect on the date of
65 publication of this document. Please review these documents
66 carefully, as they describe your rights and restrictions with respect
67 to this document. Code Components extracted from this document must
68 include Simplified BSD License text as described in Section 4.e of
69 the Trust Legal Provisions and are provided without warranty as
70 described in the Simplified BSD License.
71
72 This document may contain material from IETF Documents or IETF
73 Contributions published or made publicly available before November
74 10, 2008. The person(s) controlling the copyright in some of this
75 material may not have granted the IETF Trust the right to allow
76 modifications of such material outside the IETF Standards Process.
77 Without obtaining an adequate license from the person(s) controlling
78 the copyright in such materials, this document may not be modified
79 outside the IETF Standards Process, and derivative works of it may
80 not be created outside the IETF Standards Process, except to format
81 it for publication as an RFC or to translate it into languages other
82 than English.
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108 <span class="grey">Niemi &amp; Willis Standards Track [Page 2]</span></pre>
109 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span>
110 <span class="grey"><a href="./rfc5839">RFC 5839</a> Entity-Tags for SIP Events May 2010</span>
111
112
113 Table of Contents
114
115 <a href="#section-1">1</a>. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-4">4</a>
116 <a href="#section-1.1">1.1</a>. Document Conventions . . . . . . . . . . . . . . . . . . . <a href="#page-5">5</a>
117 <a href="#section-1.2">1.2</a>. Terminology . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-5">5</a>
118 <a href="#section-2">2</a>. Motivations and Background . . . . . . . . . . . . . . . . . . <a href="#page-5">5</a>
119 <a href="#section-2.1">2.1</a>. Overview . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-5">5</a>
120 <a href="#section-2.2">2.2</a>. Problem Description . . . . . . . . . . . . . . . . . . . <a href="#page-5">5</a>
121 <a href="#section-2.3">2.3</a>. Requirements . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-6">6</a>
122 <a href="#section-3">3</a>. Overview of Operation . . . . . . . . . . . . . . . . . . . . <a href="#page-7">7</a>
123 <a href="#section-4">4</a>. Resource Model for Entity-Tags . . . . . . . . . . . . . . . . <a href="#page-10">10</a>
124 <a href="#section-5">5</a>. Subscriber Behavior . . . . . . . . . . . . . . . . . . . . . <a href="#page-12">12</a>
125 <a href="#section-5.1">5.1</a>. Detecting Support for Conditional Notification . . . . . . <a href="#page-13">13</a>
126 <a href="#section-5.2">5.2</a>. Generating SUBSCRIBE Requests . . . . . . . . . . . . . . <a href="#page-13">13</a>
127 <a href="#section-5.3">5.3</a>. Receiving NOTIFY Requests . . . . . . . . . . . . . . . . <a href="#page-14">14</a>
128 <a href="#section-5.4">5.4</a>. Polling or Fetching Resource State . . . . . . . . . . . . <a href="#page-15">15</a>
129 <a href="#section-5.5">5.5</a>. Resuming a Subscription . . . . . . . . . . . . . . . . . <a href="#page-17">17</a>
130 <a href="#section-5.6">5.6</a>. Refreshing a Subscription . . . . . . . . . . . . . . . . <a href="#page-18">18</a>
131 <a href="#section-5.7">5.7</a>. Terminating a Subscription . . . . . . . . . . . . . . . . <a href="#page-18">18</a>
132 <a href="#section-5.8">5.8</a>. Handling Transient Errors . . . . . . . . . . . . . . . . <a href="#page-19">19</a>
133 <a href="#section-6">6</a>. Notifier Behavior . . . . . . . . . . . . . . . . . . . . . . <a href="#page-20">20</a>
134 <a href="#section-6.1">6.1</a>. Generating Entity-tags . . . . . . . . . . . . . . . . . . <a href="#page-20">20</a>
135 <a href="#section-6.2">6.2</a>. Suppressing NOTIFY Bodies . . . . . . . . . . . . . . . . <a href="#page-20">20</a>
136 <a href="#section-6.3">6.3</a>. Suppressing NOTIFY Requests . . . . . . . . . . . . . . . <a href="#page-21">21</a>
137 <a href="#section-6.4">6.4</a>. State Differentials . . . . . . . . . . . . . . . . . . . <a href="#page-21">21</a>
138 <a href="#section-6.5">6.5</a>. List Subscriptions . . . . . . . . . . . . . . . . . . . . <a href="#page-22">22</a>
139 <a href="#section-7">7</a>. Protocol Element Definitions . . . . . . . . . . . . . . . . . <a href="#page-22">22</a>
140 <a href="#section-7.1">7.1</a>. 204 (No Notification) Response Code . . . . . . . . . . . <a href="#page-22">22</a>
141 <a href="#section-7.2">7.2</a>. Suppress-If-Match Header Field . . . . . . . . . . . . . . <a href="#page-22">22</a>
142 <a href="#section-7.3">7.3</a>. Grammar . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-22">22</a>
143 <a href="#section-8">8</a>. IANA Considerations . . . . . . . . . . . . . . . . . . . . . <a href="#page-23">23</a>
144 <a href="#section-8.1">8.1</a>. 204 (No Notification) Response Code . . . . . . . . . . . <a href="#page-23">23</a>
145 <a href="#section-8.2">8.2</a>. Suppress-If-Match Header Field . . . . . . . . . . . . . . <a href="#page-23">23</a>
146 <a href="#section-9">9</a>. Security Considerations . . . . . . . . . . . . . . . . . . . <a href="#page-24">24</a>
147 <a href="#section-10">10</a>. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-24">24</a>
148 <a href="#section-11">11</a>. References . . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-24">24</a>
149 <a href="#section-11.1">11.1</a>. Normative References . . . . . . . . . . . . . . . . . . . <a href="#page-24">24</a>
150 <a href="#section-11.2">11.2</a>. Informative References . . . . . . . . . . . . . . . . . . <a href="#page-24">24</a>
151
152
153
154
155
156
157
158
159
160
161
162
163
164 <span class="grey">Niemi &amp; Willis Standards Track [Page 3]</span></pre>
165 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span>
166 <span class="grey"><a href="./rfc5839">RFC 5839</a> Entity-Tags for SIP Events May 2010</span>
167
168
169 <span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span>
170
171 The Session Initiation Protocol (SIP) events framework provides an
172 extensible facility for requesting notification of certain events
173 from other SIP user agents. This framework includes procedures for
174 creating, refreshing, and terminating subscriptions, as well as the
175 possibility to fetch or periodically poll the event resource.
176
177 Several instantiations of this framework, called event packages have
178 been defined, e.g., for presence [<a href="./rfc3856" title="&quot;A Presence Event Package for the Session Initiation Protocol (SIP)&quot;">RFC3856</a>], message waiting
179 indications [<a href="./rfc3842" title="&quot;A Message Summary and Message Waiting Indication Event Package for the Session Initiation Protocol (SIP)&quot;">RFC3842</a>], and registrations [<a href="./rfc3680" title="&quot;A Session Initiation Protocol (SIP) Event Package for Registrations&quot;">RFC3680</a>].
180
181 By default, every SUBSCRIBE request generates a NOTIFY request
182 containing the latest event state. Typically, a SUBSCRIBE request is
183 issued by the subscriber whenever it needs a subscription to be
184 installed, periodically refreshed, or terminated. Once the
185 subscription has been installed, the majority of the NOTIFYs
186 generated by the subscription refreshes are superfluous; the
187 subscriber usually is in possession of the event state already,
188 except in the unlikely case where a state change exactly coincides
189 with the periodic subscription refresh. In most cases, the final
190 event state generated upon terminating the subscription similarly
191 contains resource state that the subscriber already has.
192
193 Fetching or polling of resource state behaves in a similarly
194 suboptimal way in cases where the state has not changed since the
195 previous poll occurred. In general, the problem lies with the
196 inability to persist state across a SUBSCRIBE request.
197
198 This memo defines an extension to optimize the SIP events framework.
199 This extension allows a notifier to tag notifications (called entity-
200 tags hereafter) and the subscriber to condition its subsequent
201 SUBSCRIBE requests for actual changes since a notification carrying
202 that entity-tag was issued. The solution is similar to conditional
203 requests defined in the Hypertext Transfer Protocol (HTTP) [<a href="./rfc2616" title="&quot;Hypertext Transfer Protocol -- HTTP/1.1&quot;">RFC2616</a>],
204 and follows the mechanism already defined for the PUBLISH [<a href="./rfc3903" title="&quot;Session Initiation Protocol (SIP) Extension for Event State Publication&quot;">RFC3903</a>]
205 method for issuing conditional event publications.
206
207 This memo is structured as follows. <a href="#section-2">Section 2</a> explains the
208 background, motivations, and requirements for the work; <a href="#section-3">Section 3</a>
209 gives a general overview of the mechanism; <a href="#section-4">Section 4</a> explains the
210 underlying model for resources and entities as they apply to
211 conditional notification; <a href="#section-5">Section 5</a> defines the subscriber behavior;
212 <a href="#section-6">Section 6</a> defines the notifier behavior; <a href="#section-7">Section 7</a> includes the
213 protocol element definitions; <a href="#section-8">Section 8</a> includes the IANA
214 considerations; and <a href="#section-9">Section 9</a> includes the security considerations.
215
216
217
218
219
220 <span class="grey">Niemi &amp; Willis Standards Track [Page 4]</span></pre>
221 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span>
222 <span class="grey"><a href="./rfc5839">RFC 5839</a> Entity-Tags for SIP Events May 2010</span>
223
224
225 <span class="h3"><a class="selflink" id="section-1.1" href="#section-1.1">1.1</a>. Document Conventions</span>
226
227 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
228 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
229 document are to be interpreted as described in <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc2119">RFC 2119</a>
230 [<a href="./rfc2119" title="&quot;Key words for use in RFCs to Indicate Requirement Levels&quot;">RFC2119</a>] and indicate requirement levels for compliant
231 implementations.
232
233 <span class="h3"><a class="selflink" id="section-1.2" href="#section-1.2">1.2</a>. Terminology</span>
234
235 In addition to the terminology introduced in [<a href="./rfc3261" title="&quot;SIP: Session Initiation Protocol&quot;">RFC3261</a>], [<a href="./rfc3265" title="&quot;Session Initiation Protocol (SIP)-Specific Event Notification&quot;">RFC3265</a>],
236 and [<a href="./rfc3903" title="&quot;Session Initiation Protocol (SIP) Extension for Event State Publication&quot;">RFC3903</a>], this specification uses these additional terms to
237 describe the objects of conditional notification:
238
239 resource
240 An object identified by a URI whose resource state can be accessed
241 using the SIP Event Notification framework. There is a single
242 authoritative notifier responsible for communicating the resource
243 state.
244
245 entity
246 The representation of resource state. An entity consists of the
247 state data carried in the body of a NOTIFY message, as well as
248 related meta-data in the message header. There may be many
249 versions of an entity, one current and the others stale. Each
250 version of an entity is identified by an entity-tag, which is
251 guaranteed to be unique across all versions of all entities for a
252 resource and event package.
253
254 <span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. Motivations and Background</span>
255
256 <span class="h3"><a class="selflink" id="section-2.1" href="#section-2.1">2.1</a>. Overview</span>
257
258 A SUBSCRIBE request creates a subscription with a finite lifetime.
259 This lifetime is negotiated using the Expires header field, and
260 unless the subscription is refreshed by the subscriber before the
261 expiration is met, the subscription is terminated. The frequency of
262 these subscription refreshes depends on the event package, and
263 typically ranges from minutes to hours.
264
265 <span class="h3"><a class="selflink" id="section-2.2" href="#section-2.2">2.2</a>. Problem Description</span>
266
267 The SIP events framework does not include different protocol methods
268 for initiating and terminating of subscriptions, subscription
269 refreshes, and fetches inside and outside of the SIP dialog. The
270 SUBSCRIBE method is overloaded to perform all of these functions.
271 The difference between a fetch that does not create a (lasting)
272 subscription and a SUBSCRIBE that creates one is in the Expires
273
274
275
276 <span class="grey">Niemi &amp; Willis Standards Track [Page 5]</span></pre>
277 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span>
278 <span class="grey"><a href="./rfc5839">RFC 5839</a> Entity-Tags for SIP Events May 2010</span>
279
280
281 header field value of the SUBSCRIBE; a zero-expiry SUBSCRIBE only
282 generates a single NOTIFY, after which the subscription immediately
283 terminates. Lasting subscriptions typically have relatively short
284 expiry periods, requiring periodic sending of new SUBSCRIBE requests
285 in order to refresh the subscription.
286
287 Each new SUBSCRIBE request generates a NOTIFY request containing the
288 latest resource state. Even if the state has not changed, it is sent
289 again in response to each poll or subscription refresh. This is very
290 similar to the HTTP [<a href="./rfc2616" title="&quot;Hypertext Transfer Protocol -- HTTP/1.1&quot;">RFC2616</a>] problem of repeated GET operations on a
291 resource. HTTP solves the problem using conditional requests. The
292 server versions each entity with an entity-tag that identifies a
293 specific instance of that entity. Clients making GET requests can
294 then include the entity-tag for the version of the entity that they
295 believe to be current in an "If-None-Match" header field. The server
296 can compare this entity-tag to the entity it believes to be current
297 and suppress resending the entity in the response if the server
298 believes the client's version matches. In other words, the server
299 doesn't resend information that the client has already received.
300
301 The SIP PUBLISH [<a href="./rfc3903" title="&quot;Session Initiation Protocol (SIP) Extension for Event State Publication&quot;">RFC3903</a>] method uses a similar mechanism, where a
302 refresh of a publication is done by reference to its assigned entity-
303 tag, instead of retransmitting the event state each time the
304 publication expiration is extended.
305
306 <span class="h3"><a class="selflink" id="section-2.3" href="#section-2.3">2.3</a>. Requirements</span>
307
308 As a summary, here is the required functionality to solve the
309 presented issues:
310
311 REQ1: It must be possible to suppress the NOTIFY request (or at a
312 minimum, the event body therein) if the subscriber is already
313 in possession of (or has previously received and discarded)
314 the latest event state of the resource.
315
316 REQ2: This mechanism must apply to initial subscriptions in which
317 the subscriber is attempting to resume an earlier
318 subscription that has been paused.
319
320 REQ3: This mechanism must apply to refreshing a subscription.
321
322 REQ4: This mechanism must apply to terminating a subscription
323 (i.e., an unsubscribe).
324
325 REQ5: This mechanism must apply to fetching or polling of resource
326 state.
327
328
329
330
331
332 <span class="grey">Niemi &amp; Willis Standards Track [Page 6]</span></pre>
333 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span>
334 <span class="grey"><a href="./rfc5839">RFC 5839</a> Entity-Tags for SIP Events May 2010</span>
335
336
337 <span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. Overview of Operation</span>
338
339 Whenever a subscriber initiates a subscription, it issues a SUBSCRIBE
340 request. The SUBSCRIBE request is sent, routed, and processed by the
341 notifier normally, i.e., according to the Session Initiation Protocol
342 [<a href="./rfc3261" title="&quot;SIP: Session Initiation Protocol&quot;">RFC3261</a>] and SIP-Specific Event Notification [<a href="./rfc3265" title="&quot;Session Initiation Protocol (SIP)-Specific Event Notification&quot;">RFC3265</a>].
343
344 If the notifier receiving the SUBSCRIBE request supports conditional
345 subscriptions, it generates an entity-tag for the current entity, and
346 includes it in a SIP-ETag header field of the NOTIFY request. The
347 entity-tag is unique across all versions of all entities for a
348 resource and event package. See <a href="#section-4">Section 4</a> for more on this.
349
350 Entity-tags are independent of subscriptions. This allows
351 notifications generated to a fetch or a poll to have valid entity-
352 tags even across subsequent fetches or polls.
353
354 The subscriber will store the entity-tag received in the notification
355 along with the resource state. It can then later use this entity-tag
356 to make a SUBSCRIBE contain a condition in the form of a "Suppress-
357 If-Match" header field. Unlike the "If-Match" condition in a PUBLISH
358 [<a href="./rfc3903" title="&quot;Session Initiation Protocol (SIP) Extension for Event State Publication&quot;">RFC3903</a>] request, which applies to whether the PUBLISH succeeds or
359 returns an error, this condition applies to the stream of
360 notifications that are sent after the SUBSCRIBE request has been
361 processed.
362
363 The Suppress-If-Match header field contains the last entity-tag seen
364 by the subscriber. This condition, if true, instructs the notifier
365 to suppress either the body of a subsequent notification, or the
366 entire notification.
367
368 The condition is evaluated by matching the value of the header field
369 against the entity-tag of the entity that would normally be sent in
370 the associated NOTIFY message. There is also a wildcard entity-tag
371 with a special value of "*" that always matches.
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388 <span class="grey">Niemi &amp; Willis Standards Track [Page 7]</span></pre>
389 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span>
390 <span class="grey"><a href="./rfc5839">RFC 5839</a> Entity-Tags for SIP Events May 2010</span>
391
392
393 Subscriber Notifier
394 ---------- --------
395
396 (1) SUBSCRIBE --------&gt;
397 Expires: 3600
398 &lt;-------- (2) 200 (or 202)
399
400 &lt;-------- (3) NOTIFY
401 Subscription-State: active
402 SIP-ETag: ffee2
403 (4) 200 --------&gt;
404
405 ... time passes ...
406
407 (5) SUBSCRIBE --------&gt; \ if "ffee2"
408 Suppress-If-Match: ffee2 | matches
409 Expires: 3600 | local
410 | entity-tag
411 |
412 &lt;-------- (6) 204 / then
413
414 ... time passes and resource state (entity) changes...
415
416
417 &lt;-------- (7) NOTIFY
418 Subscription-State: active
419 SIP-ETag: ca89a
420 (8) 200 --------&gt;
421
422
423 ... time passes ...
424
425
426 (9) SUBSCRIBE --------&gt; \ if "ca89"
427 Suppress-If-Match: ca89a | matches
428 Expires: 0 | local
429 | entity-tag
430 |
431 &lt;-------- (10) 204 / then
432
433 Figure 1: Example Message Flow
434
435 Figure 1 describes a typical message flow for conditional
436 notification:
437
438 (1) The subscriber initiates a subscription by sending a SUBSCRIBE
439 request for a resource.
440
441
442
443
444 <span class="grey">Niemi &amp; Willis Standards Track [Page 8]</span></pre>
445 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span>
446 <span class="grey"><a href="./rfc5839">RFC 5839</a> Entity-Tags for SIP Events May 2010</span>
447
448
449 (2) After proper authentication and authorization, the notifier
450 accepts the subscription.
451
452 (3) The notifier then immediately sends the initial event
453 notification, including a unique entity-tag in a SIP-ETag
454 header field.
455
456 (4) The subscriber accepts the notification and stores the entity-
457 tag value along with the resource state.
458
459 (5) Later, the subscriber refreshes the subscription, and includes
460 an entity-tag in a Suppress-If-Match header field.
461
462 (6) The notifier evaluates the condition by matching its local
463 entity-tag value for the resource against the value of the
464 Suppress-If-Match header field. If the condition evaluates to
465 true, the notifier informs the subscriber that the notification
466 will not be sent.
467
468 (7) At some point, the state of the resource changes, e.g., the
469 presence status of a user changes from online to busy. This
470 triggers an event notification with a new value in the SIP-ETag
471 header field.
472
473 (8) The subscriber accepts the notification and stores the new
474 entity-tag along with the resource state.
475
476 (9) After a while, the subscriber decides to terminate the
477 subscription. It adds a condition for Suppress-If-Match, and
478 includes the entity-tag it received in the previous NOTIFY.
479
480 (10) The notifier evaluates the condition by matching its entity-tag
481 for the resource against the value of the Suppress-If-Match
482 header field. If the condition evaluates to true, the notifier
483 informs the subscriber that no notification will be sent. This
484 concludes the subscription.
485
486 The benefit of using conditional notification in this example is in
487 the reduction of the number of NOTIFY requests the subscriber can
488 expect to receive. Each event notification that the subscriber has
489 already seen is suppressed by the notifier. This example illustrates
490 only one use case for the mechanism; the same principles can be used
491 to optimize the flow of messages related to other event notification
492 use cases.
493
494
495
496
497
498
499
500 <span class="grey">Niemi &amp; Willis Standards Track [Page 9]</span></pre>
501 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span>
502 <span class="grey"><a href="./rfc5839">RFC 5839</a> Entity-Tags for SIP Events May 2010</span>
503
504
505 <span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. Resource Model for Entity-Tags</span>
506
507 The key to understanding how conditional notification works is
508 understanding the underlying resource model of event notification.
509 In general, this model is similar to the resource model of HTTP with
510 some key differences. This section explains in detail the model as
511 it applies to SIP events. Figure 2 illustrates the model.
512
513 +-----+
514 ............ | |
515 . . | URI |
516 . Represen . | |
517 . tation . +-----+
518 . . |*
519 ............ |
520 . |
521 . V
522 . +----------+ +---------+
523 composition | |* | Event |
524 +------&lt;&gt;| Resource |-----------&gt;| Package |&lt;----.
525 | | | | | |
526 | +----------+ +----.----+ |
527 | /_\ |
528 |* | classification
529 +--------+ | |
530 | | .----------------.------' |
531 | Entity | | | |
532 | | | | |*
533 +--------+ +----------+ +------------+ +----------+
534 ^ | | | | | |
535 | | Presence | | Conference | | Template |
536 | | | | | | |
537 |1..* +----------+ +------------+ +----.-----+
538 +---------+ /_\
539 | | |
540 | Version | |
541 | | +---------+
542 +---------+ | Watcher |
543 |1 | Info |
544 | | |
545 V +---------+
546 +---------+
547 | Entity- |
548 | Tag |
549 | |
550 +---------+
551
552 Figure 2: Resource Model Diagram
553
554
555
556 <span class="grey">Niemi &amp; Willis Standards Track [Page 10]</span></pre>
557 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span>
558 <span class="grey"><a href="./rfc5839">RFC 5839</a> Entity-Tags for SIP Events May 2010</span>
559
560
561 For a given event package, there is a single authoritative agent
562 responsible for zero or more resources. That is, even for a
563 distributed agent, the resource state is uniform across all
564 instances. The resource itself can be a list of resources [<a href="./rfc4662" title="&quot;A Session Initiation Protocol (SIP) Event Notification Extension for Resource Lists&quot;">RFC4662</a>].
565 Conditional notification for list subscriptions is addressed in
566 <a href="#section-6.5">Section 6.5</a>.
567
568 A resource is identified by zero or more URIs, which can be SIP URIs,
569 pres URIs [<a href="./rfc3859" title="&quot;Common Profile for Presence (CPP)&quot;">RFC3859</a>], or similar. Subscribers use this URI to
570 subscribe to the resource for certain types of events, identified by
571 the event package.
572
573 With a successful subscription, a subscriber receives event
574 notifications that communicate the resource state and the changes
575 thereto. Each event notification carries a representation of the
576 current resource state. This representation is influenced by many
577 factors, e.g., authorization and filtering rules, and the event
578 composition rules of the notifier.
579
580 This representation is realized in an "entity". Each resource may be
581 associated with zero or more entities. For example, there may be
582 multiple subscribers to the presence information of a single user (a
583 resource), and each subscriber may have a different filtered view of
584 that resource, producing one entity per subscriber. However, each
585 entity is associated with one and only one resource; there is no
586 "compositing" of resources at the entity level. Resources may
587 themselves be made up of information from other resources (be
588 "composite resources"), but this does not change the one-resource-
589 per-entity rule.
590
591 An entity consists of the data carried in the body of a NOTIFY
592 message and related meta-data in the message header. Whenever the
593 data in the body or any of the meta-data changes, the notifier MUST
594 produce a new entity-tag. This meta-data MUST include, but is not
595 limited to the following SIP header fields defined in the Session
596 Initiation Protocol [<a href="./rfc3261" title="&quot;SIP: Session Initiation Protocol&quot;">RFC3261</a>] and SIP Specific Event Notification
597 [<a href="./rfc3265" title="&quot;Session Initiation Protocol (SIP)-Specific Event Notification&quot;">RFC3265</a>]:
598
599 1. Content-Disposition
600
601 2. Content-Encoding
602
603 3. Content-Language
604
605 4. Content-Length
606
607 5. Content-Type
608
609
610
611
612 <span class="grey">Niemi &amp; Willis Standards Track [Page 11]</span></pre>
613 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span>
614 <span class="grey"><a href="./rfc5839">RFC 5839</a> Entity-Tags for SIP Events May 2010</span>
615
616
617 6. Event
618
619 Note that the Subscription-State is explicitly not part of the
620 entity. In the future, event packages may define additional fields
621 that implementations need to consider as part of the entity.
622
623 An entity has one or more versions of which only one is current and
624 all others stale. Each version has an entity-tag, which uniquely
625 identifies it across all versions of all entities pertaining to a
626 single resource and event package.
627
628 Note that two entity-tags for different resources being equal does
629 not indicate identical entities. In other words, if an entity-tag
630 received for a subscription to a first resource matches an entity-tag
631 received for a subscription to a second resource, the subscriber
632 cannot assume that the two entity values are equal.
633
634 With partial event notification, the NOTIFY message only carries the
635 delta state, or the set of changes to the previous version of the
636 entity. In that case, implementations MUST consider the full event
637 state as the version of the entity to which the entity-tag in the
638 NOTIFY message applies.
639
640 The conditional notification mechanism is independent of the way in
641 which subscriptions are installed. In other words, the mechanism
642 supports implicit subscriptions, such as those associated with the
643 REFER method [<a href="./rfc3515" title="&quot;The Session Initiation Protocol (SIP) Refer Method&quot;">RFC3515</a>].
644
645 It is possible that the same resource is in some shape or form
646 accessible through another mechanism in addition to SIP Event
647 Notification, e.g., HTTP or the SIP PUBLISH method. In general,
648 implementations MUST NOT expect the entity-tags to be shared between
649 the mechanisms, unless event packages or specific applications of SIP
650 events explicitly define such dependencies.
651
652 <span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. Subscriber Behavior</span>
653
654 This section augments the subscriber behavior defined in <a href="./rfc3265">RFC 3265</a>
655 [<a href="./rfc3265" title="&quot;Session Initiation Protocol (SIP)-Specific Event Notification&quot;">RFC3265</a>]. It first discusses general issues related to indicating
656 support for the mechanism (<a href="#section-5.1">Section 5.1</a>) and creating conditions in
657 SUBSCRIBE requests (<a href="#section-5.2">Section 5.2</a>). Next, it describes subscriber
658 behavior for receiving NOTIFY requests (<a href="#section-5.3">Section 5.3</a>), and specific
659 client workflows for polling resource state (<a href="#section-5.4">Section 5.4</a>), resuming a
660 subscription (<a href="#section-5.5">Section 5.5</a>), refreshing a subscription (<a href="#section-5.6">Section 5.6</a>),
661 and terminating a subscription (<a href="#section-5.7">Section 5.7</a>). Finally, handling of
662 transient errors is discussed (<a href="#section-5.8">Section 5.8</a>).
663
664
665
666
667
668 <span class="grey">Niemi &amp; Willis Standards Track [Page 12]</span></pre>
669 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span>
670 <span class="grey"><a href="./rfc5839">RFC 5839</a> Entity-Tags for SIP Events May 2010</span>
671
672
673 <span class="h3"><a class="selflink" id="section-5.1" href="#section-5.1">5.1</a>. Detecting Support for Conditional Notification</span>
674
675 The mechanism defined in this memo is backwards compatible with SIP
676 events [<a href="./rfc3265" title="&quot;Session Initiation Protocol (SIP)-Specific Event Notification&quot;">RFC3265</a>] in that a notifier supporting this mechanism will
677 insert a SIP entity-tag in its NOTIFY requests, and a subscriber that
678 understands this mechanism will know how to use it in creating a
679 conditional request.
680
681 Unaware subscribers will simply ignore the entity-tag, make requests
682 without conditions, and receive the default treatment from the
683 notifier. Unaware notifiers will simply ignore the conditional
684 header fields and continue normal operation.
685
686 <span class="h3"><a class="selflink" id="section-5.2" href="#section-5.2">5.2</a>. Generating SUBSCRIBE Requests</span>
687
688 When creating a conditional SUBSCRIBE request, the subscriber MUST
689 include a single conditional header field including an entity-tag in
690 the request. The condition is evaluated by comparing the entity-tag
691 of the subscribed resource with the entity-tag carried in the
692 conditional header field. If they match, the condition evaluates to
693 true.
694
695 Unlike the condition introduced for the SIP PUBLISH [<a href="./rfc3903" title="&quot;Session Initiation Protocol (SIP) Extension for Event State Publication&quot;">RFC3903</a>] method,
696 these conditions do not apply to the SUBSCRIBE request itself, but to
697 the resulting NOTIFY requests. When true, the condition drives the
698 notifier to change its behavior with regard to sending the
699 notifications after the SUBSCRIBE.
700
701 This specification defines a new header field called Suppress-If-
702 Match. This header field introduces a condition to the SUBSCRIBE
703 request. If true, it instructs the notifier either to omit the body
704 of the resulting NOTIFY message (if the SUBSCRIBE is not sent within
705 an existing dialog) or to suppress (i.e., block) the NOTIFY request
706 that would otherwise be triggered by the SUBSCRIBE (for an
707 established dialog). In the latter case, the SUBSCRIBE message will
708 be answered with a 204 (No Notification) response. As long as the
709 condition remains true, it also instructs the notifier either to
710 suppress any subsequent NOTIFY request or, if there are reportable
711 changes in the NOTIFY header, e.g., the Subscription-State has
712 changed, to suppress the body of any subsequent NOTIFY request.
713
714 If the condition is false, the notifier follows its default behavior.
715
716 If the subscriber receives a 204 (No Notification) response to an in-
717 dialog SUBSCRIBE, the subscriber MUST consider the event state and
718 the subscription state unchanged.
719
720
721
722
723
724 <span class="grey">Niemi &amp; Willis Standards Track [Page 13]</span></pre>
725 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-14" ></span>
726 <span class="grey"><a href="./rfc5839">RFC 5839</a> Entity-Tags for SIP Events May 2010</span>
727
728
729 The value of the Suppress-If-Match header field is an entity-tag,
730 which is an opaque token that the subscriber simply copies (byte-
731 wise) from a previously received NOTIFY request. Inclusion of an
732 entity-tag in a Suppress-If-Match header field of a SUBSCRIBE request
733 indicates that the client has a copy of, or is capable of recreating
734 a copy of, the entity associated with that entity-tag.
735
736 Example:
737
738 Suppress-If-Match: b4cf7
739
740 The header field can also be wildcarded using the special "*" entity-
741 tag value. Such a condition always evaluates to true regardless of
742 the value of the current entity-tag for the resource.
743
744 Example:
745
746 Suppress-If-Match: *
747
748 Such a wildcard condition effectively quenches a subscription; the
749 only notifications received are those reporting changes to the
750 subscription state and those in response to a SUBSCRIBE message sent
751 outside of an existing dialog. In both cases, the notifications will
752 not contain a body.
753
754 A subscription with a wildcard Suppress-If-Match condition is
755 useful in scenarios where the subscriber wants to temporarily put
756 a subscription in dormant mode. For example, a host may want to
757 conserve bandwidth and power when it detects from screen or input
758 device inactivity that the user isn't actively monitoring the
759 presence statuses of contacts.
760
761 <span class="h3"><a class="selflink" id="section-5.3" href="#section-5.3">5.3</a>. Receiving NOTIFY Requests</span>
762
763 When a subscriber receives a NOTIFY request that contains a SIP-ETag
764 header field, it MUST store the entity-tag if it wishes to make use
765 of the conditional notification mechanism. The subscriber MUST be
766 prepared to receive a NOTIFY with any entity-tag value, including a
767 value that matches any previous value that the subscriber might have
768 seen.
769
770 The subscriber MUST NOT infer any meaning from the value of an
771 entity-tag; specifically, the subscriber MUST NOT assume identical
772 entities (i.e., event state) for NOTIFYs with identical entity-tag
773 values when those NOTIFYs result from subscription to different
774 resources.
775
776
777
778
779
780 <span class="grey">Niemi &amp; Willis Standards Track [Page 14]</span></pre>
781 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-15" ></span>
782 <span class="grey"><a href="./rfc5839">RFC 5839</a> Entity-Tags for SIP Events May 2010</span>
783
784
785 Note that there are valid cases for which identical entity-tag
786 values on different resources may occur. For example, it is
787 possible to generate entity-tag values using a one-way hash
788 function, resulting in the possibility that two different
789 resources having the same entity-value will also have the same
790 entity-tag. Clients however MUST NOT assume that this is the
791 case, as the algorithm for the generation of entity-tags is
792 notifier-dependent and not negotiated with the subscriber.
793 Consequently, the subscriber cannot differentiate between two
794 entity-tags that have the same value because they are similar
795 hashes of identical entities, or because two notifiers happen to
796 have used the same sequential number as an entity-tag. Entity
797 tags are only required to be unique for a given resource, not
798 globally unique.
799
800 <span class="h3"><a class="selflink" id="section-5.4" href="#section-5.4">5.4</a>. Polling or Fetching Resource State</span>
801
802 Polling with conditional notification allows a user agent to
803 efficiently poll resource state. This is accomplished using the
804 Suppress-If-Match condition:
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836 <span class="grey">Niemi &amp; Willis Standards Track [Page 15]</span></pre>
837 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-16" ></span>
838 <span class="grey"><a href="./rfc5839">RFC 5839</a> Entity-Tags for SIP Events May 2010</span>
839
840
841 Subscriber Notifier
842 ---------- --------
843
844 (1) SUBSCRIBE --------&gt;
845 Expires: 0
846 &lt;-------- (2) 202
847
848 &lt;-------- (3) NOTIFY
849 Subscription-State: terminated
850 SIP-ETag: f2e45
851 Content-Length: 17539
852
853 (4) 200 --------&gt;
854
855
856 ... poll interval elapses ...
857
858
859 (5) SUBSCRIBE --------&gt;
860 Suppress-If-Match: f2e45
861 Expires: 0
862 &lt;-------- (6) 202
863
864 &lt;-------- (7) NOTIFY
865 Subscription-State: terminated
866 SIP-ETag: f2e45
867 Content-Length: 0
868
869 (8) 200 --------&gt;
870
871 Figure 3: Polling Resource State
872
873 (1) The subscriber polls for resource state by sending a SUBSCRIBE
874 with zero expiry (expires immediately).
875
876 (2) The notifier accepts the SUBSCRIBE with a 202 (Accepted)
877 response.
878
879 (3) The notifier then immediately sends a first (and last) NOTIFY
880 request with the current resource state and the current entity-
881 tag in the SIP-ETag header field.
882
883 (4) The subscriber accepts the notification with a 200 (OK)
884 response.
885
886 (5) After some arbitrary poll interval, the subscriber sends another
887 SUBSCRIBE with a Suppress-If-Match header field that includes
888 the entity-tag received in the previous NOTIFY.
889
890
891
892 <span class="grey">Niemi &amp; Willis Standards Track [Page 16]</span></pre>
893 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-17" ></span>
894 <span class="grey"><a href="./rfc5839">RFC 5839</a> Entity-Tags for SIP Events May 2010</span>
895
896
897 (6) The notifier accepts the SUBSCRIBE with a 202 (Accepted)
898 response. (202 would be used to indicate that the subscription
899 request was understood without also indicating that it was
900 authorized, as per <a href="#section-3.1.6.1">Section 3.1.6.1</a> of SIP-Specific Event
901 Notification [<a href="./rfc3265" title="&quot;Session Initiation Protocol (SIP)-Specific Event Notification&quot;">RFC3265</a>].)
902
903 (7) Since the resource state has not changed since the previous poll
904 occurred, the notifier sends a NOTIFY message with no body. It
905 also mirrors the current entity-tag of the resource in the SIP-
906 ETag header field.
907
908 (8) The subscriber accepts the notification with a 200 (OK)
909 response.
910
911 <span class="h3"><a class="selflink" id="section-5.5" href="#section-5.5">5.5</a>. Resuming a Subscription</span>
912
913 Resuming a subscription means the ability to continue an earlier
914 subscription that either closed abruptly or was explicitly
915 terminated. When resuming, the subscription is established without
916 transmitting the resource state. This is accomplished with
917 conditional notification and the Suppress-If-Match header field:
918
919 Subscriber Notifier
920 ---------- --------
921
922 (1) SUBSCRIBE --------&gt;
923 Suppress-If-Match: ega23
924 Expires: 3600
925 &lt;-------- (2) 202
926
927 &lt;-------- (3) NOTIFY
928 Subscription-State: active
929 SIP-ETag: ega23
930 Content-Length: 0
931 (4) 200 --------&gt;
932
933 Figure 4: Resuming a Subscription
934
935 (1) The subscriber attempts to resume an earlier subscription by
936 including a Suppress-If-Match header field with the entity-tag
937 it last received.
938
939 (2) The notifier accepts the subscription after proper
940 authentication and authorization, by sending a 202 (Accepted)
941 response.
942
943
944
945
946
947
948 <span class="grey">Niemi &amp; Willis Standards Track [Page 17]</span></pre>
949 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-18" ></span>
950 <span class="grey"><a href="./rfc5839">RFC 5839</a> Entity-Tags for SIP Events May 2010</span>
951
952
953 (3) Since the condition is true, the notifier then immediately sends
954 an initial NOTIFY request that has no body. It also mirrors the
955 current entity-tag of the resource in the SIP-ETag header field.
956
957 (4) The subscriber accepts the NOTIFY and sends a 200 (OK) response.
958
959 Had the entity-tag not been valid any longer, the condition would
960 have evaluated to false, and the NOTIFY would have had a body
961 containing the latest resource state.
962
963 <span class="h3"><a class="selflink" id="section-5.6" href="#section-5.6">5.6</a>. Refreshing a Subscription</span>
964
965 To refresh a subscription using conditional notification, the
966 subscriber creates a subscription refresh before the subscription
967 expires, and uses the Suppress-If-Match header field:
968
969 Subscriber Notifier
970 ---------- --------
971
972 (1) SUBSCRIBE --------&gt;
973 Suppress-If-Match: aba91
974 Expires: 3600
975
976 &lt;-------- (2) 204
977 Expires: 3600
978
979 Figure 5: Refreshing a Subscription
980
981 (1) Before the subscription expires, the subscriber sends a
982 SUBSCRIBE request that includes the Suppress-If-Match header
983 field with the latest entity-tag it has seen.
984
985 (2) If the condition evaluates to true, the notifier sends a 204 (No
986 Notification) response and sends no NOTIFY request. The Expires
987 header field of the 204 (No Notification) response indicates the
988 new expiry time.
989
990 <span class="h3"><a class="selflink" id="section-5.7" href="#section-5.7">5.7</a>. Terminating a Subscription</span>
991
992 To terminate a subscription using conditional notification, the
993 subscriber creates a SUBSCRIBE request with a Suppress-If-Match
994 condition:
995
996
997
998
999
1000
1001
1002
1003
1004 <span class="grey">Niemi &amp; Willis Standards Track [Page 18]</span></pre>
1005 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-19" ></span>
1006 <span class="grey"><a href="./rfc5839">RFC 5839</a> Entity-Tags for SIP Events May 2010</span>
1007
1008
1009 Subscriber Notifier
1010 ---------- --------
1011
1012 (1) SUBSCRIBE --------&gt;
1013 Suppress-If-Match: ega23
1014 Expires: 0
1015
1016 &lt;-------- (2) 204
1017
1018 Figure 6: Terminating a Subscription
1019
1020 (1) The subscriber decides to terminate the subscription and sends a
1021 SUBSCRIBE request with the Suppress-If-Match condition with the
1022 entity-tag it has last seen.
1023
1024 (2) If the condition evaluates to true, the notifier sends a 204 (No
1025 Notification) response, which concludes the subscription, and
1026 the subscriber can clear all state related to the subscription.
1027
1028 <span class="h3"><a class="selflink" id="section-5.8" href="#section-5.8">5.8</a>. Handling Transient Errors</span>
1029
1030 This section is non-normative.
1031
1032 In some deployments, there may be Back-to-Back User Agent (B2BUA)
1033 devices that track SIP dialogs such as subscription dialogs. These
1034 devices may be unaware of the conditional notification mechanism.
1035
1036 It is possible that some B2BUA devices may treat a NOTIFY with
1037 suppressed body as an error, or may expect all SUBSCRIBE messages to
1038 have an associated NOTIFY message.
1039
1040 In general, there is very little that an endpoint can do to recover
1041 from such transient errors. The most that can be done is to try to
1042 detect such errors, and define a fallback behavior.
1043
1044 If subscribers encounter transient errors in conditional
1045 notification, they should disable the feature and fall back to normal
1046 subscription behavior.
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060 <span class="grey">Niemi &amp; Willis Standards Track [Page 19]</span></pre>
1061 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-20" ></span>
1062 <span class="grey"><a href="./rfc5839">RFC 5839</a> Entity-Tags for SIP Events May 2010</span>
1063
1064
1065 <span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. Notifier Behavior</span>
1066
1067 This section augments the notifier behavior as specified in <a href="./rfc3265">RFC 3265</a>
1068 [<a href="./rfc3265" title="&quot;Session Initiation Protocol (SIP)-Specific Event Notification&quot;">RFC3265</a>].
1069
1070 <span class="h3"><a class="selflink" id="section-6.1" href="#section-6.1">6.1</a>. Generating Entity-tags</span>
1071
1072 An entity-tag is a token carried in the SIP-ETag header field, and it
1073 is opaque to the client. The notifier is free to decide on any means
1074 for generating the entity-tag. It can have any value, except for
1075 "*". For example, one possible method is to implement the entity-tag
1076 as a simple counter, incrementing it by one for each generated
1077 notification per resource.
1078
1079 A notifier MUST generate entity-tags for event notifications of all
1080 resources for which it is responsible. The entity-tag MUST be unique
1081 across all versions of all entities for each state of a resource as
1082 reported by a given event package. Otherwise said, for any
1083 subscription or sequence of subscriptions to a specific resource
1084 using a singular event package, each entity-tag produced MUST map to
1085 one and only one presentation of resource state (entity). Two
1086 identical entities for a specific resource might or might not have
1087 identical entity-tags; this decision is left to the notifier.
1088
1089 An entity-tag is considered valid for as long as the entity exists.
1090 An entity becomes stale when its version is no longer the current
1091 one. The notifier MUST remember (or be able to recalculate) the
1092 entity-tag of an entity as long as the version of the entity is
1093 current. The notifier MAY remember the entity-tag longer than this,
1094 e.g., for implementing journaled state differentials (<a href="#section-6.4">Section 6.4</a>).
1095
1096 The entity-tag values used in publications are not necessarily shared
1097 with the entity-tag values used in subscriptions. This is because
1098 there may not always be a one-to-one mapping between a publication
1099 and a notification of state change; there may be several sources to
1100 the event composition process, and a publication into a resource may
1101 not affect the resulting entity.
1102
1103 <span class="h3"><a class="selflink" id="section-6.2" href="#section-6.2">6.2</a>. Suppressing NOTIFY Bodies</span>
1104
1105 When a condition in a SUBSCRIBE request for suppressing notifications
1106 is true (i.e., the local entity-tag for the resource state and the
1107 entity-tag in a Suppress-If-Match header field are byte-wise
1108 identical) but there are reportable changes in the NOTIFY header
1109 (e.g., the Subscription-State has changed), the notifier MUST
1110 suppress the body of the NOTIFY request. That is, the resulting
1111 NOTIFY contains no Content-Type header field, the Content-Length is
1112 set to zero, and no payload is attached to the message.
1113
1114
1115
1116 <span class="grey">Niemi &amp; Willis Standards Track [Page 20]</span></pre>
1117 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-21" ></span>
1118 <span class="grey"><a href="./rfc5839">RFC 5839</a> Entity-Tags for SIP Events May 2010</span>
1119
1120
1121 Additionally, when a condition in a SUBSCRIBE request for suppressing
1122 notifications is true and the SUBSCRIBE message is not sent within an
1123 established dialog, the notifier MUST send a NOTIFY request with a
1124 suppressed entity body.
1125
1126 Suppressing the entity body of a NOTIFY does not change the current
1127 entity-tag of the resource. Hence, the NOTIFY MUST contain a SIP-
1128 ETag header field that contains the unchanged entity-tag of the
1129 resource state.
1130
1131 A Suppress-If-Match header field that includes an entity-tag with the
1132 value of "*" MUST always evaluate to true.
1133
1134 <span class="h3"><a class="selflink" id="section-6.3" href="#section-6.3">6.3</a>. Suppressing NOTIFY Requests</span>
1135
1136 When a condition in a SUBSCRIBE request to suppress notifications is
1137 true (i.e., the local entity-tag of the resource and the entity-tag
1138 in a Suppress-If-Match header field match), and the SUBSCRIBE is sent
1139 within an established dialog, then the notifier MUST suppress the
1140 resulting NOTIFY request, and generate a 204 (No Notification)
1141 response. As long as the condition remains true, and there are no
1142 reportable changes in the NOTIFY header, all subsequent NOTIFY
1143 requests MUST also be suppressed.
1144
1145 Notifiers MUST NOT suppress a NOTIFY unless the corresponding
1146 SUBSCRIBE message was sent in an established dialog.
1147
1148 A successful conditional SUBSCRIBE request MUST extend the
1149 subscription expiry time.
1150
1151 Suppressing the entire NOTIFY has no effect on the entity-tag of the
1152 resource. In other words, it remains unchanged.
1153
1154 A Suppress-If-Match header field that includes an entity-tag with the
1155 value of "*" MUST always evaluate to true.
1156
1157 <span class="h3"><a class="selflink" id="section-6.4" href="#section-6.4">6.4</a>. State Differentials</span>
1158
1159 Some event packages support a scheme where notifications contain
1160 state differentials, or state deltas [<a href="./rfc3265" title="&quot;Session Initiation Protocol (SIP)-Specific Event Notification&quot;">RFC3265</a>], instead of complete
1161 resource state.
1162
1163 Further extensions could define means for notifiers to keep track of
1164 the state changes of a resource, e.g., storing the changes in a
1165 journal. If a condition fails, the notifier would then send a state
1166 differential in the NOTIFY rather than the full state of the event
1167 resource. This is only possible if the event package and the
1168 subscriber both support a payload format that has this capability.
1169
1170
1171
1172 <span class="grey">Niemi &amp; Willis Standards Track [Page 21]</span></pre>
1173 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-22" ></span>
1174 <span class="grey"><a href="./rfc5839">RFC 5839</a> Entity-Tags for SIP Events May 2010</span>
1175
1176
1177 When state differentials are sent, the SIP-ETag header field MUST
1178 contain an entity-tag that corresponds to the full resource state.
1179
1180 <span class="h3"><a class="selflink" id="section-6.5" href="#section-6.5">6.5</a>. List Subscriptions</span>
1181
1182 The Event Notification Extension for Resource Lists [<a href="./rfc4662" title="&quot;A Session Initiation Protocol (SIP) Event Notification Extension for Resource Lists&quot;">RFC4662</a>] defines
1183 a mechanism for subscribing to a homogeneous list of resources using
1184 the SIP events framework.
1185
1186 A list subscription delivers event notifications that contain both
1187 Resource List Meta-Information (RLMI) documents as well as the
1188 resource state of the individual resources on the list.
1189
1190 Implementations MUST consider the full resource state of a resource
1191 list including RLMI and the entity-header as the entity to which the
1192 entity-tag applies.
1193
1194 <span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>. Protocol Element Definitions</span>
1195
1196 This section describes the protocol extensions required for
1197 conditional notification.
1198
1199 <span class="h3"><a class="selflink" id="section-7.1" href="#section-7.1">7.1</a>. 204 (No Notification) Response Code</span>
1200
1201 The 204 (No Notification) response code indicates that the request
1202 was successful, but the notification associated with the request will
1203 not be sent. It is valid only in response to a SUBSCRIBE message
1204 sent within an established dialog.
1205
1206 The response code is added to the "Success" production rule in the
1207 SIP [<a href="./rfc3261" title="&quot;SIP: Session Initiation Protocol&quot;">RFC3261</a>] message grammar.
1208
1209 <span class="h3"><a class="selflink" id="section-7.2" href="#section-7.2">7.2</a>. Suppress-If-Match Header Field</span>
1210
1211 The Suppress-If-Match header field is added to the definition of the
1212 "message-header" rule in the SIP [<a href="./rfc3261" title="&quot;SIP: Session Initiation Protocol&quot;">RFC3261</a>] grammar. Its use is
1213 described in Sections <a href="#section-5">5</a>, <a href="#section-6.3">6.3</a>, and <a href="#section-6.2">6.2</a>.
1214
1215 This header field is allowed to appear in any request, but its
1216 behavior is only defined for the SUBSCRIBE request.
1217
1218 <span class="h3"><a class="selflink" id="section-7.3" href="#section-7.3">7.3</a>. Grammar</span>
1219
1220 This section defines the formal syntax for extensions described in
1221 this memo in Augmented BNF (ABNF) [<a href="./rfc5234" title="&quot;Augmented BNF for Syntax Specifications: ABNF&quot;">RFC5234</a>]. The rules defined here
1222 augment and reference the syntax defined in <a href="./rfc3261">RFC 3261</a> [<a href="./rfc3261" title="&quot;SIP: Session Initiation Protocol&quot;">RFC3261</a>] and
1223 <a href="./rfc3903">RFC 3903</a> [<a href="./rfc3903" title="&quot;Session Initiation Protocol (SIP) Extension for Event State Publication&quot;">RFC3903</a>].
1224
1225
1226
1227
1228 <span class="grey">Niemi &amp; Willis Standards Track [Page 22]</span></pre>
1229 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-23" ></span>
1230 <span class="grey"><a href="./rfc5839">RFC 5839</a> Entity-Tags for SIP Events May 2010</span>
1231
1232
1233 Success =/ "204" ; No Notification
1234
1235 ; Success is defined in <a href="./rfc3261">RFC 3261</a>.
1236
1237 message-header =/ Suppress-If-Match
1238
1239 ; message-header is defined in <a href="./rfc3261">RFC 3261</a>.
1240
1241 Suppress-If-Match = "Suppress-If-Match" HCOLON ( entity-tag / "*" )
1242
1243 ; entity-tag is defined in <a href="./rfc3903">RFC 3903</a>.
1244
1245 <span class="h2"><a class="selflink" id="section-8" href="#section-8">8</a>. IANA Considerations</span>
1246
1247 This document registers a new response code and a new header field
1248 name.
1249
1250 <span class="h3"><a class="selflink" id="section-8.1" href="#section-8.1">8.1</a>. 204 (No Notification) Response Code</span>
1251
1252 This document registers a new response code. This response code is
1253 defined by the following information, which has been added to the
1254 methods and response-codes sub-registry available from
1255 <a href="http://www.iana.org">http://www.iana.org</a>.
1256
1257 This information has been added under "Successful 2xx" category.
1258
1259 +---------------------+-----------+
1260 | Response Code | Reference |
1261 +---------------------+-----------+
1262 | 204 No Notification | [<a href="./rfc5839">RFC5839</a>] |
1263 +---------------------+-----------+
1264
1265 <span class="h3"><a class="selflink" id="section-8.2" href="#section-8.2">8.2</a>. Suppress-If-Match Header Field</span>
1266
1267 This document registers a new SIP header field called Suppress-If-
1268 Match. This header field is defined by the following information,
1269 which has been added to the header fields sub-registry available from
1270 <a href="http://www.iana.org">http://www.iana.org</a>.
1271
1272 +-------------------+---------+-----------+
1273 | Header Name | Compact | Reference |
1274 +-------------------+---------+-----------+
1275 | Suppress-If-Match | | [<a href="./rfc5839">RFC5839</a>] |
1276 +-------------------+---------+-----------+
1277
1278
1279
1280
1281
1282
1283
1284 <span class="grey">Niemi &amp; Willis Standards Track [Page 23]</span></pre>
1285 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-24" ></span>
1286 <span class="grey"><a href="./rfc5839">RFC 5839</a> Entity-Tags for SIP Events May 2010</span>
1287
1288
1289 <span class="h2"><a class="selflink" id="section-9" href="#section-9">9</a>. Security Considerations</span>
1290
1291 The security considerations for SIP event notification are
1292 extensively discussed in <a href="./rfc3265">RFC 3265</a> [<a href="./rfc3265" title="&quot;Session Initiation Protocol (SIP)-Specific Event Notification&quot;">RFC3265</a>]. This specification
1293 introduces an optimization to SIP event notification, which in itself
1294 does not alter the security properties of the protocol.
1295
1296 <span class="h2"><a class="selflink" id="section-10" href="#section-10">10</a>. Acknowledgments</span>
1297
1298 The following people have contributed corrections and suggestions to
1299 this document: Adam Roach, Sean Olson, Johnny Vrancken, Pekka Pessi,
1300 Eva Leppanen, Krisztian Kiss, Peili Xu, Avshalom Houri, David
1301 Viamonte, Jonathan Rosenberg, Qian Sun, Dale Worley, Tolga Asveren,
1302 Brian Stucker, Eric Rescorla, Arun Arunachalam, and the SIP and
1303 SIMPLE working groups.
1304
1305 <span class="h2"><a class="selflink" id="section-11" href="#section-11">11</a>. References</span>
1306
1307 <span class="h3"><a class="selflink" id="section-11.1" href="#section-11.1">11.1</a>. Normative References</span>
1308
1309 [<a id="ref-RFC2119">RFC2119</a>] Bradner, S., "Key words for use in RFCs to Indicate
1310 Requirement Levels", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc2119">RFC 2119</a>, March 1997.
1311
1312 [<a id="ref-RFC3261">RFC3261</a>] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston,
1313 A., Peterson, J., Sparks, R., Handley, M., and E.
1314 Schooler, "SIP: Session Initiation Protocol", <a href="./rfc3261">RFC 3261</a>,
1315 June 2002.
1316
1317 [<a id="ref-RFC3265">RFC3265</a>] Roach, A., "Session Initiation Protocol (SIP)-Specific
1318 Event Notification", <a href="./rfc3265">RFC 3265</a>, June 2002.
1319
1320 [<a id="ref-RFC3903">RFC3903</a>] Niemi, A., "Session Initiation Protocol (SIP) Extension
1321 for Event State Publication", <a href="./rfc3903">RFC 3903</a>, October 2004.
1322
1323 [<a id="ref-RFC5234">RFC5234</a>] Crocker, D. and P. Overell, "Augmented BNF for Syntax
1324 Specifications: ABNF", STD 68, <a href="./rfc5234">RFC 5234</a>, January 2008.
1325
1326 <span class="h3"><a class="selflink" id="section-11.2" href="#section-11.2">11.2</a>. Informative References</span>
1327
1328 [<a id="ref-RFC2616">RFC2616</a>] Fielding, R., Gettys, J., Mogul, J., Frystyk, H.,
1329 Masinter, L., Leach, P., and T. Berners-Lee, "Hypertext
1330 Transfer Protocol -- HTTP/1.1", <a href="./rfc2616">RFC 2616</a>, June 1999.
1331
1332 [<a id="ref-RFC3515">RFC3515</a>] Sparks, R., "The Session Initiation Protocol (SIP) Refer
1333 Method", <a href="./rfc3515">RFC 3515</a>, April 2003.
1334
1335 [<a id="ref-RFC3680">RFC3680</a>] Rosenberg, J., "A Session Initiation Protocol (SIP) Event
1336 Package for Registrations", <a href="./rfc3680">RFC 3680</a>, March 2004.
1337
1338
1339
1340 <span class="grey">Niemi &amp; Willis Standards Track [Page 24]</span></pre>
1341 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-25" ></span>
1342 <span class="grey"><a href="./rfc5839">RFC 5839</a> Entity-Tags for SIP Events May 2010</span>
1343
1344
1345 [<a id="ref-RFC3842">RFC3842</a>] Mahy, R., "A Message Summary and Message Waiting
1346 Indication Event Package for the Session Initiation
1347 Protocol (SIP)", <a href="./rfc3842">RFC 3842</a>, August 2004.
1348
1349 [<a id="ref-RFC3856">RFC3856</a>] Rosenberg, J., "A Presence Event Package for the Session
1350 Initiation Protocol (SIP)", <a href="./rfc3856">RFC 3856</a>, August 2004.
1351
1352 [<a id="ref-RFC3859">RFC3859</a>] Peterson, J., "Common Profile for Presence (CPP)",
1353 <a href="./rfc3859">RFC 3859</a>, August 2004.
1354
1355 [<a id="ref-RFC4662">RFC4662</a>] Roach, A., Campbell, B., and J. Rosenberg, "A Session
1356 Initiation Protocol (SIP) Event Notification Extension for
1357 Resource Lists", <a href="./rfc4662">RFC 4662</a>, August 2006.
1358
1359 Authors' Addresses
1360
1361 Aki Niemi
1362 Nokia
1363 P.O. Box 407
1364 NOKIA GROUP, FIN 00045
1365 Finland
1366
1367 Phone: +358 50 389 1644
1368 EMail: [email protected]
1369
1370
1371 Dean Willis (editor)
1372 Softarmor Systems
1373 3100 Independence Pkwy #311-164
1374 Plano, TX 75075
1375 USA
1376
1377 Phone: +1 214 504 1987
1378 EMail: [email protected]
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396 Niemi &amp; Willis Standards Track [Page 25]
1397 </pre>