draft-ietf-sipping-config-framework-06.txt   draft-ietf-sipping-config-framework-07.txt 
SIPPING D. Petrie SIPPING D. Petrie
Internet-Draft Pingtel Corp. Internet-Draft SIPez LLC.
Expires: August 20, 2005 February 19, 2005 Expires: January 18, 2006 July 17, 2005
A Framework for Session Initiation Protocol User Agent Profile A Framework for Session Initiation Protocol User Agent Profile Delivery
Delivery draft-ietf-sipping-config-framework-07.txt
draft-ietf-sipping-config-framework-06.txt
Status of this Memo Status of this Memo
By submitting this Internet-Draft, I certify that any applicable By submitting this Internet-Draft, each author represents that any
patent or other IPR claims of which I am aware have been disclosed, applicable patent or other IPR claims of which he or she is aware
and any of which I become aware will be disclosed, in accordance with have been or will be disclosed, and any of which he or she becomes
RFC 3668. aware will be disclosed, in accordance with Section 6 of BCP 79.
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF), its areas, and its working groups. Note that Task Force (IETF), its areas, and its working groups. Note that
other groups may also distribute working documents as other groups may also distribute working documents as Internet-
Internet-Drafts. Drafts.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
The list of current Internet-Drafts can be accessed at The list of current Internet-Drafts can be accessed at
http://www.ietf.org/ietf/1id-abstracts.txt. http://www.ietf.org/ietf/1id-abstracts.txt.
The list of Internet-Draft Shadow Directories can be accessed at The list of Internet-Draft Shadow Directories can be accessed at
http://www.ietf.org/shadow.html. http://www.ietf.org/shadow.html.
This Internet-Draft will expire on August 20, 2005. This Internet-Draft will expire on January 18, 2006.
Copyright Notice Copyright Notice
Copyright (C) The Internet Society (2005). All Rights Reserved. Copyright (C) The Internet Society (2005).
Abstract Abstract
This document defines the application of a set of protocols for This document defines the application of a set of protocols for
providing profile data to SIP user agents. The objective is to providing profile data to SIP user agents. The objective is to
define a means for automatically providing profile data a user agent define a means for automatically providing profile data a user agent
needs to be functional without user or administrative intervention. needs to be functional without user or administrative intervention.
The framework for discovery, delivery, notification and updates of The framework for discovery, delivery, notification and updates of
user agent profile data is defined here. As part of this framework a 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 new SIP event package is defined here for the notification of profile
changes. This framework is also intended to ease ongoing changes. This framework is also intended to ease ongoing
administration and upgrading of large scale deployments of SIP user administration and upgrading of large scale deployments of SIP user
agents. The contents and format of the profile data to be defined is agents. The contents and format of the profile data to be defined is
outside the scope of this document. outside the scope of this document.
Table of Contents Table of Contents
1. Motivation . . . . . . . . . . . . . . . . . . . . . . . . . 4 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 4
2. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 4 2. Requirements Terminology . . . . . . . . . . . . . . . . . . 4
2.1 Requirements Terminology . . . . . . . . . . . . . . . . . 4 3. Profile Delivery Framework Terminology . . . . . . . . . . . 4
2.2 Profile Delivery Framework Terminology . . . . . . . . . . 5 4. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.3 Overview . . . . . . . . . . . . . . . . . . . . . . . . . 5 5. Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.4 Data Model . . . . . . . . . . . . . . . . . . . . . . . . 7 5.1 Service Provider Use Case Scenario Bootstrapping with
3. Profile Change Event Notification Package . . . . . . . . . 8 Digest Authentication . . . . . . . . . . . . . . . . . . 7
3.1 Event Package Name . . . . . . . . . . . . . . . . . . . . 9 5.2 Service Provider Use Case Scenario Bootstrapping with
3.2 Event Package Parameters . . . . . . . . . . . . . . . . . 9 Device Certificate . . . . . . . . . . . . . . . . . . . . 9
3.3 SUBSCRIBE Bodies . . . . . . . . . . . . . . . . . . . . . 12 6. Data Model . . . . . . . . . . . . . . . . . . . . . . . . . 9
3.4 Subscription Duration . . . . . . . . . . . . . . . . . . 13 7. Profile Change Event Notification Package . . . . . . . . . 11
3.5 NOTIFY Bodies . . . . . . . . . . . . . . . . . . . . . . 13 7.1 Event Package Name . . . . . . . . . . . . . . . . . . . . 11
3.6 Notifier processing of SUBSCRIBE requests . . . . . . . . 14 7.2 Event Package Parameters . . . . . . . . . . . . . . . . . 11
3.7 Notifier generation of NOTIFY requests . . . . . . . . . . 15 7.3 SUBSCRIBE Bodies . . . . . . . . . . . . . . . . . . . . . 16
3.8 Subscriber processing of NOTIFY requests . . . . . . . . . 15 7.4 Subscription Duration . . . . . . . . . . . . . . . . . . 16
3.9 Handling of forked requests . . . . . . . . . . . . . . . 16 7.5 NOTIFY Bodies . . . . . . . . . . . . . . . . . . . . . . 17
3.10 Rate of notifications . . . . . . . . . . . . . . . . . 16 7.6 Notifier processing of SUBSCRIBE requests . . . . . . . . 17
3.11 State Agents . . . . . . . . . . . . . . . . . . . . . . 16 7.7 Notifier generation of NOTIFY requests . . . . . . . . . . 19
3.12 Examples . . . . . . . . . . . . . . . . . . . . . . . . 16 7.8 Subscriber processing of NOTIFY requests . . . . . . . . . 19
3.13 Use of URIs to Retrieve State . . . . . . . . . . . . . 17 7.9 Handling of forked requests . . . . . . . . . . . . . . . 20
3.13.1 Device URIs . . . . . . . . . . . . . . . . . . . . 18 7.10 Rate of notifications . . . . . . . . . . . . . . . . . 20
3.13.2 User and Application URIs . . . . . . . . . . . . . 19 7.11 State Agents . . . . . . . . . . . . . . . . . . . . . . 20
3.13.3 Local Network URIs . . . . . . . . . . . . . . . . . 20 7.12 Examples . . . . . . . . . . . . . . . . . . . . . . . . 20
4. Profile Delivery Framework Details . . . . . . . . . . . . . 20 7.13 Use of URIs to Retrieve State . . . . . . . . . . . . . 21
4.1 Discovery of Subscription URI . . . . . . . . . . . . . . 20 7.13.1 Device URIs . . . . . . . . . . . . . . . . . . . . 22
4.1.1 Discovery of Local Network URI . . . . . . . . . . . . 21 7.13.2 User and Application URIs . . . . . . . . . . . . . 23
4.1.2 Discovery of Device URI . . . . . . . . . . . . . . . 21 7.13.3 Local Network URIs . . . . . . . . . . . . . . . . . 24
4.1.3 Discovery of User and Application URI . . . . . . . . 24 8. Profile Delivery Framework Details . . . . . . . . . . . . . 24
4.2 Enrollment with Profile Server . . . . . . . . . . . . . . 24 8.1 Discovery of Subscription URI . . . . . . . . . . . . . . 24
4.3 Notification of Profile Changes . . . . . . . . . . . . . 24 8.1.1 Discovery of Local Network URI . . . . . . . . . . . . 25
4.4 Retrieval of Profile Data . . . . . . . . . . . . . . . . 25 8.1.2 Discovery of Device URI . . . . . . . . . . . . . . . 25
4.5 Upload of Profile Changes . . . . . . . . . . . . . . . . 25 8.1.3 Discovery of User and Application URI . . . . . . . . 28
4.6 Usage of XCAP with the Profile Package . . . . . . . . . . 25 8.2 Enrollment with Profile Server . . . . . . . . . . . . . . 29
5. IANA Considerations . . . . . . . . . . . . . . . . . . . . 28 8.3 Notification of Profile Changes . . . . . . . . . . . . . 29
5.1 SIP Event Package . . . . . . . . . . . . . . . . . . . . 28 8.4 Retrieval of Profile Data . . . . . . . . . . . . . . . . 29
6. Security Considerations . . . . . . . . . . . . . . . . . . 28 8.5 Upload of Profile Changes . . . . . . . . . . . . . . . . 30
6.1 Confidential Profile Content in NOTIFY Request . . . . . . 29 8.6 Usage of XCAP with the Profile Package . . . . . . . . . . 30
6.2 Confidential Profile Content via Content Indirection . . . 29 9. IANA Considerations . . . . . . . . . . . . . . . . . . . . 33
6.3 Integrity protection for non-confidential profiles . . . . 30 9.1 SIP Event Package . . . . . . . . . . . . . . . . . . . . 33
7. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 30 10. Security Considerations . . . . . . . . . . . . . . . . . . 33
8. Change History . . . . . . . . . . . . . . . . . . . . . . . 30 10.1 Confidential Profile Content in NOTIFY Request . . . . . 34
8.1 Changes from draft-ietf-sipping-config-framework-05.txt . 31 10.2 Confidential Profile Content via Content Indirection . . 34
8.2 Changes from draft-ietf-sipping-config-framework-04.txt . 31 10.3 Integrity protection for non-confidential profiles . . . 36
8.3 Changes from draft-ietf-sipping-config-framework-03.txt . 31 11. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 36
8.4 Changes from draft-ietf-sipping-config-framework-02.txt . 31 12. Change History . . . . . . . . . . . . . . . . . . . . . . . 36
8.5 Changes from draft-ietf-sipping-config-framework-01.txt . 32 12.1 Changes from
8.6 Changes from draft-ietf-sipping-config-framework-00.txt . 32 draft-ietf-sipping-config-framework-06.txt . . . . . . . 36
8.7 Changes from 12.2 Changes from
draft-petrie-sipping-config-framework-00.txt . . . . . . . 32 draft-ietf-sipping-config-framework-05.txt . . . . . . . 37
8.8 Changes from draft-petrie-sip-config-framework-01.txt . . 33 12.3 Changes from
8.9 Changes from draft-petrie-sip-config-framework-00.txt . . 33 draft-ietf-sipping-config-framework-04.txt . . . . . . . 37
9. References . . . . . . . . . . . . . . . . . . . . . . . . . 33 12.4 Changes from
9.1 Normative References . . . . . . . . . . . . . . . . . . . . 33 draft-ietf-sipping-config-framework-03.txt . . . . . . . 38
9.2 Informative References . . . . . . . . . . . . . . . . . . . 34 12.5 Changes from
Author's Address . . . . . . . . . . . . . . . . . . . . . . 36 draft-ietf-sipping-config-framework-02.txt . . . . . . . 38
Intellectual Property and Copyright Statements . . . . . . . 37 12.6 Changes from
draft-ietf-sipping-config-framework-01.txt . . . . . . . 38
12.7 Changes from
draft-ietf-sipping-config-framework-00.txt . . . . . . . 38
12.8 Changes from
draft-petrie-sipping-config-framework-00.txt . . . . . . 39
12.9 Changes from draft-petrie-sip-config-framework-01.txt . 39
12.10 Changes from draft-petrie-sip-config-framework-00.txt . 39
13. References . . . . . . . . . . . . . . . . . . . . . . . . . 40
13.1 Normative References . . . . . . . . . . . . . . . . . . 40
13.2 Informative References . . . . . . . . . . . . . . . . . 41
Author's Address . . . . . . . . . . . . . . . . . . . . . . 42
Intellectual Property and Copyright Statements . . . . . . . 43
1. Motivation 1. Introduction
Today all SIP (Session Initiation Protocol) [RFC3261] user agent Today all SIP (Session Initiation Protocol) [RFC3261] user agent
implementers use proprietary means of delivering user, device, implementers use proprietary means of delivering user, device,
application and local network policy profiles to the user agent. The application and local network policy profiles to the user agent. The
profile delivery framework defined in this document is intended to profile delivery framework defined in this document is intended to
enable a first phase migration to a standard means of providing enable a first phase migration to a standard means of providing
profiles to SIP user agents. It is expected that UA (User Agent) profiles to SIP user agents. It is expected that UA (User Agent)
implementers will be able to use this framework as a means of implementers will be able to use this framework as a means of
delivering their existing proprietary data profiles (i.e. using delivering their existing proprietary data profiles (i.e. using their
their existing proprietary binary or text formats). This in itself existing proprietary binary or text formats). This in itself is a
is a tremendous advantage in that a SIP environment can use a single tremendous advantage in that a SIP environment can use a single
profile delivery server for profile data to user agents from multiple profile delivery server for profile data to user agents from multiple
implementers. Follow-on standardization activities can: implementers. Follow-on standardization activities can:
1. define a standard profile content format framework (e.g. XML 1. define a standard profile content format framework (e.g. XML
with namespaces [W3C.REC-xml-names11-20040204] or name-value with namespaces [W3C.REC-xml-names11-20040204] or name-value
pairs [RFC0822]). pairs [RFC0822]).
2. specify the content (i.e. name the profile data parameters, xml 2. specify the content (i.e. name the profile data parameters, xml
schema, name spaces) of the data profiles. schema, name spaces) of the data profiles.
One of the objectives of the framework described in this document is 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 to provide a start up experience similar to that of users of an
skipping to change at page 4, line 44 skipping to change at page 4, line 44
deployment of large numbers of user agents. deployment of large numbers of user agents.
Another objective is to provide a scalable means for ongoing Another objective is to provide a scalable means for ongoing
administration of profiles. Administrators and users are likely to administration of profiles. Administrators and users are likely to
want to make changes to profiles. want to make changes to profiles.
Additional requirements for the framework defined in this document Additional requirements for the framework defined in this document
are described in: [I-D.ietf-sipping-ua-prof-framewk-reqs], are described in: [I-D.ietf-sipping-ua-prof-framewk-reqs],
[I-D.sinnreich-sipdev-req] [I-D.sinnreich-sipdev-req]
2. Introduction 2. Requirements Terminology
2.1 Requirements Terminology
Keywords "MUST", "MUST NOT", "REQUIRED", "SHOULD", "SHOULD NOT" and Keywords "MUST", "MUST NOT", "REQUIRED", "SHOULD", "SHOULD NOT" and
"MAY" that appear in this document are to be interpreted as described "MAY" that appear in this document are to be interpreted as described
in [RFC2119]. in [RFC2119].
2.2 Profile Delivery Framework Terminology 3. Profile Delivery Framework Terminology
profile - data set specific to a user, device, user's application or profile - data set specific to a user, device, user's application or
the local network. the local network.
device - software or hardware appliance containing one or more SIP device - software or hardware appliance containing one or more SIP
user agent. user agents.
profile content server - The server that provides the content of the profile content server - The server that provides the content of the
profiles using the protocol specified by the URI scheme. profiles using the protocol specified by the URI scheme.
notifier - As defined in [RFC3265] the SIP user agent server which notifier - As defined in [RFC3265] the SIP user agent server which
processes SUBSCRIBE requests for events and sends NOTIFY requests processes SUBSCRIBE requests for events and sends NOTIFY requests
with profile data or URIs (Uniform Resource Identifiers) that with profile data or URIs (Uniform Resource Identifiers) that
point to the data. point to the data.
profile delivery server - The logical collection of the notifier and profile delivery server - The logical collection of the notifier and
the server which provides the contents of the notification either the server which provides the contents of the notification either
directly in the NOTIFY requests or indirectly via profile URI(s). directly in the NOTIFY requests or indirectly via profile URI(s).
hotelling- when a user moves to a new user agent (i.e. that is not hotelling- when a user moves to a new user agent (i.e. that is not
already provisioned to know the user's identity, credentials or already provisioned to know the user's identity, credentials or
profile data) and gives the user agent sufficient information to profile data) and gives the user agent sufficient information to
retrieve the user's profile(s). The user agent either permanently retrieve the user's profile(s). The user agent either permanently
or temporarily makes the user's profiles effective on that user or temporarily makes the user's profiles effective on that user
agent. agent.
roaming- when the user agent moves to a different local network roaming- when the user agent moves to a different local network
2.3 Overview 4. Overview
The profile life cycle can be described by five functional steps. The profile life cycle can be described by five functional steps.
These steps are not necessarily discrete. However it is useful to These steps are not necessarily discrete. However it is useful to
describe these steps as logically distinct. These steps are named as describe these steps as logically distinct. These steps are named as
follows: follows:
Discovery - discover a profile delivery server Discovery - discover a profile delivery server
Enrollment - enroll with the profile delivery server Enrollment - enroll with the profile delivery server
Profile Retrieval - retrieve profile data Profile Retrieval - retrieve profile data
Profile Change Notification - receive notification of profile changes Profile Change Notification - receive notification of profile changes
Profile Change Upload - upload profile data changes back to the Profile Change Upload - upload profile data changes back to the
profile delivery server profile delivery server
Discovery is the process by which a UA finds the address and port at 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 which it enrolls with the profile delivery server. As there is no
single discovery mechanism which will work in all network single discovery mechanism which will work in all network
environments, a number of discovery mechanisms are defined with a environments, a number of discovery mechanisms are defined with a
prescribed order in which the UA tries them until one succeeds. prescribed order in which the UA tries them until one succeeds. The
means of discovery is described in Section 8.1.
Enrollment is the process by which a UA makes itself known to the Enrollment is the process by which a UA makes itself known to the
profile delivery server. In enrolling, the UA provides identity profile delivery server. In enrolling, the UA provides identity
information, requested profile type(s) and supported protocols for information, requested profile type(s) and supported protocols for
profile retrieval. It also subscribes to a mechanism for profile retrieval. It also subscribes to a mechanism for
notification of profile changes. As a result of enrollment, the UA notification of profile changes. As a result of enrollment, the UA
receives the data or the URI for each of the profiles that the receives the data or the URI for each of the profiles that the
profile delivery server is able to provide. Each profile type (set) profile delivery server is able to provide. Each profile type (set)
requires a separate enrollment or SUBSCRIBE session. A profile type requires a separate enrollment or SUBSCRIBE session. A profile type
may represent one or more data sets (e.g. one profile data set for may represent one or more data sets (e.g. one profile data set for
each of a user's applications). each of a user's applications). Enrollment which is performed by the
device by constructing and sending a SUBSCRIBE request to profile
delivery server for the event package described in Section 7.
Profile Retrieval is the process of retrieving the content for each Profile Retrieval is the process of retrieving the content for each
of the profiles the UA requested. of the profiles the UA requested. The profiles are retrieved either
directly or indirectly from the NOTIFY request body as describe in
Section 7.5 and Section 8.4.
Profile Change Notification is the process by which the profile Profile Change Notification is the process by which the profile
delivery server notifies the UA that the content of one or more of delivery server notifies the UA that the content of one or more of
the profiles has changed. If the content is provided indirectly the the profiles has changed. If the content is provided indirectly the
UA MAY retrieve the profile from the specified URI upon receipt of UA MAY retrieve the profile from the specified URI upon receipt of
the change notification. the change notification. Profile change notification is provided by
the NOTIFY request for the event package as described in Section 7.8
and Section 8.3.
Profile Change Upload is the process by which a UA or other entity Profile Change Upload is the process by which a UA or other entity
(e.g. corporate directory or configuration management server) pushes (e.g. corporate directory or configuration management server) pushes
a change to the profile data back up to the profile delivery server. a change to the profile data back up to the profile delivery server.
This process is described in Section 8.5.
This framework defines a new SIP event package [RFC3265] to solve This framework defines a new SIP event package [RFC3265] to solve
enrollment and profile change notification steps. This event package enrollment and profile change notification steps. The event package
defines everything but the mandatory content type. This makes this in Section 7 defines everything but the mandatory content type. This
event package abstract until the content type is bound. The profile makes this event package abstract until the content type is bound.
content type(s) will be defined outside the scope of this document. The profile content type(s) will be defined outside the scope of this
It is the author's belief that it would be a huge accomplishment if document. It is the author's belief that it would be a huge
all SIP user agent used this framework for delivering their existing accomplishment if all SIP user agents used this framework for
proprietary profiles. Even though this does not accomplish delivering their existing proprietary profiles. Even though this
interoperability of profiles, it is a big first step in easing the does not accomplish interoperability of profiles, it is a big first
administration of SIP user agents. The definition of standard step in easing the administration of SIP user agents. The definition
profiles and data sets (see [I-D.petrie-sipping-profile-datasets] ) of standard profiles and data sets (see [I-D.petrie-sipping-profile-
will enable interoperability as a subsequent step. datasets] ) will enable interoperability as a subsequent step.
The question arises as to why SIP should be used for the profile 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 delivery framework. In this document SIP is used for only a small
portion of the framework. Other existing protocols are more portion of the framework. Other existing protocols are more
appropriate for transport of the profile contents (to and from the appropriate for transport of the profile contents (to and from the
user agent) and are suggested in this document. The discovery step user agent) and are suggested in this document. The discovery step
is simply a specified order and application of existing protocols. is simply a specified order and application of existing protocols
SIP is only needed for the enrollment and change notification (see Section 8.1). SIP is only needed for the enrollment (see
functionality of the profile delivery framework. In many SIP Section 8.2) and change notification functionality (see Section 8.3)
environments (e.g. carrier/subscriber and multi-site enterprise) of the profile delivery framework. In many SIP environments (e.g.
firewall, NAT (Network Address Translation) and IP addressing issues carrier/subscriber and multi-site enterprise) firewall, NAT (Network
make it difficult to get messages between the profile delivery server Address Translation) and IP addressing issues make it difficult to
and the user agent requiring the profiles. 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 With SIP the users and devices already are assigned globally routable
addresses. In addition the firewall and NAT problems are already addresses. In addition the firewall and NAT problems are already
presumably solved in the environments in which SIP user agents are to presumably solved in the environments in which SIP user agents are to
be used. Therefore SIP is the best solution for allowing the user be used. The local network profile (see Section 6, Section 7.13.3
agent to enroll with the profile delivery server, which may require and Section 8.1.1) provides the means to get firewall and NAT
traversal of multiple firewalls and NATs. For the same reason the traversal mechanism information to the device. Therefore SIP is the
notification of profile changes is best solved by SIP. It should be best solution for allowing the user agent to enroll with the profile
noted that this document is scoped to providing profiles for devices delivery server, which may require traversal of multiple firewalls
which contain one or more SIP user agents. This framework may be and NATs. For the same reason the notification of profile changes is
applied to non-SIP devices, however more general requirements for best solved by SIP. It should be noted that this document is scoped
non-SIP devices are beyond the scope of this document. to providing profiles for devices which contain one or more SIP user
agents. This framework may be applied to non-SIP devices, however
more general requirements for non-SIP devices are beyond the scope of
this document.
The content delivery server may be either in the public network or The content delivery server may be either in the public network or
accessible through a private network. The user agents requiring accessible through a private network. The user agents requiring
profiles may be behind firewalls and NATs and many protocols, such as profiles may be behind firewalls and NATs and many protocols, such as
HTTP, may be used for profile content retrieval without special HTTP, may be used for profile content retrieval without special
consideration in the firewalls and NATs (e.g. an HTTP client on the consideration in the firewalls and NATs (e.g. an HTTP client on the
UA can typically pull content from a server outside the NAT/ UA can typically pull content from a server outside the NAT/
firewall.). firewall.).
2.4 Data Model 5. Use Cases
The following use case are intented to help give a understanding of
how the profile delivery framework can be used. These use cases are
not intended to be exhaustive in demonstrating all the capabilities
or ways the framework can be applied.
5.1 Service Provider Use Case Scenario Bootstrapping with Digest
Authentication
The following describes a use case scenario for bootstrapping a new
user agent, which has had no prior provisioned information, to the
point of being functional with a SIP Service Provider's system. In
this example scenario, the user has purchased a new SIP user agent.
The user signs up for the service to obtain three pieces of
information: a hostname, a user ID and a password. These three
pieces of information may be one-time use, that become invalid after
the one use. This scenario assumes that no association or mapping
between the device and the user's account is created before the
following steps:
1. The user plugs the device in to provide power and network
connectivity the first time (or installs the software in the case
of a software user agent). The device subscribes to the local
network to get the local network profile. However as the device
is plugged into a residential LAN or router, there is no profile
delivery server for the local network profile (see Section 8.1.1
and Section 7.13.3). The device assumes symmetric SIP signalling
as there is not local network profie which may have provided
other firewall or NAT traversal mechanism information.
2. The device prompts the user for the hostname to subscribe to for
the device profile. The hostname was provided by the service
provider and use as the host part of the SUBSCRIBE profile URI
described in Section 7.13.1. Note: in a scenario where the
system operator (e.g. enterprise) has control of the network, the
hostname for the SUBSCRIBE can be discovered (see Section 8.1.2)
to avoid the need for the user to enter the hostname.
3. The device creates a TLS connection for the SIP SUBSCRIBE request
to the provided hostname. The device verifies the server's
certificate. If the common name does not match the hostname or
the certificate is not valid, the device warns the user and
prompts whether to continue.
4. The profile delivery server receives the SUBSCRIBE request for
the device profile and sends a NOTIFY with content indirection
containing the HTTPS URI for the device profile (see
Section 7.5).
5. The device receives the NOTIFY request with the device profile
URI. The device prompts the user for the user ID and password
provided by the service provider. The device does an HTTPS GET
to retrieve the device profile (see Section 8.4 and Section 7.8).
The profile delivery server challenges for Digest authentication.
The device re-sends the HTTPS GET with Digest credentials using
the user ID and password entered by the user. Note: for devices
with only DTMF style input, the service provider may provide the
host, user ID and password in octal format that can be entered
requiring only digits.
6. The profile delivery server receives the HTTP GET request for the
device profile along with the user ID and password for the
specific user. At this point the profile delivery server has
authenticated the user and can create an association between a
specific device identified in the HTTPS URI and the user or user
account (see Section 10.2). The profile delivery server provides
the device profile which contains the on-going SUBSCRIBE request
URIs for the device, user and application profiles along with
credentials for retrieving the profiles.
7. The device receives the device profile from the HTTPS response,
re-SUBSCRIBEs using the device profile URI provided in the
profile. The device profile also may contain URIs for the
default user's user and application profile SUBSCRIBE request
URIs for the SIP event package defined in Section 7. The device
uses these URIs to retrieve user and application profiles in a
similar way to the device profile. After retriving these
profiles the device is fully functional in the service provider's
SIP service.
5.2 Service Provider Use Case Scenario Bootstrapping with Device
Certificate
The following describes another use case scenario where the device
implementor provides a certificate for the device which authenticates
the device ID. In this scenario, the user signs up for the SIP
service with the service provider and provides the device ID (see
Section 7.13.1 for more information on device ID) to the service
provider prior to the following steps, so that the service provider
has an association or mapping between the device ID and the user
account ahead of time. The service provide gives the user a hostname
to be entered on the device.
1. Step 1-3 occur the same as in the prior use case described in
Section 5.1.
2. The device receives the NOTIFY request with the device profile
URI. The device does an HTTPS GET to retrieve the device profile
(see Section 8.4 and Section 7.8).
3. The profile delivery server requests the device certficate in the
TLS connection used for the HTTPS GET. The device has a
certificate which has a SIP URI in the Subject Alternative Name
field that contains the device ID. The device certificate is
signed and provided by the implementor for the purpose of
authenticating the device ID in the initial bootstrapping process
only. The profile delivery server validates the device ID and
encrypts the device profile using the public key in the device's
certificate as described in Section 10.2
4. The device receives the encrypted device profile from the HTTPS
response, decrypts the profile using it private key. The process
continues in a similar way to step 6 in the above use case. The
device profile contains a more perminent device certificate and
private key or Digest authentication credentials which is used
for on-going device ID authentication.
6. Data Model
A conscious separation of device, user, application and local network A conscious separation of device, user, application and local network
profiles is made in this document. This is useful to provide profiles is made in this document. This is useful to provide
features such as hotelling (described above) as well as securing or features such as hotelling (described above) as well as securing or
restricting user agent functionality. By maintaining this restricting user agent functionality. By maintaining this
separation, a user may walk up to someone else's user agent and separation, a user may walk up to someone else's user agent and
direct that user agent to get the new user's profile data. In doing direct that user agent to get the new user's profile data. In doing
so the user agent can replace the previous user's profile data while so the user agent can replace the previous user's profile data while
still keeping the device's and the local network's profile data which still keeping the device's and the local network's profile data which
may be necessary for core functionality and communication described may be necessary for core functionality and communication described
skipping to change at page 8, line 10 skipping to change at page 10, line 33
applications are enabled with this separation of profiles. applications are enabled with this separation of profiles.
A very high level data model is implied here with the separation of A very high level data model is implied here with the separation of
these four profile types. Each profile type instance requires a these four profile types. Each profile type instance requires a
separate subscription to retrieve the profile. A loose hierarchy separate subscription to retrieve the profile. A loose hierarchy
exists mostly for the purpose of boot strapping and discovery or exists mostly for the purpose of boot strapping and discovery or
formation of the profile URIs. No other meaning is implied by this formation of the profile URIs. No other meaning is implied by this
hierarchy. However the profile format and data sets to be defined hierarchy. However the profile format and data sets to be defined
outside this document may define additional meaning to this outside this document may define additional meaning to this
hierarchy. In the boot strapping scenario, a device straight out of hierarchy. In the boot strapping scenario, a device straight out of
the box (software or hardware) does not know anything about it's user the box (software or hardware) does not know anything about its user
or local network. The one thing that is does know is it's instance or local network. The one thing that is does know is it's instance
id. So the hierarchy of the profiles exists as follows. id. So the hierarchy of the profiles exists as follows.
The instance id is used to form the user id part of the URI for The local network profile is subscribed to and retrieved based upon a
subscribing to the device profile. The device profile may contain a URI formed from the local network domain. The local network profile
default user AOR (Address of Record) for that device. The default is subscribed to first as it may contain information on how to
user AOR may then be used to retrieve the user profile. Applications communicate to the Internet or primary network from the local network
to be used on the device may be defined in the device and user (e.g. HTTP proxy, SIP firewall or NAT traversal information). The
profiles. The user's AOR is also used to retrieve any application device instance id is used to form the user id part of the URI for
profiles for that user. The local network profile is not referenced subscribing to the device and local network profiles. The device
in any way from the device, user, application profiles. It is profile may contain a default user AOR (Address of Record) for that
subscribed to and retrieved based upon a URI formed from the local device. The default user AOR may then be used to retrieve the user
network domain. profile. Applications to be used on the device may be defined in the
device and user profiles. The user's AOR is also used to retrieve
any application profiles for that user.
3. Profile Change Event Notification Package 7. Profile Change Event Notification Package
This section defines a new SIP event package [RFC3265]. The purpose This section defines a new SIP event package [RFC3265]. The purpose
of this event package is to send to subscribers notification of of this event package is to send to subscribers notification of
content changes to the profile(s) of interest and to provide the content changes to the profile(s) of interest and to provide the
location of the profile(s) via content indirection location of the profile(s) via content indirection [I-D.ietf-sip-
[I-D.ietf-sip-content-indirect-mech] or directly in the body of the content-indirect-mech] or directly in the body of the NOTIFY.
NOTIFY. Frequently the profiles delivered to the user agent are much Frequently the profiles delivered to the user agent are much larger
larger (e.g. several KB or even several MB) than the MTU of the (e.g. several KB or even several MB) than the MTU of the network.
network. These larger profiles will cause larger than normal SIP These larger profiles will cause larger than normal SIP messages and
messages and consequently higher impact on the SIP servers and consequently higher impact on the SIP servers and infrastructure. To
infrastructure. To avoid the higher impact and load on the SIP avoid the higher impact and load on the SIP infrastructure, content
infrastructure, content indirection SHOULD be used if the profile is indirection SHOULD be used if the profile is large enough to cause
large enough to cause packet fragmentation over the transport packet fragmentation over the transport protocol. The presence of
protocol. The presence of the MIME type for content indirection the MIME type for content indirection [I-D.ietf-sip-content-indirect-
[I-D.ietf-sip-content-indirect-mech] in the Accept header indicates mech] in the Accept header indicates that the user agent supports
that the user agent supports content indirection and that the profile content indirection and that the profile delivery server SHOULD use
delivery server SHOULD use content indirection. Similarly the content indirection. Similarly the content type for the differential
content type for the differential notification of profile changes notification of profile changes [I-D.ietf-simple-xcap-package] may be
[I-D.ietf-simple-xcap-package] may be used in the Accept header to used in the Accept header to express support for receiving profile
express support for receiving profile change deltas. change deltas.
The MIME types or formats of profiles to be delivered via this The MIME types or formats of profiles to be delivered via this
framework are to be defined in the documents that define the profile framework are to be defined in the documents that define the profile
contents. These profile MIME types specified in the Accept header contents. These profile MIME types specified in the Accept header
along with the profile types specified in the Event header parameter along with the profile types specified in the Event header parameter
"profile-type" MAY be used to specify which profiles get delivered "profile-type" MAY be used to specify which profiles get delivered
either directly or indirectly in the NOTIFY requests. As this event either directly or indirectly in the NOTIFY requests. As this event
package does not specify the mandatory content type, this package is package does not specify the mandatory content type, this package is
abstract. The profile definition documents will specify the abstract. The profile definition documents will specify the
mandatory content type to make a concrete event package. mandatory content type to make a concrete event package.
3.1 Event Package Name 7.1 Event Package Name
The name of this package is "sip-profile". This value appears in the The name of this package is "ua-profile". This value appears in the
Event header field present in SUBSCRIBE and NOTIFY requests for this Event header field present in SUBSCRIBE and NOTIFY requests for this
package as defined in [RFC3265]. package as defined in [RFC3265].
3.2 Event Package Parameters 7.2 Event Package Parameters
This package defines the following new parameters for the event This package defines the following new parameters for the event
header: "profile-type", "vendor", "model", "version", "effective-by", header: "profile-type", "vendor", "model", "version", "effective-by",
"document", "app-id", "network-user". The "effective-by" parameter "document", "auid", "network-user". The "effective-by" parameter is
is for use in NOTIFY requests only. The "effective-by" parameter is for use in NOTIFY requests only. The "effective-by" parameter is
ignored if it appears in a SUBSCRIBE request. The others parameters ignored if it appears in a SUBSCRIBE request. The other parameters
are for use in the SUBSCRIBE request and are ignored if they appear are for use in the SUBSCRIBE request and are ignored if they appear
in NOTIFY requests. in NOTIFY requests.
The "profile-type" parameter is used to indicate the token name of The "profile-type" parameter is used to indicate the token name of
the profile type the user agent wishes to obtain data or URIs for and the profile type the user agent wishes to obtain data or URIs for and
to be notified of subsequent changes. Using a token in this to be notified of subsequent changes. Using a token in this
parameter allows the URI semantics for retrieving the profiles to be parameter allows the URI semantics for retrieving the profiles to be
opaque to the subscribing user agent. All it needs to know is the opaque to the subscribing user agent. All it needs to know is the
token value for this parameter. This document defines four logical token value for this parameter. This document defines four logical
types of profiles and their token names. The contents or format of types of profiles and their token names. The contents or format of
the profiles is outside the scope of this document. the profiles is outside the scope of this document.
The four types of profiles defined here are "device", "user", The four types of profiles defined here are "device", "user",
"application" and "local". Specifying "device" type profile(s) "application" and "local-network". Specifying "device" type
indicates the desire for the profile data (URI when content profile(s) indicates the desire for the profile data (URI when
indirection is used) and change notification of the contents of the content indirection is used) and change notification of the contents
profile that is specific to the device or user agent. Specifying of the profile that is specific to the device or user agent.
"user" type profile indicates the desire for the profile data (URI Specifying "user" type profile indicates the desire for the profile
when content indirection is used) and change notification of the data (URI when content indirection is used) and change notification
profile content for the user. Specifying "application" type profile of the profile content for the user. Specifying "application" type
indicates the desire for the profile data (URI when content profile indicates the desire for the profile data (URI when content
indirection is used) and change notification of the profile content indirection is used) and change notification of the profile content
for the user's applications. Specifying "local" type profile for the user's applications. Specifying "local-network" type profile
indicates the desire for profiles data (URI when content indirection indicates the desire for profile data (URI when content indirection
is used) specific to the local network. The device, user, is used) specific to the local network. The device, user,
application or local network is identified in the URI of the application or local network is identified in the URI of the
SUBSCRIBE request. A separate SUBSCRIBE dialog is used for each SUBSCRIBE request. A separate SUBSCRIBE dialog is used for each
profile type. The profile type associated with the dialog can then profile type. The profile type associated with the dialog can then
be used to infer which profile type changed and is contained in the be used to infer which profile type changed and is contained in the
NOTIFY or content indirection URI. The Accept header of the NOTIFY or content indirection URI. The Accept header of the
SUBSCRIBE request MUST include the MIME types for all profile content SUBSCRIBE request MUST include the MIME types for all profile content
types for which the subscribing user agent wishes to retrieve types for which the subscribing user agent wishes to retrieve
profiles or receive change notifications. profiles or receive change notifications. In the following ABNF,
EQUAL and token are defined in [RFC3261].
Profile-type = "profile-type" EQUAL profile-value Profile-type = "profile-type" EQUAL profile-value
profile-value = profile-types / token profile-value = profile-types / token
profile-types = "device" / "user" / "application" / "local" profile-types = "device" / "user" / "application" / "local-network"
The "device", "user", "application" or "local" token in the The "device", "user", "application" or "local-network" token in
profile-type parameter may represent a class or set of profile the profile-type parameter may represent a class or set of profile
properties. As standards are defined for specific profile properties. As standards are defined for specific profile
contents related to the user, device or local network, it may be contents related to the user, device or local network, it may be
desirable to define additional tokens for the profile-type desirable to define additional tokens for the profile-type
parameter. Also additional content types may be defined along parameter. Also additional content types may be defined along
with the profile formats that can be used in the Accept header of with the profile formats that can be used in the Accept header of
the SUBSCRIBE to filter or indicate what data sets of the profile the SUBSCRIBE to filter or indicate what data sets of the profile
are desired. are desired.
The rational for the separation of user, device, application and The rational for the separation of user, device, application and
local network type profiles is provided in Section 2.3. It should be local network type profiles is provided in Section 4. It should be
noted that any of the types may result in zero or more profiles or noted that any of the types may result in zero or more profiles or
URIs being provided in the NOTIFY request. As discussed, a default URIs being provided in the NOTIFY request. As discussed, a default
user may be assigned to a device. The default user's AOR, if defined user may be assigned to a device. The default user's AOR, if defined
in the device profile, may in turn be used as the URI to SUBSCRIBE to in the device profile, may in turn be used as the URI to SUBSCRIBE to
the "user" and "application" profile types. the "user" and "application" profile types.
The data provided in the four types of profiles may overlap. As an The data provided in the four types of profiles may overlap. As an
example the codecs that a user prefers to use, the codecs that the example the codecs that a user prefers to use, the codecs that the
device supports (and the enterprise or device owner wishes to use), device supports (and the enterprise or device owner wishes to use),
the codecs that the local network can support (and the network the codecs that the local network can support (and the network
operator wishes to allow) all may overlap in how they are specified operator wishes to allow) all may overlap in how they are specified
in the three corresponding profiles. This policy of merging the in the three corresponding profiles. This policy for merging the
constraints across the multiple profile types can only unambiguously constraints across the multiple profile types can only unambiguously
be defined along with the profile format and syntax. This is out of be defined in the context of the profile syntax and semantics. This
scope for this document. is out of scope for this document.
The "vendor", "model" and "version" parameter values are tokens The "vendor", "model" and "version" parameter values are tokens
specified by the implementer of the user agent. These parameters specified by the implementer of the user agent. These parameters
MUST be provided in the SUBSCRIBE request for all profile types. The MUST be provided in the SUBSCRIBE request for all profile types. The
implementer SHOULD use their DNS domain name (e.g. example.com) as implementer SHOULD use their DNS domain name (e.g. example.com) as
the value of the "vendor" parameter so that it is known to be unique. the value of the "vendor" parameter so that it is known to be unique.
These parameters are useful to the profile delivery server to affect These parameters are useful to the profile delivery server to affect
the profiles provided. In some scenarios it is desirable to provide the profiles provided. In some scenarios it is desirable to provide
different profiles based upon these parameters. For example feature different profiles based upon these parameters. For example feature
property X in a profile may work differently on two versions of user property X in a profile may work differently on two versions of user
agent. This gives the profile delivery server the ability to agent. This gives the profile delivery server the ability to
compensate for or take advantage of the differences. compensate for or take advantage of the differences. In the
following ABNF, EQUAL and quoted-string are defined in [RFC3261].
Vendor = "vendor" EQUAL token / quoted-string Vendor = "vendor" EQUAL quoted-string
Model = "model" EQUAL token / quoted-string Model = "model" EQUAL quoted-string
Version = "version" EQUAL token / quoted-string Version = "version" EQUAL quoted-string
The "network-user" parameter MAY be used when subscribing for device The "network-user" parameter SHOULD be set when subscribing for
and local network profiles. When the profile-type is "device" or device and local network profiles if the user's AOR is known. When
"local" , the SUBSCRIBE URI addresses the device or local network the profile-type is "device" or "local-network", the SUBSCRIBE URI
profile delivery server. It by design cannot indicate the user's addresses the device or local network profile delivery server. It by
identity. The "network-user" parameter is used to indicate the design cannot indicate the user's identity. The "network-user"
user's AOR. The SUBSCRIBE server may authenticate the subscriber to parameter is used to indicate the user's AOR. The SUBSCRIBE server
verify this AOR. If the value of the "profile-type" parameter is not SHOULD authenticate the subscriber to verify the AOR in the "network-
"device" or "local", the "network-user" parameter has no defined user" parameter if the profile provided is specific to the AOR. If
meaning and is ignored. the value of the "profile-type" parameter is not "device" or "local-
network", the "network-user" parameter has no defined meaning and is
ignored. If the "network-user" parameter is provided in the
SUBSCRIBE request, it MUST be present in the NOTIFY request as well.
In the following ABNF, name-addr, addr-spec are defined in [RFC3261].
Network-User = "network-user" EQUAL name-addr / addr-spec Network-User = "network-user" EQUAL name-addr / addr-spec
When the profile-type is "device", the user agent SHOULD set the
"network-user" parameter to the user's AOR if it is known. This is
an indication to the profile delivery server to set or change the
association of the default user with the device indicated in the
SUBSCRIBE URI. If the profile delivery server implements and allows
this policy of setting the default user with a device, the user agent
can utilize this mechanism to allow a user to login and make the user
agent and user association permanent.
When the profile-type is "device", the user agent MAY set the In the case where the profile-type is "local-network", the user agent
"network-user" parameter to the user's AOR. This is an indication to SHOULD set the "network-user" parameter if the user's AOR is known.
the profile delivery server to set or change the association of the If the user has special privileges beyond that of an anonymous user
default user with the device indicated in the SUBSCRIBE URI. If the in the local network, the "network-user" parameter identifies the
profile delivery server implements and allows this policy of setting user to the local network. The value of this parameter is the user's
the default user with a device, the user agent can utilize this address of record.
mechanism to allow a user to login and make the user agent and user
association permanent.
In the case where the profile-type is "local", the user agent MAY set
the "network-user" parameter. 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 "effective-by" parameter in the Event header of the NOTIFY The "effective-by" parameter in the Event header of the NOTIFY
request specifies the maximum number of seconds before the user agent request specifies the maximum number of seconds before the user agent
must attempt to make the new profile effective. A value of 0 (zero) must attempt to make the new profile effective. The "effective-by"
indicates that the subscribing user agent must attempt to make the parameter MAY be provided in the NOTIFY request for any of the
profiles effective immediately (despite possible service profile types. A value of 0 (zero) indicates that the subscribing
interruptions). This gives the profile delivery server the power to user agent must attempt to make the profiles effective immediately
control when the profile is effective. This may be important to (despite possible service interruptions). This gives the profile
resolve an emergency problem or disable a user agent immediately. delivery server the power to control when the profile is effective.
The "effective-by" parameter is ignored in all messages other than This may be important to resolve an emergency problem or disable a
the NOTIFY request. user agent immediately. The "effective-by" parameter is ignored in
all messages other than the NOTIFY request. In the following ABNF,
EQUAL and DIGIT are defined in [RFC3261].
Effective-By = "effective-by" EQUAL 1*DIGIT Effective-By = "effective-by" EQUAL 1*DIGIT
The "document" parameter is used to specify a relative URI for a The "document" parameter is used to specify a relative URI for a
specific profile document that the user agent wishes to retrieve and specific profile document that the user agent wishes to retrieve and
to receive change notification. This is particularly useful for for which it wishes to receive change notification. This is useful
profile content like XCAP [I-D.ietf-simple-xcap] where there is a for profile content like XCAP [I-D.ietf-simple-xcap] where there is a
well defined URI schema and the user agent knows the specific content well defined URI schema and the user agent knows the specific content
that it wants. This provides a filtering mechanism to restrict the that it wants. This provides a filtering mechanism to restrict the
content to be retrieved and for which change notification is to be content to be retrieved and for which change notification is to be
received. (The size of the content is important in limited bandwidth received. (The size of the content is important in limited bandwidth
environments.) The "document" parameter value syntax is a quoted environments.) The "document" parameter value syntax is a quoted
string. The values for the "document" parameter are defined as part string. The values for the "document" parameter are defined as part
of the profile data format, which is out of scope for this document. of the profile data format, which is out of scope for this document.
For more details on the use of this package with XCAP see Section To use the "document" parameter, the profile data format, must also
4.6. The "document" parameter MAY be set in SUBSCRIBE requests. It define a URL path schema. For more details on the use of this
is ignored in all other messages. package and the "document" parameter with XCAP see Section 8.6. The
"document" parameter MAY be set in SUBSCRIBE requests for any of the
profile types. It is ignored in all other messages. In the
following ABNF EQUAL and quoted-string is defined in [RFC3261].
Document = "document" EQUAL quoted-string Document = "document" EQUAL quoted-string
The "app-id" parameter MAY be set when the "profile-type" parameter The "auid" parameter MAY be set when the "profile-type" parameter
value is "application". The "app-id" indicates that the user agent value is "application". The "auid" indicates that the user agent
wishes to retrieve the profile data or URI and change notification wishes to retrieve the profile data or URI and change notification
for the application profile data for the specific application for the application profile data for the specific application
indicated in the value of the "app-id" parameter. Like the indicated in the value of the "auid" parameter. Like the "document"
"document" parameter, the "app-id" parameter provides a filtering parameter, the "auid" parameter provides a filtering mechanism on the
mechanism on the profile content. The "app-id" parameter value is a profile content. The "auid" parameter value is a quoted string. The
token. The values for the app-id parameter are defined as part of values for the "auid" parameter are defined as part of the profile
the profile data format, which is out of scope for this document. data format to be used with XCAP (see [I-D.ietf-simple-xcap] ), which
The "app-id" parameter has meaning only in SUBSCRIBE requests when is out of scope for this document. The "auid" parameter has meaning
the "profile-type" Event header parameter is set to "application". only in SUBSCRIBE requests when the "profile-type" Event header
The "app-id" parameter is ignored in all other messages. parameter is set to "application". It is an error to set both the
"document" and "auid" parameters in a SUBSCRIBE request. The "auid"
parameter is ignored in all other messages.
App-Id = "app-id" EQUAL token / quoted-string AUID = "auid" EQUAL quoted-string
SUBSCRIBE request Event header examples: SUBSCRIBE request Event header examples:
Event: sip-profile;profile-type=device; Event: ua-profile;profile-type=device;
vendor=vendor.example.com;model=Z100;version=1.2.3 vendor="vendor.example.com";model="Z100";version="1.2.3"
Event: sip-profile;profile-type="user"; Event: ua-profile;profile-type="user";
document="user-aor/"; document="user-aor/";
vendor=premier;model=trs8000;version=5.5 vendor="premier";model="trs8000";version="5.5"
NOTIFY request Event header examples: NOTIFY request Event header examples:
Event: sip-profile;effective-by=0 Event: ua-profile;effective-by=0
Event: sip-profile;effective-by=3600 Event: ua-profile;effective-by=3600
3.3 SUBSCRIBE Bodies The following table shows the use of Event header parameters in
SUBSCRIBE requests for the four profile types:
profile-type || device | user | application | local-network
===========================================================
vendor || m | m | m | m
model || m | m | m | m
version || m | m | m | m
network-user || | | | s
document || o | o | o | o
auid || | | o |
effective-by || | | |
m - manditory
s - SHOULD be provided
o - optional
Non-specified means that the parameter has no meaning and
should be ignored.
The following table shows the use of Event header parameters in
NOTIFY requests for the four profile types:
profile-type || device | user | application | local-network
===========================================================
vendor || | | |
model || | | |
version || | | |
network-user || | | | s
document || o/m | o/m | o/m | o/m
auid || | | o/m |
effective-by || o | o | o | o
o/m - manditory if provided in the SUBSCRIBE request
7.3 SUBSCRIBE Bodies
This package defines no new use of the SUBSCRIBE request body. This package defines no new use of the SUBSCRIBE request body.
Future follow on documents may specify a filter-like mechanism using Future documents may specify a filter-like mechanism using etags to
etags to minimize the delivery or notification of profiles where the minimize the delivery or notification of profiles where the user
user agent already has a current version. agent already has a current version.
3.4 Subscription Duration 7.4 Subscription Duration
As the presence (or lack of) a device or user agent it not very time As the presence (or lack of) a device or user agent is not very time
critical to the functionality of the profile delivery server, it is critical to the functionality of the profile delivery server, it is
recommended that default subscription duration be 86400 seconds (one recommended that default subscription duration be 86400 seconds (one
day). A one time fetch of a profile can be accomplished by setting day). A one-time fetch of a profile can be accomplished by setting
the Expires parameter to 0 as defined in [RFC3265] resulting in a the Expires parameter to 0 as defined in [RFC3265] resulting in a
single NOTIFY with no change notification. single NOTIFY with no change notification.
3.5 NOTIFY Bodies 7.5 NOTIFY Bodies
The size of profile content is likely to be hundreds to several The size of profile content is likely to be hundreds to several
thousand of bytes in size. For this reason if the Accept header of thousand of bytes in size. For this reason if the Accept header of
the SUBSCRIBE included the MIME type: message/external-body the SUBSCRIBE included the MIME type message/external-body indicating
indicating support for content indirection the profile delivery support for content indirection the profile delivery server SHOULD
server SHOULD use content indirection use content indirection [I-D.ietf-sip-content-indirect-mech] in the
[I-D.ietf-sip-content-indirect-mech] in the NOTIFY body for providing NOTIFY body for providing the profiles.
the profiles.
When delivering profiles via content indirection the profile delivery When delivering profiles via content indirection the profile delivery
server MUST include the Content-ID MIME header described in server MUST include the Content-ID MIME header described in
[I-D.ietf-sip-content-indirect-mech] for each profile URI. This is [I-D.ietf-sip-content-indirect-mech] for each profile URI. This is
to avoid unnecessary download of the profiles. Some user agents are to avoid unnecessary download of the profiles. Some user agents are
not able to make a profile effective without rebooting or restarting. not able to make a profile effective without rebooting or restarting.
Rebooting is something to be avoided on a user agent performing Rebooting is something to be avoided on a user agent performing
services such as telephony. In this way the Content-ID allows the services such as telephony. In this way the Content-ID allows the
user agent to avoid unnecessary interruption of service as well. The user agent to avoid unnecessary interruption of service as well. The
Content-Type MUST be specified for each URI. The profile delivery Content-Type MUST be specified for each URI. For minimal
server MUST support the "http:" and "https:" schemes URI for content interoperability, the profile delivery server MUST support the
indirection. Other URI schemes MAY also be provided in the content "http:" and "https:" URI schemes for content indirection. Other URI
indirection. schemes MAY also be provided in the content indirection. However the
security considerations are define for content indirection using HTTP
and HTTPS. Other protocols MAY be supported for content indirection,
but are out of scope of this document.
Initially user agent implementers may use a proprietary content Initially user agent implementers may use a proprietary content
type for the profiles retrieved from the URI(s). This is a good type for the profiles retrieved from the URI(s). This is a good
first step towards easing the management of user agents. Standard first step towards easing the management of user agents. Standard
profile contents, content type and formats will need to be defined profile contents, content type and formats will need to be defined
for true interoperability of profile delivery. The specification for true interoperability of profile delivery. The specification
of the content is out of the scope of this document. of the content is out of the scope of this document.
The URI scheme [RFC2396] used in content indirection may be dictated The URI scheme [RFC2396] used in content indirection may be dictated
by the profile content that is required. It is expected that FTP by the profile content that is required. It is expected that FTP
[RFC0959], HTTP [RFC2616], HTTPS [RFC2818], LDAP [RFC3377], XCAP [RFC0959], HTTP [RFC2616], HTTPS [RFC2818], LDAP [RFC3377], XCAP
[I-D.ietf-simple-xcap] and other URI schemes could be used by this [I-D.ietf-simple-xcap] and other URI schemes could be used by this
package and framework if the subscribing user agent and profile package and framework if the subscribing user agent and profile
delivery server both support the same scheme. The negotiation of the delivery server both support the same scheme. The negotiation of the
URI scheme is described in the following sections. URI scheme is described in the following sections.
3.6 Notifier processing of SUBSCRIBE requests 7.6 Notifier processing of SUBSCRIBE requests
The general rules for processing SUBSCRIBE requests [RFC3265] apply The general rules for processing SUBSCRIBE requests [RFC3265] apply
to this package. If content indirection is used for delivering the to this package. If content indirection is used for delivering the
profiles, the notifier does not need to authenticate the subscription profiles, the notifier does not need to authenticate the subscription
as the profile content is not transported in the SUBSCRIBE or NOTIFY as the profile content is not transported in the SUBSCRIBE or NOTIFY
transaction messages. With content indirection only URIs are transaction messages. With content indirection only URIs are
transported in the NOTIFY request which may be secured using the transported in the NOTIFY request which may be secured using the
techniques in Section 6. If content indirection is not used, SIPS techniques in Section 10. If content indirection is not used, the
with SIP authentication SHOULD be used. The subscriber MUST support subscribe server SHOULD reject SUBSCRIBE requests from conections
the "http:" or "https:" URI scheme for content indirection. If the that are not over TLS and SHOULD challenge the SUBSCRIBE request with
subscriber wishes to use a URI scheme other than "http:", the SIP Digest authentication. The subscriber MUST support the "http:"
subscriber must use the "schemes" Contact header field parameter to or "https:" URI scheme for content indirection. If the subscriber
indicate the URI scheme as defined in wishes to use a URI scheme other than "http:", the subscriber must
[I-D.ietf-sip-content-indirect-mech]. For example the subscriber may use the "schemes" Contact header field parameter to indicate the URI
request that content indirection use the "ldaps:" URI scheme by scheme as defined in [I-D.ietf-sip-content-indirect-mech]. For
including "ldaps" in the "scheme" Contact header parameter of the example the subscriber may request that content indirection use the
SUBSCRIBE request. If the subscriber does not specify the URI "ldaps:" URI scheme by including "ldaps" in the "scheme" Contact
scheme, the notifier may use either "http:" or "https:". header parameter of the SUBSCRIBE request. If the subscriber does
not specify the URI scheme, the notifier may use either "http:" or
"https:".
The profile generation behavior of the profile delivery server is The profile generation behavior of the profile delivery server is
left to the implementer. The profile delivery server may be as 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 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 HTTP server delivering static files that are hand edited. At the
other extreme the profile delivery server can be part of a other extreme the profile delivery server can be part of a
configuration management system that integrates with a corporate configuration management system that integrates with a corporate
directory and IT system or carrier operations support systems, directory and IT system or carrier operations support systems,
where the profiles are automatically generated. The design of where the profiles are automatically generated. The design of
this framework intentionally provides the flexibility of this framework intentionally provides the flexibility of
skipping to change at page 14, line 47 skipping to change at page 18, line 39
If the user or device is not known to the profile delivery server, If the user or device is not known to the profile delivery server,
the implementer MAY accept the subscription or reject it. It is the implementer MAY accept the subscription or reject it. It is
recommended that the implementer accept the subscription. It is recommended that the implementer accept the subscription. It is
useful for the profile delivery server to maintain the subscription useful for the profile delivery server to maintain the subscription
for unprovisioned users or devices as an administrator may add the for unprovisioned users or devices as an administrator may add the
user or device to the system after the initial subscription, defining user or device to the system after the initial subscription, defining
the profile contents. This allows the profile delivery server to the profile contents. This allows the profile delivery server to
immediately send a NOTIFY request with the profile URIs. If the immediately send a NOTIFY request with the profile URIs. If the
profile delivery server does not accept the subscription from an profile delivery server does not accept the subscription from an
unknown user or device, the administer or user must manually provoke unknown user or device, the administer or user must manually provoke
the user agent to resubscribe. This may be difficult if the user the user agent to re-subscribe. This may be difficult if the user
agent and administrator are at different locations. agent and administrator are at different locations.
A user agent can provide hotelling by collecting a user's AOR and A user agent can provide hotelling by collecting a user's AOR and
credentials needed to SUBSCRIBE and retrieve the user's profiles. credentials needed to SUBSCRIBE and retrieve the user's profiles.
Hotelling functionality is achieved by subscribing to the user's AOR Hotelling functionality is achieved by subscribing to the user's AOR
and specifying the "user" profile type. This same mechanism can also and specifying the "user" profile type. This same mechanism can also
be used to secure a user agent, requiring a non-mobile user to login be used to secure a user agent, requiring a non-mobile user to login
to enable functionality beyond the default user's restricted to enable functionality beyond the default user's restricted
functionality. functionality.
When the Event header "profile-type" is "device" and the user agent When the Event header "profile-type" is "device" and the user agent
has provided the user's AOR in the "network-user" parameter, the has provided the user's AOR in the "network-user" parameter, the
profile delivery server MAY set or change the default user associated profile delivery server MAY set or change the default user associated
with the device indicated in the SUBSCRIBE URI. This is an with the device indicated in the SUBSCRIBE URI. This is an
skipping to change at page 15, line 17 skipping to change at page 19, line 8
be used to secure a user agent, requiring a non-mobile user to login be used to secure a user agent, requiring a non-mobile user to login
to enable functionality beyond the default user's restricted to enable functionality beyond the default user's restricted
functionality. functionality.
When the Event header "profile-type" is "device" and the user agent When the Event header "profile-type" is "device" and the user agent
has provided the user's AOR in the "network-user" parameter, the has provided the user's AOR in the "network-user" parameter, the
profile delivery server MAY set or change the default user associated profile delivery server MAY set or change the default user associated
with the device indicated in the SUBSCRIBE URI. This is an with the device indicated in the SUBSCRIBE URI. This is an
implementation or policy decision. The profile delivery server implementation or policy decision. The profile delivery server
SHOULD authenticate the user for the SUBSCRIBE request before SHOULD authenticate the user for the SUBSCRIBE request before
effecting the default user associated with the device as indicated in changing the default user associated with the device.
the "network-user" parameter.
3.7 Notifier generation of NOTIFY requests 7.7 Notifier generation of NOTIFY requests
As in [RFC3265], the profile delivery server MUST always send a As in [RFC3265], the profile delivery server MUST always send a
NOTIFY request upon accepting a subscription. If the device or user NOTIFY request upon accepting a subscription. If the device or user
is unknown to the profile delivery server and it chooses to accept is unknown to the profile delivery server and it chooses to accept
the subscription, the implementer has two choices. A NOTIFY MAY be the subscription, the implementer has two choices. A NOTIFY MAY be
sent with no body or content indirection containing the profile sent with no body or content indirection containing the profile
URI(s). Alternatively a NOTIFY MAY be sent with a body or content URI(s). Alternatively a NOTIFY MAY be sent with a body or content
indirection containing URI(s) pointing to a default data set. The indirection containing URI(s) pointing to a default data set. The
data sets provided may allow for only limited functionality of the data sets provided may allow for only limited functionality of the
user agent (e.g. a phone user agent with data to enable calls to user agent (e.g. for a user agent with telephony capabilities, to
help desk and emergency services.). This is an implementation and enable calls to help desk and emergency services.). This is an
business policy decision for the profile delivery server. implementation and business policy decision for the profile delivery
server.
If the URI in the SUBSCRIBE request is a known identity and If the URI in the SUBSCRIBE request is a known identity and is
provisioned with the requested profile type (i.e. as specified in provisioned with the requested profile type (i.e. as specified in the
the profile-type parameter of the Event header), the profile delivery profile-type parameter of the Event header), the profile delivery
server SHOULD send a NOTIFY with profile data or content indirection server SHOULD send a NOTIFY with profile data or content indirection
(if the content indirection mime type was included in the Accept (if the content indirection mime type was included in the Accept
header) containing the URI for the profile. header) containing the URI for the profile. To protect the integrety
of the profile data or indirect content profile data URIs, the
notifier SHOULD send the NOTIFY request on the same TLS connection as
the SUBSCRIBE request came in on if TLS was used.
The profile delivery server may specify when the new profiles must be The profile delivery server may specify when the new profiles must be
made effective by the user agent. The profile delivery server MAY made effective by the user agent. The profile delivery server MAY
specify a maximum time in seconds (zero or more), in the specify a maximum time in seconds (zero or more), in the
"effective-by" event header parameter, by which the user agent is "effective-by" event header parameter, by which the user agent is
required to make the new profiles effective for all dialogs. required to make the new profiles effective for all dialogs.
3.8 Subscriber processing of NOTIFY requests 7.8 Subscriber processing of NOTIFY requests
The user agent subscribing to this event package MUST adhere to the The user agent subscribing to this event package MUST adhere to the
NOTIFY request processing behavior specified in [RFC3265]. The user NOTIFY request processing behavior specified in [RFC3265]. The user
agent MUST attempt to make the profiles effective within the time in agent MUST attempt to make the profiles effective within the time in
seconds given in the "effective-by" Event header parameter if present seconds given in the "effective-by" Event header parameter if present
in the NOTIFY request (see Section 3.7). By default the user agent in the NOTIFY request (see Section 7.7). By default the user agent
makes the profiles effective as soon as it thinks that it is makes the profiles effective as soon as it thinks that it is non-
non-obtrusive (e.g. when there are no active calls). Profile obtrusive to do so (e.g. when there are no active calls). Profile
changes SHOULD affect behavior on all new dialogs which are created changes SHOULD affect behavior on all new dialogs which are created
after the notification, but may not be able to affect existing after the notification, but may not be able to affect existing
dialogs. The user agent SHOULD use one of the techniques specified dialogs. The user agent SHOULD use one of the techniques specified
in Section 6 to securely retrieve the profiles. If the subscriber in Section 10 to securely retrieve the profiles. If the subscriber
included the MIME type: message/external-body for content indirection included the MIME type message/external-body for content indirection
in the SUBSCRIBE request Accept header, the subscriber MUST support in the SUBSCRIBE request Accept header, the subscriber MUST support
the http: or https: URI schemes for content indirection. If the the http: or https: URI schemes for content indirection. If the
subscriber indicated alternative URI schemes for content indirection subscriber indicated alternative URI schemes for content indirection
it MUST also indicate support for http: or https:. The subscriber it MUST also indicate support for http: or https:. The subscriber
should still be prepared to use http: or https: as the profile should still be prepared to use http: or https: as the profile
delivery server may not support the alternative URI schemes. delivery server may not support the alternative URI schemes.
3.9 Handling of forked requests 7.9 Handling of forked requests
This event package allows the creation of only one dialog as a result This event package allows the creation of only one dialog as a result
of an initial SUBSCRIBE request. The techniques to achieve this are of an initial SUBSCRIBE request. The techniques to achieve this are
described in section 4.4.9 of [RFC3265]. described in section 4.4.9 of [RFC3265].
3.10 Rate of notifications 7.10 Rate of notifications
It is anticipated that the rate of change for user and device It is anticipated that the rate of change for user and device
profiles will be very infrequent (i.e. days or weeks apart). For profiles will be very infrequent (i.e. days or weeks apart). For
this reason no throttling or minimum period between NOTIFY requests this reason no throttling or minimum period between NOTIFY requests
is specified for this package. is specified for this package.
3.11 State Agents 7.11 State Agents
State agents are not applicable to this event package. State agents are not applicable to this event package.
3.12 Examples 7.12 Examples
Example SUBSCRIBE and NOTIFY request using content indirection: Example SUBSCRIBE and NOTIFY request using content indirection:
SUBSCRIBE sip:MAC%3aFF00000036C5@acme.example.com SIP/2.0 SUBSCRIBE sip:MAC%3aFF00000036C5@acme.example.com SIP/2.0
Event: sip-profile;profile-type=device;vendor=vendor.example.com; Event: ua-profile;profile-type=device;vendor="vendor.example.com";
model=Z100;version=1.2.3 model="Z100";version="1.2.3"
From: sip:MAC%3aFF00000036C5@acme.example.com;tag=1234 From: sip:MAC%3aFF00000036C5@acme.example.com;tag=1234
To: sip:MAC%3aFF00000036C5@acme.example.com;tag=abcd To: sip:MAC%3aFF00000036C5@acme.example.com;tag=abcd
Call-ID: 3573853342923422@10.1.1.44 Call-ID: 3573853342923422@10.1.1.44
CSeq: 2131 SUBSCRIBE CSeq: 2131 SUBSCRIBE
Contact: sip:MAC%3aFF00000036C5@10.1.1.44 Contact: sip:MAC%3aFF00000036C5@10.1.1.44
Via: SIP/2.0/TCP 10.1.1.41; Via: SIP/2.0/TCP 10.1.1.41;
branch=z9hG4bK6d6d35b6e2a203104d97211a3d18f57a branch=z9hG4bK6d6d35b6e2a203104d97211a3d18f57a
Accept: message/external-body, application/z100-device-profile Accept: message/external-body, application/z100-device-profile
Content-Length: 0 Content-Length: 0
NOTIFY sip:MAC%3aFF00000036C5@10.1.1.44 SIP/2.0 NOTIFY sip:MAC%3aFF00000036C5@10.1.1.44 SIP/2.0
Event: sip-profile;effective-by=3600 Event: ua-profile;effective-by=3600
From: sip:MAC%3aFF00000036C5@acme.example.com;tag=abcd From: sip:MAC%3aFF00000036C5@acme.example.com;tag=abcd
To: sip:MAC%3aFF00000036C5@acme.example.com;tag=1234 To: sip:MAC%3aFF00000036C5@acme.example.com;tag=1234
Call-ID: 3573853342923422@10.1.1.44 Call-ID: 3573853342923422@10.1.1.44
CSeq: 321 NOTIFY CSeq: 321 NOTIFY
Via: SIP/2.0/UDP 192.168.0.3; Via: SIP/2.0/UDP 192.168.0.3;
branch=z9hG4bK1e3effada91dc37fd5a0c95cbf6767d1 branch=z9hG4bK1e3effada91dc37fd5a0c95cbf6767d1
MIME-Version: 1.0 MIME-Version: 1.0
Content-Type: multipart/mixed; boundary=boundary42 Content-Type: multipart/mixed; boundary=boundary42
Content-Length: ... Content-Length: ...
skipping to change at page 17, line 42 skipping to change at page 21, line 42
access-type="URL"; access-type="URL";
expiration="Mon, 24 June 2002 09:00:00 GMT"; expiration="Mon, 24 June 2002 09:00:00 GMT";
URL="http://www.example.com/devices/ff00000036c5"; URL="http://www.example.com/devices/ff00000036c5";
size=1234 size=1234
Content-Type: application/z100-device-profile Content-Type: application/z100-device-profile
Content-ID: <39EHF78SA@example.com> Content-ID: <39EHF78SA@example.com>
--boundary42-- --boundary42--
3.13 Use of URIs to Retrieve State 7.13 Use of URIs to Retrieve State
The URI for the SUBSCRIBE request is formed differently depending The URI for the SUBSCRIBE request is formed differently depending
upon which profile type the subscription is for. This allows the upon which profile type the subscription is for. This allows the
different profile types to be potentially managed by different different profile types to be potentially managed by different
profile delivery servers (perhaps even operated by different profile delivery servers (perhaps even operated by different
entities). entities).
3.13.1 Device URIs 7.13.1 Device URIs
The URI for the "device" type profile (device URI) is based upon the The URI for the "device" type profile (device URI) is based upon the
identity of the device. The device URI MUST be unique across all identity of the device. The device URI MUST be unique across all
devices and implementations. If an instance id is used as the user devices and implementations. If an instance id is used as the user
part of the device URI, it SHOULD remain the same for the lifetime of part of the device URI, it SHOULD remain the same for the lifetime of
the user agent. The device URI is used to identify which profile is the user agent. The device URI is used to identify which profile is
associated with a specific instance of a user agent. associated with a specific instance of a user agent.
If the user agent changed its device URI, the profile delivery If the user agent changed its device URI, the profile delivery
server would not know the association between the profile and the server would not know the association between the profile and the
device. This would also make it difficult for the profile device. This would also make it difficult for the profile
delivery server to track user agents under profile management. delivery server to track user agents under profile management.
The profile delivery server may decide to provide the same device The profile delivery server may decide to provide the same device
profile to all devices of the same vendor, model and version. profile to all devices of the same vendor, model and version.
However this is a implementation choice on the profile delivery However this is a implementation choice of the profile delivery
server. The subscribing device has no way of knowing whether the server. The subscribing device has no way of knowing whether the
profiles for each device are different. For this reason the profiles for each device are different. For this reason the
device must always use a unique id in the device SUBSCRIBE request device must always use a unique id in the device SUBSCRIBE request
URI. As an example the device profile for similar devices may URI. As an example the device profile for similar devices may
differ with properties such as the default user. This is how the differ with properties such as the default user. This is how the
bootstrapping mechanism works as described in Section 4.1.3. bootstrapping mechanism works as described in Section 8.1.3.
The URI for the device type profile MUST use a unique identifier as The URI for the device type profile MUST use a unique identifier as
the user portion of the URI. The host and port portion of the URI is the user portion of the URI. The host and port portion of the URI is
set to that of the domain or address of the profile deliver server set to that of the domain or address of the profile delivery server
which manages that user agent. A means of discovering the host and which manages that user agent. A means of discovering the host and
port portion is discussed in Section 4.1. There is an administration port portion is discussed in Section 8.1. There is an administration
aspect of the unique identifier, that makes it desirable for the id aspect of the unique identifier, that makes it desirable for the id
to be obtainable or predictable prior to installation of the device to be obtainable or predictable prior to installation of the device
(hard or soft). Also from a human factors perspective, ids that are (hard or soft). Also from a human factors perspective, ids that are
easily distinguished and communicated will make the administrators easily distinguished and communicated will make the administrators
job a little easier. The MAC address or UUID SHOULD be used for job a little easier. The MAC address or UUID SHOULD be used for
constructing a unique identifier to be used in the user portion of constructing a unique identifier to be used in the user portion of
the device URI. the device URI.
If the identifier is a MAC address, it MUST be formatted as the If the identifier is a MAC address, it MUST be formatted as the
letters "MAC:" followed by a 12 digit hexadecimal representation of letters "MAC:" followed by a 12 digit hexadecimal representation of
the MAC address. The address can not include ":", whitespace, or the MAC address. The address can not include ":", whitespace, or
other formatting. other formatting.
The MAC address of the device may be used if there will always be The MAC address of the device may be used if there will always be
no more than one user agent using that MAC address over time (e.g. no more than one user agent using that MAC address over time (e.g.
a dedicated telephone appliance). The MAC address may not be used a dedicated telephone appliance). The MAC address may not be used
if more than one user agent instance exists or use the same MAC if more than one user agent instance exists using the same MAC
address (e.g. multiple instances of a softphone may run on a address (e.g. multiple instances of a softphone may run on a
general purpose computing device). The advantage of the MAC general purpose computing device). The advantage of the MAC
address is that many vendors put bar codes on the device with the address is that many vendors put bar codes on the device with the
actual MAC address on it. A bar code scanner is a convenient actual MAC address on it. A bar code scanner is a convenient
means of collecting the instance id for input and provisioning on means of collecting the instance id for input and provisioning on
the profile delivery server. If the MAC address is used, it is the profile delivery server. If the MAC address is used, it is
recommended that the MAC address is rendered in all upper case recommended that the MAC address is rendered in all upper case
with no punctuation for consistency across implementations. A with no punctuation for consistency across implementations. A
prefix of "MAC:" should be added to the MAC address to form a prefix of "MAC:" should be added to the MAC address to form a
proper URN [RFC2141]. For example a device managed by proper URN [RFC2141]. For example a device managed by
sipuaconfig.example.com using its MAC address to form the device sipuaconfig.example.com using its MAC address to form the device
URI might look like: URI might look like:
sip:MAC%3a00DF1E004CD0@sipuaconfig.example.com. sip:MAC%3a00DF1E004CD0@sipuaconfig.example.com.
UHEX = DIGIT / %x41-46 ;uppercase A-F UHEX = DIGIT / %x41-46 ;uppercase A-F
MAC = %x4d.41.43 ; MAC in caps MAC = %x4d.41.43 ; MAC in caps
RANDID = %x52.41.4e.44.49.44 ; RANDID in caps mac-ident = MAC ":" 12UHEX
uniq-ident = ( mac-ident / rand-ident )
mac-ident = MAC "-" 12UHEX
When the MAC address is not used in the device URI, UUID SHOULD be When the MAC address is not used in the device URI, UUID SHOULD be
used. used.
For devices where there is no MAC address or the MAC address is For devices where there is no MAC address or the MAC address is
not unique to an instance of a user agent (e.g. multiple not unique to an instance of a user agent (e.g. multiple
softphones on a computer or a gateway with multiple logical user softphones on a computer or a gateway with multiple logical user
agents) it is recommended that a UUID is used as the user portion agents) it is recommended that a UUID is used as the user portion
of the device URI. The same approach to defining a user agent of the device URI. The same approach to defining a user agent
instance ID as [I-D.ietf-sip-gruu] should be used. When instance ID as [I-D.ietf-sip-gruu] should be used. When
constructing the instance id the implementer should also consider constructing the instance id the implementer should also consider
that a human may need to manually enter the instance id to that a human may need to manually enter the instance id to
provision the device in the profile delivery server (i.e. longer provision the device in the profile delivery server (e.g. longer
strings are more error prone in data entry). When the URN is used strings are more error prone in data entry). When the URN is used
as the user part of URI, it MUST be URL escaped. The ":" is not a as the user part of URI, it MUST be URL escaped. The ":" is not a
legal character (without being escaped) in the user part of a legal character (without being escaped) in the user part of a
name-addr. For example the instance ID: name-addr. For example the instance ID:
urn:uuid:f81d4fae-7ced-11d0-a765-00a0c91e6bf6 would be escaped to urn:uuid:f81d4fae-7ced-11d0-a765-00a0c91e6bf6 would be escaped to
look as follows in a URI: look as follows in a URI:
sip:urn%3auuid%3af81d4fae-7ced-11d0-a765-00a0c91e6bf6@example.com. sip:urn%3auuid%3af81d4fae-7ced-11d0-a765-00a0c91e6bf6@example.com.
Soft user agents are likely to need to use this approach due to Soft user agents are likely to need to use this approach due to
the multi-user nature of general purpose computers. The software the multi-user nature of general purpose computers. The software
installer program might generate the uuid as part of the install installer program might generate the uuid as part of the install
process so that it remains persistent for the installation. It process so that it remains persistent for the installation. It
may also be desirable that any upgrades of the software maintain may also be desirable that any upgrades of the software maintain
the unique id. However these are all implementation choices. the unique id. However these are all implementation choices.
3.13.2 User and Application URIs 7.13.2 User and Application URIs
The URI for the "user" and "application" type profiles is based upon The URI for the "user" and "application" type profiles is based upon
the identity of the user. The user's address of record (AOR) is used the identity of the user. The user's address of record (AOR) is used
as the URI in the SUBSCRIBE request. A new user agent or device may as the URI in the SUBSCRIBE request. A new user agent or device may
not know the user's AOR. The user's AOR may be obtained as part of a not know the user's AOR. The user's AOR may be obtained as part of a
default user property in the device profile. Alternatively the user default user property in the device profile. Alternatively the user
agent may prompt the user for an AOR and credentials to be used to agent may prompt the user for an AOR and credentials to be used to
authenticate the request. This can provide a login and/or hotelling authenticate the request. This can provide a login and/or hotelling
feature on the user agent. The user agent may be pre-provisioned feature on the user agent. The user agent may be pre-provisioned
with the user's AOR or provided as information on a SIM or flash key. with the user's AOR or provided as information on a SIM or flash key.
These are only examples not an exhaustive list of sources for the These are only examples not an exhaustive list of sources for the
user AOR. user AOR.
3.13.3 Local Network URIs 7.13.3 Local Network URIs
The URI for the "local" type profile is based upon the identity of The URI for the "local-network" type profile is based upon the
the local network. When subscribing to the local network profile, identity of the local network. When subscribing to the local network
the user part of the URI is "anonymous". The host and port part of profile, the user part of the URI SHOULD be the same device ID used
the URI is the local network name/domain. The discovery of the local as the user part of the device profile SUBSCRIBE request URI defined
network name or domain is discussed in Section 4.1. The user agent in Section 7.13.1. The host and port part of the URI is the local
may provide the user's AOR as the value to the "network-user" event network name/domain. The discovery of the local network name or
header parameter. This is useful if the user has privileges in the domain is discussed in Section 8.1. The user agent may provide the
local network beyond those of the default user. The profile delivery user's AOR as the value to the "network-user" event header parameter.
server SHOULD authenticate the user before providing the profile if This is useful if the user has privileges in the local network beyond
additional privileges are granted. Example URI: those of the default user. When "network-user" is provided the
sip:anonymous@example.com profile delivery server SHOULD authenticate the user before providing
the profile if additional privileges are granted. Example URI:
sip:MAC%3a00DF1E004CD0@example.com
4. Profile Delivery Framework Details The local network profile SUBSCRIBE request URI uses the device ID
in the user part of the local network request URI so that every
device in the network has a unique and constant request URI. Even
though every device may get the same or similar local network
profiles, the uniqueness of the URI provides an important
capability. Having unique URIs allows the management of the local
network to track user agents present in the network and
consequently also manage resources such as bandwidth and port
allocation.
8. Profile Delivery Framework Details
The following describes how different functional steps of the profile The following describes how different functional steps of the profile
delivery framework work. Also described here is how the event delivery framework work. Also described here is how the event
package defined in this document provides the enrollment and package defined in this document provides the enrollment and
notification functions within the framework. notification functions within the framework.
4.1 Discovery of Subscription URI 8.1 Discovery of Subscription URI
The discovery approach varies depending upon which profile type URI The discovery approach varies depending upon which profile type URI
is to be discovered. The order of discovery is important in the boot is to be discovered. The order of discovery is important in the
strapping situation as the user agent may not have any information bootstrapping situation as the user agent may not have any
provisioned. The local network profile should be discovered first as information provisioned. The local network profile should be
it may contain key information such as how to traverse a NAT/firewall discovered first as it may contain key information such as how to
to get to outside services (e.g. the user's profile delivery traverse a NAT/firewall to get to outside services (e.g. the user's
server). The device profile URI should be discovered next. The profile delivery server). The device profile URI should be
device profile may contain the default user's AOR or firmware/ discovered next. The device profile may contain the default user's
software information that should be updated first before proceeding AOR or firmware/software information that should be updated first
with the discovery process. The user and application profile before proceeding with the discovery process. The user and
subscription URIs should be discovered last. The URIs are formed application profile subscription URIs should be discovered last. The
differently for each of the profile types. This is to support the URIs are formed differently for each of the profile types. This is
delegation of the profile management to potentially four different to support the delegation of the profile management to potentially
entities. However all four profile types may be provided by the same four different entities. However all four profile types may be
entity. As the user agent has no way of knowing whether the profiles provided by the same entity. As the user agent has no way of knowing
are provide by one or more different profile delivery servers ahead whether the profiles are provide by one or more different profile
of time, it must subscribe to all four profile types in separate delivery servers ahead of time, it must subscribe to all four profile
SUBSCRIBE requests to get the profiles. types in separate SUBSCRIBE requests to get the profiles.
4.1.1 Discovery of Local Network URI 8.1.1 Discovery of Local Network URI
The "discovered" host for the "local" profile subscription URI is the The "discovered" host for the "local-network" profile subscription
local IP network domain for the user agent, either provisioned as URI is the local IP network domain for the user agent, either
part of the device's static network configuration or discovered via provisioned as part of the device's static network configuration or
DHCP. The local network profile subscription URI SHOULD not be discovered via DHCP. The local network profile subscription URI
cached if the user agent moves from one local network to another SHOULD not be remembered if the user agent moves from one local
other. The user agent should perform the local network discovery network to another other. The user agent should perform the local
every time it starts up or network connectivity is regained. network discovery to construct the network profile subscription
request URI every time it starts up or network connectivity is
regained.
For example: The user agent requested and received the local For example: The user agent requested and received the local
domain name via DHCP: airport.example.net. The local network domain name via DHCP: airport.example.net. If the device ID is:
profile SUBSCRIBE request URI would look like: MAC:00DF1E004CD0, the local network profile SUBSCRIBE request URI
sip:anonymous@airport.example.net. The user agent should send would look like: sip:MAC%3a00DF1E004CD0@airport.example.net. The
this request using the normal SIP locating mechanisms defined in user agent should send this request using the normal SIP locating
[RFC3263]. The Event header would look like the following if the mechanisms defined in [RFC3263]. The Event header would look like
user agent decided to provide the user's AOR: the following if the user agent decided to provide
sip:alice@example.com as Alice may have a prior arrangement with sip:alice@example.com as the user's AOR. (Alice may have a prior
the local network operator giving her special policy privileges: arrangement with the local network operator giving her special
privileges.):
Event: sip-profile;profile-type=local; Event: ua-profile;profile-type=local-network;
network-user="sip:alice@example.com" network-user="sip:alice@example.com"
4.1.2 Discovery of Device URI 8.1.2 Discovery of Device URI
The discovery function is needed to bootstrap user agents to the The discovery function is needed to bootstrap user agents to the
point of knowing where to enroll with the profile delivery server. point of knowing where to enroll with the profile delivery server.
Section 3.13.1 describes how to form the user part of the device Section 7.13.1 describes how to form the user part of the device
profile SUBSCRIBE request URI used for enrollment. However the profile SUBSCRIBE request URI used for enrollment. However the
bootstrapping problem for the user agent (out of the box) is what to bootstrapping problem for the user agent (out of the box) is what to
use for the host and port in the device URI. Due to the wide use for the host and port in the device URI. Due to the wide
variation of environments in which the enrolling user agent may variation of environments in which the enrolling user agent may
reside (e.g. behind residential router, enterprise LAN, WLAN reside (e.g. behind residential router, enterprise LAN, WLAN hotspot,
hotspot, ISP, dialup modem) and the limited control that the ISP, dialup modem) and the limited control that the administrator of
administrator of the profile delivery server (e.g. enterprise, the profile delivery server (e.g. enterprise, service provider) may
service provider) may have over that environment, no single discovery have over that environment, no single discovery mechanism works
mechanism works everywhere. everywhere.
Therefore a number of mechanisms should be tried in the specified Therefore a number of mechanisms should be tried in the specified
order: SIP DHCP option [RFC3361], SIP DNS SRV [RFC3263], DNS A record order: SIP DHCP option [RFC3361], SIP DNS SRV [RFC3263], DNS A record
and manual. The user agent may be pre-provisioned with the host and and manual. The user agent may be pre-provisioned with the host and
port (e.g. service providers may pre-provision a device before port (e.g. service providers may pre-provision a device before
sending it to a subscriber, provide a SIM or flash key, etc.) in sending it to a subscriber, provide a SIM or flash key, etc.) in
which case this discovery mechanism is not needed. Before performing which case this discovery mechanism is not needed. Before performing
the discovery steps, the user agent should provide a means to skip the discovery steps, the user agent should provide a means to skip
the discovery stage and manually enter the device URI host and port. the discovery stage and manually enter the device URI host and port.
In addition the user agent should allow the user to accept or reject In addition the user agent should allow the user to accept or reject
the discovered host and port, in case an alternate to the discovered the discovered host and port, in case an alternate to the discovered
host and port are desired. host and port are desired.
1. The first discovery mechanism that should be tried to construct 1. The first discovery mechanism that should be tried to construct
the device SUBSCRIBE request URI, as described in Section 3.13.1, the device SUBSCRIBE request URI, as described in Section 7.13.1,
is to use the host and port of the out bound proxy discovered by is to use the host and port of the out bound proxy discovered by
the SIP DHCP option as described in [RFC3361]. If the SIP DHCP the SIP DHCP option as described in [RFC3361]. If the SIP DHCP
option is not provided in the DHCP response; or no SIP response option is not provided in the DHCP response; or no SIP response
is received for the SUBSCRIBE request; or a SIP failure response is received for the SUBSCRIBE request; or a SIP failure response
other than for authorization is received for the SUBSCRIBE other than for authorization is received for the SUBSCRIBE
request to the sip-profile event, the next discovery mechanism request to the ua-profile event, the next discovery mechanism
should be tried. should be tried.
For example: Consider a dedicated hardware device with a For example: Consider a dedicated hardware device with a
single user agent having the MAC address: abc123efd456. The single user agent having the MAC address: abc123efd456. The
user agent sends a DHCP request including the request for the user agent sends a DHCP request including the request for the
DHCP option for SIP: 120 (see [RFC3361]). If the DHCP DHCP option for SIP: 120 (see [RFC3361]). If the DHCP
response includes an answer for option 120, then the DNS name response includes an answer for option 120, then the DNS name
or IP address included is used in the host part of the device or IP address included is used in the host part of the device
URI. For this example let's assume: example.com. The device URI. For this example let's assume: example.com. The device
URI would look like: sip:MAC%3aABC123EFD456@example.com. The URI would look like: sip:MAC%3aABC123EFD456@example.com. The
user agent should send this request using the normal SIP user agent should send this request using the normal SIP
locating mechanisms defined in [RFC3263]. If the response locating mechanisms defined in [RFC3263]. If the response
fails then, the next discovery mechanism is tried. fails then, the next discovery mechanism is tried.
2. The local IP network domain for the user agent, either configured 2. The local IP network domain for the user agent, either configured
or discovered via DHCP, should be used with the technique in or discovered via DHCP, should be used with the technique in
[RFC3263] to obtain a host and port to use in the SUBSCRIBE URI. [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 If no SIP response or a SIP failure response other than for
authorization is received for the SUBSCRIBE request to the authorization is received for the SUBSCRIBE request to the ua-
sip-profile event, the next discovery mechanism should be tried. profile event, the next discovery mechanism should be tried.
For example: The user agent requested and received the local For example: The user agent requested and received the local
domain name (option 15) in the DHCP response: domain name (option 15) in the DHCP response:
boston.example.com. The device URI would look like: boston.example.com. The device URI would look like:
sip:MAC%3aABC123EFD456@boston.example.com. The user agent sip:MAC%3aABC123EFD456@boston.example.com. The user agent
should send this request using the normal SIP locating should send this request using the normal SIP locating
mechanisms defined in [RFC3263]. If the response fails then, mechanisms defined in [RFC3263]. If the response fails then,
the next discovery mechanism is tried. the next discovery mechanism is tried.
3. The fully qualified host name constructed using the host name 3. The fully qualified host name constructed by concatenating
"sipuaconfig" and concatenated with the local IP network domain "sipuaconfig" and the local IP network domain (as provided via
(as provided via DHCP or provisioned) should be tried next using DHCP or provisioned) should be tried next using the technique in
the technique in [RFC3263] to obtain a host and port to use in [RFC3263] to obtain a host and port to use in the SUBSCRIBE URI.
the SUBSCRIBE URI. If no SIP response or a SIP failure response If no SIP response or a SIP failure response other than for
other than for authorization is received for the SUBSCRIBE authorization is received for the SUBSCRIBE request to the ua-
request to the sip-profile event, the next discovery mechanism profile event, the next discovery mechanism should be tried.
should be tried.
For example: The user agent requested and received the local For example: The user agent requested and received the local
domain name via DHCP as in the above example: domain name via DHCP as in the above example:
boston.example.com. The device URI would look like: boston.example.com. The device URI would look like:
sip:MAC%3aABC123EFD456@sipuaconfig.boston.example.com. The sip:MAC%3aABC123EFD456@sipuaconfig.boston.example.com. The
user agent should send this request using the normal SIP user agent should send this request using the normal SIP
locating mechanisms defined in [RFC3263]. If the response locating mechanisms defined in [RFC3263]. If the response
fails then, the next discovery mechanism is tried. fails then, the next discovery mechanism is tried.
4. If all other discovery techniques fail, the user agent MUST 4. If all other discovery techniques fail, a manual means for the
provide a manual means for the user to enter the host and port user to enter the host and port used to construct the SUBSCRIBE
used to construct the SUBSCRIBE request URI. request URI MUST be provided by the user agent.
Two approaches to the manual discovery process are suggested. In the Two approaches to the manual discovery process are suggested. In the
first approach using SIP, the user agent provides a means for first approach using SIP, the user agent provides a means for
entering the subscription host and port information for the request entering the subscription host and port information for the request
URI along with the user id and password to be used for authentication URI along with the user id and password to be used for authentication
of the SUBSCRIBE request. With this approach the user agent begins of the SUBSCRIBE request. With this approach the user agent begins
with the enrollment process followed by the change notification and with the enrollment process followed by the change notification and
profile retrieve steps. profile retrieve steps.
An alternative to the manual discovery using SIP, is to start with An alternative to the manual discovery using SIP, is to start with
the retrieve process. The user agent provides a means of entering a the retrieve process. The user agent provides a means of entering a
HTTPS URI along with the user id and password to be used for HTTPS URI along with the user id and password to be used for
authentication of the retrieval of the profile. The retrieved device authentication of the retrieval of the profile. The retrieved device
profile may contain the properties for the SUBSCRIBE request URI and profile may contain the properties for the SUBSCRIBE request URI and
credentials to enroll and get change notification of profile changes. credentials to enroll and get change notification of profile changes.
This approach bootstraps the process in a different step in the This approach bootstraps the process in a different step in the
cycle, but uses the same profile framework. cycle, but uses the same profile framework. When the device starts
with retrieval of the profile via HTTPS (instead of a SIP SUBSCRIBE
to the event package), the device MUST provide the Event header in
the HTTPS request using the same format as described for the
SUBSCRIBE request (see Section 7.2) . The Event header is necessary
to determine which profile is requested as well as for providing
specific information about the device.
Once a user agent has successfully discovered, enrolled and received Once a user agent has successfully discovered, enrolled and received
a NOTIFY response with profile data or URI(s), the user agent should a NOTIFY response with profile data or URI(s), the user agent should
cache the device profile SUBSCRIBE request URI to avoid having to cache (i.e. store persistantly) the device profile SUBSCRIBE request
URI (rather than reconstructing it as described in the discovery
process every time the device is restarted) to avoid having to
rediscover the profile delivery server again in the future. Caching rediscover the profile delivery server again in the future. Caching
of the device URI is necessary when the user agent is likely to move of the device URI is necessary when the user agent is likely to move
to different local network domains as the local network may not be to different local network domains as the local network may not be
the provider for the device's profile. The user agent should not the provider for the device's profile. The user agent should not
cache the device URI until it receives a NOTIFY with profile data or cache the device URI until it receives a NOTIFY with profile data or
URI(s). The reason for this is that a profile delivery server may URI(s). The reason for this is that a profile delivery server may
send 202 responses to SUBSCRIBE requests and NOTIFY responses to send 202 responses to SUBSCRIBE requests and NOTIFY responses to
unknown user agent (see Section 3.6) with no profile data or URIs. unknown user agent (see Section 7.6) with no profile data or URIs.
Until the profile delivery server has sent a NOTIFY request with Until the profile delivery server has sent a NOTIFY request with
profile data or URI(s), it has not agreed to provide profiles. profile data or URI(s), it has not agreed to provide profiles.
To illustrate why the user agent should not cache the device To illustrate why the user agent should not cache the device
profile SUBSCRIBE URI until profile data or URI(s) are provided in profile SUBSCRIBE URI until profile data or URI(s) are provided in
the NOTIFY, consider the following example: a user agent running the NOTIFY, consider the following example: a user agent running
on a laptop plugged into a visited LAN in which a foreign profile on a laptop plugged into a visited LAN in which a foreign profile
delivery server is discovered. The profile delivery server never delivery server is discovered. The profile delivery server never
provides profile URIs in the NOTIFY request as it is not provides profile URIs in the NOTIFY request as it is not
provisioned to accept the user agent. The user then takes the provisioned to accept the user agent. The user then takes the
laptop to their enterprise LAN. If the user agent cached the laptop to their enterprise LAN. If the user agent cached the
SUBSCRIBE URI from the visited LAN (which did not provide SUBSCRIBE URI from the visited LAN (which did not provide
profiles), when subsequently placed in the enterprise LAN which is profiles), when subsequently placed in the enterprise LAN which is
provisioned to provide profiles to the user agent, the user agent provisioned to provide profiles to the user agent, the user agent
would not attempt to discover the profile delivery server. would not attempt to discover the profile delivery server.
4.1.3 Discovery of User and Application URI 8.1.3 Discovery of User and Application URI
The default user's AOR from the device profile (if provided) may then The user's AOR may be preprovisioned or provided via SIM or flash
be used to subscribe to the "user" and "application" profiles. The key, etc. The device profile may define a default user and AOR. If
user's AOR may be preprovisioned or provided via SIM or flash key, provided in the device profile and a preprovisioned user AOR is not
etc. Alternatively the user's AOR to be used for the "user" and provided, the default user's AOR is used to subscribe to the "user"
"application" subscription URI, may be "discovered" manually by and "application" profiles. If not provided through the above two
prompting the user. This "discovered" URI for the user and approaches, the AOR to be used for the "user" and "application"
application profile subscription may be cached. subscription URI, is "discovered" manually by prompting the user.
The URI obtained in the discovery steps described above for the
"user" and "application" profile subscriptions is stored persistantly
in the device until explicitly reset or updated by the user or
profile.
4.2 Enrollment with Profile Server 8.2 Enrollment with Profile Server
Enrollment is accomplished by subscribing to the event package Enrollment is accomplished by subscribing to the event package
described in Section 3. The enrollment process is useful to the described in Section 7. The enrollment process is useful to the
profile delivery server as it makes the server aware of user agents profile delivery server as it makes the server aware of user agents
to which it may deliver profiles (those user agents the profile to which it may deliver profiles (those user agents the profile
delivery server is provisioned to provide profiles to; those present delivery server is provisioned to provide profiles to; those present
to which the server may provide profiles in the future; and those to which the server may provide profiles in the future; and those
that the server can automatically provide default profiles). It is that the server can automatically provide default profiles). It is
an implementation choice and business policy as to whether the an implementation choice and business policy as to whether the
profile delivery server provides profiles to user agents that it is profile delivery server provides profiles to user agents that it is
not explicitly provisioned to do so. However the profile delivery not explicitly provisioned to do so. However the profile delivery
server SHOULD accept (with 2xx response) SUBSCRIBE requests from any server SHOULD accept (with 2xx response) SUBSCRIBE requests from any
user agent as explained in Section 3.5. user agent as explained in Section 7.5.
4.3 Notification of Profile Changes 8.3 Notification of Profile Changes
The NOTIFY request in the sip-profile event package serves two The NOTIFY request in the ua-profile event package serves two
purposes. First it provides the user agent with a means to obtain purposes. First it provides the user agent with a means to obtain
the profile data directly or via URI(s) for desired profiles without the profile data directly or via URI(s) for desired profiles without
requiring the end user to manually enter them. It also provides the requiring the end user to manually enter them. It also provides the
means for the profile delivery server to notify the user agent that means for the profile delivery server to notify the user agent that
the content of the profiles has changed and should be made effective. the content of the profiles has changed and should be made effective.
Optionally the differential changes may be obtained by notification Optionally the differential changes may be obtained by notification
by including the content-type: "application/xcap-diff+xml" defined in by including the content-type: "application/xcap-diff+xml" defined in
[I-D.ietf-simple-xcap-package] in the Accept header of the SUBSCRIBE [I-D.ietf-simple-xcap-package] in the Accept header of the SUBSCRIBE
request. request.
4.4 Retrieval of Profile Data 8.4 Retrieval of Profile Data
The user agent retrieves its needed profile(s) directly or via the 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. URI(s) provided in the NOTIFY request as specified in Section 7.5.
The profile delivery server SHOULD secure the content of the profiles The profile delivery server SHOULD secure the content of the profiles
using one of the techniques described in Section 6. The user agent using one of the techniques described in Section 10. The user agent
SHOULD make the new profiles effective in the timeframe described in SHOULD make the new profiles effective in the timeframe described in
Section 3.2. Section 7.2.
The contents of the profiles SHOULD be cached by the user agent. The The contents of the profiles SHOULD be cached (i.e. stored
cache should be used if the user agent is unable to successfully persistently) by the user agent. The cache should be used if the
SUBSCRIBE or receive the NOTIFY providing the most recent profile. user agent is unable to successfully SUBSCRIBE or receive the NOTIFY
This it to avoid the situation where the content delivery server is providing the most recent profile. The cached profile should be
not available, leaving the user agent non-functional. The user agent replaced each time a profile is received in a NOTIFY or retrieved via
should verify that it has the latest profile content using the "hash" content indirection. This it to avoid the situation where the
parameter defined in [I-D.ietf-sip-content-indirect-mech]. content delivery server being not available, leaves the user agent
non-functional. The user agent should verify that it has the latest
profile content using the "hash" parameter defined in [I-D.ietf-sip-
content-indirect-mech].
4.5 Upload of Profile Changes 8.5 Upload of Profile Changes
The user agent or other service MAY push changes up to the profile The user agent or other service MAY push changes up to the profile
delivery server using the technique appropriate to the profile's URL delivery server using the technique appropriate to the profile's URL
scheme (e.g. HTTP PUT method, FTP put command). The technique for scheme (e.g. HTTP PUT method, FTP put command). The technique for
pushing incremental or atomic changes MUST be described by the pushing incremental or atomic changes MUST be described by the
specific profile data framework. A means for pushing changes up into specific profile data framework. A means for pushing changes up into
the profile delivery server for XCAP is defined in the profile delivery server for XCAP is defined in [I-D.ietf-simple-
[I-D.ietf-simple-xcap]. xcap].
4.6 Usage of XCAP with the Profile Package 8.6 Usage of XCAP with the Profile Package
This framework allows for the usage of several different protocols This framework allows for the usage of several different protocols
for the retrieval of profiles. One protocol which is suitable is for the retrieval of profiles. One protocol which is suitable is
XCAP [I-D.ietf-simple-xcap], which allows for HTTP URIs to represent XCAP [I-D.ietf-simple-xcap], which allows for HTTP URIs to represent
XML documents, elements and attributes. XCAP defines a specific XML documents, elements and attributes. XCAP defines a specific
hierarchy for how documents are organized. As a result, it is hierarchy for how documents are organized. As a result, it is
necessary to discuss how that organization relates to the rough data necessary to discuss how that organization relates to the rough data
model presented here. model presented here.
When a user or device enrolls with a SUBSCRIBE request, the request When a user or device enrolls with a SUBSCRIBE request, the request
URI will contain some kind of identifying information for that user URI will contain identifying information for that user or device.
or device. This identity is mapped to an XCAP User ID (XUID) based This identity is mapped to an XCAP User ID (XUID) based on an
on an implementation specific mapping. The "profile-type" along with implementation specific mapping. The "profile-type" along with the
the "app-id" Event header parameters specify the specific XCAP "auid" Event header parameters specify the specific XCAP application
application usage. usage.
In particular, when the Event header parameter "profile-type" is In particular, when the Event header parameter "profile-type" is
"application", the "app-id" MAY be included to contain the XCAP "application", the "auid" MAY be included to contain the XCAP
Application Unique ID (AUID). When the "profile-type" is Application Unique ID (AUID) [I-D.ietf-simple-xcap]. When the
"application", but the "app-id" parameter is absent, this specifies "profile-type" is "application", but the "auid" parameter is absent,
that the user wishes to SUBSCRIBE to all documents for all this specifies that the user wishes to SUBSCRIBE to all documents for
application usages associated with the user in the request-uri. This all application usages associated with the user in the request-uri.
provides a convenient way for a single subscription to be used to This provides a convenient way for a single subscription to be used
obtain all application data. The XCAP root is determined by a local to obtain all application data. The XCAP root is determined by a
mapping. local mapping.
When the "profile-type" is "device", or "user" or "local", this maps When the "profile-type" is "device", or "user" or "local-network",
to an AUID and document selector for representing device, user and this maps to an AUID and document selector for representing device,
local-network data, respectively. The mapping is a matter of local user and local-network data, respectively. The mapping is a matter
policy. This allows different providers to use different XCAP of local policy. This allows different providers to use different
application usages and document schemas for representing these XCAP application usages and document schemas for representing these
profiles, without having to configure the device with the specific profiles, without having to configure the device with the specific
AUID which is being used. AUID which is being used.
Furthermore, when the "document" attribute is present, it identifies Furthermore, when the "document" attribute is present, it identifies
a specific document that is being requested. If the "profile-type" a specific document that is being requested. The "auid" SHOULD NOT
is "application", the "app-id" MAY be present as well if the be present if the "document" is also present. The "document"
"document" relative path does not indicate the specific application attribute specifies a relative path reference. The path is
profile. The "document" attribute then specifies a relative path constucted from a set of path segments (e.g. directories) using the
reference. Its first path segment is either "global", specifying "/" separator. For XCAP the relative document path is constructed
global data, or "user", specifying user data for the user in the using the following steps:"
request URI. The next path segment identifies the path in the global
directory or the user's home directory. For "profile-type" 1. Its first path segment is either "global", specifying global
"application", if "app-id" is not present the next path segment (i.e. data, or "user", specifying user data for the user in the request
after "global" or the user's home directory segment) MAY indicate the URI.
XCAP Application Unique ID (AUID) if the user agent wishes to 2. If the prior path segment is "user", the next path segment
subscribe to a specific application profile. identifies the the user's home directory. That is the next path
segment is the user's directory name. The user's directory name
is appended onto the "document" path with the "/" separator. If
the prior path segment is "global" nothing is appended to the
document path for this step.
3. When the "profile-type" is "application", the next path segment
to append (i.e. after "global" or the user's home directory
segment) MAY indicate the XCAP Application Unique ID (AUID) if
the user agent wishes to subscribe to a specific application
profile.
4. If the AUID was added to the document path in the prior step,
additional path segments may be added according to the specific
schema of the profile and the query mechanism provided in
[I-D.ietf-simple-xcap].
For example, consider a phone with an instance ID of For example, consider a phone with an instance ID of
urn:uuid:00000000-0000-0000-0000-0003968cf920. To obtain its device urn:uuid:00000000-0000-0000-0000-0003968cf920. To obtain its device
profile, it would generate a SUBSCRIBE that contain the following profile, it would generate a SUBSCRIBE that contains the following
Request-Line and Event header: (Note that line folding of the Request-Line and Event header: (Note that line folding of the
Request-URI is illegal in SIP. The Request URI is shown broken Request-URI is illegal in SIP. The Request URI is shown broken
across the first 3-line here only due to formatting limitations of across the first 3-lines here only due to formatting limitations of
IETF documents.) IETF documents. The Event header is shown continued across a second
line for the same reason.)
SUBSCRIBE SUBSCRIBE
sip:urn%3auuid%3a00000000-0000-0000-0000-0003968cf920@example.com sip:urn%3auuid%3a00000000-0000-0000-0000-0003968cf920@example.com
SIP/2.0 SIP/2.0
Event: sip-profile;profile-type=device Event: ua-profile;profile-type=device;Vendor="vendor2";
Model="1";Version="2.2.2"
If the profile data is stored in an XCAP server, the server would map If the profile data is stored in an XCAP server, the server would map
the "device" profile to an application usage and document selector the "device" profile to an application usage and document selector
based on local policy. If this mapping specifies the AUID based on local policy. The user ID that might be used in the case of
"vendor2-device-data" and a document called "index" within the user a device profile could be the device ID which is identified in the
directory, the corresponding HTTP URI for the document is: (Note that user part of the SUBSCRIBE URI. The XCAP server may use a root
this URL is only one line; it is split across two lines due to directory of: http://xcap.example.com/root. Local policy may provide
a mapping for the AUID "vendor2-device-data" based upon the "vendor"
parameter and a document called "index" within the user directory,
the corresponding HTTP URI for the document might be: (Note that this
URL is only one line; it is split across three lines due to
formatting limitations of IETF documents.) formatting limitations of IETF documents.)
http://xcap.example.com/root/vendor2-device-data/users/ http://xcap.example.com/root/users/
urn%3auuid%3a00000000-0000-0000-0000-0003968cf920/index urn%3auuid%3a00000000-0000-0000-0000-0003968cf920/
vendor2-device-data/index
and indeed, if a content indirection is returned in a NOTIFY, the URL and indeed, if a content indirection is returned in a NOTIFY, the URL
would equal this. would equal this.
That user profile might specify the user identity (as a SIP AOR) and That user profile might specify the user identity (as a SIP AOR) and
their application-usages. From that, the device can enroll to learn their application-usages. From that, the device can enroll to learn
about its application data. To learn about all of the data: about its application data. To learn about all of the data:
SUBSCRIBE sip:alice@example.com SIP/2.0 SUBSCRIBE sip:alice@example.com SIP/2.0
Event: sip-profile;profile-type=application Event: ua-profile;profile-type=application;Vendor="vendor2";
Model="1";Version="2.2.2"
The server would map the request URI to an XUI (user-aor, for The server would map the request URI to an XUI (user-aor, for
example) and the xcap root based on local policy. If there are two example) and the xcap root based on local policy. If there are two
AUIDs, "resource-lists" [I-D.ietf-simple-xcap-list-usage] and AUIDs, "resource-lists" [I-D.ietf-simple-xcap-list-usage] and "rls-
"rls-services" [I-D.ietf-simple-xcap-list-usage], this would result services" [I-D.ietf-simple-xcap-list-usage], this would result in a
in a subscription to all documents within: subscription to all documents within:
http://xcap.example.com/root/rls-services/users/user-aor http://xcap.example.com/root/users/user-aor/rls-services
http://xcap.example.com/root/resource-lists/users/user-aor http://xcap.example.com/root/users/user-aor/resource-lists
The user would not be subscribed to the global data for these two The user would not be subscribed to the global data for these two
application usages, since that data is not important for users. application usages, since that data is not important for users.
However, the user/device could be made aware that it needs to However, the user/device could be made aware that it needs to
subscribe to a specific document. In that case, its subscribe would subscribe to a specific document. In that case, its subscribe would
look like: look like:
SUBSCRIBE sip:user-aor@example.com SIP/2.0 SUBSCRIBE sip:user-aor@example.com SIP/2.0
Event: sip-profile;profile-type=application;app-id=resource-lists Event: ua-profile;profile-type=application;auid="resource-lists";
;document="global/index" Vendor="vendor2";Model="1";Version="2.2.2"
this would result in a subscription to the single global document for this would result in a subscription to the single global document for
resource-lists. resource-lists.
In some cases, these subscriptions are to a multiplicity of In some cases, these subscriptions are to a multiplicity of
documents. In that case, the notification format will need to be one documents. In that case, the notification format will need to be one
which can indicate what document has changed. This includes content which can indicate what document has changed. This includes content
indirection, but also the xcap diff format indirection, but also the xcap diff format [I-D.ietf-simple-xcap-
[I-D.ietf-simple-xcap-package]. package].
5. IANA Considerations 9. IANA Considerations
There are several IANA considerations associated with this There are several IANA considerations associated with this
specification. specification.
5.1 SIP Event Package 9.1 SIP Event Package
This specification registers a new event package as defined in This specification registers a new event package as defined in
[RFC3265]. The following information required for this registration: [RFC3265]. The following information required for this registration:
Package Name: sip-profile
Package Name: ua-profile
Package or Template-Package: This is a package Package or Template-Package: This is a package
Published Document: RFC XXXX (Note to RFC Editor: Please fill in Published Document: RFC XXXX (Note to RFC Editor: Please fill in
XXXX with the RFC number of this specification). XXXX with the RFC number of this specification).
Person to Contact: Daniel Petrie dpetrie AT pingtel.com Person to Contact: Daniel Petrie dan.ietf AT SIPez DOT com
New event header parameters: profile-type, vendor, model, version, New event header parameters: profile-type, vendor, model, version,
effective-by, document, app-id, network-user effective-by, document, auid, network-user
6. Security Considerations 10. Security Considerations
Profiles may contain sensitive data such as user credentials and Profiles may contain sensitive data such as user credentials and
personal information. The protection of this data depends upon how personal information. The protection of this data depends upon how
the data is delivered. Some profiles may be safe to deliver without the data is delivered. Some profiles may be safe to deliver without
the need to protect the content. For example in some environments the need to protect the content. For example in some environments
the local network profile may contain the list of codecs that are the local network profile may contain the list of codecs that are
acceptable for use in the network and information on NAT traversal acceptable for use in the network and information on NAT traversal
such as a STUN server to use. As the information in this example such as a STUN server to use. As the information in this example
local network profile does not contain passwords or sensitive local network profile does not contain passwords or sensitive
information it may be acceptable to provide it without authentication information it may be acceptable to provide it without authentication
or confidentiality (encryption). We refer to these as or confidentiality (encryption). We refer to these as non-
non-confidential profiles. Non-confidential profiles require message confidential profiles. Non-confidential profiles require message
integrity and profile server authentication, as described in Section integrity and profile server authentication, as described in
6.3. However any profiles that contain personal information, Section 10.3. However any profiles that contain personal
passwords or credentials (confidential profiles) require mutual information, passwords or credentials (confidential profiles) require
authentication, confidentiality, and message integrity, and must mutual authentication, confidentiality, and message integrity, and
follow the guidance provided in the next two subsections. Profile must follow the guidance provided in the next two subsections.
specifications that define schemas MUST identify if they contain Profile specifications that define schemas MUST identify if they
confidential data to indicate which of the security approaches contain confidential data to indicate which of the security
describer here should be used. approaches describer here should be used.
The profile data is delivered in either the NOTIFY request or via the The profile data is delivered in either the NOTIFY request or via the
URI scheme indicated in the content indirection in the NOTIFY URI scheme indicated in the content indirection in the NOTIFY
request. The security approach is different for these two delivery request. The security approach is different for these two delivery
mechanisms. mechanisms.
Subscribers implementing this specification MUST implement either Subscribers implementing this specification MUST implement either
HTTP or HTTPS. Subscribers also MUST implement the hash verification HTTP or HTTPS. Subscribers also MUST implement the hash verification
scheme described in SIP content indirection scheme described in SIP content indirection [I-D.ietf-sip-content-
[I-D.ietf-sip-content-indirect-mech]. SIP profile delivery servers indirect-mech]. SIP profile delivery servers MUST implement both
MUST implement both HTTP and HTTPS, and SHOULD implement a SIP HTTP and HTTPS, and SHOULD implement a SIP Authentication Service as
Authentication Service as described in the SIP Identity mechanism described in the SIP Identity mechanism [I-D.ietf-sip-identity]. All
[I-D.ietf-sip-identity]. All SIP entities are already required to SIP entities are already required to implement SIP Digest
implement SIP Digest authentication [RFC3261]. authentication [RFC3261].
6.1 Confidential Profile Content in NOTIFY Request 10.1 Confidential Profile Content in NOTIFY Request
When the profile data is delivered directly in the NOTIFY request, When the profile data is delivered directly in the NOTIFY request,
the SUBSCRIBE request MUST be authenticated (for example, using the the SUBSCRIBE request MUST be authenticated using the SIP Digest
SIP Digest authentication mechanism). As the profile content is authentication mechanism. As the profile content is delivered in the
delivered in the resulting NOTIFY request to the subscription, resulting NOTIFY request to the subscription, authenticating the
authenticating the SUBSCRIBE is the only way to prevent unauthorized SUBSCRIBE is the only way to prevent unauthorized access to the
access to the profile data. To provide message integrity and profile data. To provide message integrity and confidentiality over
confidentiality over the profile data, a direct TLS connection the profile data, a direct TLS connection MUST be established for the
established with the SUBSCRIBE request or S/MIME MUST be used for the SUBSCRIBE request. The device SHOULD authenticate the server via the
NOTIFY request containing the profile data. The profile data in the TLS connection, which also provides a means of verifying that a
S/MIME body should be encrypted using the public key for the user or direct TLS connection was used (e.g. The device may prompt the user
device subscribing to the profile data. For user, application and to verify the Common Name in the server's certificate.). The server
local network profiles the user public key is used. For device may challenge the device for its certificate, when establishing the
profiles the device public key is used. TLS connection, to obtain the public to S/MIME encode the NOTIFY
request body containing the profile data. Because the device
verified that it has a direct TLS connection by verifying the
server's certificate and the server verified the identity of the
device using Digest Authentication, the server can assume the
certficate provided by the device is authenticated. The use of
S/MIME in the NOTIFY request does not relieve the need to
authenticate the SUBSCRIBE request using SIP Digest authentication.
In this scenario S/MIME only provides message integrity and
confidentiality of the content of the profile. If S/MIME is not used
for the profile data in the NOTIFY request, the notifier MUST use the
same direct TLS connection established by device for the SUBSCRIBE
request. In this scenario the use of user specific ID and secret in
the Digest Authentication can be used to establish an association
between user ID and the device ID provide in the device profile
SUBSCRIBE request.
6.2 Confidential Profile Content via Content Indirection 10.2 Confidential Profile Content via Content Indirection
When the profile data is delivered via content indirection, SIP When the profile data is delivered via content indirection,
integrity protection (a direct TLS connection established by the user authentication, integrity, confidentiality are all provided in the
agent for the SUBSCRIBE request, S/MIME or [I-D.ietf-sip-identity]) profile indirection retrieval scheme. When content indirection is
MUST be used to protect the integrity of any content indirection body used, the SUBSCRIBE request does not need to be authenticated. There
provided in a SIP NOTIFY request. In addition, the indirect profile is a TLS certificate approach and a Digest Authentication approach
transport mechanism also requires security protection. A which may be used to provide the required security. The profile
non-replayable authentication mechanism such as Digest authentication delivery server MUST support both of these methods. The device MUST
MUST be used for the content indirection URI scheme which provides support the Digest Authentication method to provide minimal
the profile data (e.g. LDAP, HTTP and HTTPS all support Digest interoperablity.
authentication). URI schemes which provide no authentication or only
clear-text authentication SHOULD NOT be used for profile delivery as For the TLS certificate approach, the device requests the profile
they are vulnerable to replay attacks (e.g. TFTP does not provide using HTTPS. To provide authentication, the server challenges the
device for its certificate. The server obtains the user part of the
SIP URI in the Subject Alternative Name field of the device's
certificate. The user part of the SIP URI in the device's
certificate is used as the device ID to authenticate if the device is
authorized to retieive the specified profile. The device
certificates chain of authorities MUST also be verified. This
approach for providing security requires that the device ID and
associated user are provisioned to the content indirection retreival.
For the Digest Authentication approach, HTTPS SHOULD be used to
provide confidentiality of the profile data. HTTP Digest
Authentication [RFC2617] MUST be used to authenticate and authorize
the device to retrieve the profile. The shared secret used in the
Digest Authentication is provided through out of band means to the
device or user of the device. The same credentials used for SIP
Digest authentication (e.g. authenication of SIP SUBSCRIBE and
REGISTER requests) are used in the HTTPS request. Other URI schemes
may be used, but are not defined in this document. A non-replayable
authentication mechanism such as Digest authentication MUST be used
for the content indirection URI scheme which provides the profile
data (e.g. LDAP, HTTP and HTTPS all support Digest authentication).
URI schemes which provide no authentication or only clear-text
authentication SHOULD NOT be used for profile delivery as they are
vulnerable to replay attacks (e.g. TFTP does not provide
authentication). authentication).
Without a suitable authentication mechanism, the content Without a suitable authentication mechanism, the content
indirection profile delivery URI scheme is susceptible to replay indirection profile delivery URI scheme is susceptible to replay
attacks. Even if the profile is symmetrically encrypted, if it attacks. Even if the profile is symmetrically encrypted, if it
can be retrieved through a replay attack, the encrypted profile can be retrieved through a replay attack, the encrypted profile
can be used for offline attacks to crack the encryption key. can be used for offline attacks to crack the encryption key.
The profile delivery scheme MUST use channel security such as TLS The profile delivery scheme MUST use channel security such as TLS
(e.g. HTTPS) to protect the content from being snooped in transport (e.g. HTTPS) to protect the content from being snooped in transport
to the user agent. Mutual authentication using the client and server to the user agent. Mutual authentication using the client and server
certificates MAY be used to verify the authenticity of the user or certificates MAY be used to verify the authenticity of the user or
device identity and the profile delivery server identity. The user device identity and the profile delivery server identity. The user
agent SHOULD provide a mechanism for the user to approve the profile agent SHOULD provide a mechanism for the user to approve the
delivery server identity or provision the acceptable server SUBSCRIBE server identity or provision the acceptable server identity
identity(s) through out of band means. Other transport schemes which through out of band means.
do not support TLS MAY be used if communications channel for profile
transport is known to be secured (e.g. VPN or IPsec type
mechanisms).
6.3 Integrity protection for non-confidential profiles 10.3 Integrity protection for non-confidential profiles
Even for non-confidential profiles, the subscriber MUST verify the Even for non-confidential profiles, the subscriber MUST verify the
authenticity of the profile delivery server, and MUST verify that the authenticity of the profile delivery server, and MUST verify that the
integrity of the profile data and content indirection URI, if one is integrity of the profile data and content indirection URI, if one is
provided. To meet these requirements in the SIP messaging the NOTIFY provided. To meet these requirements in the SIP messaging the NOTIFY
request MUST use a SIP Identity header [I-D.ietf-sip-identity], or S/ request MUST use a SIP Identity header [I-D.ietf-sip-identity], or
MIME. If content is provided via redirection, the content S/MIME. If content is provided via redirection, the content
indirection "hash" parameter MUST be included unless the profile data indirection "hash" parameter MUST be included unless the profile data
is delivered via a protocol which natively provides authentication is delivered via a protocol which natively provides authentication
and message integrity, such as HTTP or LDAP protected by TLS. The and message integrity, such as HTTP or LDAP protected by TLS. The
content retrieved via the content indirection URI MUST be integrity content retrieved via the content indirection URI MUST be integrity
checked using the "hash" parameter. checked using the "hash" parameter.
For example, Alice subscribes to the local domain profile for For example, Alice subscribes to the local domain profile for
paris.example.com. She receives the following NOTIFY request which paris.example.com. She receives the following NOTIFY request which
uses content indirection, including a "hash" parameter. Alice uses uses content indirection, including a "hash" parameter. Alice uses
the Identity header from the NOTIFY to verify that the request came the Identity header from the NOTIFY to verify that the request came
from paris.example.com and that the body was not modified. Then she from paris.example.com and that the body was not modified. Then she
fetches the content at the provided URI and verifies that the hash fetches the content at the provided URI and verifies that the hash
she calculates from the profile matches the hash provided in the SIP she calculates from the profile matches the hash provided in the SIP
signaling. signaling.
7. Acknowledgements 11. Acknowledgements
Many thanks to those who contributed and commented on the many Many thanks to those who contributed and commented on the many
iterations of this document. Detailed input was provided by Jonathan iterations of this document. Detailed input was provided by Jonathan
Rosenberg from Cisco, Henning Schulzrinne from Columbia University, Rosenberg from Cisco, Henning Schulzrinne from Columbia University,
Cullen Jennings from Cisco, Rohan Mahy from Airespace, Rich Schaaf Cullen Jennings from Cisco, Rohan Mahy from Airespace, Rich Schaaf
from Pingtel, Volker Hilt from Bell Labs, Hisham Khartabil from from Pingtel, Volker Hilt from Bell Labs, Adam Roach of Estacado
Telio, Henry Sinnreich from MCI, Martin Dolly from AT&T Labs, John Systems, Hisham Khartabil from Telio, Henry Sinnreich from MCI,
Elwell from Siemens, Elliot Eichen and Robert Liao from Verizon. Martin Dolly from AT&T Labs, John Elwell from Siemens, Elliot Eichen
and Robert Liao from Verizon, Dale Worley from Pingtel.
8. Change History 12. Change History
[[RFC Editor: Please remove this entire section upon publication as [[RFC Editor: Please remove this entire section upon publication as
an RFC.]] an RFC.]]
8.1 Changes from draft-ietf-sipping-config-framework-05.txt 12.1 Changes from draft-ietf-sipping-config-framework-06.txt
Restructured the introduction and overview section to be more
consistent with other Internet-Drafts.
Added additional clarifcation for the Digest Authentication and
Certificate based authentication cases in the security section.
Added two use case scenarios with cross referencing to better
illustrate how the framework works. Added better cross
referencing in the overview section to help readers find where
concepts and functionality is defined in the document.
Clarified the section on the use of XCAP. Changed the Event
parameter "App-Id" to "auid". Made "auid" mutually exclusive to
"document". "auid" is now only used with XCAP.
Local network subscription URI changed to <device-id>@
<local-network> (was anonymous@<local-network>). Having a
different request URI for each device allows the network
management to track user agents and potentially manage bandwidth,
port allocation, etc.
Changed event package name from sip-profile to ua-profile per
discussion on the list and last IETF meeting.
Changed "local" profile type token to "local-network" per
discussion on the list and last IETF meeting.
Simplified "Vendor", "Model", "Version" event header parameters to
allow only quoted string values (previously allowed token as
well).
Clarified use of the term cache.
Added references for ABNF constructs.
Numerous editorial changes. Thanks Dale!
12.2 Changes from draft-ietf-sipping-config-framework-05.txt
Made HTTP and HTTPS profile transport schemes mandatory in the Made HTTP and HTTPS profile transport schemes mandatory in the
profile delivery server. The subscribing device must implement profile delivery server. The subscribing device must implement
HTTP or HTTPS as the profile transport scheme. HTTP or HTTPS as the profile transport scheme.
Rewrote the security considerations section. Rewrote the security considerations section.
Divided references into Normative and Informative. Divided references into Normative and Informative.
Minor edits through out. Minor edits through out.
8.2 Changes from draft-ietf-sipping-config-framework-04.txt 12.3 Changes from draft-ietf-sipping-config-framework-04.txt
Clarified usage of instance-id Clarified usage of instance-id
Specify which event header parameters are mandatory or optional Specify which event header parameters are mandatory or optional
and in which messages. and in which messages.
Included complete list of event header parameters in parameter Included complete list of event header parameters in parameter
overview and IANA sections. overview and IANA sections.
Removed TFTP reference as protocol for profile transport. Removed TFTP reference as protocol for profile transport.
Added examples for discovery. Added examples for discovery.
Added ABNF for all event header parameters. Added ABNF for all event header parameters.
Changed profile-name parameter back to profile-type. This was Changed profile-name parameter back to profile-type. This was
changed profile-name in 02 when the parameter could contain either changed to profile-name in 02 when the parameter could contain
a token or a path. Now that the path is contained in the separate either a token or a path. Now that the path is contained in the
parameter: "document", profile-type make more sense as the separate parameter: "document", profile-type make more sense as
parameter name. the parameter name.
Fixed some statements that should have and should not have been Fixed some statements that should have and should not have been
normative. normative.
Added the ability for the user agent to request that the default Added the ability for the user agent to request that the default
user associated with the device be set/changed using the user associated with the device be set/changed using the "network-
"network-user" parameter. user" parameter.
A bunch of editorial nits and fixes. A bunch of editorial nits and fixes.
8.3 Changes from draft-ietf-sipping-config-framework-03.txt 12.4 Changes from draft-ietf-sipping-config-framework-03.txt
Incorporated changes to better support the requirements for the use Incorporated changes to better support the requirements for the use
of this event package with XCAP and SIMPLE so that we can have one 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 (i.e. simple-xcap-package now defines a content type not a
package). Added an additional profile type: "application". Added package). Added an additional profile type: "application". Added
document and app-id Event header parameters in support of the document and app-id Event header parameters in support of the
application profile. Define a loose high level data model or application profile. Define a loose high level data model or
relationship between the four profile types. Tried to edit and fix relationship between the four profile types. Tried to edit and fix
the confusing and ambiguous sections related to URI formation and the confusing and ambiguous sections related to URI formation and
discovery for the different profile types. Better describe the discovery for the different profile types. Better describe the
importance of uniqueness for the instance id which is used in the importance of uniqueness for the instance id which is used in the
user part of the device URI. user part of the device URI.
8.4 Changes from draft-ietf-sipping-config-framework-02.txt 12.5 Changes from draft-ietf-sipping-config-framework-02.txt
Added the concept of the local network as a source of profile data. Added the concept of the local network as a source of profile data.
There are now three separate logical sources for profile data: user, There are now three separate logical sources for profile data: user,
device and local network. Each of these requires a separate device and local network. Each of these requires a separate
subscription to obtain. subscription to obtain.
8.5 Changes from draft-ietf-sipping-config-framework-01.txt 12.6 Changes from draft-ietf-sipping-config-framework-01.txt
Changed the name of the profile-type event parameter to profile-name. 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 Also allow the profile-name parameter to be either a token or an
explicit URI. explicit URI.
Allow content indirection to be optional. Clarified the use of the Allow content indirection to be optional. Clarified the use of the
Accept header to indicate how the profile is to be delivered. Accept header to indicate how the profile is to be delivered.
Added some content to the Iana section. Added some content to the Iana section.
8.6 Changes from draft-ietf-sipping-config-framework-00.txt 12.7 Changes from draft-ietf-sipping-config-framework-00.txt
This version of the document was entirely restructured and re-written This version of the document was entirely restructured and re-written
from the previous version as it had been micro edited too much. 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 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 one section and is believed to be complete and up to date with
[RFC3265]. [RFC3265].
The URI used to subscribe to the event package is now either the user The URI used to subscribe to the event package is now either the user
or device address or record. or device address or record.
The user agent information (vendor, model, MAC and serial number) are The user agent information (vendor, model, MAC and serial number) are
now provided as event header parameters. now provided as event header parameters.
Added a mechanism to force profile changes to be make effective by Added a mechanism to force profile changes to be make effective by
the user agent in a specified maximum period of time. the user agent in a specified maximum period of time.
Changed the name of the event package from sip-config to sip-profile Changed the name of the event package from sip-config to ua-profile
Three high level security approaches are now specified. Three high level security approaches are now specified.
8.7 Changes from draft-petrie-sipping-config-framework-00.txt 12.8 Changes from draft-petrie-sipping-config-framework-00.txt
Changed name to reflect SIPPING work group item Changed name to reflect SIPPING work group item
Synchronized with changes to SIP DHCP [RFC3361], SIP [RFC3261] and Synchronized with changes to SIP DHCP [RFC3361], SIP [RFC3261] and
[RFC3263], SIP Events [RFC3265] and content indirection [RFC3263], SIP Events [RFC3265] and content indirection [I-D.ietf-
[I-D.ietf-sip-content-indirect-mech] sip-content-indirect-mech]
Moved the device identity parameters from the From field parameters Moved the device identity parameters from the From field parameters
to User-Agent header parameters. to User-Agent header parameters.
Many thanks to Rich Schaaf of Pingtel, Cullen Jennings of Cisco and Many thanks to Rich Schaaf of Pingtel, Cullen Jennings of Cisco and
Adam Roach of Dyamicsoft for the great comments and input. Adam Roach of Estacado Systems for the great comments and input.
8.8 Changes from draft-petrie-sip-config-framework-01.txt 12.9 Changes from draft-petrie-sip-config-framework-01.txt
Changed the name as this belongs in the SIPPING work group. Changed the name as this belongs in the SIPPING work group.
Minor edits Minor edits
8.9 Changes from draft-petrie-sip-config-framework-00.txt 12.10 Changes from draft-petrie-sip-config-framework-00.txt
Split the enrollment into a single SUBSCRIBE dialog for each profile. Split the enrollment into a single SUBSCRIBE dialog for each profile.
The 00 draft sent a single SUBSCRIBE listing all of the desired. The 00 draft sent a single SUBSCRIBE listing all of the desired.
These have been split so that each enrollment can be routed These have been split so that each enrollment can be routed
differently. As there is a concept of device specific and user differently. As there is a concept of device specific and user
specific profiles, these may also be managed on separate servers. specific profiles, these may also be managed on separate servers.
For instance in a roaming situation the device might get its profile For instance in a roaming situation the device might get its profile
data from a local server which knows the LAN specific profile data. data from a local server which knows the LAN specific profile data.
At the same time the user specific profiles might come from the At the same time the user specific profiles might come from the
user's home environment profile delivery server. user's home environment profile delivery server.
skipping to change at page 33, line 39 skipping to change at page 40, line 11
Eliminated some of the complexity in the discovery mechanism. Eliminated some of the complexity in the discovery mechanism.
Suggest caching information discovered about a profile delivery Suggest caching information discovered about a profile delivery
server to avoid an avalanche problem when a whole building full of server to avoid an avalanche problem when a whole building full of
devices powers up. devices powers up.
Added the User-Profile From header field parameter so that the device 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 can request a user specific profile for a user that is different from
the device's default user. the device's default user.
9. References 13. References
9.1 Normative References 13.1 Normative References
[I-D.ietf-sip-content-indirect-mech] [I-D.ietf-sip-content-indirect-mech]
Burger, E., "A Mechanism for Content Indirection in Burger, E., "A Mechanism for Content Indirection in
Session Initiation Protocol (SIP) Messages", Session Initiation Protocol (SIP) Messages",
draft-ietf-sip-content-indirect-mech-05 (work in draft-ietf-sip-content-indirect-mech-05 (work in
progress), October 2004. progress), October 2004.
[I-D.ietf-sip-identity] [I-D.ietf-sip-identity]
Peterson, J., "Enhancements for Authenticated Identity Peterson, J. and C. Jennings, "Enhancements for
Management in the Session Initiation Protocol (SIP)", Authenticated Identity Management in the Session
draft-ietf-sip-identity-04 (work in progress), February Initiation Protocol (SIP)", draft-ietf-sip-identity-05
2005. (work in progress), May 2005.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, March 1997. Requirement Levels", BCP 14, RFC 2119, March 1997.
[RFC2132] Alexander, S. and R. Droms, "DHCP Options and BOOTP Vendor [RFC2132] Alexander, S. and R. Droms, "DHCP Options and BOOTP Vendor
Extensions", RFC 2132, March 1997. Extensions", RFC 2132, March 1997.
[RFC2246] Dierks, T. and C. Allen, "The TLS Protocol Version 1.0", [RFC2246] Dierks, T. and C. Allen, "The TLS Protocol Version 1.0",
RFC 2246, January 1999. RFC 2246, January 1999.
[RFC2616] Fielding, R., Gettys, J., Mogul, J., Frystyk, H., [RFC2616] Fielding, R., Gettys, J., Mogul, J., Frystyk, H.,
Masinter, L., Leach, P. and T. Berners-Lee, "Hypertext Masinter, L., Leach, P., and T. Berners-Lee, "Hypertext
Transfer Protocol -- HTTP/1.1", RFC 2616, June 1999. Transfer Protocol -- HTTP/1.1", RFC 2616, June 1999.
[RFC2617] Franks, J., Hallam-Baker, P., Hostetler, J., Lawrence, S., [RFC2617] Franks, J., Hallam-Baker, P., Hostetler, J., Lawrence, S.,
Leach, P., Luotonen, A. and L. Stewart, "HTTP Leach, P., Luotonen, A., and L. Stewart, "HTTP
Authentication: Basic and Digest Access Authentication", Authentication: Basic and Digest Access Authentication",
RFC 2617, June 1999. RFC 2617, June 1999.
[RFC2818] Rescorla, E., "HTTP Over TLS", RFC 2818, May 2000. [RFC2818] Rescorla, E., "HTTP Over TLS", RFC 2818, May 2000.
[RFC3261] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston, [RFC3261] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston,
A., Peterson, J., Sparks, R., Handley, M. and E. Schooler, A., Peterson, J., Sparks, R., Handley, M., and E.
"SIP: Session Initiation Protocol", RFC 3261, June 2002. Schooler, "SIP: Session Initiation Protocol", RFC 3261,
June 2002.
[RFC3263] Rosenberg, J. and H. Schulzrinne, "Session Initiation [RFC3263] Rosenberg, J. and H. Schulzrinne, "Session Initiation
Protocol (SIP): Locating SIP Servers", RFC 3263, June Protocol (SIP): Locating SIP Servers", RFC 3263,
2002. June 2002.
[RFC3265] Roach, A., "Session Initiation Protocol (SIP)-Specific [RFC3265] Roach, A., "Session Initiation Protocol (SIP)-Specific
Event Notification", RFC 3265, June 2002. Event Notification", RFC 3265, June 2002.
[RFC3361] Schulzrinne, H., "Dynamic Host Configuration Protocol [RFC3361] Schulzrinne, H., "Dynamic Host Configuration Protocol
(DHCP-for-IPv4) Option for Session Initiation Protocol (DHCP-for-IPv4) Option for Session Initiation Protocol
(SIP) Servers", RFC 3361, August 2002. (SIP) Servers", RFC 3361, August 2002.
9.2 Informative References 13.2 Informative References
[I-D.ietf-simple-xcap] [I-D.ietf-simple-xcap]
Rosenberg, J., "The Extensible Markup Language (XML) Rosenberg, J., "The Extensible Markup Language (XML)
Configuration Access Protocol (XCAP)", Configuration Access Protocol (XCAP)",
draft-ietf-simple-xcap-06 (work in progress), February draft-ietf-simple-xcap-07 (work in progress), June 2005.
2005.
[I-D.ietf-simple-xcap-list-usage] [I-D.ietf-simple-xcap-list-usage]
Rosenberg, J., "Extensible Markup Language (XML) Formats Rosenberg, J., "Extensible Markup Language (XML) Formats
for Representing Resource Lists", for Representing Resource Lists",
draft-ietf-simple-xcap-list-usage-05 (work in progress), draft-ietf-simple-xcap-list-usage-05 (work in progress),
February 2005. February 2005.
[I-D.ietf-simple-xcap-package] [I-D.ietf-simple-xcap-package]
Rosenberg, J., "An Extensible Markup Language (XML) Rosenberg, J., "An Extensible Markup Language (XML)
Document Format for Indicating Changes in XML Document Format for Indicating Changes in XML
Configuration Access Protocol (XCAP) Resources", Configuration Access Protocol (XCAP) Resources",
draft-ietf-simple-xcap-package-03 (work in progress), draft-ietf-simple-xcap-package-03 (work in progress),
January 2005. January 2005.
[I-D.ietf-sip-gruu] [I-D.ietf-sip-gruu]
Rosenberg, J., "Obtaining and Using Globally Routable User Rosenberg, J., "Obtaining and Using Globally Routable User
Agent (UA) URIs (GRUU) in the Session Initiation Protocol Agent (UA) URIs (GRUU) in the Session Initiation Protocol
(SIP)", draft-ietf-sip-gruu-02 (work in progress), July (SIP)", draft-ietf-sip-gruu-04 (work in progress),
2004. July 2005.
[I-D.ietf-sipping-ua-prof-framewk-reqs] [I-D.ietf-sipping-ua-prof-framewk-reqs]
Petrie, D. and C. Jennings, "Requirements for SIP User Petrie, D. and C. Jennings, "Requirements for SIP User
Agent Profile Delivery Framework", Agent Profile Delivery Framework",
draft-ietf-sipping-ua-prof-framewk-reqs-00 (work in draft-ietf-sipping-ua-prof-framewk-reqs-00 (work in
progress), March 2003. progress), March 2003.
[I-D.petrie-sipping-profile-datasets] [I-D.petrie-sipping-profile-datasets]
Petrie, D., "A Schema for Session Initiation Protocol User Petrie, D., "A Schema for Session Initiation Protocol User
Agent Profile Data Sets", Agent Profile Data Sets",
draft-petrie-sipping-profile-datasets-00 (work in draft-petrie-sipping-profile-datasets-00 (work in
progress), July 2004. progress), July 2004.
[I-D.sinnreich-sipdev-req] [I-D.sinnreich-sipdev-req]
Butcher, I., Lass, S., Petrie, D., Sinnreich, H. and C. Sinnreich, H., "SIP Telephony Device Requirements and
Stredicke, "SIP Telephony Device Requirements and Configuration", draft-sinnreich-sipdev-req-07 (work in
Configuration", draft-sinnreich-sipdev-req-05 (work in progress), June 2005.
progress), January 2005.
[RFC0822] Crocker, D., "Standard for the format of ARPA Internet [RFC0822] Crocker, D., "Standard for the format of ARPA Internet
text messages", STD 11, RFC 822, August 1982. text messages", STD 11, RFC 822, August 1982.
[RFC0959] Postel, J. and J. Reynolds, "File Transfer Protocol", STD [RFC0959] Postel, J. and J. Reynolds, "File Transfer Protocol",
9, RFC 959, October 1985. STD 9, RFC 959, October 1985.
[RFC2131] Droms, R., "Dynamic Host Configuration Protocol", RFC [RFC2131] Droms, R., "Dynamic Host Configuration Protocol",
2131, March 1997. RFC 2131, March 1997.
[RFC2141] Moats, R., "URN Syntax", RFC 2141, May 1997. [RFC2141] Moats, R., "URN Syntax", RFC 2141, May 1997.
[RFC2396] Berners-Lee, T., Fielding, R. and L. Masinter, "Uniform [RFC2396] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
Resource Identifiers (URI): Generic Syntax", RFC 2396, Resource Identifiers (URI): Generic Syntax", RFC 2396,
August 1998. August 1998.
[RFC3377] Hodges, J. and R. Morgan, "Lightweight Directory Access [RFC3377] Hodges, J. and R. Morgan, "Lightweight Directory Access
Protocol (v3): Technical Specification", RFC 3377, Protocol (v3): Technical Specification", RFC 3377,
September 2002. September 2002.
[W3C.REC-xml-names11-20040204] [W3C.REC-xml-names11-20040204]
Tobin, R., Hollander, D., Layman, A. and T. Bray, Tobin, R., Hollander, D., Layman, A., and T. Bray,
"Namespaces in XML 1.1", W3C REC REC-xml-names11-20040204, "Namespaces in XML 1.1", W3C REC REC-xml-names11-20040204,
February 2004. February 2004.
Author's Address Author's Address
Daniel Petrie Daniel Petrie
Pingtel Corp. SIPez LLC.
400 W. Cummings Park 34 Robbins Rd
Suite 2200 Arlington, MA 02476
Woburn, MA 01801
US US
Phone: "Dan Petrie (+1 617 835 1379)"<sip:dpetrie AT pingtel.com> Phone: "+1 617 273 4000
EMail: dpetrie AT pingtel.com Email: dan.ietf AT SIPez DOT com
URI: http://www.pingtel.com/ URI: http://www.SIPez.com/
Intellectual Property Statement Intellectual Property Statement
The IETF takes no position regarding the validity or scope of any The IETF takes no position regarding the validity or scope of any
Intellectual Property Rights or other rights that might be claimed to Intellectual Property Rights or other rights that might be claimed to
pertain to the implementation or use of the technology described in pertain to the implementation or use of the technology described in
this document or the extent to which any license under such rights this document or the extent to which any license under such rights
might or might not be available; nor does it represent that it has might or might not be available; nor does it represent that it has
made any independent effort to identify any such rights. Information made any independent effort to identify any such rights. Information
on the procedures with respect to rights in RFC documents can be on the procedures with respect to rights in RFC documents can be
 End of changes. 

This html diff was produced by rfcdiff 1.25, available from http://www.levkowetz.com/ietf/tools/rfcdiff/