SIPPING D. Petrie Internet-Draft Pingtel Corp. Expires:November 15, 2004 MayJanuary 17, 2005 July 19, 2004 A Framework for Session Initiation Protocol User Agent Profile Deliverydraft-ietf-sipping-config-framework-03.txtdraft-ietf-sipping-config-framework-04.txt Status of this Memo This document is an Internet-Draft and is in full conformance with all provisions of Section 10 of RFC2026. Internet-Drafts are working documents of the Internet Engineering Task Force (IETF), its areas, and its working groups. Note that other groups may also distribute working documents as Internet-Drafts. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress." The list of current Internet-Drafts can be accessed at http://www.ietf.org/ietf/1id-abstracts.txt. The list of Internet-Draft Shadow Directories can be accessed at http://www.ietf.org/shadow.html. This Internet-Draft will expire onNovember 15, 2004.January 17, 2005. Copyright Notice Copyright (C) The Internet Society (2004). All Rights Reserved. Abstract This document defines the application of a set of protocols for providing profile data to SIP user agents. The objective is to define a means for automatically providing profile data a user agent needs to be functional without user or administrative intervention. The framework for discovery, delivery, notification and updates of user agent profile data is defined here. As part of this framework a new SIP event package is defined here for the notification of profile changes. This framework is also intended to ease ongoing administration and upgrading of large scale deployments of SIP user agents. The contents and format of the profile data to be defined is outside the scope of this document. Table of Contents 1. Motivation . . . . . . . . . . . . . . . . . . . . . . . . .34 2. Introduction . . . . . . . . . . . . . . . . . . . . . . . .34 2.1 Requirements Terminology . . . . . . . . . . . . . . . . .34 2.2 Profile Delivery Framework Terminology . . . . . . . . . .45 2.3 Overview . . . . . . . . . . . . . . . . . . . . . . . . .45 3. Profile Change Event Notification Package . . . . . . . . .68 3.1 Event Package Name . . . . . . . . . . . . . . . . . . . .68 3.2 Event Package Parameters . . . . . . . . . . . . . . . . .68 3.3 SUBSCRIBE Bodies . . . . . . . . . . . . . . . . . . . . .911 3.4 Subscription Duration . . . . . . . . . . . . . . . . . .911 3.5 NOTIFY Bodies . . . . . . . . . . . . . . . . . . . . . .911 3.6 Notifier processing of SUBSCRIBE requests . . . . . . . .1012 3.7 Notifier generation of NOTIFY requests . . . . . . . . . .1013 3.8 Subscriber processing of NOTIFY requests . . . . . . . . .1113 3.9 Handling of forked requests . . . . . . . . . . . . . . .1114 3.10 Rate of notifications . . . . . . . . . . . . . . . . .1114 3.11 State Agents . . . . . . . . . . . . . . . . . . . . . .1214 3.12 Examples . . . . . . . . . . . . . . . . . . . . . . . .1214 3.13 Use of URIs to Retrieve State . . . . . . . . . . . . .1315 3.13.1 Device URIs . . . . . . . . . . . . . . . . . . . . 15 3.13.2 User and Application URIs . . . . . . . . . . . . . 17 3.13.3 Local Network URIs . . . . . . . . . . . . . . . . . 17 4. Profile Delivery Framework Details . . . . . . . . . . . . .1317 4.1 Discovery of Subscription URI . . . . . . . . . . . . . .13 4.2 Enrollment with Profile Server17 4.1.1 Discovery of Local Network URI . . . . . . . . . . . . 17 4.1.2 Discovery of Device URI . .15 4.3 Notification of Profile Changes. . . . . . . . . . . . .15 4.4 Retrieval18 4.1.3 Discovery ofProfile DataUser and Application URI . . . . . . . . 19 4.2 Enrollment with Profile Server . . . . . . . . . . . . .15 4.5 Upload. 19 4.3 Notification of Profile Changes . . . . . . . . . . . . . 20 4.4 Retrieval of Profile Data . . .16 5. IANA Considerations .. . . . . . . . . . . . . 20 4.5 Upload of Profile Changes . . . . . .16 5.1 SIP Event Package. . . . . . . . . . 20 4.6 Usage of XCAP with the Profile Package . . . . . . . . . .16 6. Security20 5. IANA Considerations . . . . . . . . . . . . . . . . . .16 6.1 Symmetric Encryption of Profile Data. . 23 5.1 SIP Event Package . . . . . . . . . .16 7. Differences from Simple XCAP Package. . . . . . . . . . 23 6. Security Considerations . . . . .17 8. Open Issues. . . . . . . . . . . . . 23 6.1 Symmetric Encryption of Profile Data . . . . . . . . . . .17 9.23 7. Change History . . . . . . . . . . . . . . . . . . . . . . .17 9.124 7.1 Changes from draft-ietf-sipping-config-framework-03.txt . 24 7.2 Changes from draft-ietf-sipping-config-framework-02.txt .18 9.224 7.3 Changes from draft-ietf-sipping-config-framework-01.txt .18 9.324 7.4 Changes from draft-ietf-sipping-config-framework-00.txt .18 9.425 7.5 Changes from draft-petrie-sipping-config-framework-00.txt . . . . . . .18 9.525 7.6 Changes from draft-petrie-sip-config-framework-01.txt . .19 9.625 7.7 Changes from draft-petrie-sip-config-framework-00.txt . .19 10.25 8. References . . . . . . . . . . . . . . . . . . . . . . . . .1926 Author's Address . . . . . . . . . . . . . . . . . . . . . .2128 A. Acknowledgments . . . . . . . . . . . . . . . . . . . . . .2128 Intellectual Property and Copyright Statements . . . . . . .2229 1. Motivation Today all SIP user agent implementers use proprietary means of delivering user or device profiles to the user agent. The profile delivery framework defined in this document is intended to enable a first phase migration to a standard means of providing profiles to SIP user agents. It is expected that UA implementers will be able to use this framework as a means of delivering their existing proprietary user and device data profiles (i.e. using their existing proprietary binary or text formats). This in itself is a tremendous advantage in that a SIP environment can use a single profile delivery server for profile data to user agents from multiple implementers. Follow-on standardization activities can: 1. define a standard profile content format framework (e.g. XML withname spaces [??]namespaces [W3C.REC-xml-names11-20040204] or name-value pairs [RFC0822]). 2. specify the content (i.e. name the profile data parameters, xml schema, name spaces) of the data profiles. One of the objectives of the framework described in this document is to provide a start up experience similar to that of users of an analog telephone. When you plug in an analog telephone it just works (assuming the line is live and the switch has been provisioned). There is no end user configuration required to make analog phone work, at least in a basic sense. So the objective here is to be able to take a new SIP user agent out of the box, plug it in or install the software and have it get its profiles without human intervention other than security measures. This is necessary for cost effective deployment of large numbers of user agents. Another objective is to provide a scalable means for ongoing administration of profiles. Administrators and users are likely to want to make changes to user and device profiles. Additional requirements for the framework defined in this document are described in: [I-D.ietf-sipping-ua-prof-framewk-reqs], [I-D.sinnreich-sipdev-req] 2. Introduction 2.1 Requirements Terminology Keywords "MUST", "MUST NOT", "REQUIRED", "SHOULD", "SHOULD NOT" and "MAY" that appear in this document are to be interpreted as described in RFC 2119[RFC2119]. 2.2 Profile Delivery Framework Terminology profile - data set specific to a user or device. device - SIP user agent, either software or hardware appliance. profile content server - The server that provides the content of the profiles using the protocol specified by the URL scheme. notifier - The SIP user agent server which processes SUBSCRIBE requests for events and sends NOTIFY requests with profile data or URI(s) point to the data. profile delivery server - The logical collection of the SIP notifier and the server which provides the contents of the profile URI(s). 2.3 Overview The profile life cycle can be described by five functional steps. These steps are not necessarily discrete. However it is useful to describe these steps as logically distinct. These steps are named as follows: Discovery - discover a profile delivery server Enrollment - enroll with the profile delivery server Profile Retrieval - retrieve profile data Profile Change Notification - receive notification of profile changes Profile Change Upload - upload profile data changes back to the profile delivery server Discovery is the process by which a UA finds the address and port at which it enrolls with the profile delivery server. As there is no single discovery mechanism which will work in all network environments, a number of discovery mechanisms are defined with a prescribed order in which the UA tries them until one succeeds. Enrollment is the process by which a UA makes itself known to the profile delivery server. In enrolling the UA provides identity information, name requested profile type(s) and supported protocols for profile retrieval. It also subscribes to a mechanism for notification of profile changes. As a result of enrollment, the UA receives the data or the URI for each of the profiles that the profile delivery server is able to provide. Each profile type (set) requires a separate enrollment or SUBSCRIBE session. Profile Retrieval is the process of retrieving the content for each of the profiles the UA requested. Profile Change Notification is the process by which the profile delivery server notifies the UA that the content of one or more of the profiles has changed. If the content is provided indirectly the UA SHOULD retrieve the profile from the specified URI upon receipt of the change notification. Profile Upload is the process by which a UA or other entity (e.g. OSS, corporate directory or configuration management server) pushes a change to the profile data back up to the profile delivery server. This framework defines a new SIP event package [RFC3265] to solve enrollment and profile change notification steps.The question arises as to why SIP should be used forThis event packet defines everything but theprofile delivery framework. Inmandatory content type. This make thisdocument SIP is used for only a small portion ofevent package abstract until theframework.content type is bound. The profile content type(s) will be defined outside the scope of this document. It is he author's belief that it would be a huge accomplishment if all SIP user agent used this framework for delivering their existing proprietary profiles. Even though this does not accomplish interoperability of profiles, it is a big first step in easing the administration of SIP user agents. The definition of standard profiles and data set (see [I-D.petrie-sipping-profile-datasets] ) will enable interoperability as a subsequent step. The question arises as to why SIP should be used for the profile delivery framework. In this document SIP is used for only a small portion of the framework. Other existing protocols are more appropriate for transport of the profile contents (to and from the user agent) and are suggested in this document. The discovery step is simply a specified order and application of existing protocols. SIP is only needed for the enrollment and change notification functionality of the profile delivery framework. In many SIP environments (e.g. carrier/subscriber and multi-site enterprise) firewall, NAT and IP addressing issues make it difficult to get messages between the profile delivery server and the user agent requiring the profiles. With SIP the users and devices already are assigned globally routable addresses. In addition the firewall and NAT problems are already presumably solved in the environments in which SIP user agents are to be used. Therefore SIP is the best solution for allowing the user agent to enroll with the profile delivery server which may require traversal of multiple firewalls and NATs. For the same reason the notification of profile changes is best solved by SIP.It is assumed that theThe content delivery serverwillmay be either in the public network or accessible through a DMZ. The user agents requiring profiles may be behind firewalls and NATs and many protocols, such as HTTP, may be used for profile content retrieval without special consideration in the firewalls andNATs.NATs (e.g. an HTTP client on the UA can typically pull content from a server outside the NAT/firewall.). A conscious separation of device, user,deviceapplication and local network profiles is made in this document. This is useful to provide features such ashotelinghotelling as well as securing or restricting user agent functionality. By maintaining this separation, a user may walk up to someone else's user agent and direct that user agent to get their profile data. In doing so the user agent can replace the previous user's profile data while still keeping the devices profile data that may be necessary for core functionality and communication described in this document. The local network profiles are relevant to a visiting device which gets plugged in to a foreign network. The concept of the local network providing profile data is useful to providehotelinghotelling (described above) as well as local policy data that may constrain the user or device behavior relative to the local network. For example media types and codecs may be constrained to reflect the networks capabilities.3. Profile Change Event Notification Package This section defines a new SIP event package [RFC3265].Thepurpose of this event package is to send to subscribers notificationseparation ofcontent changes tothese profiles also enables theprofile(s)separation ofinterest and to providethelocationmanagement of theprofile(s) via content indirection [I-D.ietf-sip-content-indirect-mech] or directly in the body ofprofiles. The user profile may be managed by a profile delivery server operated by theNOTIFY. Frequentlyuser's ISP. The device profile may be delivered from a profile delivery server operated by theprofilesuser's employer. The application profile may be deliveredtofrom theuser agentuser's ASP. The local network profile may delivered by a WIFI hotspot service provider. Some interesting services and mobility applications aremuch larger (e.g. several KB or even several MB) than the MTUenabled with this separation of profiles. A very high level data model is implied here with thenetwork. These larger profiles will cause larger than normal SIP messages and consequently higher impact onseparation of these four profile types. Each profile type requires a separate subscription to retrieve theSIP servers and infrastructure. To avoidprofile. A loose hierarchy exists mostly for thehigher impactpurpose of boot strapping andload on the SIP infrastructure, content indirection SHOULD be used ifdiscovery or formation of the profile URIs. No other meaning islarge enough to cause packet fragmentation over the transport protocol. The user agent SHOULD specifyimplied by this hierarchy. However the profiledelivery means andformatvia the MIME type in the Accepts header. The MIME types or formats of profileand data sets to bedelivered viadefine outside thisframework aredocument, may define additional meaning tobe defined in other documents. These profile MIME types specified in the Accepts header along withthis hierarchy. In theprofile types specified inboot strapping scenario, a device straight out of theEvent header parameter "profile-name" MAY be used to specify which profiles get delivered either directlybox (software orindirectly in the NOTIFY requests. When content indirection ishardware) does notused, itknow anything about it's user or local network. The one thing that ismore important to specify the minimum set of profiles, asdoes know is it's instance id. So theentire content for allhierarchy of the profilesis included in the NOTIFY request. 3.1 Event Package Nameexists as follows. Thename of this packageinstance id is"sip-profile". This value appears in the Event header field present in SUBSCRIBE and NOTIFY requests for this package as defined in [RFC3265]. 3.2 Event Package Parameters This package definesused to form thefollowing new parametersURI for subscribing to theevent header: profile-name, vendor, model, version, effective-by.device profile. Theeffective-by parameter isdevice profile may contain a default user AOR foruse in NOTIFY requests only.that device. Theothers are for use in the SUBSCRIBE request, butdefault user AOR may then be usedin NOTIFY requests as well. The profile-name parameter is usedtoindicate the token name of the profile typeretrieve the useragent wishes to obtain URIs for or to explicitly specify the URI to which it isprofile. Applications to benotified of change. Using a token in this parameter allows the URL semantics for retrievingused on theprofiles todevice may beopaque todefined in thesubscribingdevice and useragent. All it needs to knowprofiles. The user's AOR isthe token valuealso used to retrieve any application profiles forthis parameter. Howeverthat user. The local network profile is not referenced insome cases the user agent may know the URI ofany way from theprofile and only wishes to know about changesdevice, user, application profiles. It is subscribed tothe profile. The user agent MAY supply theand retrieved based upon a URIfor the profile as the value offormed from theprofile-name parameter.local network domain. 3. Profile Change Event Notification Package Thisdocumentsection definesthree type categories of profiles and their token names.a new SIP event package [RFC3265]. Thecontents or formatpurpose ofthe profilesthis event package isoutside the scopeto send to subscribers notification ofthis document. The three typescontent changes to the profile(s) ofprofiles define here are "user", "device"interest and"local". Specifying device type profile(s) indicatesto provide thedesire forlocation of the profile(s)(URIs whenvia content indirectionis used) and change notification[I-D.ietf-sip-content-indirect-mech] or directly in the body ofallthe NOTIFY. Frequently the profilesthat are specificdelivered to thedevice oruseragent. Specifying user type profile(s) indicates the desire for the profiles(s)agent are much larger (e.g. several KB orURI(s) and change notificationeven several MB) than the MTU ofall profile(s) that are specific totheuser. Specifying local typenetwork. These larger profilesindicateswill cause larger than normal SIP messages and consequently higher impact on thedesire for profile(s) or URI(s) specific toSIP servers and infrastructure. To avoid thelocal network. The user, device or local network is identified inhigher impact and load on theURI ofSIP infrastructure, content indirection SHOULD be used if theSUBSCRIBE request.profile is large enough to cause packet fragmentation over the transport protocol. TheAccept headerpresence of theSUBSCRIBE request MUST include theMIMEtypestype forall profilecontenttypesindirection [I-D.ietf-sip-content-indirect-mech] in the Accept header indicates that thesubscribinguser agentwishessupports content indirection and that the profile delivery server SHOULD use content indirection. Similarly the content type for the differential notification of profile changes [I-D.ietf-simple-xcap-package] may be used in the Accept header toretrieve profiles orreceive profile changenotifications.deltas. Theuser, device or local token in the profile-name parameter may represent a classMIME types orsetformats ofprofiles as opposed to a single profile. As standards are defined for specificprofilecontents relatedtothe user device or local network, it maybedesirabledelivered via this framework are todefine additional tokens forbe defined in theprofile-name header. This is to allow a user agent to subscribe todocuments thatspecificdefine the profileas opposed tocontents. These profile MIME types specified in theentire class or set of user or device profiles. The rational forAccept header along with theseparation of user, device and local network type profiles is providedprofile types specified inSection 2.3. It should be noted that any ofthetypes may indicate that zero or moreEvent header parameter "profile-name" MAY be used to specify which profiles get delivered either directly orURIs are providedindirectly in the NOTIFYrequest.requests. Asdiscussed, a default user may be assigned to a device. Inthisscenario the profile delivery server may provide the URI(s) in the NOTIFY request for the default user when subscribing toevent package does not specify thedevicemandatory content type, this package is abstract. The profiletype. Effectivelydefinition documents will specify thedevice profilemandatory content typebecomesto make asupersetconcrete event package. 3.1 Event Package Name The name ofthe user profile type subscription. Thatthis package is "sip-profile". This value appears in thelist of profile URIs (or MIME parts if multiple profiles are provided directlyEvent header field present in SUBSCRIBE and NOTIFY requests for this package as defined in [RFC3265]. 3.2 Event Package Parameters This package defines theNOTIFY) provided when requesting profile type "device" includesfollowing new parameters for theprofiles provided when subscribingevent header: "profile-name", "vendor", "model", "version", "effective-by", "document", "app-id". The effective-by parameter is forprofile type "user"use in NOTIFY requests only. The others are for use in thedefault user of that device.SUBSCRIBE request, but may be used in NOTIFY requests as well. Theuser type"profile-name" parameter isstill useful in this scenarioused toallowindicate the token name of the profile type the user agent wishes to obtainprofiledata or URIs for and to be notified of subsequent changes. Using auser other thantoken in this parameter allows thedefault user. This providesURL semantics for retrieving theabilityprofiles tosupport a hoteling function where a user may "login"be opaque toanythe subscribing useragent and haveagent. All ituse a user's profile(s). The data provided inneeds to know is thethreetoken value for this parameter. This document defines four logical types of profilesmay overlap. As an example the codecs that a user prefers to use,and their token names. The contents or format of thecodecs thatprofiles is outside thedevice supports (andscope of this document. The four types of profiles define here are "device", "user", "application" and "local". Specifying "device" type profile(s) indicates theenterprise wishes to use),desire for thecodecs thatprofile data (URI when content indirection is used) and change notification of thelocal network can support (andcontents of themanagement wishes to allow) all may overlap in how theyprofile(s) that arespecified inspecific to thethree corresponding profiles. Typically these should be applied indevice or user agent. Specifying "user" type profile indicates theorder ofdesire for theleastprofile data or URI tomost constraint (i.e. user, device then local network). However this policythe profile(s) and change notification ofmergingtheconstraints acrossprofile content for themultipleuser. Specifying "application" type profiletypes can only unambiguously be defined along withindicates the desire for the profileformatdata or URI to the profile(s) andsyntax. This is outchange notification ofscopethe profile content forthis document. The "vendor", "model" and "version" parameter values are tokens specified bythevendor ofuser's applications. Specifying "local" type profile indicates theuser agent. These parameters are usefuldesire for profiles data or URI to theprofile delivery serverprofile(s) specific toaffecttheprofiles provided. In some scenarios itlocal network. The device, user, application or local network isdesirable to provide different profiles based upon these parameters. For example feature parameter Xidentified ina profile may work differently on two versionsthe URI of the SUBSCRIBE request. The Accept header ofuser agent. This givesthe SUBSCRIBE request MUST include the MIME types for all profiledeliver servercontent types that theabilitysubscribing user agent wishes tocompensate forretrieve profiles ortake advantage of the differences.receive change notifications. Profile-Name = "profile-name" HCOLON profile-value profile-value = profile-types / token profile-types = "device" / "user" / "application" / "local" The"network-user""device", "user", "application" or "local" token in the profile-name parameteris used when subscribingmay represent a class or set of profile properties. As standards are defined forlocal network profiles. Ifspecific profile contents related to thevalue ofuser device or local network, it may be desirable to define additional tokens for the profile-nameparameter is not "local", the "network-user" parameter has noheader. Also additional content types may be definedmeaning. Ifalong with theuser has special privileges beyondprofile formats thatof an anonymous usercan be used in thelocal network, the "network-user" parameter identifiesAccept header of theuserSUBSCRIBE to filter or indicate what data sets of thelocal network.profile are desired. Thevaluerational for the separation ofthis parameteruser, device and local network type profiles isthe user's addressprovided in Section 2.3. It should be noted that any ofrecord.the types may indicate that zero or more profiles or URIs are provided in the NOTIFY request. As discussed, a default user may be assigned to a device. TheSUBSCRIBE serverdefault user's AOR mayauthenticatein turn be used as thesubscriberURI toverify this AOR.SUBSCRIBE to the "user" and "application" profile types. The"effective-by" parameterdata provided in theEvent headerfour types of profiles may overlap. As an example the codecs that a user prefers to use, the codecs that the device supports (and the enterprise or device owner wishes to use), the codecs that the local network can support (and the network operator wishes to allow) all may overlap in how they are specified in the three corresponding profiles. This policy of merging the constraints across the multiple profile types can only unambiguously be defined along with the profile format and syntax. This is out of scope for this document. The "vendor", "model" and "version" parameter values are tokens specified by the implementer of the user agent. These parameters are useful to the profile delivery server to affect the profiles provided. In some scenarios it is desirable to provide different profiles based upon these parameters. For example feature property X in a profile may work differently on two versions of user agent. This gives the profile deliver server the ability to compensate for or take advantage of the differences. The "network-user" parameter is used when subscribing for local network profiles. If the value of the profile-name parameter is not "local", the "network-user" parameter has no defined meaning. If the user has special privileges beyond that of an anonymous user in the local network, the "network-user" parameter identifies the user to the local network. The value of this parameter is the user's address of record. The SUBSCRIBE server may authenticate the subscriber to verify this AOR. The "effective-by" parameter in the Event header of the NOTIFY specifies the maximum number of seconds before the user agent MUST make the new profile effective. A value of 0 (zero) indicates that the user agent MUST make the profiles effective immediately (despite possible service interruptions). This gives the profile delivery server the power to control when the profile is effective. This may be important to resolve an emergency problem or disable a user agent immediately.SUBSCRIBE request example: Event: sip-profile;profile-name=device; vendor=acme;model=Z100;version=1.2.3 Event:The "document" parameter is used to specify a relative URI for a specific profile document that the user agent wishes to retrieve and to receive change notification. This is particularly useful for profile content like XCAP [I-D.ietf-simple-xcap] where there is a well defined URL schema and the user agent knows the specific content that it wants. The "document" parameter value syntax is a quoted string. For more details on the use of this package with XCAP see Section 4.6. The "app-id" parameter is only used when the "profile-name" parameter value is "application". The "app-id" indicates that the user agent wishes to retrieve the profile data or URI and change notification for the application profile data for the specific application indicated in the value of the "app-id" parameter. The "app-id" parameter value is a token. SUBSCRIBE request Event header examples: Event: sip-profile;profile-name=device; vendor=acme;model=Z100;version=1.2.3 Event: sip-profile;profile-name= "http://example.com/services/user-profiles/users/freds.xml"; vendor=premier;model=trs8000;version=5.5 NOTIFY request Event header examples: Event:sip-profile;effective-by=0 Event:sip-profile;effective-by=3600 3.3 SUBSCRIBE Bodies This package defines no new use of the SUBSCRIBE request body. Future follow on documents may specify a filter-like mechanism using etags to minimize the delivery or notification of profiles where the user agent already has a current version. 3.4 Subscription Duration As the presence (or lack of) a device or user agent it not very time critical to the functionality of the profile delivery server, it is recommended that default subscription duration be 86400 seconds (one day). 3.5 NOTIFY Bodies The size of profile content is likely to be hundreds to several thousand bytes in size. Frequently even with very modest sized SDP bodies, SIP messages get fragmented causing problems for many user agents. For this reasonthe profile delivery server MUST use content indirection [I-D.ietf-sip-content-indirect-mech] in the NOTIFY body for providing the profilesif the Accept header of the SUBSCRIBE included the MIME type: message/external-body indicating support for contentindirection.indirection the profile delivery server SHOULD use content indirection [I-D.ietf-sip-content-indirect-mech] in the NOTIFY body for providing the profiles. When delivering profiles via content indirection the profile delivery server MUST include the Content-ID defined in [I-D.ietf-sip-content-indirect-mech] for each profile URL. This is to avoid unnecessary download of the profiles. Some user agents are not able to make a profile effective without rebooting or restarting. Rebooting isprobablysomething to be avoided on a user agent performing services such as telephony. In this way the Content-ID allows the user agent to avoid unnecessary interruption of service as well. The Content-Type MUST be specified for each URI. Initiallyit is expected that mostuser agent implementerswillmay use a proprietary content type for the profiles retrieved from the URIs(s).ItThis ishoped that over timeastandard content type will be specified that will be adopted by implementersgood first step towards easing the management of user agents.One direction that appearsStandard profile contents, content type and formats will need to bepromisingdefined forthis content is to use XML with name spaces [??] to segment the data into sets that the user agent implementer may choose to support based upon desired feature set.true interoperability of profile delivery. The specification of the content is out of the scope of this document. Likewise the URL scheme used in the content indirection is outside the scope of this document. This document is agnostic to the URL schemes as the profile content may dictate what is required. It is expected that TFTP [RFC3617], FTP [??], HTTP [RFC2616], HTTPS [RFC2818], LDAP [RFC3377], XCAP[I-D.rosenberg-simple-xcap][I-D.ietf-simple-xcap] and other URL schemes are supported by this package and framework. 3.6 Notifier processing of SUBSCRIBE requests The general rules for processing SUBSCRIBE requests [RFC3265] apply to this package. If content indirection is used for delivering the profiles, the notifier does not need to authenticate the subscription as the profile content is not transported in the SUBSCRIBE or NOTIFY transaction messages. With content indirection only URLs are transported in the NOTIFY request which may be secured using the techniques in Section 6. If content indirection is not used, SIPSandwith SIP authentication SHOULD be used. The behavior of the profile delivery server is left to the implementer. The profile delivery server may be as simple as a SIP SUBSCRIBE UAS and NOTIFY UAC front end to a simple HTTP server delivering static files that are hand edited. At the other extreme the profile delivery server can be part of a configuration management system that integrates with a corporate directory and IT system or carrier OSS, where the profiles are automatically generated. The design of this framework intentionally provides the flexibility of implementation from simple/cheap to complex/expensive. If the user or device is not known to the profile delivery server, the implementer MAY accept the subscription or reject it. It is recommended that the implementer accept the subscription. It is useful for the profile delivery server to maintain the subscription as an administrator may add the user or device to the system, defining the profile contents. This allows the profile delivery server to immediately send a NOTIFY request with the profile URIs. If the profile delivery server does not accept the subscription from an unknown user or device, the administer or user must manually provoke the user agent to reSUBSCRIBE. This may be difficult if the user agent and administrator are at differentsites.locations. 3.7 Notifier generation of NOTIFY requests As in [RFC3265], the profile delivery server MUST always send a NOTIFY request upon accepting a subscription. If the device or user is unknown to the profile delivery server and it chooses to accept the subscription, the implementer has two choices. A NOTIFY MAY be sent with no body or content indirection containing the profile URI(s). Alternatively a NOTIFY MAY be sent withURI(s) pointing toadefault databody or content indirection containing URI(s) pointing to a default data set.Typically thisThe dataset allowssets provided may allow for only limited functionality of the user agent (e.g. a phone user agent with data tocallenable calls to help desk and emergency services.). This is an implementation and business policydecision. A user or devicedecision for the profile delivery server. If the URI in the SUBSCIRBE request is a known identity andfullyprovisionedonwith the requested profile type (i.e. as specified in the profile-name parameter), the profile delivery server SHOULD send a NOTIFY with profile data or content indirectioncontaining URIs for all of the profiles associated with the user or device (i.e. whichever specified in(if theprofile-name parameter). The device may be associated with a default user. The URI(s) for this default user profiles MAY becontent type was includedwithin theURI(s) ofAccept header) containing thedevice ifURI for theprofile type specified is device.profile. A user agent can provideHotelinghotelling by collecting auser’suserËs AOR and credentials needed to SUBSCRIBE and retrieve theuser profiles from the URI(s). Hotelinguser's profiles. hotelling functionality is achieved by subscribing to the user's AOR and specifying the "user" profile type. This same mechanism can also be used to secure a user agent, requiring a user to login to enable functionality beyond the defaultuser’suserËs restricted functionality. The profile delivery server MAY specify when the new profiles MUST be made effective by the user agent. By default the user agent makes the profiles effective as soon as it thinks that it is non-obtrusive. Profile changes SHOULDeffectaffect behavior on all newsessionsdialogs which are created after the notification, but may not be able to effect existingsessions.dialogs. However the profile delivery server MAY specify a maximum time in seconds (zero or more), in the effective-by event header parameter, by which the user agent MUST make the new profiles effective for allsessions.dialogs. 3.8 Subscriber processing of NOTIFY requests The user agent subscribing to this event package MUST adhere to the NOTIFY request processing behavior specified in [RFC3265]. The user agent MUST make the profiles effective as specified in the NOTIFY request (see Section 3.7). The user agent SHOULD use one of the techniques specified in[RFC3265]Section 6 to securely retrieve the profiles. 3.9 Handling of forked requests This event package allows the creation of only one dialog as a result of an initial SUBSCRIBE request. The techniques to achieve this are described in section 4.4.9 of [RFC3265]. 3.10 Rate of notifications It is anticipated that the rate of change for user and device profiles will be very infrequent (i.e. days or weeks apart). For this reason no throttling or minimum period between NOTIFY requests is specified for this package. 3.11 State Agents State agents are not applicable to this event package. 3.12 Examples Example SUBSCRIBE and NOTIFY request using content indirection: SUBSCRIBEsip:00df1e004cd0@example.comsip:ff00000036c5@example.com SIP/2.0 Event: sip-profile;profile-name=device;vendor=acme; model=Z100;version=1.2.3 From:sip:00df1e004cd0@acme.com;tag=1234sip:ff00000036c5@acme.com;tag=1234 To:sip:00df1e004cd0@acme.com;tag=abcdsip:ff00000036c5@acme.com;tag=abcd Call-ID: 3573853342923422@10.1.1.44 CSeq: 2131 SUBSCRIBE Contact:sip:00df1e004cd0@10.1.1.44sip:ff00000036c5@10.1.1.44 Accept: message/external-body, application/z100-device-profile Content-Length: 0 NOTIFYsip:00df1e004cd0@10.1.1.44sip:ff00000036c5@10.1.1.44 SIP/2.0 Event: sip-profile;effective-by=3600 From:sip:00df1e004cd0@acme.com;tag=abcdsip:ff00000036c5@acme.com;tag=abcd To:sip:00df1e004cd0@acme.com;tag=1234sip:ff00000036c5@acme.com;tag=1234 Call-ID: 3573853342923422@10.1.1.44 CSeq: 321 NOTIFY MIME-Version: 1.0 Content-Type: multipart/mixed; boundary=boundary42 Content-Length: ... --boundary42 Content-Type: message/external-body; access-type="URL"; expiration="Mon, 24 June 2002 09:00:00 GMT";URL="http://www.example.com/devices/fsmith"; size=2222 Content-Type: application/z100-user-profile Content-ID: <69ADF2E92@example.com> --boundary42 Content-Type: message/external-body; access-type="URL"; expiration="Mon, 24 June 2002 09:00:00 GMT";URL="http://www.example.com/devices/ff00000036c5"; size=1234 Content-Type: application/z100-device-profile Content-ID: <39EHF78SA@example.com> --boundary42-- 3.13 Use of URIs to Retrieve State The URI for the SUBSCRIBE request is formed differently depending upon which profile typespecified determines what goes in the user part oftheSUBSRIBE URI. Ifsubscription is for. This allows the different profile types to be potentially managed by different profile delivery servers (perhaps even operated by different entities). 3.13.1 Device URIs The URI for the "device" typerequestedprofile is"device",base upon theuser partidentity of the device. The device URIis an identity thatMUST be uniqueacross all user agents from all implementers. This identity must be staticover timeso thatand space for all devices and implementations. The instance id used as the user part of theprofile delivery server can keep a specificdeviceand its identityURI SHOULD remain the same for the lifetime of the user agent. The device URI is used to identify which profile is associated withits profiles. For Ethernet hardware type user agents supporting only a single user atatime this is most easily accomplished using its MAC address. Software based user agents running on general purpose hardware may also be able to use the MAC address for identity. However in situations where multiple instancesspecific instance of a useragents are running onagent. If thesame hardware it may be necessary to use another scheme, such as using a unique serial number for each softwareuser agentinstance. For example a device having a MAC address of 00df1e004cd0 might subscribewere tothechange its deviceprofile URI: sip:00df1e004cd0@sipuaconfig.example.com. When subscribing to a user profile for user Fred S.URI, theuser agentprofile delivery server wouldsubscribe to the URI: sip:freds@sipuaconfig.example.com Ifloose its association between the profiletype requested is "user", the URI in the SUBSCRIBE request is the address of record forand theuser.device. Thisallowswould also make it difficult for theuser to specify (e.g. login)profile delivery server tothetrack useragent by simply entering their known identity. If theagents under profiletype specified in the profile-name parameter is "local", themanagement. The URIinfor theSUBSCRIBE request hasdevice type profile should use a unique identifier as the userID: anonymous.portion of the URI. The hostpartand port portion of the URIis the local network name. This typically is discoveredaspartset to that of theDHCP request/responsedomain orprovisioned as partaddress of thestatic IP configuration forprofile deliver server which manages that user agent. A means of discovering thedevice. When subscribinghost and port portion is discussed in Section 4.1. Two approaches are suggested for constructing a unique identifier to be used in thelocal network profile typeuser portion of the deviceshould provide the user'sURI. The MAC address ofrecord inthe"network-user" parameter,device may be used if there will always be no more than one user agent using that MAC address over time (e.g. a dedicate telephone appliance). The MAC address may not be used if more than one user agent instance exists or use theAOR is known to the device. Example URI: sip:ananymous@example.com 4. Profile Delivery Framework Detailssame MAC address (e.g. multiple instances of a softphone may run on a general purpose computing device). Thefollowing describes how different functional stepsadvantage of theprofile delivery framework work. Also described hereMAC address ishow the event package defined in this document providesthat many vendors put bar codes on theenrollment and notification functions withindevice with theframework. 4.1 Discovery of Subscription URI The discovery functionactual MAC address on it. A bar code scanner isneeded to bootstrap user agents to the pointa convenient means ofknowing where to enroll withcollecting the instance id for input and provisioning on the profile delivery server.Section 3.13 describes how to form the URI used to send the SUBSCRIBE request for enrollment. However the bootstrapping problem forIf theuser agent (out ofMAC address is used, it is recommended that thebox)MAC address iswhat to userendered in all lower case with no punctuation for consistency across implementations. For example a device managed by sipuaconfig.example.com using its MAC address to form thehost and port indevice URI might look like: sip:00df1e004cd0@sipuaconfig.example.com. For devices where there is no MAC address or theURI. DueMAC address is not unique tothe wide variationan instance ofenvironments in which the enrollinga user agentmay reside(e.g.behind residential router, enterprise LAN, ISP, dialup modem) and the limited controlmultiple softphones on a computer or a gateway with multiple logical user agents) it is recommended that a URN [RFC2141] is used as theadministratoruser portion of theprofile delivery server (e.g. enterprise, service provider) may have over that environment, no single discovery mechanism works everywhere. Thereforedevice URI. The approach to defining anumber of mechanisms SHOULD be trieduser agent instance ID in for GRUU [I-D.ietf-sip-gruu] should be considered. When constructing thespecified order: SIP DHCP option [RFC3361], SIP DNS SRV [RFC3263], DNS A record and manual. 1. The first discovery mechanisminstance id the implementer should also consider thatSHOULD be tried isa human may need toconstructmanual enter theSUBSCRIBE URI as describedinstance id to provision the device inSection 3.13 usingthehost and port of out bound proxy discovered byprofile delivery server (i.e. longer strings are more error prone in data entry). When theSIP DHCP optionURN is used asdescribed in [RFC3361]. IftheSIP DHCP optionuser part of URI, it MUST be URL escaped. The ":" is notprovideda legal character (without being escaped) in theDHCP response, no SIP response oruser part of aSIP failure response other than for authorization is received for the SUBSCRIBE request to the sip-profile event,name-addr. For example thenext discovery mechanism SHOULDinstance ID: urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6 would betried. 2.escaped to look as follows in a URI: sip:urn%3auuid%3af81d4fae-7dec-11d0-a765-00a0c91e6bf6@example.com. 3.13.2 User and Application URIs Thelocal IP network domainURI for theuser agent, either configured or discovered via DHCP, should be"user" and "application" type profiles is based upon the identity of the user. The user's address of record (AOR) is usedwithas thetechnique in [RFC3263] to obtain a host and port to useURI in the SUBSCRIBEURI. If no SIP responserequest. A new user agent ora SIP failure response other than for authorization is received for the SUBSCRIBE request to the sip-profile event,device may not know thenext discovery mechanism SHOULD be tried. 3.user's AOR. Thefully qualified host name constructed usinguser's AOR may be obtained as part of a default user property in thehost name "sipuaconfig" and concatenated withdevice profile. Alternatively thelocal IP network domain should be tried next usinguser agent may prompt thetechnique in [RFC3263]user for an AOR toobtainbe used. This can provide ahost and port to use inlogin and/or hotelling feature on theSUBSCRIBE URI. If no SIP response or a SIP failure response other thanuser agent. 3.13.3 Local Network URIs The URI forauthorizationthe "local" type profile isreceived forbased upon theSUBSCRIBE requestidentity of the local network. When subscribing to thesip-profile event,local network profile, thenext discovery mechanism SHOULD be tried. 4. If all otheruse part of the URI is "anonymous". The host and port part of the URI is the local network name/domain. The discoverytechniques fail,of the local network name or domain is discussed in Section 4.1. The user agentMUSTmay providea manual means fortheuser to enteruser's AOR as thehost and port usedvalue toconstructtheSUBSCRIBE URI. Once a user agent has successfully discovered, enrolled, received a NOTIFY response with profile data or URI(s),"network-user" event header parameter. This is useful if the useragent SHOULD cachehas privileges in theSUBCRIBE URI to avoid having to rediscoverlocal network beyond those of the default user. The profile delivery serveragain inSHOULD authenticate thefuture. Theuseragent SHOULD NOT cachebefore providing theSUBSCRIBE URI until it receives a NOTIFY withprofiledata or URI(s).if additional privileges are granted. Example URI: sip:ananymous@example.com 4. Profile Delivery Framework Details Thereason for this is that a profile delivery server may send 202 responses to SUBSCRIBE requests and NOTIFY responses to unknown user agent (see Section 3.6) with no URIs. Untilfollowing describes how different functional steps of the profile deliveryserver has sent a NOTIFY request with profile data or URI(s), it has not agreed to provide profiles. To illustrate why the user agent should not cacheframework work. Also described here is how theSUBSCRIBE URI until profile URI(s) are providedevent package defined in this document provides theNOTIFY, considerenrollment and notification functions within thefollowing example: a user agent running on a laptop plugged into a visited LAN inframework. 4.1 Discovery of Subscription URI The discover approach varies depending upon whicha foreignprofiledelivery servertype URI is to be discovered. Theprofile delivery server never provides profile URIsorder of discover is important in theNOTIFY requestboot strapping situation asit isuser agent may notprovisionedhave any information provisioned. The local network profile should be discovered first as it may contain key information such as how toaccepttraverse a NAT/firewall to get to outside services (e.g. theuser agent.user's profile delivery server). Theuser then takes the laptop to their enterprise LAN. Ifdevice profile URI should be discovered next. The device profile may contain the default user's AOR. The useragent cached the SUBSCRIBEand application profile subscription URI's are discovered last. 4.1.1 Discovery of Local Network URIfrom the visited LAN (which did not provide profiles), when subsequently placed inThe "discovered" host for theenterprise LAN which"local" profile subscription URI isprovisioned to provide profiles totheuser agent,local IP network domain for the useragent would not attempt to discoveragent, either provisioned as part of theprofile delivery server. 4.2 Enrollment with Profile Server Enrollment is accomplished by subscribing to the event package described in Section 3.device's static network configuration or discovered via DHCP. Theenrollment process is useful to thelocal network profiledelivery serversubscription URI should not be cached asit makestheserver aware ofuser agentto which itmaydelivery profiles (thosebe move from one local network to the other. The useragentsagent should perform theprofile delivery serverlocal network discovery every time it starts up or network connectivity isprovisionedregained. 4.1.2 Discovery of Device URI The discovery function is needed to bootstrap user agents toprovide profiles to; those present that the server may be provide profiles in the future; and those thattheserver can automatically provide default profiles). It is an implementation choice and business policy aspoint of knowing where towhetherenroll with the profile deliveryserver provides profilesserver. Section 3.13.1 describes how touser agents that it is not provisionedform the device URI used todo so. Howeversend theprofile server SHOULD accept (with 2xx response)SUBSCRIBErequests from any user agent. 4.3 Notification of Profile Changes The NOTIFYrequestinfor enrollment. However thesip-profile event package serves two purposes. First it providesbootstrapping problem for the user agentwith a means to obtain the profile data or URI(s) for desired profiles without requiring(out of theend userbox) is what tomanually enter them. It also provides the meansuse for theprofile delivery serverhost and port in the device URI. Due tonotifythe wide variation of environments in which the enrolling user agent may reside (e.g. behind residential router, enterprise LAN, WIFI hotspot, ISP, dialup modem) and the limited control that thecontentadministrator of theprofiles have changed and should be made effective. 4.4 Retrievalprofile delivery server (e.g. enterprise, service provider) may have over that environment, no single discovery mechanism works everywhere. Therefore a number ofProfile Datamechanisms SHOULD be tried in the specified order: SIP DHCP option [RFC3361], SIP DNS SRV [RFC3263], DNS A record and manual. The user agentretrieves its needed profile(s) viamay be preprovisioned with theURI(s) providedhost and port (e.g. service providers may preprovision a device before sending it to a subscriber) in which case this discovery mechanism is not needed. Before performing theNOTIFY request as specified in Section 3.5. The profile delivery serverdiscover steps, the user agent SHOULDsecureprovide a means to skip thecontent ofdiscovery stage and manually enter theprofiles using one ofdevice URI host and port. In addition thetechniques described in Section 6. Theuser agent SHOULDmakeallow thenew profiles effectiveuser to accept or reject the discovered host and port, in case an alternate to thetimeframediscovered host and port are desired. 1. The first discovery mechanism that SHOULD be tried is to construct the device SUBSCRIBE URI, as described in Section3.2. The contents3.13.1, is to use the host and port of theprofiles SHOULD be cachedout bound proxy discovered by theuser agent. This it to avoid the situation whereSIP DHCP option as described in [RFC3361]. If thecontent delivery serverSIP DHCP option is notavailable, leavingprovided in theuser agent non-functional. 4.5 Upload of Profile Changes The user agentDHCP response; orother service MAY push changes up tono SIP response is received for theprofile delivery server usingSUBSCRIBE request; or a SIP failure response other than for authorization is received for thetechnique appropriateSUBSCRIBE request to theprofile's URL scheme (e.g.sip-profile event, the next discovery mechanism SHOULD be tried. 2. The local IP network domain for the user agent, either configured or discovered via DHCP, should be used with the technique in [RFC3263] to obtain a host and port to use in the SUBSCRIBE URI. If no SIP response or a SIP failure response other than for authorization is received for the SUBSCRIBE request to the sip-profile event, the next discovery mechanism SHOULD be tried. 3. The fully qualified host name constructed using the host name "sipuaconfig" and concatenated with the local IP network domain (as provided via DHCP or provisioned) should be tried next using the technique in [RFC3263] to obtain a host and port to use in the SUBSCRIBE URI. If no SIP response or a SIP failure response other than for authorization is received for the SUBSCRIBE request to the sip-profile event, the next discovery mechanism SHOULD be tried. 4. If all other discovery techniques fail, the user agent MUST provide a manual means for the user to enter the host and port used to construct the SUBSCRIBE URI. Once a user agent has successfully discovered, enrolled, received a NOTIFY response with profile data or URI(s), the user agent SHOULD cache the device profile SUBCRIBE URI to avoid having to rediscover the profile delivery server again in the future. The user agent SHOULD NOT cache the SUBSCRIBE URI until it receives a NOTIFY with profile data or URI(s). The reason for this is that a profile delivery server may send 202 responses to SUBSCRIBE requests and NOTIFY responses to unknown user agent (see Section 3.6) with no URIs. Until the profile delivery server has sent a NOTIFY request with profile data or URI(s), it has not agreed to provide profiles. To illustrate why the user agent should not cache the device profile SUBSCRIBE URI until profile data or URI(s) are provided in the NOTIFY, consider the following example: a user agent running on a laptop plugged into a visited LAN in which a foreign profile delivery server is discovered. The profile delivery server never provides profile URIs in the NOTIFY request as it is not provisioned to accept the user agent. The user then takes the laptop to their enterprise LAN. If the user agent cached the SUBSCRIBE URI from the visited LAN (which did not provide profiles), when subsequently placed in the enterprise LAN which is provisioned to provide profiles to the user agent, the user agent would not attempt to discover the profile delivery server. 4.1.3 Discovery of User and Application URI The default user's AOR from the device profile (if provided) may then be used to subscribe to the "user" and "application" profiles. Alternatively the user's AOR to be used for the "user" and application" subscription URI, may be "discovered" manually by prompting the user. This "discovered" URI for the user and application profile subscription may be cached. 4.2 Enrollment with Profile Server Enrollment is accomplished by subscribing to the event package described in Section 3. The enrollment process is useful to the profile delivery server as it makes the server aware of user agents to which it may delivery profiles (those user agents the profile delivery server is provisioned to provide profiles to; those present that the server may be provide profiles in the future; and those that the server can automatically provide default profiles). It is an implementation choice and business policy as to whether the profile delivery server provides profiles to user agents that it is not explicitly provisioned to do so. However the profile server SHOULD accept (with 2xx response) SUBSCRIBE requests from any user agent as explained in Section 3.5. 4.3 Notification of Profile Changes The NOTIFY request in the sip-profile event package serves two purposes. First it provides the user agent with a means to obtain the profile directly data or via URI(s) for desired profiles without requiring the end user to manually enter them. It also provides the means for the profile delivery server to notify the user agent that the content of the profiles have changed and should be made effective. Optionally the differential changes may be obtained by including the content-type defined in [I-D.ietf-simple-xcap-package] in the Accept header of the SUBSCRIBE request. 4.4 Retrieval of Profile Data The user agent retrieves its needed profile(s) directly or via the URI(s) provided in the NOTIFY request as specified in Section 3.5. The profile delivery server SHOULD secure the content of the profiles using one of the techniques described in Section 6. The user agent SHOULD make the new profiles effective in the timeframe described in Section 3.2. The contents of the profiles SHOULD be cached by the user agent. This it to avoid the situation where the content delivery server is not available, leaving the user agent non-functional. 4.5 Upload of Profile Changes The user agent or other service MAY push changes up to the profile delivery server using the technique appropriate to the profile's URL scheme (e.g. HTTP PUT method, FTP put command). The technique for pushing incremental or atomic changes MUST be described by the specific profile data framework.5. IANA Considerations There are several IANA considerations associatedA means for pushing changes up into the profile delivery server for XCAP is defined in [I-D.ietf-simple-xcap]. 4.6 Usage of XCAP withthis specification. 5.1 SIP Eventthe Profile Package Thisspecification registersframework allows for the usage of several different protocols for the retrieval of profiles. One protocol which is suitable is XCAP [I-D.ietf-simple-xcap], which allows for HTTP URIs to represent XML documents, elements and attributes. XCAP defines anew event package as defined in [RFC3265]. The followingspecific hierarchy for how documents are organized. As a result, it is necessary to discuss how that organization relates to the rough data model presented here. When a user or device enrolls with a SUBSCRIBE request, the request will contain some kind of identifying informationrequiredforthis registration: Package Name: sip-profile Packagethat user orTemplate-Package:device. This identity isa package Published Document: RFC XXXX (Notemapped toRFC Editor: Please fill in XXXXan XCAP User ID (XUID) based on an implementation specific mapping. The "profile-name" along with theRFC number of this specification). Person to Contact: Daniel Petrie dpetrie@pingtel.com New event"app-id" Event headerparameters: profile-name, vendor, model, version, effective-by 6. Security Considerations Profiles may contain sensitive data such as user credentials. The protection of this data depends upon howparameters specify thedataspecific XCAP application usage. In particular, when the "profile-name" isdelivered. If"application", thedata"app-id" contains the XCAP Application Unique ID (AUID). When the "profile-name" isdeliveredapplication, but the "app-id" parameter is absent, this specifies that the user wishes to SUBSCRIBE to all documents for all application usages associated with the user in theNOTIFY body, SIP authentication MUST be usedrequest-uri. This provides a convenient way forSUBSCRIPTION and SIPS and/or S/MIME MAYa single subscription to beuseused toencrypt theobtain all application data.IfThe XCAP root is determined by a local mapping. When thedata"profile-name" isprovided via content indirection, SIP authentication"device", or "user" or "local-network", this maps to an AUID and document selector for representing device, user and local-network data, respectively. The mapping isnot necessarya matter of local policy. This allows different providers to use different XCAP application usages and document schemas for representing these profiles, without having to configure theSUBSCRIBE request. With content indirectiondevice with thedataspecific AUID which isprotected viabeing used. Furthermore, when theauthentication, authorization and encryption mechanisms provided by"document" attribute is present, it identifies a specific document that is being requested. If theprofile URL scheme. Use of"profile-name" is "application", the "app-id" MUST be present as well. The "document" attribute then specifies a relative path reference. Its first path segment is either "global", specifying global data, or "user", specifying user data for theURL scheme security mechanisms via content indirection simplifiesuser in thesecurity solution asrequest URI. The next path segment identifies theSIP event package does not need to authenticate, authorizepath in the global directory orprotectthecontentsuser's home directory. For example, consider a phone with an instance ID ofthe SIP messages. Effectivelyurn:uuid:00000000-0000-0000-0000-0003968cf920. To obtain its device profile, it would generate a SUBSCRIBE that looks like this: SUBSCRIBE sip:urn%3auuid%3a00000000-0000-0000-0000-0003968cf920@example.com Event: sip-profile;profile-name=device If the profiledeliverydata is stored in an XCAP server, the serverwill providewould the "device" profileURI(s)toanyone. The URLs themselves are protected via authentication, authorizationan application usage andsnooping (e.g. via HTTPS). 6.1 Symmetric Encryption of Profile Datadocument selector based on local policy. If this mapping specifies theURL scheme used for content indirection does not provide authentication, authorization or encryption,AUID "vendor2-device-data" and atechnique to provide this is to encryptdocument called "index" within theprofiles onuser directory, thecontent delivery server usingcorresponding HTTP URI for the document is: http://xcap.example.com/root/vendor2-device-data/users/ urn%3auuid%3a00000000-0000-0000-0000-0003968cf920/index and indeed, if asymmetric encryption algorithm usingcontent indirection is returned in ashared key. The encrypted profiles are delivered byNOTIFY, thecontent delivery server viaURL would equal this. That user profile might specify theURIs provided inuser identity (as a SIP AOR) and their application-usages. From that, theNOTIFY requests. Using this techniquedevice can enroll to learn about its application data. To learn about all of theprofile deliverydata: SUBSCRIBE sip:user-aor@example.com SIP/2.0 Event: sip-profile;profile-name=application The serverdoes not needwould map the request URI toprovide authentication or authorizationan XUI (user-aor, for example) and theretrieval as the profilesxcap root based on local policy. If there areobscured. The user agent must obtain the usernametwo AUIDs, "resource-lists" [I-D.ietf-simple-xcap-list-usage] andpassword from the"rls-services" [I-D.ietf-simple-xcap-list-usage], this would result in a subscription to all documents within: http://xcap.example.com/root/rls-services/users/user-aor http://xcap.example.com/root/resource-lists/users/user-aor The useror other out of band meanswould not be subscribed togeneratethekey and decryptglobal data for these two application usages, since that data is not important for users. However, theprofiles. 7. Differences from Simple XCAP Package The author ofuser/device could be made aware that it needs to subscribe to a specific document. In that case, its subscribe would look like: SUBSCRIBE sip:user-aor@example.com SIP/2.0 Event: sip-profile;profile-name=application;app-id=resource-lists ;document="global/index" thisdocument had an action item from the July 2003 IETF SIPPING WG meetingwould result in a subscription toconsider resolvingthedifferencessingle global document for resource-lists. In some cases, these subscriptions are to a multiplicity ofthe sip-profile and simple XCAP package [I-D.ietf-simple-xcap-package]. It is the author's opiniondocuments. In thatXCAP [I-D.rosenberg-simple-xcap] cancase, the notification format will need to besupported byone which can indicate what document has changed. This includes content indirection, but also theframework andxcap diff format [I-D.ietf-simple-xcap-package]. 5. IANA Considerations There are several IANA considerations associated with this specification. 5.1 SIP Event Package This specification registers a new event package as defined inthis document and that this package provides a superset of the functionality in the XCAP package.[RFC3265]. The followinglists the differences between the event packaged defined ininformation required for thisdocument vs. the one defined in [I-D.ietf-simple-xcap-package]. The simple XCAPregistration: Package Name: sip-profile Package or Template-Package: This is a packagerequires that the relative path be known and specified byPublished Document: RFC XXXX (Note to RFC Editor: Please fill in XXXX with the RFC number of this specification). Person to Contact: Daniel Petrie dpetrie@pingtel.com New event header parameters: profile-name, vendor, model, version, effective-by, document, app-id 6. Security Considerations Profiles may contain sensitive data such as useragent when subscribing for change notification.credentials. Theevent package inprotection of thisdocument requires a token or complete URIdata depends upon how the data is delivered. If the data is delivered in the NOTIFY body, SIP authentication MUST beknownused for SUBSCRIPTION andspecified when subscribing. The advantage ofSIPS and/or S/MIME MAY be use to encrypt thetokendata. If the data isthat bootstrappingprovided via content indirection, SIP authentication iseasier and well defined. It also leavesnot necessary for thefreedom of specifyingSUBSCRIBE request. With content indirection the data is protected via the authentication, authorization andchangingencryption mechanisms provided by theentire pathprofile URL scheme. Use of theprofileURLup toscheme security mechanisms via content indirection simplifies theprofile delivery server. Thesecurity solution as the SIP event packagedefined in this document allows multiple URIsdoes not need tobe provided inauthenticate, authorize or protect theNOTIFY request body as a resultcontents ofa single token specified intheSUBSCRIBE event parameter: profile-name. This allowsSIP messages. Effectively the profile delivery servertocan safely providesets of profilesprofile URI(s) to anyone. The profile content is protected via the URL scheme transport mechanisms for authentication, authorization and encryption (e.g. via HTTPS). HTTPS provides two possible mechanisms for authentication: 1) the device may have a certificate that theuser agentprofile deliver server can request in the TLS setup; or 2) the profile deliver server may use HTTP authentication [RFC2617] with the device or users credentials. 6.1 Symmetric Encryption of Profile Data If the transport for the URL scheme used for content indirection does nothave enough informationprovide authentication, authorization or encryption, a technique tospecify inprovide this is to encrypt theSUBSCRIBE URI (e.g. at boot strapping timeprofiles on the content delivery server using a symmetric encryption algorithm using a shared key. The encrypted profiles are delivered by the content delivery server via theuser agent may not knowURIs provided in theuser's identity, butNOTIFY requests. Using this technique the profile delivery servermay knowdoes not need to provide authentication or authorization for thedefaultretrieval as the profiles are obscured. The userforagent must obtain thedevice's identity) orusername and password from thedoc-componentuser or other out of band means to generate thesimple XCAP package. All other functional differences between draft-ietf-sipping-config-framework-00key anddraft-ietf-simple-xcap-package-00 are believed to be resolved in this version of this document. 8. Open Issues 9.decrypt the profiles. 7. Change History Many thanks to those who contributed and commented on the many iterations of this document. Detailed input was provided by Jonathan Rosenberg from Dynamicsoft, Henning Schulzrinne from Columbia U., Cullen Jennings from Cisco, Rohan Mahy from Cisco, Rich Schaaf from Pingtel, Volker Hilt from Bell Labs.9.17.1 Changes from draft-ietf-sipping-config-framework-03.txt Incorporated changes to better support the requirements for the use of this event package with XCAP and SIMPLE so that we can have one package (i.e. simple-xcap-package now defines a content type not a package). Added an additional profile type: application. Added document and app-id Event header parameters in support of the application profile. Define a loose high level data model or relationship between the four profile types. Tried to edit and fix the confusing and ambiguous sections related to URI formation and discovery for the different profile types. Better describe the importance of uniqueness for the instance id which is used in the user part of the device URI. 7.2 Changes from draft-ietf-sipping-config-framework-02.txt Added the concept of the local network as a source of profile data. There are now three separate logical sources for profile data: user, device and local network. Each of these requires a separate subscription to obtain.9.27.3 Changes from draft-ietf-sipping-config-framework-01.txt Changed the name of the profile-type event parameter to profile-name. Also allow the profile-name parameter to be either a token or an explicit URI. Allow content indirection to be optional. Clarified the use of the Accept header to indicate how the profile is to be delivered. Added some content to the Iana section.9.37.4 Changes from draft-ietf-sipping-config-framework-00.txt This version of the document was entirely restructured and re-written from the previous version as it had been micro edited too much. All of the aspects of defining the event package are now organized in one section and is believed to be complete and up to date with [RFC3265]. The URI used to subscribe to the event package is now either the user or device address or record. The user agent information (vendor, model, MAC and serial number) are now provided as event header parameters. Added a mechanism to force profile changes to be make effective by the user agent in a specified maximum period of time. Changed the name of the event package from sip-config to sip-profile Three high levelsecurityapproachessecurity approaches are now specified.9.47.5 Changes from draft-petrie-sipping-config-framework-00.txt Changed name to reflect SIPPING work group item Synchronized with changes to SIP DHCP [RFC3361], SIP [RFC3261] and [RFC3263], SIP Events [RFC3265] and content indirection [I-D.ietf-sip-content-indirect-mech] Moved the device identity parameters from the From field parameters to User-Agent header parameters. Many thanks to Rich Schaaf of Pingtel, Cullen Jennings of Cisco and Adam Roach of Dyamicsoft for the great comments and input.9.57.6 Changes from draft-petrie-sip-config-framework-01.txt Changed the name as this belongs in the SIPPING work group. Minor edits9.67.7 Changes from draft-petrie-sip-config-framework-00.txt Split the enrollment into a single SUBSCRIBE dialog for each profile. The 00 draft sent a single SUBSCRIBE listing all of the desired. These have been split so that each enrollment can be routed differently. As there is a concept of device specific and user specific profiles, these may also be managed on separate servers. For instance in a roaming situation the device might get its profile data from a local server which knows the LAN specific profile data. At the same time the user specific profiles might come from the user's home environment profile delivery server. Removed the Config-Expires header as it is largely superfluous with the SUBSCRIBE Expires header. Eliminated some of the complexity in the discovery mechanism. Suggest caching information discovered about a profile delivery server to avoid an avalanche problem when a whole building full of devices powers up. Added the User-Profile From header field parameter so that the device can request a user specific profile for a user that is different from the device's default user.108 References [I-D.ietf-simple-xcap] Rosenberg, J., "The Extensible Markup Language (XML) Configuration Access Protocol (XCAP)", draft-ietf-simple-xcap-02 (work in progress), February 2004. [I-D.ietf-simple-xcap-list-usage] Rosenberg, J., "An Extensible Markup Language (XML) Configuration Access Protocol (XCAP) Usage for Presence Lists", draft-ietf-simple-xcap-list-usage-02 (work in progress), February 2004. [I-D.ietf-simple-xcap-package] Rosenberg, J., "A Session Initiation Protocol (SIP) Event Package for Modification Events for the Extensible Markup Language (XML) Configuration Access Protocol (XCAP) Managed Documents", draft-ietf-simple-xcap-package-01 (work in progress), February 2004. [I-D.ietf-sip-content-indirect-mech] Olson, S., "A Mechanism for Content Indirection in Session Initiation Protocol (SIP) Messages", draft-ietf-sip-content-indirect-mech-03 (work in progress), June 2003. [I-D.ietf-sip-gruu] Rosenberg, J., "Obtaining and Using Globally Routable User Agent (UA) URIs (GRUU) in the Session Initiation Protocol (SIP)", draft-ietf-sip-gruu-02 (work in progress), July 2004. [I-D.ietf-sipping-ua-prof-framewk-reqs] Petrie, D. and C. Jennings, "Requirements for SIP User Agent Profile Delivery Framework", draft-ietf-sipping-ua-prof-framewk-reqs-00 (work in progress), March 2003.[I-D.rosenberg-simple-xcap] Rosenberg, J., "The Extensible Markup Language (XML) Configuration Access[I-D.petrie-sipping-profile-datasets] Petrie, D., "A Schema for Session Initiation Protocol(XCAP)", draft-rosenberg-simple-xcap-00User Agent Profile Data Sets", draft-petrie-sipping-profile-datasets-00 (work in progress),May 2003.July 2004. [I-D.sinnreich-sipdev-req] Butcher, I., Lass, S., Petrie, D., Sinnreich, H. and C. Stredicke, "SIP Telephony DeviceRequirements, ConfigurationRequirements andData", draft-sinnreich-sipdev-req-03Configuration", draft-sinnreich-sipdev-req-04 (work in progress),FebruaryJuly 2004. [RFC0822] Crocker, D., "Standard for the format of ARPA Internet text messages", STD 11, RFC 822, August 1982. [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997. [RFC2131] Droms, R., "Dynamic Host Configuration Protocol", RFC 2131, March 1997. [RFC2132] Alexander, S. and R. Droms, "DHCP Options and BOOTP Vendor Extensions", RFC 2132, March 1997. [RFC2141] Moats, R., "URN Syntax", RFC 2141, May 1997. [RFC2246] Dierks, T. and C. Allen, "The TLS Protocol Version 1.0", RFC 2246, January 1999. [RFC2616] Fielding, R., Gettys, J., Mogul, J., Frystyk, H., Masinter, L., Leach, P. and T. Berners-Lee, "Hypertext Transfer Protocol -- HTTP/1.1", RFC 2616, June 1999. [RFC2617] Franks, J., Hallam-Baker, P., Hostetler, J., Lawrence, S., Leach, P., Luotonen, A. and L. Stewart, "HTTP Authentication: Basic and Digest Access Authentication", RFC 2617, June 1999. [RFC2818] Rescorla, E., "HTTP Over TLS", RFC 2818, May 2000. [RFC3261] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston, A., Peterson, J., Sparks, R., Handley, M. and E. Schooler, "SIP: Session Initiation Protocol", RFC 3261, June 2002. [RFC3263] Rosenberg, J. and H. Schulzrinne, "Session Initiation Protocol (SIP): Locating SIP Servers", RFC 3263, June 2002. [RFC3265] Roach, A., "Session Initiation Protocol (SIP)-Specific Event Notification", RFC 3265, June 2002. [RFC3361] Schulzrinne, H., "Dynamic Host Configuration Protocol (DHCP-for-IPv4) Option for Session Initiation Protocol (SIP) Servers", RFC 3361, August 2002. [RFC3377] Hodges, J. and R. Morgan, "Lightweight Directory Access Protocol (v3): Technical Specification", RFC 3377, September 2002. [RFC3617] Lear, E., "Uniform Resource Identifier (URI) Scheme and Applicability Statement for the Trivial File Transfer Protocol (TFTP)", RFC 3617, October 2003. [W3C.REC-xml-names11-20040204] Layman, A., Tobin, R., Bray, T. and D. Hollander, "Namespaces in XML 1.1", W3C REC REC-xml-names11-20040204, February 2004. Author's Address Daniel Petrie Pingtel Corp. 400 W. Cummings Park Suite 2200 Woburn, MA 01801 US Phone: "Dan Petrie (+1 781 938 5306)"<sip:dpetrie@pingtel.com> EMail: dpetrie@pingtel.com URI: http://www.pingtel.com/ Appendix A. Acknowledgments Intellectual Property Statement The IETF takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on the IETF's procedures with respect to rights in standards-track and standards-related documentation can be found in BCP-11. Copies of claims of rights made available for publication and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementors or users of this specification can be obtained from the IETF Secretariat. The IETF invites any interested party to bring to its attention any copyrights, patents or patent applications, or other proprietary rights which may cover technology that may be required to practice this standard. Please address the information to the IETF Executive Director. The IETF has been notified of intellectual property rights claimed in regard to some or all of the specification contained in this document. For more information consult the online list of claimed rights. Full Copyright Statement Copyright (C) The Internet Society (2004). All Rights Reserved. This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this paragraph are included on all such copies and derivative works. However, this document itself may not be modified in any way, such as by removing the copyright notice or references to the Internet Society or other Internet organizations, except as needed for the purpose of developing Internet standards in which case the procedures for copyrights defined in the Internet Standards process must be followed, or as required to translate it into languages other than English. The limited permissions granted above are perpetual and will not be revoked by the Internet Society or its successors or assignees. This document and the information contained herein is provided on an "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Acknowledgment Funding for the RFC Editor function is currently provided by the Internet Society.