RFC 4488 PROPOSED STANDARD SIP · REFER · EXTENSION

REFER no-subscribe: Suppression of Session Initiation Protocol (SIP) REFER Method Implicit Subscription

A SIP header that lets the sender of a REFER say it does not want the automatic subscription and its notifications.

On rfc-editor.org ↗
PUBLISHED
May 2006
AUTHORS
O. Levin
STREAM
IETF
NEW HEADER FIELD
Refer-Sub (true or false)
NEW OPTION TAG
norefersub
REJECTION OF UNSUPPORTED REQUIRE
420 (Bad Extension)
COMPACT FORM
None
DOI
10.17487/RFC4488

RFC text

Contents
Original text · RFC Editor View on rfc-editor.org ↗
Network Working Group                                           O. Levin
Request for Comments: 4488                         Microsoft Corporation
Category: Standards Track                                       May 2006


           Suppression of Session Initiation Protocol (SIP)
                   REFER Method Implicit Subscription

Status of This Memo

   This document specifies an Internet standards track protocol for the
   Internet community, and requests discussion and suggestions for
   improvements.  Please refer to the current edition of the "Internet
   Official Protocol Standards" (STD 1) for the standardization state
   and status of this protocol.  Distribution of this memo is unlimited.

Copyright Notice

   Copyright (C) The Internet Society (2006).

Abstract

   The Session Initiation Protocol (SIP) REFER extension as defined in
   RFC 3515 automatically establishes a typically short-lived event
   subscription used to notify the party sending a REFER request about
   the receiver's status in executing the transaction requested by the
   REFER.  These notifications are not needed in all cases.  This
   specification provides a way to prevent the automatic establishment
   of an event subscription and subsequent notifications using a new SIP
   extension header field that may be included in a REFER request.

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . . . 2
   2.  Terminology . . . . . . . . . . . . . . . . . . . . . . . . . . 2
   3.  Motivation  . . . . . . . . . . . . . . . . . . . . . . . . . . 2
   4.  Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . 3
   5.  Preventing Forking of REFER Requests  . . . . . . . . . . . . . 4
   6.  Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
   7.  IANA Considerations . . . . . . . . . . . . . . . . . . . . . . 5
   8.  Security Considerations . . . . . . . . . . . . . . . . . . . . 6
   9.  Acknowledgements  . . . . . . . . . . . . . . . . . . . . . . . 6
   10. References  . . . . . . . . . . . . . . . . . . . . . . . . . . 7
       10.1.  Normative References . . . . . . . . . . . . . . . . . . 7
       10.2.  Informative References . . . . . . . . . . . . . . . . . 7

1.  Introduction

   The REFER specification [3] specifies that every REFER creates an
   implicit subscription between the REFER-Issuer and the REFER-
   Recipient.

   This document defines a new SIP header field: "Refer-Sub" meaningful
   within a REFER transaction only.  This header field, when set to
   "false", specifies that a REFER-Issuer requests that the REFER-
   Recipient doesn't establish an implicit subscription and the
   resultant dialog.

   This document defines a new option tag: "norefersub".  This tag, when
   included in the Supported header field, indicates that a User Agent
   (UA) is capable of accepting a REFER request without creating an
   implicit subscription when acting as a REFER-Recipient.

2.  Terminology

   The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
   "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
   document are to be interpreted as described in RFC 2119 [1].

   To simplify discussions of the REFER method and its extensions, the
   three terms below are being used throughout the document:

   o  REFER-Issuer: the UA issuing the REFER request

   o  REFER-Recipient: the UA receiving the REFER request

   o  REFER-Target: the UA designated in the Refer-To Uniform Resource
      Identifier (URI)

3.  Motivation

   The REFER specification mandates that every REFER creates an implicit
   subscription between the REFER-Issuer and the REFER-Recipient.  This
   subscription results in at least one NOTIFY being sent from the
   REFER-Recipient to the REFER-Issuer.  The REFER-Recipient may choose
   to cancel the implicit subscription with this NOTIFY.  The REFER-
   Issuer may choose to cancel this implicit subscription with an
   explicit SUBSCRIBE (Expires: 0) after receipt of the initial NOTIFY.

   One purpose of requiring the implicit subscription and initial NOTIFY
   is to allow for the situation where the REFER request gets forked and
   the REFER-Issuer needs a way to see the multiple dialogs that may be
   established as a result of the forked REFER.  This is the same
   approach used to handle forking of SUBSCRIBE [4] requests.  Where the
   REFER-Issuer explicitly specifies that forking not occur, the
   requirement that an implicit subscription be established is
   unnecessary.

   Another purpose of the NOTIFY is to inform the REFER-Issuer of the
   progress of the SIP transaction that results from the REFER at the
   REFER-Recipient.  In the case where the REFER-Issuer is already aware
   of the progress of the requested operation, such as when the REFER-
   Issuer has an explicit subscription to the dialog event package at
   the REFER-Recipient, the implicit subscription and resultant NOTIFY
   traffic related to the REFER can create an unnecessary network
   overhead.

4.  Definitions

   This document defines a new SIP header field: "Refer-Sub".  This
   header field is meaningful and MAY be used with a REFER request and
   the corresponding 2XX response only.  This header field set to
   "false" specifies that a REFER-Issuer requests that the REFER-
   Recipient doesn't establish an implicit subscription and the
   resultant dialog.  Note that when using this extension, the REFER
   remains a target refresh request (as in the default case -- when the
   extension is not used).

   This document adds the following entry to Table 2 of [2].  The
   additions to this table are also provided for extension methods at
   the time of publication of this document.  This is provided as a
   courtesy to the reader and is not normative in any way:

   Header field        where    proxy ACK  BYE  CAN  INV  OPT  REG  MSG

   Refer-Sub           R, 2xx          -    -    -    -    -    -    -

   Header field        where    SUB  NOT  REF  INF  UPD  PRA  PUB

   Refer-Sub           R, 2xx    -    -    o    -    -    -    -


   The Refer-Sub header field MAY be encrypted as part of end-to-end
   encryption.

   The syntax of the header field follows the BNF defined below:

    Refer-Sub       = "Refer-Sub" HCOLON refer-sub-value *(SEMI exten)
    refer-sub-value = "true" / "false"
    exten           = generic-param

   where the syntax of generic-param is defined in [2].

   The "Refer-Sub" header field set to "false" MAY be used by the REFER-
   Issuer only when the REFER-Issuer can be certain that the REFER
   request will not be forked.

   If the REFER-Recipient supports the extension and is willing to
   process the REFER transaction without establishing an implicit
   subscription, it MUST insert the "Refer-Sub" header field set to
   "false" in the 2xx response to the REFER-Issuer.  In this case, no
   implicit subscription is created.  Consequently, no new dialog is
   created if this REFER was issued outside any existing dialog.

   If the REFER-Issuer inserts the "Refer-Sub" header field set to
   "false", but the REFER-Recipient doesn't grant the suggestion (i.e.,
   either does not include the "Refer-Sub" header field or includes the
   "Refer-Sub" header field set to "true" in the 2xx response), an
   implicit subscription is created as in the default case.

   This document also defines a new option tag, "norefersub".  This tag,
   when included in the Supported header field, specifies that a User
   Agent (UA) is capable of accepting a REFER request without creating
   an implicit subscription when acting as a REFER-Recipient.

   The REFER-Issuer can know the capabilities of the REFER-Recipient
   from the presence of the option tags in the Supported header field of
   the dialog initiating request or response.  Another way of learning
   the capabilities would be by using presence, such as defined in [6].
   However, if the capabilities of the REFER-Recipient are not known,
   using the "norefersub" tag with the Require header field is NOT
   RECOMMENDED.  This is due to the fact that in the event the REFER-
   Recipient doesn't support the extension, in order to fall back to the
   normal REFER, the REFER-Issuer will need to issue a new REFER
   transaction thus resulting in additional round-trips.

   As described in Section 8.2.2.3 in [2], a REFER-Recipient will reject
   a REFER request containing a Require: norefersub header field with a
   420 (Bad Extension) response unless it supports this extension.  Note
   that Require: norefersub can be present with a Refer-Sub: false
   header field.

5.  Preventing Forking of REFER Requests

   The REFER specification allows for the possibility of forking a REFER
   request that is sent outside of an existing dialog.  In addition, a
   proxy may fork an unknown method type.  Should forking occur, the
   sender of the REFER with "Refer-Sub" will not be aware as only a
   single 2xx response will be forwarded by the forking proxy.  As a
   result, the responsibility is on the issuer of the REFER with "Refer-
   Sub" to ensure that no forking will result.

   If a REFER request to a given Request-URI might fork, the REFER-
   Issuer SHOULD NOT include the "Refer-Sub" header field.  The REFER-
   Issuer SHOULD use standardized mechanisms for ensuring the REFER
   request does not fork.  In absence of any other mechanism, the
   Request-URI of the REFER request SHOULD have Globally Routable User
   Agent URI (GRUU) properties according to the definitions of [5] as
   those properties ensure the request will not fork.

6.  Example

   An example of REFER that suppresses the implicit subscription is
   shown below.  Note that the conventions used in the SIP Torture Test
   Messages [7] document are reused, specifically the <allOneLine> tag.

   REFER sip:pc-b@example.com SIP/2.0
   Via: SIP/2.0/TCP issuer.example.com;branch=z9hG4bK-a-1
   From: <sip:a@example.com>;tag=1a
   <allOneLine>
   To: sip:b@example.com;opaque=urn:uuid:f8
   1d4fae-7dec-11d0-a765-00a0c91e6bf6;grid=99a
   </allOneLine>
   Call-ID: 1@issuer.example.com
   CSeq: 234234 REFER
   Max-Forwards: 70
   Refer-To: <sip:c@example.com;method=INVITE>
   Refer-Sub: false
   Supported: norefersub
   Contact: sip:a@issuer.example.com
   Content-Length: 0

7.  IANA Considerations

   This document registers a new SIP header field "Refer-Sub".  This
   header field is only meaningful for the REFER request defined in RFC
   3515 [3] and the corresponding response.  The following information
   has been added to the SIP Header field sub-registry in the SIP
   Parameters Registry:

   o  Header Name: Refer-Sub

   o  Compact Form: None

   o  Reference: RFC 4488

   This document also registers a new SIP option tag, "norefersub",
   adding it to the SIP Option Tags sub-registry in the SIP Parameters
   Registry.  The required information for this registration, as
   specified in RFC 3261 [2], is:

   o  Name: norefersub

   o  Description: This option tag specifies a User Agent ability of
      accepting a REFER request without establishing an implicit
      subscription (compared to the default case defined in RFC 3515
      [3]).

8.  Security Considerations

   The purpose of this SIP extension is to modify the expected behavior
   of the REFER-Recipient.  The change in behavior is for the REFER-
   Recipient not to establish a dialog and not to send NOTIFY messages
   back to the REFER-Issuer.  As such, a malicious inclusion of a
   "Refer-Sub" header field set to "false" reduces the processing and
   state requirements on the recipient.  As a result, its use in a
   denial-of-service attack seems limited.

   On the other hand, by inserting a "Refer-Sub" header field set to
   "false", a man-in-the-middle (MitM) can potentially exploit the
   mechanism for easier (than an interception) suppression of the
   notifications from the REFER-Receiver without the REFER-Issuer
   noticing it.  Also, by removing a "Refer-Sub" header field set to
   "false", a MitM can cause the REFER-Receiver to generate
   notifications over the implicit dialog that otherwise had been
   suppressed by the REFER-Issuer.

   To protect against these kinds of MitM attacks, integrity protection
   should be used.  For example, the REFER-Issuer could use S/MIME as
   discussed in RFC 3261 [2] to protect against these kinds of attacks.

9.  Acknowledgements

   The SIP community would like to thank Sriram Parameswar for his
   ideas, originally presented in "Suppressing Refer Implicit
   Subscription" (October 2002), which served as the basis for this
   specification.

10.  References

10.1.  Normative References

   [1]  Bradner, S., "Key words for use in RFCs to Indicate Requirement
        Levels", BCP 14, RFC 2119, March 1997.

   [2]  Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston, A.,
        Peterson, J., Sparks, R., Handley, M., and E. Schooler, "SIP:
        Session Initiation Protocol", RFC 3261, June 2002.

   [3]  Sparks, R., "The Session Initiation Protocol (SIP) Refer
        Method", RFC 3515, April 2003.

   [4]  Roach, A.B., "Session Initiation Protocol (SIP)-Specific Event
        Notification", RFC 3265, June 2002.

10.2.  Informative References

   [5]  Rosenberg, J., "Obtaining and Using Globally Routable User Agent
        (UA) URIs (GRUU) in the Session Initiation Protocol (SIP)",
         Work in Progress, October 2005.

   [6]  Lonnfors, M. and K. Kiss, "Session Initiation Protocol (SIP)
        User Agent Capability Extension to Presence Information Data
        Format (PIDF)", Work in Progress, January 2006.

   [7]  Sparks, R., Ed., Hawrylyshen, A., Johnston, A., Rosenberg, J.,
        and H. Schulzrinne, "Session Initiation Protocol (SIP) Torture
        Test Messages", RFC 4475, May 2006.

Author's Address

   Orit Levin
   Microsoft Corporation
   One Microsoft Way
   Redmond, WA  98052
   USA

   Phone: 425-722-2225
   EMail: oritl@microsoft.com

Full Copyright Statement

   Copyright (C) The Internet Society (2006).

   This document is subject to the rights, licenses and restrictions
   contained in BCP 78, and except as set forth therein, the authors
   retain all their rights.

   This document and the information contained herein are provided on an
   "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
   OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET
   ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED,
   INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE
   INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
   WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

Intellectual Property

   The IETF takes no position regarding the validity or scope of any
   Intellectual Property Rights or other rights that might be claimed to
   pertain to the implementation or use of the technology described in
   this document or the extent to which any license under such rights
   might or might not be available; nor does it represent that it has
   made any independent effort to identify any such rights.  Information
   on the procedures with respect to rights in RFC documents can be
   found in BCP 78 and BCP 79.

   Copies of IPR disclosures made to the IETF Secretariat and any
   assurances of licenses to be made available, or the result of an
   attempt made to obtain a general license or permission for the use of
   such proprietary rights by implementers or users of this
   specification can be obtained from the IETF on-line IPR repository at
   http://www.ietf.org/ipr.

   The IETF invites any interested party to bring to its attention any
   copyrights, patents or patent applications, or other proprietary
   rights that may cover technology that may be required to implement
   this standard.  Please address the information to the IETF at
   ietf-ipr@ietf.org.

Acknowledgement

   Funding for the RFC Editor function is provided by the IETF
   Administrative Support Activity (IASA).

AI ELI5

On this page
PROBLEMEvery SIP REFER automatically creates an implicit subscription, and at least one NOTIFY is sent back. That is wasted traffic when the sender does not need progress reports, for example when it already follows the dialog event package.
MECHANISMThe sender adds a Refer-Sub header set to false. If the recipient agrees, it echoes Refer-Sub: false in its 2xx response and creates no subscription or dialog. A new option tag, norefersub, signals support.
THE CATCHREFER can be used without subscription overhead, but only when the sender is sure the request will not fork.

§1Why Suppress the Subscription

The REFER specification (RFC 3515) requires every REFER to create an implicit subscription between the REFER-Issuer and the REFER-Recipient. This results in at least one NOTIFY sent from the recipient to the issuer. The recipient may cancel the subscription with that NOTIFY, or the issuer may cancel it with a SUBSCRIBE carrying Expires: 0.

The subscription has two purposes. First, it lets the issuer see the multiple dialogs that a forked REFER could create, the same approach used for forked SUBSCRIBE requests. If the issuer states that forking must not occur, that need disappears. Second, the NOTIFY reports progress of the resulting transaction. If the issuer already knows the progress, for example through an explicit subscription to the dialog event package at the recipient, the extra NOTIFY traffic is unnecessary network overhead.

Normally, when you ask someone to do a job, they report back. If you are already watching them work, the reports are just noise.

§2Roles and the New Tokens

The RFC uses three terms. The REFER-Issuer is the UA sending the REFER. The REFER-Recipient is the UA receiving it. The REFER-Target is the UA named in the Refer-To URI.

It defines a new header field, Refer-Sub, which is meaningful only within a REFER transaction. Set to false, it asks the recipient not to establish an implicit subscription and the resulting dialog. It also defines a new option tag, norefersub, which a UA places in the Supported header field to say it can accept a REFER without creating an implicit subscription.

There is the person asking, the person doing the asking-for, and the person to be called. A new word, Refer-Sub, lets the asker say 'no reports please'.

§3The Refer-Sub Header

Refer-Sub MAY be used only with a REFER request and the matching 2xx response. It may be encrypted as part of end-to-end encryption. The syntax is Refer-Sub = "Refer-Sub" HCOLON refer-sub-value *(SEMI exten), where the value is true or false and exten is a generic parameter.

Even with the extension in use, the REFER remains a target refresh request, as it does by default.

The RFC also adds a courtesy row for the header to the SIP header table: it applies to requests (R) and 2xx responses, and is optional (o) in REFER.

The header is a small sticky note on the request that says 'true' or 'false' for whether you want reports.

§4How the Exchange Works

The issuer adds Refer-Sub: false to the REFER. If the recipient supports the extension and is willing to proceed without a subscription, it MUST insert Refer-Sub: false in its 2xx response. No implicit subscription is created, and no new dialog is created if the REFER was issued outside an existing dialog.

If the recipient does not include the header, or includes it set to true, the implicit subscription is created as usual. So the header is a request that the recipient can decline.

The issuer can learn support from the Supported header field of the dialog-initiating request or response, or through presence. Using Require: norefersub when capabilities are unknown is NOT RECOMMENDED, because an unsupporting recipient rejects the request with a 420 (Bad Extension) response and the issuer needs another round trip to fall back to a normal REFER. Require: norefersub can appear together with Refer-Sub: false.

You ask 'no reports, please'. The helper says 'okay, no reports' by repeating it, or stays quiet and reports anyway.

REQUEST AND GRANT
REFER with Refer-Sub: falseREFER-Issuer → REFER-RecipientAsks that no implicit subscription be created.
GRANTED BY
2xx with Refer-Sub: falseREFER-Recipient → REFER-IssuerGrants it: no subscription and no new dialog.

§5Forking and the Example

A REFER sent outside an existing dialog can fork, and a proxy may fork an unknown method. If forking happens, the issuer will not notice, because the forking proxy forwards only a single 2xx response. So the issuer is responsible for making sure no forking will result.

If a REFER to a Request-URI might fork, the issuer SHOULD NOT include Refer-Sub. It SHOULD use standardized mechanisms to prevent forking. Absent any other mechanism, the Request-URI SHOULD have GRUU properties, which ensure the request will not fork.

The RFC's example is a REFER with Refer-To: <sip:c@example.com;method=INVITE>, Refer-Sub: false and Supported: norefersub.

If your message might go to several people at once, you cannot skip the reports, because you would not know which one answered.

REFER THAT SUPPRESSES THE SUBSCRIPTION (RFC 4488, SECTION 6)
REFER with Refer-Sub: false
REFER sip:pc-b@example.com SIP/2.0
Via: SIP/2.0/TCP issuer.example.com;branch=z9hG4bK-a-1
From: <sip:a@example.com>;tag=1a
Call-ID: 1@issuer.example.com
CSeq: 234234 REFER
Max-Forwards: 70
Refer-To: <sip:c@example.com;method=INVITE>
Refer-Sub: false
Supported: norefersub
Contact: sip:a@issuer.example.com
Content-Length: 0

§6Security and IANA

A malicious Refer-Sub: false reduces the processing and state needed at the recipient, so the RFC sees limited use in denial-of-service attacks. A man in the middle, however, could add the header to suppress notifications without the issuer noticing, or remove it so the recipient generates notifications the issuer had suppressed. The RFC says integrity protection should be used, for example S/MIME as discussed in RFC 3261.

IANA registers the Refer-Sub header field (no compact form) and the norefersub option tag.

Someone sneaky could add or erase the 'no reports' note, so the message should be sealed against tampering.

§7References