|
TECHNICAL SPECIFICATION
Digital cellular telecommunications system (Phase 2+) (GSM);
Universal Mobile Telecommunications System (UMTS);
LTE;
Sh interface based on the Diameter protocol;
Protocol details
(3GPP TS 29.329 version 15.1.0 Release 15)
---------------------- Page: 1 ----------------------
3GPP TS 29.329 version 15.1.0 Release 15 1 ETSI TS 129 329 V15.1.0 (2018-07)
Reference
RTS/TSGC-0429329vf10
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
The present document can be downloaded from:
The present document may be made available in electronic versions and/or in print. The content of any electronic and/or
print versions of the present document shall not be modified without the prior written authorization of ETSI. In case of any
existing or perceived difference in contents between such versions and/or in print, the only prevailing document is the
print of the Portable Document Format (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
If you find errors in the present document, please send your comment to one of the following services:
Copyright Notification
No part may be reproduced or utilized in any form or by any means, electronic or mechanical, including photocopying
and microfilm except as authorized by written permission of ETSI.
The content of the PDF version shall not be modified without the written authorization of ETSI.
The copyright and the foregoing restriction extend to reproduction in all media.
© ETSI 2018.
All rights reserved.
TM TM TM
DECT , PLUGTESTS , UMTS and the ETSI logo are trademarks of ETSI registered for the benefit of its Members.
TM TM
3GPP and LTE are trademarks of ETSI registered for the benefit of its Members and
of the 3GPP Organizational Partners.
oneM2M logo is protected for the benefit of its Members.
GSM and the GSM logo are trademarks registered and owned by the GSM Association.
ETSI
---------------------- Page: 2 ----------------------
3GPP TS 29.329 version 15.1.0 Release 15 2 ETSI TS 129 329 V15.1.0 (2018-07)
Intellectual Property Rights
Essential patents
IPRs essential or potentially essential to normative deliverables 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 (https://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.
Trademarks
The present document may include trademarks and/or tradenames which are asserted and/or registered by their owners.
ETSI claims no ownership of these except for any which are indicated as being the property of ETSI, and conveys no
right to use or reproduce any trademark and/or tradename. Mention of those trademarks in the present document does
not constitute an endorsement by ETSI of products, services or organizations associated with those trademarks.
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
.
Modal verbs terminology
In the present document "shall", "shall not", "should", "should not", "may", "need not", "will", "will not", "can" and
"cannot" are to be interpreted as described in clause 3.2 of the ETSI Drafting Rules (Verbal forms for the expression of
provisions).
"must" and "must not" are NOT allowed in ETSI deliverables except when used in direct citation.
ETSI
---------------------- Page: 3 ----------------------
3GPP TS 29.329 version 15.1.0 Release 15 3 ETSI TS 129 329 V15.1.0 (2018-07)
Contents
Intellectual Property Rights . 2
Foreword . 2
Modal verbs terminology . 2
Foreword . 5
1 Scope . 6
2 References . 6
3 Definitions, symbols and abbreviations . 7
3.1 Definitions . 7
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 . 8
6.1.1 User-Data-Request (UDR) Command . 8
6.1.2 User-Data-Answer (UDA) Command . 9
6.1.3 Profile-Update-Request (PUR) Command . 9
6.1.4 Profile-Update-Answer (PUA) Command . 10
6.1.5 Subscribe-Notifications-Request (SNR) Command . 10
6.1.6 Subscribe-Notifications-Answer (SNA) Command . 11
6.1.7 Push-Notification-Request (PNR) Command . 11
6.1.8 Push-Notifications-Answer (PNA) Command . 12
6.2 Result-Code AVP values . 13
6.2.1 Success . 13
6.2.2 Permanent Failures . 13
6.2.2.1 DIAMETER_ERROR_USER_DATA_NOT_RECOGNIZED (5100) . 13
6.2.2.2 DIAMETER_ERROR_OPERATION_NOT_ALLOWED (5101) . 13
6.2.2.3 DIAMETER_ERROR_USER_DATA_CANNOT_BE_READ (5102) . 13
6.2.2.4 DIAMETER_ERROR_USER_DATA_CANNOT_BE_MODIFIED (5103) . 13
6.2.2.5 DIAMETER_ERROR_USER_DATA_CANNOT_BE_NOTIFIED (5104) . 13
6.2.2.6 DIAMETER_ERROR_TOO_MUCH_DATA (5008) . 13
6.2.2.7 DIAMETER_ERROR_TRANSPARENT_DATA OUT_OF_SYNC (5105) . 13
6.2.2.8 DIAMETER_ERROR_FEATURE_UNSUPPORTED (5011) . 13
6.2.2.9 DIAMETER_ERROR_SUBS_DATA_ABSENT (5106) . 13
6.2.2.10 DIAMETER_ERROR_NO_SUBSCRIPTION_TO_DATA (5107) . 13
6.2.2.11 DIAMETER_ERROR_DSAI_NOT_AVAILABLE (5108) . 14
6.2.2.12 DIAMETER_ERROR_IDENTITIES_DONT_MATCH (5002) . 14
6.2.3 Transient Failures . 14
6.2.3.1 DIAMETER_USER_DATA_NOT_AVAILABLE (4100) . 14
6.2.3.2 DIAMETER_PRIOR_UPDATE_IN_PROGRESS (4101) . 14
6.3 AVPs . 15
6.3.1 User-Identity AVP . 16
6.3.2 MSISDN AVP . 16
6.3.3 User-Data AVP . 16
6.3.4 Data-Reference AVP . 16
6.3.5 Service-Indication AVP . 17
6.3.6 Subs-Req-Type AVP . 17
6.3.7 Requested-Domain AVP . 17
6.3.7A Requested-Nodes AVP . 18
6.3.8 Current-Location AVP . 18
6.3.9 Server-Name AVP . 18
6.3.10 Identity-Set AVP . 18
6.3.11 Supported-Features AVP . 18
6.3.12 Feature-List-ID AVP . 18
ETSI
---------------------- Page: 4 ----------------------
3GPP TS 29.329 version 15.1.0 Release 15 4 ETSI TS 129 329 V15.1.0 (2018-07)
6.3.13 Feature-List AVP . 18
6.3.14 Supported-Applications AVP . 19
6.3.15 Public-Identity AVP . 19
6.3.16 Expiry-Time AVP . 19
6.3.17 Send-Data-Indication AVP . 19
6.3.18 DSAI-Tag AVP . 19
6.3.19 Wildcarded-Public-Identity AVP . 19
6.3.20 Wildcarded-IMPU AVP . 19
6.3.21 Session-Priority AVP . 19
6.3.22 One-Time-Notification AVP . 19
6.3.23 Serving-Node-Indication AVP. 19
6.3.24 Repository-Data-ID AVP . 19
6.3.25 Sequence-Number AVP . 20
6.3.26 Pre-paging-Supported AVP . 20
6.3.27 Local-Time-Zone-Indication AVP . 20
6.3.28 UDR-Flags . 20
6.3.29 Call-Reference-Info AVP . 20
6.3.30 Call-Reference-Number AVP . 21
6.3.31 AS-Number AVP . 21
6.3.32 OC-Supported-Features . 21
6.3.33 OC-OLR . 21
6.3.34 DRMP AVP . 21
6.3.35 Load . 21
6.4 Use of namespaces . 21
6.4.1 AVP codes . 21
6.4.2 Experimental-Result-Code AVP values . 21
6.4.3 Command Code values . 21
6.4.4 Application-ID value . 21
7 Special Requirements . 22
7.1 Version Control . 22
Annex A (informative): Change history . 23
History . 25
ETSI
---------------------- Page: 5 ----------------------
3GPP TS 29.329 version 15.1.0 Release 15 5 ETSI TS 129 329 V15.1.0 (2018-07)
Foreword
rd
This Technical Specification has been produced by the 3 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
---------------------- Page: 6 ----------------------
3GPP TS 29.329 version 15.1.0 Release 15 6 ETSI TS 129 329 V15.1.0 (2018-07)
1 Scope
The present document defines a transport protocol for use in the IP multimedia (IM) Core Network (CN) subsystem
based on the Diameter base protocol as specified in IETF RFC 6733 [15].
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 base protocol as specified in IETF RFC 6733 [15]. Where this is
not possible, extensions to the Diameter base protocol as specified in IETF RFC 6733 [15] 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] Void.
[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".
[11] 3GPP TS 29.002 "Mobile Application Part (MAP) specification".
[12] IETF RFC 7683: "Diameter Overload Indication Conveyance".
[13] IETF RFC 7944: "Diameter Routing Message Priority".
[14] IETF draft-ietf-dime-load-03: "Diameter Load Information Conveyance".
Editor's note: The above document cannot be formally referenced until it is published as an RFC.
[15] IETF RFC 6733: "Diameter Base Protocol".
ETSI
---------------------- Page: 7 ----------------------
3GPP TS 29.329 version 15.1.0 Release 15 7 ETSI TS 129 329 V15.1.0 (2018-07)
[16]] 3GPP TS 29.336: "Home Subscriber Server (HSS) diameter interfaces for interworking with
packet data networks and applications".
3 Definitions, symbols and abbreviations
3.1 Definitions
Refer to IETF RFC 6733 [15] for the definitions of some terms used in this document.
For the purposes of the present document, the following terms and definitions apply.
Attribute-Value Pair: see IETF RFC 6733 [15], 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
DRMP Diameter Routing Message Priority
DSCP Differentiated Services Code Point
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
he Diameter base protocol as specified in IETF RFC 6733 [15] 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
ETSI
---------------------- Page: 8 ----------------------
3GPP TS 29.329 version 15.1.0 Release 15 8 ETSI TS 129 329 V15.1.0 (2018-07)
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.
Every command is defined by means of the ABNF syntax (as defined in RFC 2234 [5]), according to the Command
Code Format (CCF) specification defined in IETF RFC 6733 [15]. 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.
NOTE: As the Diameter commands described in this specification have been defined based on the former
specification of the Diameter base protocol, the Vendor-Specific-Application-Id AVP is still listed as a
required AVP (an AVP indicated as {AVP}) in the command code format specifications defined in this
specification to avoid backward compatibility issues, even if the use of this AVP has been deprecated in
the new specification of the Diameter base protocol (IETF RFC 6733 [15]).
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 >
[ DRMP ]
{ 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 ]
ETSI
---------------------- Page: 9 ----------------------
3GPP TS 29.329 version 15.1.0 Release 15 9 ETSI TS 129 329 V15.1.0 (2018-07)
*[ DSAI-Tag ]
[ Session-Priority ]
[ User-Name ]
[ Requested-Nodes ]
[ Serving-Node-Indication ]
[ Pre-paging-Supported ]
[ Local-Time-Zone-Indication ]
[ UDR-Flags ]
[ Call-Reference-Info ]
[ OC-Supported-Features ]
*[ 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
< User-Data-Answer > ::= < Diameter Header: 306, PXY, 16777217 >
< Session-Id >
[ DRMP ]
{ Vendor-Specific-Application-Id }
[ Result-Code ]
[ Experimental-Result ]
{ Auth-Session-State }
{ Origin-Host }
{ Origin-Realm }
*[ Supported-Features ]
[ Wildcarded-Public-Identity ]
[ Wildcarded-IMPU ]
[ User-Data ]
[ OC-Supported-Features ]
[ OC-OLR ]
*[ Load ]
*[ 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 >
[ DRMP ]
{ Vendor-Specific-Application-Id }
{ Auth-Session-State }
{ Origin-Host }
{ Origin-Realm }
[ Destination-Host ]
{ Destination-Realm }
*[ Supported-Features ]
{ User-Identity }
[ Wildcarded-Public-Identity ]
[ Wildcarded-IMPU ]
ETSI
---------------------- Page: 10 ----------------------
3GPP TS 29.329 version 15.1.0 Release 15 10 ETSI TS 129 329 V15.1.0 (2018-07)
[ User-Name ]
*{ Data-Reference }
{ User-Data }
[ OC-Supported-Features ]
*[ AVP ]
*[ Proxy-Info ]
*[ Route-Record ]
NOTE: More than one Data-Reference AVP may be present in the message only if both the AS and the HSS
support the Update-Eff-Enhance feature. How the AS knows whether the HSS supports the Update-Eff-
Enhance feature is implementation issue, e.g. the AS can get the information from a previous PUA
message.
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 >
[ DRMP ]
{ Vendor-Specific-Application-Id }
[ Result-Code ]
[ Experimental-Result ]
{ Auth-Session-State }
{ Origin-Host }
{ Origin-Realm }
[ Wildcarded-Public-Identity ]
[ Wildcarded-IMPU ]
[ Repository-Data-ID ]
[ Data-Referenc
...