]> Comprehensive Errata for the 'retransmission-allowed' XML Element Unaffiliated
Mars PA United States of America br@brianrosen.net
Comtech TCS
2401 Elliott Avenue Seattle WA 98121 United States of America jeff.martin@comtech.com
ART sipcore This document fixes use of the 'retransmission-allowed' element of PIDF-LO in six published RFCs. All text and examples should show 'true' or 'false' to match the XML schema definitions, but some RFCs incorrectly use 'yes' or 'no'. This document updates RFC4119, RFC5606, RFC5774, RFC6442, RFC7378, RFC8262.
Introduction The PIDF Location Object (PIDF-LO) format defined by includes the <retransmission-allowed> element. Section 2.2.5 "Schema Definitions" defines this element as a boolean data type as described in W3C's "XML Schema Part 2: Datatypes (Second Edition)" . As a boolean data type, <retransmission-allowed> can have the following values: 'true', 'false', '0', or '1'. Unfortunately the examples in the text of RFC 4119 used values 'yes' and 'no', which are not allowed per section 2.2.5 "Schema Definitions". This problem was reported in errata id 1535 in 2008, and verified in 2010. Since RFC 4119, there are another 13 RFCs with <retransmission-allowed> example text. Despite the errata for RFC 4119, 5 of these 13 RFCs repeated the incorrect use of 'yes' and 'no' in their examples of <retransmission-allowed>: , , , , and . The other 8 RFCs correctly use 'true' and 'false' in their examples: , , , , , , , and . Rather than submitting individual errata against those 5 RFCs' incorrect examples of <retransmission-allowed>, this document updates them all to replace all use of 'yes' with 'true', and all use of 'no' with 'false'. The original RFC 4119 is also updated here for completeness, to further confirm the existing errata id 1535 for RFC 4119. This also incorporates fixes to namespace issues in the <retransmission-allowed> examples in RFC4119 & RFC5774, as initially reported in errata id 1771. Finally, this incorporates all the fixes in errata ids 1535 & 1771 to RFC4119. In addition to the <retransmission-allowed> fixes discussed above, these two errata also have minor fixes for the discussion of elements <retention-expiry> & <ruleset-reference>, and namespace issues for the examples of <retention-expiry>.
Requirements Notation The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 when, and only when, they appear in all capitals, as shown here.
Additional Copyright Notice This document may contain material from IETF Documents or IETF Contributions published or made publicly available before November 10, 2008. The person(s) controlling the copyright in some of this material may not have granted the IETF Trust the right to allow modifications of such material outside the IETF Standards Process. Without obtaining an adequate license from the person(s) controlling the copyright in such materials, this document may not be modified outside the IETF Standards Process, and derivative works of it may not be created outside the IETF Standards Process, except to format it for publication as an RFC or to translate it into languages other than English.
Changes to Documents
RFC 4119 - A Presence-based GEOPRIV Location Object Format (PIDF-LO) section 2.2.2 page 8, replace:
  • 'retransmission-allowed': When the value of this element is 'no', the Recipient of this Location Object is not permitted to share the enclosed Location Information, or the object as a whole, with other parties. When the value of this element is 'yes', distributing this Location is permitted (barring an existing out-of-band agreement or obligation to the contrary). By default, the value MUST be assumed to be 'no'. Implementations MUST include this field, with a value of 'no', if the Rule Maker specifies no preference.
With:
  • 'retransmission-allowed': When the value of this element is 'false', the Recipient of this Location Object is not permitted to share the enclosed Location Information, or the object as a whole, with other parties. When the value of this element is 'true', distributing this Location is permitted (barring an existing out-of-band agreement or obligation to the contrary). By default, the value MUST be assumed to be 'false'. Implementations MUST include this field, with a value of 'false', if the Rule Maker specifies no preference.
And replace:
  • 'retention-expires': This field [...] in the 'retention-expires' element [...] 'ruleset-reference': This field [...] HTTPS-based ruleset-references into [...]
With:
  • 'retention-expiry': This field [...] in the 'retention-expiry' element [...] 'external-ruleset': This field [...] HTTPS-based external-ruleset into [...]
Section 2.3 "Example Location Objects", replace both occurrences of:
  • xmlns:gp="urn:ietf:params:xml:ns:pidf:geopriv10"
With:
  • xmlns:gp="urn:ietf:params:xml:ns:pidf:geopriv10" xmlns:gpb="urn:ietf:params:xml:ns:pidf:geopriv10:basicPolicy"
And replace:
  • <gp:retransmission-allowed>no</gp:retransmission-allowed> <gp:retention-expiry>2003-06-23T04:57:29Z</gp:retention-expiry>
With:
  • <gpb:retransmission-allowed>false</gpb:retransmission-allowed> <gpb:retention-expiry>2003-06-23T04:57:29Z</gpb:retention-expiry>
And replace:
  • <gp:retransmission-allowed>yes</gp:retransmission-allowed> <gp:retention-expiry>2003-06-23T04:57:29Z</gp:retention-expiry>
With: > <gpb:retransmission-allowed>yes</gpb:retransmission-allowed> > <gpb:retention-expiry>2003-06-23T04:57:29Z</gpb:retention-expiry>
RFC 5606 - Implications of 'retransmission-allowed' for SIP Location Conveyance Section 2, replace:
  • These questions and concerns are particularly problematic when <retransmission-allowed> is set to "no" (the default case). This core concern might be put as "to whom does <retransmission-allowed> apply in location-based routing?" More specifically: Is any entity that reads LI bound by <retransmission-allowed>? If so, does that mean a proxy that performs location-based routing is unable to forward a request and complete a SIP call if <retransmission-allowed> is "no"? Alternatively, must they strip the location body from the message in order to complete the call? If the proxy does not understand RFC 4119, it may forward a SIP message containing a policy statement <retransmission-allowed> set to "no". Is any proxy that does understand RFC 4119 required to parse the LI for this statement, even if it would not do so in order to route the message?
With:
  • These questions and concerns are particularly problematic when <retransmission-allowed> is set to "false" (the default case). This core concern might be put as "to whom does <retransmission-allowed> apply in location-based routing?" More specifically: Is any entity that reads LI bound by <retransmission-allowed>? If so, does that mean a proxy that performs location-based routing is unable to forward a request and complete a SIP call if <retransmission-allowed> is "false"? Alternatively, must they strip the location body from the message in order to complete the call? If the proxy does not understand RFC 4119, it may forward a SIP message containing a policy statement <retransmission-allowed> set to "false". Is any proxy that does understand RFC 4119 required to parse the LI for this statement, even if it would not do so in order to route the message?
Section 3.1, replace:
  • After extensive discussion in both GEOPRIV and SIP contexts, there seems to be consensus that a solution for this problem must enable location-based routing to work even when the <retransmission-allowed> flag is set to "no".
With:
  • After extensive discussion in both GEOPRIV and SIP contexts, there seems to be consensus that a solution for this problem must enable location-based routing to work even when the <retransmission-allowed> flag is set to "false".
Section 3.2, replace:
  • Because of this presumption, one SIP element may pass the LI to another even if the LO it contains has <retransmission-allowed> set to "no"; this sees the passing of the SIP message as part of the delivery to authorized recipients, rather than as retransmission. SIP entities are still enjoined from passing these messages outside the normal routing to external entities if <retransmission-allowed> is set to "no", as it is the passing to third parties that <retransmission-allowed> is meant to control.
With:
  • Because of this presumption, one SIP element may pass the LI to another even if the LO it contains has <retransmission-allowed> set to "false"; this sees the passing of the SIP message as part of the delivery to authorized recipients, rather than as retransmission. SIP entities are still enjoined from passing these messages outside the normal routing to external entities if <retransmission-allowed> is set to "false", as it is the passing to third parties that <retransmission-allowed> is meant to control.
Section 3.5, replace:
  • "Location-Routing-Allowed" being set to "No" has no protocol-level mechanism for enforcement of this behavior; like the PIDF-LO <retransmission-allowed> being set to "no", it is a way for the Rule Maker to express a preference to the SIP elements, which are LI recipients.
With:
  • "Location-Routing-Allowed" being set to "No" has no protocol-level mechanism for enforcement of this behavior; like the PIDF-LO <retransmission-allowed> being set to "false", it is a way for the Rule Maker to express a preference to the SIP elements, which are LI recipients.
Section 3.6, replace:
  • Where the B2BUA in fact does act as an endpoint (terminating the session and originating a different session), <retransmission-allowed> applies to it, and it must not copy location if <retransmission-allowed> is "no".
With:
  • Where the B2BUA in fact does act as an endpoint (terminating the session and originating a different session), <retransmission-allowed> applies to it, and it must not copy location if <retransmission-allowed> is "false".
RFC 5774 - Considerations for Civic Addresses in PIDF-LO: Guidelines and IANA Registry Definition Section A.5 "Example", replace:
  • xmlns:gp="urn:ietf:params:xml:ns:pidf:geopriv10"
With:
  • xmlns:gp="urn:ietf:params:xml:ns:pidf:geopriv10" xmlns:gpb="urn:ietf:params:xml:ns:pidf:geopriv10:basicPolicy"
And replace:
  • <gp:retransmission-allowed>yes</gp:retransmission-allowed> <gp:retention-expiry>2009-11-10T12:00:00Z</gp:retention-expiry>
With:
  • <gpb:retransmission-allowed>true</gpb:retransmission-allowed> <gpb:retention-expiry>2009-11-10T12:00:00Z</gpb:retention-expiry>
RFC 6442 - Location Conveyance for SIP section 4.4 page 18, replace:
  • This location error is specific to having the PIDF-LO <retransmission-allowed> element set to "no". This location error is stating it requires permission (i.e., PIDF-LO <retransmission-allowed> element set to "yes") to process this SIP request further. If the LS sending the location information does not want to give this permission, it will not change this permission in a new request. If the LS wants this message processed with the <retransmission-allowed> element set to "yes", it MUST choose another logical path (if one exists) for this SIP request.
With:
  • This location error is specific to having the PIDF-LO <retransmission-allowed> element set to "false". This location error is stating it requires permission (i.e., PIDF-LO <retransmission-allowed> element set to "true") to process this SIP request further. If the LS sending the location information does not want to give this permission, it will not change this permission in a new request. If the LS wants this message processed with the <retransmission-allowed> element set to "false", it MUST choose another logical path (if one exists) for this SIP request.
Errata id 4236 incorrectly includes the following text
  • Section 5.1, 5.2 says:
    • <gbp:retransmission-allowed>false
      </gbp:retransmission-allowed>
    It should say:
    • <gbp:retransmission-allowed>no
      </gbp:retransmission-allowed>
Sections 5.1 and 5.2 of RFC6442 are correct without any need for this errata id 4236. This errata should be ignored.
RFC 7378 - Trustworthy Location section 6 page 25, replace:
  • as noted in RFC5606, Section 3.2:
    • ... Because of this presumption, one SIP element may pass the LI to another even if the LO it contains has <retransmission-allowed> set to "no"; this sees the passing of the SIP message as part of the delivery to authorized recipients, rather than as retransmission. SIP entities are still enjoined from passing these messages outside the normal routing to external entities if <retransmission-allowed> is set to "no", as it is the passing to third parties that <retransmission-allowed> is meant to control.
With:
  • as noted in RFC5606, Section 3.2:
    • ... Because of this presumption, one SIP element may pass the LI to another even if the LO it contains has <retransmission-allowed> set to "false"; this sees the passing of the SIP message as part of the delivery to authorized recipients, rather than as retransmission. SIP entities are still enjoined from passing these messages outside the normal routing to external entities if <retransmission-allowed> is set to "false", as it is the passing to third parties that <retransmission-allowed> is meant to control.
RFC 8262 - Content-ID Header Field in SIP section 1.4.1 "Example 1", replace:
  • <gbp:retransmission-allowed>no
    </gbp:retransmission-allowed>
With:
  • <gbp:retransmission-allowed>false
    </gbp:retransmission-allowed>
General guidance to implementers Implementations that create <retransmission-allowed> MUST use only values 'true', 'false', '0', or '1' as required by the schema in section 2.2.5 of . Implementations that create SHOULD use only values 'true' and 'false'. Implementations that accept <retransmission-allowed> MUST handle values 'true', 'false', '0', and '1'. Implementations that accept SHOULD treat values 'yes' & 'no' as synonyms for 'true' & 'false'.
Security Considerations The changes in this document do not require additional security considerations beyond those already noted in the individual RFCs affected by this RFC.
IANA Considerations None
References Normative References A Presence-based GEOPRIV Location Object Format This document describes an object format for carrying geographical information on the Internet. This location object extends the Presence Information Data Format (PIDF), which was designed for communicating privacy-sensitive presence information and which has similar properties. [STANDARDS-TRACK] Implications of 'retransmission-allowed' for SIP Location Conveyance This document explores an ambiguity in the interpretation of the element of the Presence Information Data Format for Location Objects (PIDF-LO) in cases where PIDF-LO is conveyed by the Session Initiation Protocol (SIP). It provides recommendations for how the SIP location conveyance mechanism should adapt to this ambiguity. Documents standardizing the SIP location conveyance mechanisms will be Standards-Track documents processed according to the usual SIP process. This document is intended primarily to provide the SIP working group with a statement of the consensus of the GEOPRIV working group on this topic. It secondarily provides tutorial information on the problem space for the general reader. This memo provides information for the Internet community. Considerations for Civic Addresses in the Presence Information Data Format Location Object (PIDF-LO): Guidelines and IANA Registry Definition This document provides a guideline for creating civic address considerations documents for individual countries, as required by RFC 4776. Furthermore, this document also creates an IANA Registry referring to such address considerations documents and registers such address considerations for Austria. This memo documents an Internet Best Current Practice. Location Conveyance for the Session Initiation Protocol This document defines an extension to the Session Initiation Protocol (SIP) to convey geographic location information from one SIP entity to another SIP entity. The SIP extension covers end-to-end conveyance as well as location-based routing, where SIP intermediaries make routing decisions based upon the location of the Location Target. [STANDARDS-TRACK] Trustworthy Location The trustworthiness of location information is critically important for some location-based applications, such as emergency calling or roadside assistance. This document describes threats to conveying location, particularly for emergency calls, and describes techniques that improve the reliability and security of location information. It also provides guidelines for assessing the trustworthiness of location information. Content-ID Header Field in the Session Initiation Protocol (SIP) This document specifies the Content-ID header field for usage in the Session Initiation Protocol (SIP). This document also updates RFC 5621, which only allows a Content-ID URL to reference a body part that is part of a multipart message-body. This update enables a Content-ID URL to reference a complete message-body and metadata provided by some additional SIP header fields. This document updates RFC 5368 and RFC 6442 by clarifying their usage of the SIP Content-ID header field. XML Schema Part 2: Datatypes Second Edition See section 3.2.2 boolean Key words for use in RFCs to Indicate Requirement Levels In many standards track documents several words are used to signify the requirements in the specification. These words are often capitalized. This document defines these words as they should be interpreted in IETF documents. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements. Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words RFC 2119 specifies common key words that may be used in protocol specifications. This document aims to reduce the ambiguity by clarifying that only UPPERCASE usage of the key words have the defined special meanings. Informative References Carrying Location Objects in RADIUS and Diameter This document describes procedures for conveying access-network ownership and location information based on civic and geospatial location formats in Remote Authentication Dial-In User Service (RADIUS) and Diameter. The distribution of location information is a privacy-sensitive task. Dealing with mechanisms to preserve the user's privacy is important and is addressed in this document. [STANDARDS-TRACK] HTTP-Enabled Location Delivery (HELD) This document defines a Layer 7 Location Configuration Protocol (L7 LCP) and describes the use of HTTP and HTTP/TLS as transports for the L7 LCP. The L7 LCP is used for retrieving location information from a server within an access network. It includes options for retrieving location information in two forms: by value and by reference. The protocol is an extensible application-layer protocol that is independent of the session layer. [STANDARDS-TRACK] Multi-Threaded Routing Toolkit (MRT) Border Gateway Protocol (BGP) Routing Information Export Format with Geo-Location Extensions This document updates the Multi-threaded Routing Toolkit (MRT) export format for Border Gateway Protocol (BGP) routing information by extending it to include optional terrestrial coordinates of a BGP collector and its BGP peers. [STANDARDS-TRACK] A Location Dereference Protocol Using HTTP-Enabled Location Delivery (HELD) This document describes how to use the Hypertext Transfer Protocol (HTTP) over Transport Layer Security (TLS) as a dereference protocol to resolve a reference to a Presence Information Data Format Location Object (PIDF-LO). This document assumes that a Location Recipient possesses a URI that can be used in conjunction with the HTTP-Enabled Location Delivery (HELD) protocol to request the location of the Target. [STANDARDS-TRACK] Geolocation Policy: A Document Format for Expressing Privacy Preferences for Location Information This document defines an authorization policy language for controlling access to location information. It extends the Common Policy authorization framework to provide location-specific access control. More specifically, this document defines condition elements specific to location information in order to restrict access to data based on the current location of the Target. Furthermore, this document defines two algorithms for reducing the granularity of returned location information. The first algorithm is defined for usage with civic location information, whereas the other one applies to geodetic location information. Both algorithms come with limitations. There are circumstances where the amount of location obfuscation provided is less than what is desired. These algorithms might not be appropriate for all application domains. [STANDARDS-TRACK] Location Configuration Extensions for Policy Management Current location configuration protocols are capable of provisioning an Internet host with a location URI that refers to the host's location. These protocols lack a mechanism for the target host to inspect or set the privacy rules that are applied to the URIs they distribute. This document extends the current location configuration protocols to provide hosts with a reference to the rules that are applied to a URI so that the host can view or set these rules. Additional Data Related to an Emergency Call When an emergency call is sent to a Public Safety Answering Point (PSAP), the originating device, the access network provider to which the device is connected, and all service providers in the path of the call have information about the call, the caller, or the location, which is helpful for the PSAP to have in handling the emergency. This document describes data structures and mechanisms to convey such data to the PSAP. The intent is that every emergency call carry as much of the information described here as possible using the mechanisms described here. The mechanisms permit the data to be conveyed by reference (as an external resource) or by value (within the body of a SIP message or a location object). This follows the tradition of prior emergency services standardization work where data can be conveyed by value within the call signaling (i.e., in the body of the SIP message) or by reference. Non-interactive Emergency Calls Use of the Internet for emergency calling is described in RFC 6443, 'Framework for Emergency Calling Using Internet Multimedia'. In some cases of emergency calls, the transmission of application data is all that is needed, and no interactive media channel is established: a situation referred to as 'non-interactive emergency calls', where, unlike most emergency calls, there is no two-way interactive media such as voice or video or text. This document describes use of a SIP MESSAGE transaction that includes a container for the data based on the Common Alerting Protocol (CAP). That type of emergency request does not establish a session, distinguishing it from SIP INVITE, which does. Any device that needs to initiate a request for emergency services without an interactive media channel would use the mechanisms in this document.
Contributors Comtech TCS
2401 Elliott Avenue Seattle WA 98121 United States of America skip.hines@comtech.com
Comtech TCS
2401 Elliott Avenue Seattle WA 98121 United States of America roger.marshall@comtech.com
Comtech TCS
2401 Elliott Avenue Seattle WA 98121 United States of America victor.burton@comtech.com