idnits 2.17.1 draft-ietf-sipping-config-framework-05.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- ** It looks like you're using RFC 3978 boilerplate. You should update this to the boilerplate described in the IETF Trust License Policy document (see https://trustee.ietf.org/license-info), which is required now. -- Found old boilerplate from RFC 3667, Section 5.1 on line 14. -- Found old boilerplate from RFC 3978, Section 5.5 on line 1482. -- Found old boilerplate from RFC 3979, Section 5, paragraph 1 on line 1454. -- Found old boilerplate from RFC 3979, Section 5, paragraph 2 on line 1461. -- Found old boilerplate from RFC 3979, Section 5, paragraph 3 on line 1467. ** Found boilerplate matching RFC 3978, Section 5.4, paragraph 1 (on line 1488), which is fine, but *also* found old RFC 2026, Section 10.4C, paragraph 1 text on line 36. ** The document seems to lack an RFC 3978 Section 5.1 IPR Disclosure Acknowledgement -- however, there's a paragraph with a matching beginning. Boilerplate error? ** This document has an original RFC 3978 Section 5.4 Copyright Line, instead of the newer IETF Trust Copyright according to RFC 4748. ** This document has an original RFC 3978 Section 5.5 Disclaimer, instead of the newer disclaimer which includes the IETF Trust according to RFC 4748. ** The document uses RFC 3667 boilerplate or RFC 3978-like boilerplate instead of verbatim RFC 3978 boilerplate. After 6 May 2005, submission of drafts without verbatim RFC 3978 boilerplate is not accepted. The following non-3978 patterns matched text found in the document. That text should be removed or replaced: By submitting this Internet-Draft, I certify that any applicable patent or other IPR claims of which I am aware have been disclosed, or will be disclosed, and any of which I become aware will be disclosed, in accordance with RFC 3668. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- == No 'Intended status' indicated for this document; assuming Proposed Standard Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** The document seems to lack separate sections for Informative/Normative References. All references will be assumed normative when checking for downward references. == There are 2 instances of lines with private range IPv4 addresses in the document. If these are generic example addresses, they should be changed to use any of the ranges defined in RFC 6890 (or successor): 192.0.2.x, 198.51.100.x or 203.0.113.x. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the RFC 3978 Section 5.4 Copyright Line does not match the current year == Line 506 has weird spacing: '...ication of pr...' == Line 870 has weird spacing: '...hat the admin...' == Line 1337 has weird spacing: '...Changes in XM...' == The document seems to lack the recommended RFC 2119 boilerplate, even if it appears to use RFC 2119 keywords. (The document does seem to have the reference to RFC 2119 which the ID-Checklist requires). -- The document seems to lack a disclaimer for pre-RFC5378 work, but may have content which was first submitted before 10 November 2008. If you have contacted all the original authors and they are all willing to grant the BCP78 rights to the IETF Trust, then this is fine, and you can ignore this comment. If not, you may need to add the pre-RFC5378 disclaimer. (See the Legal Provisions document at https://trustee.ietf.org/license-info for more information.) -- The document date (October 24, 2004) is 7121 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) == Unused Reference: 'RFC2131' is defined on line 1381, but no explicit reference was found in the text == Unused Reference: 'RFC2132' is defined on line 1384, but no explicit reference was found in the text == Unused Reference: 'RFC2246' is defined on line 1389, but no explicit reference was found in the text == Outdated reference: A later version (-12) exists of draft-ietf-simple-xcap-04 == Outdated reference: A later version (-05) exists of draft-ietf-simple-xcap-list-usage-04 == Outdated reference: A later version (-03) exists of draft-ietf-simple-xcap-package-02 -- Possible downref: Normative reference to a draft: ref. 'I-D.ietf-simple-xcap-package' == Outdated reference: A later version (-15) exists of draft-ietf-sip-gruu-02 -- Possible downref: Normative reference to a draft: ref. 'I-D.ietf-sipping-ua-prof-framewk-reqs' == Outdated reference: A later version (-05) exists of draft-petrie-sipping-profile-datasets-00 == Outdated reference: A later version (-08) exists of draft-sinnreich-sipdev-req-04 ** Downref: Normative reference to an Informational draft: draft-sinnreich-sipdev-req (ref. 'I-D.sinnreich-sipdev-req') ** Obsolete normative reference: RFC 822 (Obsoleted by RFC 2822) ** Obsolete normative reference: RFC 2141 (Obsoleted by RFC 8141) ** Obsolete normative reference: RFC 2246 (Obsoleted by RFC 4346) ** Obsolete normative reference: RFC 2396 (Obsoleted by RFC 3986) ** Obsolete normative reference: RFC 2616 (Obsoleted by RFC 7230, RFC 7231, RFC 7232, RFC 7233, RFC 7234, RFC 7235) ** Obsolete normative reference: RFC 2617 (Obsoleted by RFC 7235, RFC 7615, RFC 7616, RFC 7617) ** Obsolete normative reference: RFC 2818 (Obsoleted by RFC 9110) ** Obsolete normative reference: RFC 3265 (Obsoleted by RFC 6665) ** Obsolete normative reference: RFC 3377 (Obsoleted by RFC 4510) Summary: 17 errors (**), 0 flaws (~~), 16 warnings (==), 9 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 1 SIPPING D. Petrie 2 Internet-Draft Pingtel Corp. 3 Expires: April 24, 2005 October 24, 2004 5 A Framework for Session Initiation Protocol User Agent Profile 6 Delivery 7 draft-ietf-sipping-config-framework-05.txt 9 Status of this Memo 11 By submitting this Internet-Draft, I certify that any applicable 12 patent or other IPR claims of which I am aware have been disclosed, 13 and any of which I become aware will be disclosed, in accordance with 14 RFC 3668. 16 Internet-Drafts are working documents of the Internet Engineering 17 Task Force (IETF), its areas, and its working groups. Note that 18 other groups may also distribute working documents as 19 Internet-Drafts. 21 Internet-Drafts are draft documents valid for a maximum of six months 22 and may be updated, replaced, or obsoleted by other documents at any 23 time. It is inappropriate to use Internet-Drafts as reference 24 material or to cite them other than as "work in progress." 26 The list of current Internet-Drafts can be accessed at 27 http://www.ietf.org/ietf/1id-abstracts.txt. 29 The list of Internet-Draft Shadow Directories can be accessed at 30 http://www.ietf.org/shadow.html. 32 This Internet-Draft will expire on April 24, 2005. 34 Copyright Notice 36 Copyright (C) The Internet Society (2004). All Rights Reserved. 38 Abstract 40 This document defines the application of a set of protocols for 41 providing profile data to SIP user agents. The objective is to 42 define a means for automatically providing profile data a user agent 43 needs to be functional without user or administrative intervention. 44 The framework for discovery, delivery, notification and updates of 45 user agent profile data is defined here. As part of this framework a 46 new SIP event package is defined here for the notification of profile 47 changes. This framework is also intended to ease ongoing 48 administration and upgrading of large scale deployments of SIP user 49 agents. The contents and format of the profile data to be defined is 50 outside the scope of this document. 52 Table of Contents 54 1. Motivation . . . . . . . . . . . . . . . . . . . . . . . . . 4 55 2. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 4 56 2.1 Requirements Terminology . . . . . . . . . . . . . . . . . 4 57 2.2 Profile Delivery Framework Terminology . . . . . . . . . . 5 58 2.3 Overview . . . . . . . . . . . . . . . . . . . . . . . . . 5 59 3. Profile Change Event Notification Package . . . . . . . . . 8 60 3.1 Event Package Name . . . . . . . . . . . . . . . . . . . . 8 61 3.2 Event Package Parameters . . . . . . . . . . . . . . . . . 8 62 3.3 SUBSCRIBE Bodies . . . . . . . . . . . . . . . . . . . . . 12 63 3.4 Subscription Duration . . . . . . . . . . . . . . . . . . 12 64 3.5 NOTIFY Bodies . . . . . . . . . . . . . . . . . . . . . . 12 65 3.6 Notifier processing of SUBSCRIBE requests . . . . . . . . 13 66 3.7 Notifier generation of NOTIFY requests . . . . . . . . . . 14 67 3.8 Subscriber processing of NOTIFY requests . . . . . . . . . 14 68 3.9 Handling of forked requests . . . . . . . . . . . . . . . 15 69 3.10 Rate of notifications . . . . . . . . . . . . . . . . . 15 70 3.11 State Agents . . . . . . . . . . . . . . . . . . . . . . 15 71 3.12 Examples . . . . . . . . . . . . . . . . . . . . . . . . 15 72 3.13 Use of URIs to Retrieve State . . . . . . . . . . . . . 16 73 3.13.1 Device URIs . . . . . . . . . . . . . . . . . . . . 17 74 3.13.2 User and Application URIs . . . . . . . . . . . . . 18 75 3.13.3 Local Network URIs . . . . . . . . . . . . . . . . . 18 76 4. Profile Delivery Framework Details . . . . . . . . . . . . . 19 77 4.1 Discovery of Subscription URI . . . . . . . . . . . . . . 19 78 4.1.1 Discovery of Local Network URI . . . . . . . . . . . . 19 79 4.1.2 Discovery of Device URI . . . . . . . . . . . . . . . 20 80 4.1.3 Discovery of User and Application URI . . . . . . . . 22 81 4.2 Enrollment with Profile Server . . . . . . . . . . . . . . 22 82 4.3 Notification of Profile Changes . . . . . . . . . . . . . 23 83 4.4 Retrieval of Profile Data . . . . . . . . . . . . . . . . 23 84 4.5 Upload of Profile Changes . . . . . . . . . . . . . . . . 23 85 4.6 Usage of XCAP with the Profile Package . . . . . . . . . . 23 86 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . 26 87 5.1 SIP Event Package . . . . . . . . . . . . . . . . . . . . 26 88 6. Security Considerations . . . . . . . . . . . . . . . . . . 26 89 6.1 Symmetric Encryption of Profile Data . . . . . . . . . . . 27 90 7. Change History . . . . . . . . . . . . . . . . . . . . . . . 27 91 7.1 Changes from draft-ietf-sipping-config-framework-04.txt . 27 92 7.2 Changes from draft-ietf-sipping-config-framework-03.txt . 27 93 7.3 Changes from draft-ietf-sipping-config-framework-02.txt . 28 94 7.4 Changes from draft-ietf-sipping-config-framework-01.txt . 28 95 7.5 Changes from draft-ietf-sipping-config-framework-00.txt . 28 96 7.6 Changes from 97 draft-petrie-sipping-config-framework-00.txt . . . . . . . 29 98 7.7 Changes from draft-petrie-sip-config-framework-01.txt . . 29 99 7.8 Changes from draft-petrie-sip-config-framework-00.txt . . 29 100 8. References . . . . . . . . . . . . . . . . . . . . . . . . . 30 101 Author's Address . . . . . . . . . . . . . . . . . . . . . . 32 102 A. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . 32 103 Intellectual Property and Copyright Statements . . . . . . . 33 105 1. Motivation 107 Today all SIP user agent implementers use proprietary means of 108 delivering user, device, application and local network policy 109 profiles to the user agent. The profile delivery framework defined 110 in this document is intended to enable a first phase migration to a 111 standard means of providing profiles to SIP user agents. It is 112 expected that UA implementers will be able to use this framework as a 113 means of delivering their existing proprietary data profiles (i.e. 114 using their existing proprietary binary or text formats). This in 115 itself is a tremendous advantage in that a SIP environment can use a 116 single profile delivery server for profile data to user agents from 117 multiple implementers. Follow-on standardization activities can: 118 1. define a standard profile content format framework (e.g. XML 119 with namespaces [W3C.REC-xml-names11-20040204] or name-value 120 pairs [RFC0822]). 121 2. specify the content (i.e. name the profile data parameters, xml 122 schema, name spaces) of the data profiles. 124 One of the objectives of the framework described in this document is 125 to provide a start up experience similar to that of users of an 126 analog telephone. When you plug in an analog telephone it just works 127 (assuming the line is live and the switch has been provisioned). 128 There is no end user configuration required to make analog phone 129 work, at least in a basic sense. So the objective here is to be able 130 to take a new SIP user agent out of the box, plug it in or install 131 the software and have it get its profiles without human intervention 132 other than security measures. This is necessary for cost effective 133 deployment of large numbers of user agents. 135 Another objective is to provide a scalable means for ongoing 136 administration of profiles. Administrators and users are likely to 137 want to make changes to profiles. 139 Additional requirements for the framework defined in this document 140 are described in: [I-D.ietf-sipping-ua-prof-framewk-reqs], 141 [I-D.sinnreich-sipdev-req] 143 2. Introduction 145 2.1 Requirements Terminology 147 Keywords "MUST", "MUST NOT", "REQUIRED", "SHOULD", "SHOULD NOT" and 148 "MAY" that appear in this document are to be interpreted as described 149 in [RFC2119]. 151 2.2 Profile Delivery Framework Terminology 153 profile - data set specific to a user, device, user's application or 154 the local network. 155 device - software or hardware appliance containing one or more SIP 156 user agent. 157 profile content server - The server that provides the content of the 158 profiles using the protocol specified by the URI scheme. 159 notifier - As defined in [RFC3265] the SIP user agent server which 160 processes SUBSCRIBE requests for events and sends NOTIFY requests 161 with profile data or URI(s) that point to the data. 162 profile delivery server - The logical collection of the notifier and 163 the server which provides the contents of the notification either 164 directly in the NOTIFY requests or indirectly via profile URI(s). 166 2.3 Overview 168 The profile life cycle can be described by five functional steps. 169 These steps are not necessarily discrete. However it is useful to 170 describe these steps as logically distinct. These steps are named as 171 follows: 173 Discovery - discover a profile delivery server 174 Enrollment - enroll with the profile delivery server 175 Profile Retrieval - retrieve profile data 176 Profile Change Notification - receive notification of profile changes 177 Profile Change Upload - upload profile data changes back to the 178 profile delivery server 180 Discovery is the process by which a UA finds the address and port at 181 which it enrolls with the profile delivery server. As there is no 182 single discovery mechanism which will work in all network 183 environments, a number of discovery mechanisms are defined with a 184 prescribed order in which the UA tries them until one succeeds. 186 Enrollment is the process by which a UA makes itself known to the 187 profile delivery server. In enrolling the UA provides identity 188 information, requested profile type(s) and supported protocols for 189 profile retrieval. It also subscribes to a mechanism for 190 notification of profile changes. As a result of enrollment, the UA 191 receives the data or the URI for each of the profiles that the 192 profile delivery server is able to provide. Each profile type (set) 193 requires a separate enrollment or SUBSCRIBE session. A profile type 194 may represent one or more data sets (e.g. one profile data set for 195 each of a user's applications). 197 Profile Retrieval is the process of retrieving the content for each 198 of the profiles the UA requested. 200 Profile Change Notification is the process by which the profile 201 delivery server notifies the UA that the content of one or more of 202 the profiles has changed. If the content is provided indirectly the 203 UA MAY retrieve the profile from the specified URI upon receipt of 204 the change notification. 206 Profile Change Upload is the process by which a UA or other entity 207 (e.g. OSS, corporate directory or configuration management server) 208 pushes a change to the profile data back up to the profile delivery 209 server. 211 This framework defines a new SIP event package [RFC3265] to solve 212 enrollment and profile change notification steps. This event package 213 defines everything but the mandatory content type. This makes this 214 event package abstract until the content type is bound. The profile 215 content type(s) will be defined outside the scope of this document. 216 It is the author's belief that it would be a huge accomplishment if 217 all SIP user agent used this framework for delivering their existing 218 proprietary profiles. Even though this does not accomplish 219 interoperability of profiles, it is a big first step in easing the 220 administration of SIP user agents. The definition of standard 221 profiles and data sets (see [I-D.petrie-sipping-profile-datasets] ) 222 will enable interoperability as a subsequent step. 224 The question arises as to why SIP should be used for the profile 225 delivery framework. In this document SIP is used for only a small 226 portion of the framework. Other existing protocols are more 227 appropriate for transport of the profile contents (to and from the 228 user agent) and are suggested in this document. The discovery step 229 is simply a specified order and application of existing protocols. 230 SIP is only needed for the enrollment and change notification 231 functionality of the profile delivery framework. In many SIP 232 environments (e.g. carrier/subscriber and multi-site enterprise) 233 firewall, NAT and IP addressing issues make it difficult to get 234 messages between the profile delivery server and the user agent 235 requiring the profiles. 237 With SIP the users and devices already are assigned globally routable 238 addresses. In addition the firewall and NAT problems are already 239 presumably solved in the environments in which SIP user agents are to 240 be used. Therefore SIP is the best solution for allowing the user 241 agent to enroll with the profile delivery server, which may require 242 traversal of multiple firewalls and NATs. For the same reason the 243 notification of profile changes is best solved by SIP. It should be 244 noted that this document is scoped to providing profiles for devices 245 which contain one or more SIP user agents. This framework may be 246 applied to non-SIP devices, however more general requirements for 247 non-SIP devices are beyond the scope of this document. 249 The content delivery server may be either in the public network or 250 accessible through a DMZ. The user agents requiring profiles may be 251 behind firewalls and NATs and many protocols, such as HTTP, may be 252 used for profile content retrieval without special consideration in 253 the firewalls and NATs (e.g. an HTTP client on the UA can typically 254 pull content from a server outside the NAT/firewall.). 256 A conscious separation of device, user, application and local network 257 profiles is made in this document. This is useful to provide 258 features such as hotelling as well as securing or restricting user 259 agent functionality. By maintaining this separation, a user may walk 260 up to someone else's user agent and direct that user agent to get the 261 new user's profile data. In doing so the user agent can replace the 262 previous user's profile data while still keeping the device's and the 263 local network's profile data which may be necessary for core 264 functionality and communication described in this document. The 265 local network profiles are relevant to a visiting device which gets 266 plugged in to a foreign network. The concept of the local network 267 providing profile data is useful to provide hotelling (described 268 above) as well as local policy data that may constrain the user or 269 device behavior relative to the local network. For example media 270 types and codecs may be constrained to reflect the network's 271 capabilities. 273 The separation of these profiles also enables the separation of the 274 management of the profiles. The user profile may be managed by a 275 profile delivery server operated by the user's ISP. The device 276 profile may be delivered from a profile delivery server operated by 277 the user's employer. The application profile(s) may be delivered 278 from the user's ASP. The local network profile may delivered by a 279 WIFI hotspot service provider. Some interesting services and 280 mobility applications are enabled with this separation of profiles. 282 A very high level data model is implied here with the separation of 283 these four profile types. Each profile type instance requires a 284 separate subscription to retrieve the profile. A loose hierarchy 285 exists mostly for the purpose of boot strapping and discovery or 286 formation of the profile URIs. No other meaning is implied by this 287 hierarchy. However the profile format and data sets to be defined 288 outside this document may define additional meaning to this 289 hierarchy. In the boot strapping scenario, a device straight out of 290 the box (software or hardware) does not know anything about it's user 291 or local network. The one thing that is does know is it's instance 292 id. So the hierarchy of the profiles exists as follows. 294 The instance id is used to form the user id part of the URI for 295 subscribing to the device profile. The device profile may contain a 296 default user AOR for that device. The default user AOR may then be 297 used to retrieve the user profile. Applications to be used on the 298 device may be defined in the device and user profiles. The user's 299 AOR is also used to retrieve any application profiles for that user. 300 The local network profile is not referenced in any way from the 301 device, user, application profiles. It is subscribed to and 302 retrieved based upon a URI formed from the local network domain. 304 3. Profile Change Event Notification Package 306 This section defines a new SIP event package [RFC3265]. The purpose 307 of this event package is to send to subscribers notification of 308 content changes to the profile(s) of interest and to provide the 309 location of the profile(s) via content indirection 310 [I-D.ietf-sip-content-indirect-mech] or directly in the body of the 311 NOTIFY. Frequently the profiles delivered to the user agent are much 312 larger (e.g. several KB or even several MB) than the MTU of the 313 network. These larger profiles will cause larger than normal SIP 314 messages and consequently higher impact on the SIP servers and 315 infrastructure. To avoid the higher impact and load on the SIP 316 infrastructure, content indirection SHOULD be used if the profile is 317 large enough to cause packet fragmentation over the transport 318 protocol. The presence of the MIME type for content indirection 319 [I-D.ietf-sip-content-indirect-mech] in the Accept header indicates 320 that the user agent supports content indirection and that the profile 321 delivery server SHOULD use content indirection. Similarly the 322 content type for the differential notification of profile changes 323 [I-D.ietf-simple-xcap-package] may be used in the Accept header to 324 express support for receiving profile change deltas. 326 The MIME types or formats of profile to be delivered via this 327 framework are to be defined in the documents that define the profile 328 contents. These profile MIME types specified in the Accept header 329 along with the profile types specified in the Event header parameter 330 "profile-type" MAY be used to specify which profiles get delivered 331 either directly or indirectly in the NOTIFY requests. As this event 332 package does not specify the mandatory content type, this package is 333 abstract. The profile definition documents will specify the 334 mandatory content type to make a concrete event package. 336 3.1 Event Package Name 338 The name of this package is "sip-profile". This value appears in the 339 Event header field present in SUBSCRIBE and NOTIFY requests for this 340 package as defined in [RFC3265]. 342 3.2 Event Package Parameters 344 This package defines the following new parameters for the event 345 header: "profile-type", "vendor", "model", "version", "effective-by", 346 "document", "app-id", "network-user". The "effective-by" parameter 347 is for use in NOTIFY requests only. The "effected-by" parameter is 348 ignored if it appears in a SUBSCRIBE request. The others parameters 349 are for use in the SUBSCRIBE request and are ignored if they appear 350 in NOTIFY requests. 352 The "profile-type" parameter is used to indicate the token name of 353 the profile type the user agent wishes to obtain data or URIs for and 354 to be notified of subsequent changes. Using a token in this 355 parameter allows the URI semantics for retrieving the profiles to be 356 opaque to the subscribing user agent. All it needs to know is the 357 token value for this parameter. This document defines four logical 358 types of profiles and their token names. The contents or format of 359 the profiles is outside the scope of this document. 361 The four types of profiles define here are "device", "user", 362 "application" and "local". Specifying "device" type profile(s) 363 indicates the desire for the profile data (URI when content 364 indirection is used) and change notification of the contents of the 365 profile(s) that are specific to the device or user agent. Specifying 366 "user" type profile indicates the desire for the profile data (URI 367 when content indirection is used) and change notification of the 368 profile content for the user. Specifying "application" type profile 369 indicates the desire for the profile data (URI when content 370 indirection is used) and change notification of the profile content 371 for the user's applications. Specifying "local" type profile 372 indicates the desire for profiles data (URI when content indirection 373 is used) specific to the local network. The device, user, 374 application or local network is identified in the URI of the 375 SUBSCRIBE request. The Accept header of the SUBSCRIBE request MUST 376 include the MIME types for all profile content types for which the 377 subscribing user agent wishes to retrieve profiles or receive change 378 notifications. 380 Profile-type = "profile-type" HCOLON profile-value 381 profile-value = profile-types / token 382 profile-types = "device" / "user" / "application" / "local" 384 The "device", "user", "application" or "local" token in the 385 profile-type parameter may represent a class or set of profile 386 properties. As standards are defined for specific profile 387 contents related to the user device or local network, it may be 388 desirable to define additional tokens for the profile-type 389 parameter. Also additional content types may be defined along 390 with the profile formats that can be used in the Accept header of 391 the SUBSCRIBE to filter or indicate what data sets of the profile 392 are desired. 394 The rational for the separation of user, device, application and 395 local network type profiles is provided in Section 2.3. It should be 396 noted that any of the types may result in zero or more profiles or 397 URIs being provided in the NOTIFY request. As discussed, a default 398 user may be assigned to a device. The default user's AOR may in turn 399 be used as the URI to SUBSCRIBE to the "user" and "application" 400 profile types. 402 The data provided in the four types of profiles may overlap. As an 403 example the codecs that a user prefers to use, the codecs that the 404 device supports (and the enterprise or device owner wishes to use), 405 the codecs that the local network can support (and the network 406 operator wishes to allow) all may overlap in how they are specified 407 in the three corresponding profiles. This policy of merging the 408 constraints across the multiple profile types can only unambiguously 409 be defined along with the profile format and syntax. This is out of 410 scope for this document. 412 The "vendor", "model" and "version" parameter values are tokens 413 specified by the implementer of the user agent. These parameters 414 MUST be provided in the SUBSCRIBE request for all profile types. 415 These parameters are useful to the profile delivery server to affect 416 the profiles provided. In some scenarios it is desirable to provide 417 different profiles based upon these parameters. For example feature 418 property X in a profile may work differently on two versions of user 419 agent. This gives the profile delivery server the ability to 420 compensate for or take advantage of the differences. 422 Vendor = "vendor" HCOLON token / quoted-string 423 Model = "model" HCOLON token / quoted-string 424 Version = "version" HCOLON token / quoted-string 426 The "network-user" parameter MAY be used when subscribing for device 427 and local network profiles. When the profile-type is "device" or 428 "local" , the SUBSCRIBE URI addresses the device or local network 429 profile delivery server. It by design cannot indicate the user's 430 identity. The "network-user" parameter is used to indicate the 431 user's AOR. The SUBSCRIBE server may authenticate the subscriber to 432 verify this AOR. If the value of the "profile-type" parameter is not 433 "device" or "local", the "network-user" parameter has no defined 434 meaning and is ignored. 436 Network-User = "network-user" HCOLON name-addr / addr-spec 438 When the profile-type is "device", the user agent MAY set the 439 "network-user" parameter to the user's AOR. This is an indication to 440 the profile delivery server to set or change the association of the 441 default user with the device indicated in the SUBSCRIBE URI. If the 442 profile delivery server implements and allows this policy of setting 443 the default user with a device, the user agent can utilize this 444 mechanism to allow a user to login and make the user agent and user 445 association stick. 447 In the case where the profile-type is "local", the user agent MAY set 448 the "network-user" parameter. If the user has special privileges 449 beyond that of an anonymous user in the local network, the 450 "network-user" parameter identifies the user to the local network. 451 The value of this parameter is the user's address of record. 453 The "effective-by" parameter in the Event header of the NOTIFY 454 request specifies the maximum number of seconds before the user agent 455 must attempt to make the new profile effective. A value of 0 (zero) 456 indicates that the subscribing user agent must attempt to make the 457 profiles effective immediately (despite possible service 458 interruptions). This gives the profile delivery server the power to 459 control when the profile is effective. This may be important to 460 resolve an emergency problem or disable a user agent immediately. 461 The "effective-by" parameter is ignored in all messages other than 462 the NOTIFY request. 464 Effective-By = "effective-by" HCOLON 1*DIGIT 466 The "document" parameter is used to specify a relative URI for a 467 specific profile document that the user agent wishes to retrieve and 468 to receive change notification. This is particularly useful for 469 profile content like XCAP [I-D.ietf-simple-xcap] where there is a 470 well defined URI schema and the user agent knows the specific content 471 that it wants. The "document" parameter value syntax is a quoted 472 string. For more details on the use of this package with XCAP see 473 Section 4.6. The "document" parameter MAY be set in SUBSCRIBE 474 requests. It is ignored in all other messages. 476 Document = "document" HCOLON quoted-string 478 The "app-id" parameter MAY be set when the "profile-type" parameter 479 value is "application". The "app-id" indicates that the user agent 480 wishes to retrieve the profile data or URI and change notification 481 for the application profile data for the specific application 482 indicated in the value of the "app-id" parameter. The "app-id" 483 parameter value is a token. The "app-id" parameter has meaning only 484 in SUBSCRIBE requests when the "profile-type" Event header parameter 485 is set to "application". The "app-id" parameter is ignored in all 486 other messages. 488 App-Id = "app-id" HCOLON token / quoted-string 489 SUBSCRIBE request Event header examples: 490 Event: sip-profile;profile-type=device; 491 vendor=acme;model=Z100;version=1.2.3 493 Event: sip-profile;profile-type="user";document= 494 "http://example.com/services/user-profiles/users/freds.xml"; 495 vendor=premier;model=trs8000;version=5.5 497 NOTIFY request Event header examples: 498 Event:sip-profile;effective-by=0 500 Event:sip-profile;effective-by=3600 502 3.3 SUBSCRIBE Bodies 504 This package defines no new use of the SUBSCRIBE request body. 505 Future follow on documents may specify a filter-like mechanism using 506 etags to minimize the delivery or notification of profiles where the 507 user agent already has a current version. 509 3.4 Subscription Duration 511 As the presence (or lack of) a device or user agent it not very time 512 critical to the functionality of the profile delivery server, it is 513 recommended that default subscription duration be 86400 seconds (one 514 day). 516 3.5 NOTIFY Bodies 518 The size of profile content is likely to be hundreds to several 519 thousand bytes in size. Frequently even with very modest sized SDP 520 bodies, SIP messages get fragmented causing problems for many user 521 agents. For this reason if the Accept header of the SUBSCRIBE 522 included the MIME type: message/external-body indicating support for 523 content indirection the profile delivery server SHOULD use content 524 indirection [I-D.ietf-sip-content-indirect-mech] in the NOTIFY body 525 for providing the profiles. 527 When delivering profiles via content indirection the profile delivery 528 server MUST include the Content-ID defined in 529 [I-D.ietf-sip-content-indirect-mech] for each profile URI. This is 530 to avoid unnecessary download of the profiles. Some user agents are 531 not able to make a profile effective without rebooting or restarting. 532 Rebooting is something to be avoided on a user agent performing 533 services such as telephony. In this way the Content-ID allows the 534 user agent to avoid unnecessary interruption of service as well. The 535 Content-Type MUST be specified for each URI. 537 Initially user agent implementers may use a proprietary content 538 type for the profiles retrieved from the URI(s). This is a good 539 first step towards easing the management of user agents. Standard 540 profile contents, content type and formats will need to be defined 541 for true interoperability of profile delivery. The specification 542 of the content is out of the scope of this document. 544 Likewise the URI scheme [RFC2396] used in the content indirection is 545 outside the scope of this document. This document is agnostic to the 546 URI schemes as the profile content may dictate what is required. It 547 is expected that FTP [RFC0959], HTTP [RFC2616], HTTPS [RFC2818], 548 LDAP [RFC3377], XCAP [I-D.ietf-simple-xcap] and other URI schemes are 549 supported by this package and framework. 551 3.6 Notifier processing of SUBSCRIBE requests 553 The general rules for processing SUBSCRIBE requests [RFC3265] apply 554 to this package. If content indirection is used for delivering the 555 profiles, the notifier does not need to authenticate the subscription 556 as the profile content is not transported in the SUBSCRIBE or NOTIFY 557 transaction messages. With content indirection only URIs are 558 transported in the NOTIFY request which may be secured using the 559 techniques in Section 6. If content indirection is not used, SIPS 560 with SIP authentication SHOULD be used. 562 The behavior of the profile delivery server is left to the 563 implementer. The profile delivery server may be as simple as a SIP 564 SUBSCRIBE UAS and NOTIFY UAC front end to a simple HTTP server 565 delivering static files that are hand edited. At the other extreme 566 the profile delivery server can be part of a configuration management 567 system that integrates with a corporate directory and IT system or 568 carrier operations support systems, where the profiles are 569 automatically generated. The design of this framework intentionally 570 provides the flexibility of implementation from simple/cheap to 571 complex/expensive. 573 If the user or device is not known to the profile delivery server, 574 the implementer MAY accept the subscription or reject it. It is 575 recommended that the implementer accept the subscription. It is 576 useful for the profile delivery server to maintain the subscription 577 as an administrator may add the user or device to the system, 578 defining the profile contents. This allows the profile delivery 579 server to immediately send a NOTIFY request with the profile URIs. 580 If the profile delivery server does not accept the subscription from 581 an unknown user or device, the administer or user must manually 582 provoke the user agent to reSUBSCRIBE. This may be difficult if the 583 user agent and administrator are at different locations. 585 When the Event header "profile-type" is "device" and the user agent 586 has provided the user's AOR in the "network-user" parameter, the 587 profile delivery server MAY set or change the default user associated 588 with the device indicated in the SUBSCRIBE URI. This is an 589 implementation or policy decision. The profile delivery server 590 SHOULD authenticate the user for the SUBSCIRBE request before 591 effecting the default user indicated in the "network-user" parameter. 593 3.7 Notifier generation of NOTIFY requests 595 As in [RFC3265], the profile delivery server MUST always send a 596 NOTIFY request upon accepting a subscription. If the device or user 597 is unknown to the profile delivery server and it chooses to accept 598 the subscription, the implementer has two choices. A NOTIFY MAY be 599 sent with no body or content indirection containing the profile 600 URI(s). Alternatively a NOTIFY MAY be sent with a body or content 601 indirection containing URI(s) pointing to a default data set. The 602 data sets provided may allow for only limited functionality of the 603 user agent (e.g. a phone user agent with data to enable calls to 604 help desk and emergency services.). This is an implementation and 605 business policy decision for the profile delivery server. 607 If the URI in the SUBSCIRBE request is a known identity and 608 provisioned with the requested profile type (i.e. as specified in 609 the profile-type parameter of the Event header), the profile delivery 610 server SHOULD send a NOTIFY with profile data or content indirection 611 (if the content type was included in the Accept header) containing 612 the URI for the profile. 614 A user agent can provide hotelling by collecting a user's AOR and 615 credentials needed to SUBSCRIBE and retrieve the user's profiles. 616 Hotelling functionality is achieved by subscribing to the user's AOR 617 and specifying the "user" profile type. This same mechanism can also 618 be used to secure a user agent, requiring a non-mobile user to login 619 to enable functionality beyond the default user's restricted 620 functionality. 622 The profile delivery server may specify when the new profiles must be 623 made effective by the user agent. The profile delivery server MAY 624 specify a maximum time in seconds (zero or more), in the 625 "effective-by" event header parameter, by which the user agent is 626 required to make the new profiles effective for all dialogs. 628 3.8 Subscriber processing of NOTIFY requests 630 The user agent subscribing to this event package MUST adhere to the 631 NOTIFY request processing behavior specified in [RFC3265]. The user 632 agent MUST attempt to make the profiles effective within the time in 633 seconds given in the "effective-by" Event header parameter if present 634 in the NOTIFY request (see Section 3.7). By default the user agent 635 makes the profiles effective as soon as it thinks that it is 636 non-obtrusive. Profile changes SHOULD affect behavior on all new 637 dialogs which are created after the notification, but may not be able 638 to affect existing dialogs. The user agent SHOULD use one of the 639 techniques specified in Section 6 to securely retrieve the profiles. 641 3.9 Handling of forked requests 643 This event package allows the creation of only one dialog as a result 644 of an initial SUBSCRIBE request. The techniques to achieve this are 645 described in section 4.4.9 of [RFC3265]. 647 3.10 Rate of notifications 649 It is anticipated that the rate of change for user and device 650 profiles will be very infrequent (i.e. days or weeks apart). For 651 this reason no throttling or minimum period between NOTIFY requests 652 is specified for this package. 654 3.11 State Agents 656 State agents are not applicable to this event package. 658 3.12 Examples 660 Example SUBSCRIBE and NOTIFY request using content indirection: 662 SUBSCRIBE sip:ff00000036c5@acme.com SIP/2.0 663 Event: sip-profile;profile-type=device;vendor=acme; 664 model=Z100;version=1.2.3 665 From: sip:ff00000036c5@acme.com;tag=1234 666 To: sip:ff00000036c5@acme.com;tag=abcd 667 Call-ID: 3573853342923422@10.1.1.44 668 CSeq: 2131 SUBSCRIBE 669 Contact: sip:ff00000036c5@10.1.1.44 670 Via: SIP/2.0/TCP 10.1.1.41; 671 branch=z9hG4bK6d6d35b6e2a203104d97211a3d18f57a 672 Accept: message/external-body, application/z100-device-profile 673 Content-Length: 0 675 NOTIFY sip:ff00000036c5@10.1.1.44 SIP/2.0 676 Event: sip-profile;effective-by=3600 677 From: sip:ff00000036c5@acme.com;tag=abcd 678 To: sip:ff00000036c5@acme.com;tag=1234 679 Call-ID: 3573853342923422@10.1.1.44 680 CSeq: 321 NOTIFY 681 Via: SIP/2.0/UDP 192.168.0.3; 682 branch=z9hG4bK1e3effada91dc37fd5a0c95cbf6767d1 683 MIME-Version: 1.0 684 Content-Type: multipart/mixed; boundary=boundary42 685 Content-Length: ... 687 --boundary42 688 Content-Type: message/external-body; 689 access-type="URL"; 690 expiration="Mon, 24 June 2002 09:00:00 GMT"; 691 URL="http://www.example.com/devices/ff00000036c5"; 692 size=1234 694 Content-Type: application/z100-device-profile 695 Content-ID: <39EHF78SA@example.com> 697 --boundary42-- 699 3.13 Use of URIs to Retrieve State 701 The URI for the SUBSCRIBE request is formed differently depending 702 upon which profile type the subscription is for. This allows the 703 different profile types to be potentially managed by different 704 profile delivery servers (perhaps even operated by different 705 entities). 707 3.13.1 Device URIs 709 The URI for the "device" type profile (device URI) is base upon the 710 identity of the device. The device URI MUST be unique over time and 711 space for all devices and implementations. If an instance id is used 712 as the user part of the device URI, it SHOULD remain the same for the 713 lifetime of the user agent. The device URI is used to identify which 714 profile is associated with a specific instance of a user agent. 716 If the user agent were to change its device URI, the profile 717 delivery server would lose its association between the profile and 718 the device. This would also make it difficult for the profile 719 delivery server to track user agents under profile management. 720 The profile delivery server may decide to provide the same device 721 profile to all devices of the same vendor, model and version. 722 However this is a implementation choice on the profile delivery 723 server. The subscribing device has no way of knowing the profile 724 difference. As an example the device profile for similar devices 725 may differ with properties such as the default user. This is how 726 the bootstrapping mechanism works as described in Section 4.1.3. 728 The URI for the device type profile should use a unique identifier as 729 the user portion of the URI. The host and port portion of the URI is 730 set to that of the domain or address of the profile deliver server 731 which manages that user agent. A means of discovering the host and 732 port portion is discussed in Section 4.1. Like the call-id header 733 value in SIP, consistency of the format across implementations is 734 less important than the guarantee of uniqueness across all instances. 735 There is a administration aspect of the unique identifier, that makes 736 it desirable for the id to be obtainable or predictable prior to 737 installation of the device (hard or soft). Also from a human factors 738 perspective, ids that are easily distinguished and communicated will 739 make the administrators job a little easier. Two approaches are 740 suggested for constructing a unique identifier to be used in the user 741 portion of the device URI. 743 The MAC address of the device may be used if there will always be 744 no more than one user agent using that MAC address over time (e.g. 745 a dedicate telephone appliance). The MAC address may not be used 746 if more than one user agent instance exists or use the same MAC 747 address (e.g. multiple instances of a softphone may run on a 748 general purpose computing device). The advantage of the MAC 749 address is that many vendors put bar codes on the device with the 750 actual MAC address on it. A bar code scanner is a convenient 751 means of collecting the instance id for input and provisioning on 752 the profile delivery server. If the MAC address is used, it is 753 recommended that the MAC address is rendered in all lower case 754 with no punctuation for consistency across implementations. For 755 example a device managed by sipuaconfig.example.com using its MAC 756 address to form the device URI might look like: 757 sip:00df1e004cd0@sipuaconfig.example.com. 759 For devices where there is no MAC address or the MAC address is 760 not unique to an instance of a user agent (e.g. multiple 761 softphones on a computer or a gateway with multiple logical user 762 agents) it is recommended that a URN [RFC2141] is used as the user 763 portion of the device URI. The approach to defining a user agent 764 instance ID for GRUU [I-D.ietf-sip-gruu] should be considered. 765 When constructing the instance id the implementer should also 766 consider that a human may need to manual enter the instance id to 767 provision the device in the profile delivery server (i.e. longer 768 strings are more error prone in data entry). When the URN is used 769 as the user part of URI, it MUST be URL escaped. The ":" is not a 770 legal character (without being escaped) in the user part of a 771 name-addr. For example the instance ID: 772 urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6 would be escaped to 773 look as follows in a URI: 774 sip:urn%3auuid%3af81d4fae-7dec-11d0-a765-00a0c91e6bf6@example.com. 775 Soft user agents are likely to need to use this approach due to 776 the multi-user nature of general purpose computers. The software 777 installer program might generate the uuid as part of the install 778 process so that it remains persistent for the installation. It 779 may also be desirable that any upgrades of the software maintain 780 the unique id. However these are all implementation choices. 782 3.13.2 User and Application URIs 784 The URI for the "user" and "application" type profiles is based upon 785 the identity of the user. The user's address of record (AOR) is used 786 as the URI in the SUBSCRIBE request. A new user agent or device may 787 not know the user's AOR. The user's AOR may be obtained as part of a 788 default user property in the device profile. Alternatively the user 789 agent may prompt the user for an AOR and credentials to be used to 790 authenticate the request. This can provide a login and/or hotelling 791 feature on the user agent. The user agent may be pre-provisioned 792 with the user's AOR or provided as information on a SIM or flash key. 793 These are only examples not an exhaustive list of sources for the 794 user AOR. 796 3.13.3 Local Network URIs 798 The URI for the "local" type profile is based upon the identity of 799 the local network. When subscribing to the local network profile, 800 the user part of the URI is "anonymous". The host and port part of 801 the URI is the local network name/domain. The discovery of the local 802 network name or domain is discussed in Section 4.1. The user agent 803 may provide the user's AOR as the value to the "network-user" event 804 header parameter. This is useful if the user has privileges in the 805 local network beyond those of the default user. The profile delivery 806 server SHOULD authenticate the user before providing the profile if 807 additional privileges are granted. Example URI: 808 sip:ananymous@example.com 810 4. Profile Delivery Framework Details 812 The following describes how different functional steps of the profile 813 delivery framework work. Also described here is how the event 814 package defined in this document provides the enrollment and 815 notification functions within the framework. 817 4.1 Discovery of Subscription URI 819 The discovery approach varies depending upon which profile type URI 820 is to be discovered. The order of discovery is important in the boot 821 strapping situation as user agent may not have any information 822 provisioned. The local network profile should be discovered first as 823 it may contain key information such as how to traverse a NAT/firewall 824 to get to outside services (e.g. the user's profile delivery 825 server). The device profile URI should be discovered next. The 826 device profile may contain the default user's AOR or firmware/ 827 software information that should be updated first before proceeding 828 with the discovery process. The user and application profile 829 subscription URIs should be discovered last. The URIs are formed 830 differently for each of the profile types. This is to support the 831 delegation of the profile management to potentially four different 832 entities. However all four profile types may be provided by the same 833 entity. As the user agent has no way of knowing whether the profiles 834 are provide by one or more different profile delivery servers ahead 835 of time, it must subscribe to all four profile types in separate 836 SUBSCRIBE requests to get the profiles. 838 4.1.1 Discovery of Local Network URI 840 The "discovered" host for the "local" profile subscription URI is the 841 local IP network domain for the user agent, either provisioned as 842 part of the device's static network configuration or discovered via 843 DHCP. The local network profile subscription URI should not be 844 cached as the user agent may move from one local network to the 845 other. The user agent should perform the local network discovery 846 every time it starts up or network connectivity is regained. 848 For example: The user agent requested and received the local 849 domain name via DHCP: loganairport.com. The local network URI 850 would look like: sip:anonymous@loganairport.com. The user agent 851 should send this request using the normal SIP locating mechanisms 852 defined in [RFC3263]. The Event header would look like the 853 following if the user agent decided to provide the user's AOR: 854 sip:alice@example.com as Alice may have a prior arrangement with 855 the local network operator giving her special policy privileges: 857 Event: sip-profile;profile-type=local; 858 network-user=sip:alice@example.com 860 4.1.2 Discovery of Device URI 862 The discovery function is needed to bootstrap user agents to the 863 point of knowing where to enroll with the profile delivery server. 864 Section 3.13.1 describes how to form the device URI used to send the 865 SUBSCRIBE request for enrollment. However the bootstrapping problem 866 for the user agent (out of the box) is what to use for the host and 867 port in the device URI. Due to the wide variation of environments in 868 which the enrolling user agent may reside (e.g. behind residential 869 router, enterprise LAN, WIFI hotspot, ISP, dialup modem) and the 870 limited control that the administrator of the profile delivery 871 server (e.g. enterprise, service provider) may have over that 872 environment, no single discovery mechanism works everywhere. 874 Therefore a number of mechanisms should be tried in the specified 875 order: SIP DHCP option [RFC3361], SIP DNS SRV [RFC3263], DNS A record 876 and manual. The user agent may be pre-provisioned with the host and 877 port (e.g. service providers may pre-provision a device before 878 sending it to a subscriber, provide a SIM or flash key, etc.) in 879 which case this discovery mechanism is not needed. Before performing 880 the discovery steps, the user agent should provide a means to skip 881 the discovery stage and manually enter the device URI host and port. 882 In addition the user agent should allow the user to accept or reject 883 the discovered host and port, in case an alternate to the discovered 884 host and port are desired. 886 1. The first discovery mechanism that should be tried to construct 887 the device SUBSCRIBE URI, as described in Section 3.13.1, is to 888 use the host and port of the out bound proxy discovered by the 889 SIP DHCP option as described in [RFC3361]. If the SIP DHCP 890 option is not provided in the DHCP response; or no SIP response 891 is received for the SUBSCRIBE request; or a SIP failure response 892 other than for authorization is received for the SUBSCRIBE 893 request to the sip-profile event, the next discovery mechanism 894 should be tried. 896 For example: Consider a dedicated hardware device with a 897 single user agent having the MAC address: abc123efg456. The 898 user agent sends a DHCP request including the request for the 899 DHCP option for SIP: 120 (see [RFC3361]). If the DHCP 900 response includes an answer for option 120, then the DNS name 901 or IP address included is used in the host part of the device 902 URI. For this example let's assume: example.com. The device 903 URI would look like: sip:abc123efg456@example.com. The user 904 agent should send this request using the normal SIP locating 905 mechanisms defined in [RFC3263]. If the response fails then, 906 the next discovery mechanism is tried. 908 2. The local IP network domain for the user agent, either configured 909 or discovered via DHCP, should be used with the technique in 910 [RFC3263] to obtain a host and port to use in the SUBSCRIBE URI. 911 If no SIP response or a SIP failure response other than for 912 authorization is received for the SUBSCRIBE request to the 913 sip-profile event, the next discovery mechanism should be tried. 915 For example: The user agent requested and received the local 916 domain name (option 15) in the DHCP response: 917 boston.example.com. The device URI would look like: 918 sip:abc123efg456@boston.example.com. The user agent should 919 send this request using the normal SIP locating mechanisms 920 defined in [RFC3263]. If the response fails then, the next 921 discovery mechanism is tried. 923 3. The fully qualified host name constructed using the host name 924 "sipuaconfig" and concatenated with the local IP network domain 925 (as provided via DHCP or provisioned) should be tried next using 926 the technique in [RFC3263] to obtain a host and port to use in 927 the SUBSCRIBE URI. If no SIP response or a SIP failure response 928 other than for authorization is received for the SUBSCRIBE 929 request to the sip-profile event, the next discovery mechanism 930 should be tried. 932 For example: The user agent requested and received the local 933 domain name via DHCP as in the above example: 934 boston.example.com. The device URI would look like: 935 sip:abc123efg456@sipuaconfig.boston.example.com. The user 936 agent should send this request using the normal SIP locating 937 mechanisms defined in [RFC3263]. If the response fails then, 938 the next discovery mechanism is tried. 940 4. If all other discovery techniques fail, the user agent MUST 941 provide a manual means for the user to enter the host and port 942 used to construct the SUBSCRIBE URI. 944 Once a user agent has successfully discovered, enrolled and received 945 a NOTIFY response with profile data or URI(s), the user agent should 946 cache the device profile SUBSCRIBE URI to avoid having to rediscover 947 the profile delivery server again in the future. Caching of the 948 device URI is necessary when the user agent is likely to move to 949 different local network domains as the local network may not be the 950 provider for the device's profile. The user agent should not cache 951 the device URI until it receives a NOTIFY with profile data or 952 URI(s). The reason for this is that a profile delivery server may 953 send 202 responses to SUBSCRIBE requests and NOTIFY responses to 954 unknown user agent (see Section 3.6) with no URIs. Until the profile 955 delivery server has sent a NOTIFY request with profile data or 956 URI(s), it has not agreed to provide profiles. 958 To illustrate why the user agent should not cache the device 959 profile SUBSCRIBE URI until profile data or URI(s) are provided in 960 the NOTIFY, consider the following example: a user agent running 961 on a laptop plugged into a visited LAN in which a foreign profile 962 delivery server is discovered. The profile delivery server never 963 provides profile URIs in the NOTIFY request as it is not 964 provisioned to accept the user agent. The user then takes the 965 laptop to their enterprise LAN. If the user agent cached the 966 SUBSCRIBE URI from the visited LAN (which did not provide 967 profiles), when subsequently placed in the enterprise LAN which is 968 provisioned to provide profiles to the user agent, the user agent 969 would not attempt to discover the profile delivery server. 971 4.1.3 Discovery of User and Application URI 973 The default user's AOR from the device profile (if provided) may then 974 be used to subscribe to the "user" and "application" profiles. The 975 user's AOR may be prepovisioned or provided via SIM or flash key, 976 etc. Alternatively the user's AOR to be used for the "user" and 977 "application" subscription URI, may be "discovered" manually by 978 prompting the user. This "discovered" URI for the user and 979 application profile subscription may be cached. 981 4.2 Enrollment with Profile Server 983 Enrollment is accomplished by subscribing to the event package 984 described in Section 3. The enrollment process is useful to the 985 profile delivery server as it makes the server aware of user agents 986 to which it may deliver profiles (those user agents the profile 987 delivery server is provisioned to provide profiles to; those present 988 to which the server may provide profiles in the future; and those 989 that the server can automatically provide default profiles). It is 990 an implementation choice and business policy as to whether the 991 profile delivery server provides profiles to user agents that it is 992 not explicitly provisioned to do so. However the profile delivery 993 server SHOULD accept (with 2xx response) SUBSCRIBE requests from any 994 user agent as explained in Section 3.5. 996 4.3 Notification of Profile Changes 998 The NOTIFY request in the sip-profile event package serves two 999 purposes. First it provides the user agent with a means to obtain 1000 the profile data directly or via URI(s) for desired profiles without 1001 requiring the end user to manually enter them. It also provides the 1002 means for the profile delivery server to notify the user agent that 1003 the content of the profiles has changed and should be made effective. 1004 Optionally the differential changes may be obtained by including the 1005 content-type: "application/xcap-diff+xml" defined in 1006 [I-D.ietf-simple-xcap-package] in the Accept header of the SUBSCRIBE 1007 request. 1009 4.4 Retrieval of Profile Data 1011 The user agent retrieves its needed profile(s) directly or via the 1012 URI(s) provided in the NOTIFY request as specified in Section 3.5. 1013 The profile delivery server SHOULD secure the content of the profiles 1014 using one of the techniques described in Section 6. The user agent 1015 SHOULD make the new profiles effective in the timeframe described in 1016 Section 3.2. 1018 The contents of the profiles SHOULD be cached by the user agent. 1019 This it to avoid the situation where the content delivery server is 1020 not available, leaving the user agent non-functional. 1022 4.5 Upload of Profile Changes 1024 The user agent or other service MAY push changes up to the profile 1025 delivery server using the technique appropriate to the profile's URL 1026 scheme (e.g. HTTP PUT method, FTP put command). The technique for 1027 pushing incremental or atomic changes MUST be described by the 1028 specific profile data framework. A means for pushing changes up into 1029 the profile delivery server for XCAP is defined in 1030 [I-D.ietf-simple-xcap]. 1032 4.6 Usage of XCAP with the Profile Package 1034 This framework allows for the usage of several different protocols 1035 for the retrieval of profiles. One protocol which is suitable is 1036 XCAP [I-D.ietf-simple-xcap], which allows for HTTP URIs to represent 1037 XML documents, elements and attributes. XCAP defines a specific 1038 hierarchy for how documents are organized. As a result, it is 1039 necessary to discuss how that organization relates to the rough data 1040 model presented here. 1042 When a user or device enrolls with a SUBSCRIBE request, the request 1043 UIR will contain some kind of identifying information for that user 1044 or device. This identity is mapped to an XCAP User ID (XUID) based 1045 on an implementation specific mapping. The "profile-type" along with 1046 the "app-id" Event header parameters specify the specific XCAP 1047 application usage. 1049 In particular, when the Event header parameter "profile-type" is 1050 "application", the "app-id" MAY be included to contain the XCAP 1051 Application Unique ID (AUID). When the "profile-type" is 1052 "application", but the "app-id" parameter is absent, this specifies 1053 that the user wishes to SUBSCRIBE to all documents for all 1054 application usages associated with the user in the request-uri. This 1055 provides a convenient way for a single subscription to be used to 1056 obtain all application data. The XCAP root is determined by a local 1057 mapping. 1059 When the "profile-type" is "device", or "user" or "local", this maps 1060 to an AUID and document selector for representing device, user and 1061 local-network data, respectively. The mapping is a matter of local 1062 policy. This allows different providers to use different XCAP 1063 application usages and document schemas for representing these 1064 profiles, without having to configure the device with the specific 1065 AUID which is being used. 1067 Furthermore, when the "document" attribute is present, it identifies 1068 a specific document that is being requested. If the "profile-type" 1069 is "application", the "app-id" MAY be present as well if the 1070 "document" relative path does not indicate the specific application 1071 profile. The "document" attribute then specifies a relative path 1072 reference. Its first path segment is either "global", specifying 1073 global data, or "user", specifying user data for the user in the 1074 request URI. The next path segment identifies the path in the global 1075 directory or the user's home directory. For "profile-type" 1076 "application", if "app-id" is not present the next path segment (i.e. 1077 after "global" or the user's home directory segment) MAY indicate the 1078 XCAP Application Unique ID (AUID) if the user agent wishes to 1079 subscribe to a specific application profile. 1081 For example, consider a phone with an instance ID of 1082 urn:uuid:00000000-0000-0000-0000-0003968cf920. To obtain its device 1083 profile, it would generate a SUBSCRIBE that contain the following 1084 Request-Line and Event header: 1086 SUBSCRIBE 1087 sip:urn%3auuid%3a00000000-0000-0000-0000-0003968cf920@example.com 1088 SIP/2.0 1089 Event: sip-profile;profile-type=device 1091 If the profile data is stored in an XCAP server, the server would map 1092 the "device" profile to an application usage and document selector 1093 based on local policy. If this mapping specifies the AUID 1094 "vendor2-device-data" and a document called "index" within the user 1095 directory, the corresponding HTTP URI for the document is: 1097 http://xcap.example.com/root/vendor2-device-data/users/ 1098 urn%3auuid%3a00000000-0000-0000-0000-0003968cf920/index 1100 and indeed, if a content indirection is returned in a NOTIFY, the URL 1101 would equal this. 1103 That user profile might specify the user identity (as a SIP AOR) and 1104 their application-usages. From that, the device can enroll to learn 1105 about its application data. To learn about all of the data: 1107 SUBSCRIBE sip:user-aor@example.com SIP/2.0 1108 Event: sip-profile;profile-type=application 1110 The server would map the request URI to an XUI (user-aor, for 1111 example) and the xcap root based on local policy. If there are two 1112 AUIDs, "resource-lists" [I-D.ietf-simple-xcap-list-usage] and 1113 "rls-services" [I-D.ietf-simple-xcap-list-usage], this would result 1114 in a subscription to all documents within: 1116 http://xcap.example.com/root/rls-services/users/user-aor 1117 http://xcap.example.com/root/resource-lists/users/user-aor 1119 The user would not be subscribed to the global data for these two 1120 application usages, since that data is not important for users. 1122 However, the user/device could be made aware that it needs to 1123 subscribe to a specific document. In that case, its subscribe would 1124 look like: 1126 SUBSCRIBE sip:user-aor@example.com SIP/2.0 1127 Event: sip-profile;profile-type=application;app-id=resource-lists 1128 ;document="global/index" 1130 this would result in a subscription to the single global document for 1131 resource-lists. 1133 In some cases, these subscriptions are to a multiplicity of 1134 documents. In that case, the notification format will need to be one 1135 which can indicate what document has changed. This includes content 1136 indirection, but also the xcap diff format 1137 [I-D.ietf-simple-xcap-package]. 1139 5. IANA Considerations 1141 There are several IANA considerations associated with this 1142 specification. 1144 5.1 SIP Event Package 1146 This specification registers a new event package as defined in 1147 [RFC3265]. The following information required for this registration: 1148 Package Name: sip-profile 1149 Package or Template-Package: This is a package 1150 Published Document: RFC XXXX (Note to RFC Editor: Please fill in 1151 XXXX with the RFC number of this specification). 1152 Person to Contact: Daniel Petrie dpetrie AT pingtel.com 1153 New event header parameters: profile-type, vendor, model, version, 1154 effective-by, document, app-id, network-user 1156 6. Security Considerations 1158 Profiles may contain sensitive data such as user credentials. The 1159 protection of this data depends upon how the data is delivered. If 1160 the data is delivered in the NOTIFY body, SIP authentication MUST be 1161 used for SUBSCRIPTION and SIPS and/or S/MIME MAY be use to encrypt 1162 the data. If the data is provided via content indirection, SIP 1163 authentication is not necessary for the SUBSCRIBE request. With 1164 content indirection the data is protected via the authentication, 1165 authorization and encryption mechanisms provided by the profile URL 1166 scheme. Use of the URL scheme security mechanisms via content 1167 indirection simplifies the security solution as the SIP event package 1168 does not need to authenticate, authorize or protect the contents of 1169 the SIP messages. Effectively the profile delivery server can safely 1170 provide profile URI(s) to anyone. The profile content is protected 1171 via the URL scheme transport mechanisms for authentication, 1172 authorization and encryption (e.g. via HTTPS). HTTPS provides two 1173 possible mechanisms for authentication: 1) the device may have a 1174 certificate that the profile deliver server can request in the TLS 1175 setup; or 2) the profile deliver server may use HTTP authentication 1176 [RFC2617] with the device or users credentials. 1178 6.1 Symmetric Encryption of Profile Data 1180 If the transport for the URL scheme used for content indirection does 1181 not provide authentication, authorization or encryption, a technique 1182 to provide this is to encrypt the profiles on the content delivery 1183 server using a symmetric encryption algorithm using a shared key. 1184 The encrypted profiles are delivered by the content delivery server 1185 via the URIs provided in the NOTIFY requests. Using this technique 1186 the profile delivery server does not need to provide authentication 1187 or authorization for the retrieval as the profiles are obscured. The 1188 user agent must obtain the username and password from the user or 1189 other out of band means to generate the key and decrypt the profiles. 1191 7. Change History 1193 Many thanks to those who contributed and commented on the many 1194 iterations of this document. Detailed input was provided by Jonathan 1195 Rosenberg from Dynamicsoft, Henning Schulzrinne from Columbia U., 1196 Cullen Jennings from Cisco, Rohan Mahy from Cisco, Rich Schaaf from 1197 Pingtel, Volker Hilt from Bell Labs, Hisham khartabil from Nokia, 1198 Henry Sinnreich from MCI, Martin Dolly from ATT Labs, and John Elwell 1199 from Siemens. 1201 7.1 Changes from draft-ietf-sipping-config-framework-04.txt 1203 Clarified usage of instance-id 1204 Specify which event header parameters are mandatory or optional 1205 and in which messages. 1206 Included complete list of event header parameters in parameter 1207 overview and IANA sections. 1208 Removed TFTP reference as protocol for profile transport. 1209 Added examples for discovery. 1210 Added ABNF for all event header parameters. 1211 Changed profile-name parameter back to profile-type. This was 1212 changed profile-name in 02 when the parameter could contain either 1213 a token or a path. Now that the path is contained in the separate 1214 parameter: "document", profile-type make more sense as the 1215 parameter name. 1216 Fixed some statements that should have and should not have been 1217 normative. 1218 Added the ability for the user agent to request that the default 1219 user associated with the device be set/changed using the 1220 "network-user" parameter. 1221 A bunch of editorial nits and fixes. 1223 7.2 Changes from draft-ietf-sipping-config-framework-03.txt 1225 Incorporated changes to better support the requirements for the use 1226 of this event package with XCAP and SIMPLE so that we can have one 1227 package (i.e. simple-xcap-package now defines a content type not a 1228 package). Added an additional profile type: "application". Added 1229 document and app-id Event header parameters in support of the 1230 application profile. Define a loose high level data model or 1231 relationship between the four profile types. Tried to edit and fix 1232 the confusing and ambiguous sections related to URI formation and 1233 discovery for the different profile types. Better describe the 1234 importance of uniqueness for the instance id which is used in the 1235 user part of the device URI. 1237 7.3 Changes from draft-ietf-sipping-config-framework-02.txt 1239 Added the concept of the local network as a source of profile data. 1240 There are now three separate logical sources for profile data: user, 1241 device and local network. Each of these requires a separate 1242 subscription to obtain. 1244 7.4 Changes from draft-ietf-sipping-config-framework-01.txt 1246 Changed the name of the profile-type event parameter to profile-name. 1247 Also allow the profile-name parameter to be either a token or an 1248 explicit URI. 1250 Allow content indirection to be optional. Clarified the use of the 1251 Accept header to indicate how the profile is to be delivered. 1253 Added some content to the Iana section. 1255 7.5 Changes from draft-ietf-sipping-config-framework-00.txt 1257 This version of the document was entirely restructured and re-written 1258 from the previous version as it had been micro edited too much. 1260 All of the aspects of defining the event package are now organized in 1261 one section and is believed to be complete and up to date with 1262 [RFC3265]. 1264 The URI used to subscribe to the event package is now either the user 1265 or device address or record. 1267 The user agent information (vendor, model, MAC and serial number) are 1268 now provided as event header parameters. 1270 Added a mechanism to force profile changes to be make effective by 1271 the user agent in a specified maximum period of time. 1273 Changed the name of the event package from sip-config to sip-profile 1274 Three high level security approaches are now specified. 1276 7.6 Changes from draft-petrie-sipping-config-framework-00.txt 1278 Changed name to reflect SIPPING work group item 1280 Synchronized with changes to SIP DHCP [RFC3361], SIP [RFC3261] and 1281 [RFC3263], SIP Events [RFC3265] and content indirection 1282 [I-D.ietf-sip-content-indirect-mech] 1284 Moved the device identity parameters from the From field parameters 1285 to User-Agent header parameters. 1287 Many thanks to Rich Schaaf of Pingtel, Cullen Jennings of Cisco and 1288 Adam Roach of Dyamicsoft for the great comments and input. 1290 7.7 Changes from draft-petrie-sip-config-framework-01.txt 1292 Changed the name as this belongs in the SIPPING work group. 1294 Minor edits 1296 7.8 Changes from draft-petrie-sip-config-framework-00.txt 1298 Split the enrollment into a single SUBSCRIBE dialog for each profile. 1299 The 00 draft sent a single SUBSCRIBE listing all of the desired. 1300 These have been split so that each enrollment can be routed 1301 differently. As there is a concept of device specific and user 1302 specific profiles, these may also be managed on separate servers. 1303 For instance in a roaming situation the device might get its profile 1304 data from a local server which knows the LAN specific profile data. 1305 At the same time the user specific profiles might come from the 1306 user's home environment profile delivery server. 1308 Removed the Config-Expires header as it is largely superfluous with 1309 the SUBSCRIBE Expires header. 1311 Eliminated some of the complexity in the discovery mechanism. 1313 Suggest caching information discovered about a profile delivery 1314 server to avoid an avalanche problem when a whole building full of 1315 devices powers up. 1317 Added the User-Profile From header field parameter so that the device 1318 can request a user specific profile for a user that is different from 1319 the device's default user. 1321 8 References 1323 [I-D.ietf-simple-xcap] 1324 Rosenberg, J., "The Extensible Markup Language (XML) 1325 Configuration Access Protocol (XCAP)", 1326 draft-ietf-simple-xcap-04 (work in progress), October 1327 2004. 1329 [I-D.ietf-simple-xcap-list-usage] 1330 Rosenberg, J., "Extensible Markup Language (XML) Formats 1331 for Representing Resource Lists", 1332 draft-ietf-simple-xcap-list-usage-04 (work in progress), 1333 October 2004. 1335 [I-D.ietf-simple-xcap-package] 1336 Rosenberg, J., "An Extensible Markup Language (XML) 1337 Document Format for Indicating Changes in XML 1338 Configuration Access Protocol (XCAP) Resources", 1339 draft-ietf-simple-xcap-package-02 (work in progress), July 1340 2004. 1342 [I-D.ietf-sip-content-indirect-mech] 1343 Burger, E., "A Mechanism for Content Indirection in 1344 Session Initiation Protocol (SIP) Messages", 1345 draft-ietf-sip-content-indirect-mech-05 (work in 1346 progress), October 2004. 1348 [I-D.ietf-sip-gruu] 1349 Rosenberg, J., "Obtaining and Using Globally Routable User 1350 Agent (UA) URIs (GRUU) in the Session Initiation Protocol 1351 (SIP)", draft-ietf-sip-gruu-02 (work in progress), July 1352 2004. 1354 [I-D.ietf-sipping-ua-prof-framewk-reqs] 1355 Petrie, D. and C. Jennings, "Requirements for SIP User 1356 Agent Profile Delivery Framework", 1357 draft-ietf-sipping-ua-prof-framewk-reqs-00 (work in 1358 progress), March 2003. 1360 [I-D.petrie-sipping-profile-datasets] 1361 Petrie, D., "A Schema for Session Initiation Protocol User 1362 Agent Profile Data Sets", 1363 draft-petrie-sipping-profile-datasets-00 (work in 1364 progress), July 2004. 1366 [I-D.sinnreich-sipdev-req] 1367 Butcher, I., Lass, S., Petrie, D., Sinnreich, H. and C. 1368 Stredicke, "SIP Telephony Device Requirements and 1369 Configuration", draft-sinnreich-sipdev-req-04 (work in 1370 progress), July 2004. 1372 [RFC0822] Crocker, D., "Standard for the format of ARPA Internet 1373 text messages", STD 11, RFC 822, August 1982. 1375 [RFC0959] Postel, J. and J. Reynolds, "File Transfer Protocol", STD 1376 9, RFC 959, October 1985. 1378 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 1379 Requirement Levels", BCP 14, RFC 2119, March 1997. 1381 [RFC2131] Droms, R., "Dynamic Host Configuration Protocol", RFC 1382 2131, March 1997. 1384 [RFC2132] Alexander, S. and R. Droms, "DHCP Options and BOOTP Vendor 1385 Extensions", RFC 2132, March 1997. 1387 [RFC2141] Moats, R., "URN Syntax", RFC 2141, May 1997. 1389 [RFC2246] Dierks, T. and C. Allen, "The TLS Protocol Version 1.0", 1390 RFC 2246, January 1999. 1392 [RFC2396] Berners-Lee, T., Fielding, R. and L. Masinter, "Uniform 1393 Resource Identifiers (URI): Generic Syntax", RFC 2396, 1394 August 1998. 1396 [RFC2616] Fielding, R., Gettys, J., Mogul, J., Frystyk, H., 1397 Masinter, L., Leach, P. and T. Berners-Lee, "Hypertext 1398 Transfer Protocol -- HTTP/1.1", RFC 2616, June 1999. 1400 [RFC2617] Franks, J., Hallam-Baker, P., Hostetler, J., Lawrence, S., 1401 Leach, P., Luotonen, A. and L. Stewart, "HTTP 1402 Authentication: Basic and Digest Access Authentication", 1403 RFC 2617, June 1999. 1405 [RFC2818] Rescorla, E., "HTTP Over TLS", RFC 2818, May 2000. 1407 [RFC3261] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston, 1408 A., Peterson, J., Sparks, R., Handley, M. and E. Schooler, 1409 "SIP: Session Initiation Protocol", RFC 3261, June 2002. 1411 [RFC3263] Rosenberg, J. and H. Schulzrinne, "Session Initiation 1412 Protocol (SIP): Locating SIP Servers", RFC 3263, June 1413 2002. 1415 [RFC3265] Roach, A., "Session Initiation Protocol (SIP)-Specific 1416 Event Notification", RFC 3265, June 2002. 1418 [RFC3361] Schulzrinne, H., "Dynamic Host Configuration Protocol 1419 (DHCP-for-IPv4) Option for Session Initiation Protocol 1420 (SIP) Servers", RFC 3361, August 2002. 1422 [RFC3377] Hodges, J. and R. Morgan, "Lightweight Directory Access 1423 Protocol (v3): Technical Specification", RFC 3377, 1424 September 2002. 1426 [W3C.REC-xml-names11-20040204] 1427 Tobin, R., Hollander, D., Layman, A. and T. Bray, 1428 "Namespaces in XML 1.1", W3C REC REC-xml-names11-20040204, 1429 February 2004. 1431 Author's Address 1433 Daniel Petrie 1434 Pingtel Corp. 1435 400 W. Cummings Park 1436 Suite 2200 1437 Woburn, MA 01801 1438 US 1440 Phone: "Dan Petrie (+1 781 938 5306)" 1441 EMail: dpetrie AT pingtel.com 1442 URI: http://www.pingtel.com/ 1444 Appendix A. Acknowledgments 1445 Intellectual Property Statement 1447 The IETF takes no position regarding the validity or scope of any 1448 Intellectual Property Rights or other rights that might be claimed to 1449 pertain to the implementation or use of the technology described in 1450 this document or the extent to which any license under such rights 1451 might or might not be available; nor does it represent that it has 1452 made any independent effort to identify any such rights. Information 1453 on the procedures with respect to rights in RFC documents can be 1454 found in BCP 78 and BCP 79. 1456 Copies of IPR disclosures made to the IETF Secretariat and any 1457 assurances of licenses to be made available, or the result of an 1458 attempt made to obtain a general license or permission for the use of 1459 such proprietary rights by implementers or users of this 1460 specification can be obtained from the IETF on-line IPR repository at 1461 http://www.ietf.org/ipr. 1463 The IETF invites any interested party to bring to its attention any 1464 copyrights, patents or patent applications, or other proprietary 1465 rights that may cover technology that may be required to implement 1466 this standard. Please address the information to the IETF at 1467 ietf-ipr@ietf.org. 1469 The IETF has been notified of intellectual property rights claimed in 1470 regard to some or all of the specification contained in this 1471 document. For more information consult the online list of claimed 1472 rights. 1474 Disclaimer of Validity 1476 This document and the information contained herein are provided on an 1477 "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS 1478 OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET 1479 ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, 1480 INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE 1481 INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED 1482 WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 1484 Copyright Statement 1486 Copyright (C) The Internet Society (2004). This document is subject 1487 to the rights, licenses and restrictions contained in BCP 78, and 1488 except as set forth therein, the authors retain all their rights. 1490 Acknowledgment 1492 Funding for the RFC Editor function is currently provided by the 1493 Internet Society.