ETSI TS 129 329 V8.9.0 (2012-01) Technical Specification Digital cellular telecommunications system (Phase 2+); Universal Mobile Telecommunications System (UMTS); LTE; Sh interface based on the Diameter protocol; Protocol details (3GPP TS 29.329 version 8.9.0 Release 8) 3GPP TS 29.329 version 8.9.0 Release 8 1 ETSI TS 129 329 V8.9.0 (2012-01) Reference RTS/TSGC-0429329v890 Keywords GSM,LTE,UMTS ETSI 650 Route des Lucioles F-06921 Sophia Antipolis Cedex - FRANCE Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 Siret N° 348 623 562 00017 - NAF 742 C Association à but non lucratif enregistrée à la Sous-Préfecture de Grasse (06) N° 7803/88 Important notice Individual copies of the present document can be downloaded from: http://www.etsi.org The present document may be made available in more than one electronic version or in print. In any case of existing or perceived difference in contents between such versions, the reference version is the Portable Document Format (PDF). In case of dispute, the reference shall be the printing on ETSI printers of the PDF version kept on a specific network drive within ETSI Secretariat. Users of the present document should be aware that the document may be subject to revision or change of status. Information on the current status of this and other ETSI documents is available at http://portal.etsi.org/tb/status/status.asp If you find errors in the present document, please send your comment to one of the following services: http://portal.etsi.org/chaircor/ETSI_support.asp Copyright Notification No part may be reproduced except as authorized by written permission. The copyright and the foregoing restriction extend to reproduction in all media. © European Telecommunications Standards Institute 2012. All rights reserved. DECTTM, PLUGTESTSTM, UMTSTM and the ETSI logo are Trade Marks of ETSI registered for the benefit of its Members. 3GPPTM and LTE™ are Trade Marks of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners. GSM® and the GSM logo are Trade Marks registered and owned by the GSM Association. ETSI 3GPP TS 29.329 version 8.9.0 Release 8 2 ETSI TS 129 329 V8.9.0 (2012-01) Intellectual Property Rights IPRs essential or potentially essential to the present document may have been declared to ETSI. The information pertaining to these essential IPRs, if any, is publicly available for ETSI members and non-members, and can be found in ETSI SR 000 314: "Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to ETSI in respect of ETSI standards", which is available from the ETSI Secretariat. Latest updates are available on the ETSI Web server (http://ipr.etsi.org). Pursuant to the ETSI IPR Policy, no investigation, including IPR searches, has been carried out by ETSI. No guarantee can be given as to the existence of other IPRs not referenced in ETSI SR 000 314 (or the updates on the ETSI Web server) which are, or may be, or may become, essential to the present document. Foreword This Technical Specification (TS) has been produced by ETSI 3rd Generation Partnership Project (3GPP). The present document may refer to technical specifications or reports using their 3GPP identities, UMTS identities or GSM identities. These should be interpreted as being references to the corresponding ETSI deliverables. The cross reference between GSM, UMTS, 3GPP and ETSI identities can be found under http://webapp.etsi.org/key/queryform.asp. ETSI 3GPP TS 29.329 version 8.9.0 Release 8 3 ETSI TS 129 329 V8.9.0 (2012-01) Contents Intellectual Property Rights ................................................................................................................................ 2 Foreword ............................................................................................................................................................. 2 Foreword ............................................................................................................................................................. 5 1 Scope ........................................................................................................................................................ 6 2 References ................................................................................................................................................ 6 3 Definitions, symbols and abbreviations ................................................................................................... 6 3.1 Definitions .......................................................................................................................................................... 6 3.2 Abbreviations ..................................................................................................................................................... 7 4 General ..................................................................................................................................................... 7 5 Use of the Diameter base protocol ........................................................................................................... 7 6 Diameter application for Sh interface ...................................................................................................... 7 6.1 Command-Code values ...................................................................................................................................... 7 6.1.1 User-Data-Request (UDR) Command .......................................................................................................... 8 6.1.2 User-Data-Answer (UDA) Command .......................................................................................................... 8 6.1.3 Profile-Update-Request (PUR) Command .................................................................................................... 9 6.1.4 Profile-Update-Answer (PUA) Command .................................................................................................... 9 6.1.5 Subscribe-Notifications-Request (SNR) Command ................................................................................... 10 6.1.6 Subscribe-Notifications-Answer (SNA) Command .................................................................................... 10 6.1.7 Push-Notification-Request (PNR) Command ............................................................................................. 11 6.1.8 Push-Notifications-Answer (PNA) Command ............................................................................................ 11 6.2 Result-Code AVP values .................................................................................................................................. 12 6.2.1 Success ........................................................................................................................................................ 12 6.2.2 Permanent Failures ..................................................................................................................................... 12 6.2.2.1 DIAMETER_ERROR_USER_DATA_NOT_RECOGNIZED (5100) ................................................. 12 6.2.2.2 DIAMETER_ERROR_OPERATION_NOT_ALLOWED (5101) ....................................................... 12 6.2.2.3 DIAMETER_ERROR_USER_DATA_CANNOT_BE_READ (5102) ................................................ 12 6.2.2.4 DIAMETER_ERROR_USER_DATA_CANNOT_BE_MODIFIED (5103) ....................................... 12 6.2.2.5 DIAMETER_ERROR_USER_DATA_CANNOT_BE_NOTIFIED (5104) ........................................ 12 6.2.2.6 DIAMETER_ERROR_TOO_MUCH_DATA (5008) .......................................................................... 12 6.2.2.7 DIAMETER_ERROR_TRANSPARENT_DATA OUT_OF_SYNC (5105) ....................................... 12 6.2.2.8 DIAMETER_ERROR_FEATURE_UNSUPPORTED (5011) ............................................................. 12 6.2.2.9 DIAMETER_ERROR_SUBS_DATA_ABSENT (5106) ..................................................................... 12 6.2.2.10 DIAMETER_ERROR_NO_SUBSCRIPTION_TO_DATA (5107) ..................................................... 13 6.2.2.11 DIAMETER_ERROR_DSAI_NOT_AVAILABLE (5108) ................................................................. 13 6.2.3 Transient Failures ....................................................................................................................................... 13 6.2.3.1 DIAMETER_USER_DATA_NOT_AVAILABLE (4100) .................................................................. 13 6.2.3.2 DIAMETER_PRIOR_UPDATE_IN_PROGRESS (4101) ................................................................... 13 6.3 AVPs ................................................................................................................................................................ 14 6.3.1 User-Identity AVP ...................................................................................................................................... 14 6.3.2 MSISDN AVP ............................................................................................................................................ 14 6.3.3 User-Data AVP ........................................................................................................................................... 15 6.3.4 Data-Reference AVP .................................................................................................................................. 15 6.3.5 Service-Indication AVP .............................................................................................................................. 15 6.3.6 Subs-Req-Type AVP .................................................................................................................................. 15 6.3.7 Requested-Domain AVP ............................................................................................................................. 16 6.3.8 Current-Location AVP ................................................................................................................................ 16 6.3.9 Server-Name AVP ...................................................................................................................................... 16 6.3.10 Identity-Set AVP ........................................................................................................................................ 16 6.3.11 Supported-Features AVP ............................................................................................................................ 16 6.3.12 Feature-List-ID AVP .................................................................................................................................. 16 6.3.13 Feature-List AVP ........................................................................................................................................ 16 6.3.14 Supported-Applications AVP ..................................................................................................................... 17 ETSI 3GPP TS 29.329 version 8.9.0 Release 8 4 ETSI TS 129 329 V8.9.0 (2012-01) 6.3.15 Public-Identity AVP ................................................................................................................................... 17 6.3.16 Expiry-Time AVP ....................................................................................................................................... 17 6.3.17 Send-Data-Indication AVP ......................................................................................................................... 17 6.3.18 DSAI-Tag AVP .......................................................................................................................................... 17 6.3.19 Wildcarded-Public-Identity AVP ................................................................................................................ 17 6.3.20 Wildcarded-IMPU AVP ............................................................................................................................. 17 6.3.21 Session-Priority AVP .................................................................................................................................. 17 6.3.22 One-Time-Notification AVP ...................................................................................................................... 17 6.4 Use of namespaces ........................................................................................................................................... 17 6.4.1 AVP codes .................................................................................................................................................. 17 6.4.2 Experimental-Result-Code AVP values ...................................................................................................... 18 6.4.3 Command Code values ............................................................................................................................... 18 6.4.4 Application-ID value .................................................................................................................................. 18 7 Special Requirements ............................................................................................................................. 19 7.1 Version Control ................................................................................................................................................ 19 Annex A (informative): Change history ............................................................................................... 20 History .............................................................................................................................................................. 21 ETSI 3GPP TS 29.329 version 8.9.0 Release 8 5 ETSI TS 129 329 V8.9.0 (2012-01) Foreword This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: Version x.y.z where: x the first digit: 1 presented to TSG for information; 2 presented to TSG for approval; 3 or greater indicates TSG approved document under change control. y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. z the third digit is incremented when editorial only changes have been incorporated in the document. ETSI 3GPP TS 29.329 version 8.9.0 Release 8 6 ETSI TS 129 329 V8.9.0 (2012-01) 1 Scope The present document defines a transport protocol for use in the IP multimedia (IM) Core Network (CN) subsystem based on Diameter. The present document is applicable to: - The Sh interface between an AS and the HSS. - The Sh interface between an SCS and the HSS. Whenever it is possible this document specifies the requirements for this protocol by reference to specifications produced by the IETF within the scope of Diameter. Where this is not possible, extensions to Diameter are defined within this document. 2 References The following documents contain provisions, which through reference in this text constitute provisions of the present document. - References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. - For a specific reference, subsequent revisions do not apply. - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document in the same Release as the present document. [1] 3GPP TS 29.328 "IP Multimedia (IM) Subsystem Sh interface; signalling flows and message contents" [2] 3GPP TS 33.210 "3G Security; Network Domain Security; IP Network Layer Security" [3] IETF RFC 2960 "Stream Control Transmission Protocol" [4] IETF RFC 3588 "Diameter Base Protocol" [5] IETF RFC 2234 "Augmented BNF for syntax specifications" [6] 3GPP TS 29.229 "Cx and Dx Interfaces based on the Diameter protocol; protocol details" [7] IETF RFC 3589 "Diameter Command Codes for Third Generation Partnership Project (3GPP) Release 5" [8] ITU-T Recommendation E.164: "The international public telecommunication numbering plan" [9] 3GPP TR 33.978 "Security aspects of early IP Multimedia Subsystem (IMS) (Release 6)" [10] 3GPP TS 29.364 " IMS Application Server Service Data Descriptions for AS interoperability " 3 Definitions, symbols and abbreviations 3.1 Definitions Refer to IETF RFC 3588 [4] for the definitions of some terms used in this document. For the purposes of the present document, the following terms and definitions apply. ETSI 3GPP TS 29.329 version 8.9.0 Release 8 7 ETSI TS 129 329 V8.9.0 (2012-01) Attribute-Value Pair: see IETF RFC 3588 [4], it corresponds to an Information Element in a Diameter message. Server: SIP-server. User data: user profile data. 3.2 Abbreviations For the purposes of the present document, the following abbreviations apply: AAA Authentication, Authorization and Accounting AS Application Server ABNF Augmented Backus-Naur Form AVP Attribute-Value Pair CN Core Network HSS Home Subscriber Server IANA Internet Assigned Numbers Authority IETF Internet Engineering Task Force IMS IP Multimedia Subsystem NDS Network Domain Security RFC Request For Comment SCTP Stream Control Transport Protocol UCS Universal Character Set URL Uniform Resource Locator UTF UCS Transformation Formats 4 General The Diameter Base Protocol as specified in IETF RFC 3588 [4] shall apply except as modified by the defined support of the methods and the defined support of the commands and AVPs, result and event codes specified in clause 6 of this specification. Unless otherwise specified, the procedures (including error handling and unrecognised information handling) are unmodified. 5 Use of the Diameter base protocol The same clarifications of section 5 of 3GPP TS 29.229 [6] shall apply to the Sh interface. An exception is that the application identifier for this application is defined in chapter 6. 6 Diameter application for Sh interface This clause specifies a Diameter application that allows a Diameter server and a Diameter client: - to download and update transparent and non-transparent user data - to request and send notifications on changes on user data The Sh interface protocol is defined as an IETF vendor specific Diameter application, where the vendor is 3GPP. The vendor identifier assigned by IANA to 3GPP ( http://www.iana.org/assignments/enterprise-numbers) is 10415. The Diameter application identifier assigned to the Sh interface application is 16777217 (allocated by IANA). 6.1 Command-Code values This section defines Command-Code values for this Diameter application. ETSI 3GPP TS 29.329 version 8.9.0 Release 8 8 ETSI TS 129 329 V8.9.0 (2012-01) Every command is defined by means of the ABNF syntax (as defined in RFC 2234 [5]), according to the rules in IETF RFC 3588 [4]. Whenever the definition and use of an AVP is not specified in this document, what is stated in 3GPP TS 29.229 [6] shall apply. The command codes for the Sh interface application are taken from the range allocated by IANA in IETF RFC 3589 [7] as assigned in this specification. For these commands, the Application-ID field shall be set to 16777217 (application identifier of the Sh interface application, allocated by IANA). The following Command Codes are defined in this specification: Table 6.1.1: Command-Code values Command-Name Abbreviation Code Section User-Data-Request UDR 306 6.1.1 User-Data-Answer UDA 306 6.1.2 Profile-Update-Request PUR 307 6.1.3 Profile-Update-Answer PUA 307 6.1.4 Subscribe-Notifications-Request SNR 308 6.1.5 Subscribe-Notifications-Answer SNA 308 6.1.6 Push-Notification-Request PNR 309 6.1.7 Push-Notification-Answer PNA 309 6.1.8 6.1.1 User-Data-Request (UDR) Command The User-Data-Request (UDR) command, indicated by the Command-Code field set to 306 and the ‘R’ bit set in the Command Flags field, is sent by a Diameter client to a Diameter server in order to request user data. Message Format < User-Data -Request> ::= < Diameter Header: 306, REQ, PXY, 16777217 > < Session-Id > { Vendor-Specific-Application-Id } { Auth-Session-State } { Origin-Host } { Origin-Realm } [ Destination-Host ] { Destination-Realm } *[ Supported-Features ] { User-Identity } [ Wildcarded-Public-Identity ] [ Wildcarded-IMPU ] [ Server-Name ] *[ Service-Indication ] *{ Data-Reference } *[ Identity-Set ] [ Requested-Domain ] [ Current-Location ] *[ DSAI-Tag ] [ Session-Priority ] [ User-Name ] *[ AVP ] *[ Proxy-Info ] *[ Route-Record ] 6.1.2 User-Data-Answer (UDA) Command The User-Data-Answer (UDA) command, indicated by the Command-Code field set to 306 and the ‘R’ bit cleared in the Command Flags field, is sent by a server in response to the User-Data-Request command. The Experimental-Result AVP may contain one of the values defined in section 6.2 or in 3GPP TS 29.229 [6]. Message Format ETSI 3GPP TS 29.329 version 8.9.0 Release 8 9 ETSI TS 129 329 V8.9.0 (2012-01) < User-Data-Answer > ::= < Diameter Header: 306, PXY, 16777217 > < Session-Id > { Vendor-Specific-Application-Id } [ Result-Code ] [ Experimental-Result ] { Auth-Session-State } { Origin-Host } { Origin-Realm } *[ Supported-Features ] [ Wildcarded-Public-Identity ] [ Wildcarded-IMPU ] [ User-Data ] *[ AVP ] *[ Failed-AVP ] *[ Proxy-Info ] *[ Route-Record ] 6.1.3 Profile-Update-Request (PUR) Command The Profile-Update-Request (PUR) command, indicated by the Command-Code field set to 307 and the ‘R’ bit set in the Command Flags field, is sent by a Diameter client to a Diameter server in order to update user data in the server. Message Format < Profile-Update-Request > ::= < Diameter Header: 307, REQ, PXY, 16777217 > < Session-Id > { Vendor-Specific-Application-Id } { Auth-Session-State } { Origin-Host } { Origin-Realm } [ Destination-Host ] { Destination-Realm } *[ Supported-Features ] { User-Identity } [ Wildcarded-Public-Identity ] [ Wildcarded-IMPU ] { Data-Reference } { User-Data } *[ AVP ] *[ Proxy-Info ] *[ Route-Record ] 6.1.4 Profile-Update-Answer (PUA) Command The Profile-Update-Answer (PUA) command, indicated by the Command-Code field set to 307 and the ‘R’ bit cleared in the Command Flags field, is sent by a server in response to the Profile-Update-Request command. The Experimental- Result AVP may contain one of the values defined in section 6.2 or in 3GPP TS 29.229 [6]. Message Format < Profile-Update-Answer > ::=< Diameter Header: 307, PXY, 16777217 > < Session-Id > { Vendor-Specific-Application-Id } [ Result-Code ] [ Experimental-Result ] { Auth-Session-State } { Origin-Host } { Origin-Realm } [ Wildcarded-Public-Identity ] [ Wildcarded-IMPU ] *[ Supported-Features ] *[ AVP ] ETSI