|
TECHNICAL SPECIFICATION
5G;
5G System;
5G ProSe Anchor Services;
Stage 3
(3GPP TS 29.553 version 17.1.0 Release 17)
---------------------- Page: 1 ----------------------
3GPP TS 29.553 version 17.1.0 Release 17 1 ETSI TS 129 553 V17.1.0 (2023-01)
Reference
RTS/TSGC-0429553vh10
Keywords
5G
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 - APE 7112B
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° w061004871
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 prevailing version of an ETSI
deliverable is the one made publicly available in PDF format at www.etsi.org/deliver.
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:
If you find a security vulnerability in the present document, please report it through our
Coordinated Vulnerability Disclosure Program:
https://www.etsi.org/standards/coordinated-vulnerability-disclosure
Notice of disclaimer & limitation of liability
The information provided in the present deliverable is directed solely to professionals who have the appropriate degree of
experience to understand and interpret its content in accordance with generally accepted engineering or
other professional standard and applicable regulations.
No recommendation as to products and services or vendors is made or should be implied.
No representation or warranty is made that this deliverable is technically accurate or sufficient or conforms to any law
and/or governmental rule and/or regulation and further, no representation or warranty is made of merchantability or fitness
for any particular purpose or against infringement of intellectual property rights.
In no event shall ETSI be held liable for loss of profits or any other incidental or consequential damages.
Any software contained in this deliverable is provided "AS IS" with no warranties, express or implied, including but not
limited to, the warranties of merchantability, fitness for a particular purpose and non-infringement of intellectual property
rights and ETSI shall not be held liable in any event for any damages whatsoever (including, without limitation, damages
for loss of profits, business interruption, loss of information, or any other pecuniary loss) arising out of or related to the use
of or inability to use the software.
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 2023.
All rights reserved.
ETSI
---------------------- Page: 2 ----------------------
3GPP TS 29.553 version 17.1.0 Release 17 2 ETSI TS 129 553 V17.1.0 (2023-01)
Intellectual Property Rights
Essential patents
IPRs essential or potentially essential to normative deliverables may have been declared to ETSI. The declarations
pertaining to these essential IPRs, if any, are 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 Directives including the ETSI IPR Policy, no investigation regarding the essentiality of IPRs,
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.
DECT™, PLUGTESTS™, UMTS™ and the ETSI logo are trademarks of ETSI registered for the benefit of its
Members. 3GPP™ and LTE™ are trademarks of ETSI registered for the benefit of its Members and of the 3GPP
Organizational Partners. oneM2M™ logo is a trademark of ETSI registered for the benefit of its Members and of the
®
oneM2M Partners. GSM and the GSM logo are trademarks registered and owned by the GSM Association.
Legal Notice
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. These shall be
interpreted as being references to the corresponding ETSI deliverables.
The cross reference between 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.553 version 17.1.0 Release 17 3 ETSI TS 129 553 V17.1.0 (2023-01)
Contents
Intellectual Property Rights . 2
Legal Notice . 2
Modal verbs terminology . 2
Foreword . 5
1 Scope . 7
2 References . 7
3 Definitions and abbreviations . 8
3.1 Definitions . 8
3.2 Abbreviations . 8
4 Overview . 8
5 Services offered by the 5G PAnF . 8
5.1 Introduction . 8
5.2 Npanf_ProseKey Service . 9
5.2.1 Service Description . 9
5.2.2 Service Operations . 9
5.2.2.1 Introduction . 9
5.2.2.2 Register . 9
5.2.2.2.1 General . 9
5.2.2.3 Retrieve . 10
5.2.2.3.1 General . 10
6 API Definitions . 11
6.1 Npanf_ProseKey Service API . 11
6.1.1 Introduction. 11
6.1.2 Usage of HTTP . 11
6.1.2.1 General . 11
6.1.2.2 HTTP standard headers . 11
6.1.2.2.1 General . 11
6.1.2.2.2 Content type . 11
6.1.2.3 HTTP custom headers . 11
6.1.3 Resources . 12
6.1.3.1 Overview . 12
6.1.3.2 Resource: Prose Keys . 12
6.1.3.2.1 Description . 12
6.1.3.2.2 Resource Definition . 12
6.1.3.2.3 Resource Standard Methods . 13
6.1.3.2.4 Resource Custom Operations . 13
6.1.4 Custom Operations without associated resources . 14
6.1.5 Notifications . 14
6.1.6 Data Model . 14
6.1.6.1 General . 14
6.1.6.2 Structured data types . 15
6.1.6.2.1 Introduction . 15
6.1.6.2.2 Type: ProseContextInfo . 15
6.1.6.2.3 Type: ProseKeyRequest . 15
6.1.6.2.4 Type: ProseKeyResponse . 15
6.1.6.3 Simple data types and enumerations . 15
6.1.6.3.1 Introduction . 15
6.1.6.3.2 Simple data types . 15
6.1.6.4 Data types describing alternative data types or combinations of data types . 16
6.1.6.5 Binary data . 16
6.1.7 Error Handling . 16
6.1.7.1 General . 16
ETSI
---------------------- Page: 4 ----------------------
3GPP TS 29.553 version 17.1.0 Release 17 4 ETSI TS 129 553 V17.1.0 (2023-01)
6.1.7.2 Protocol Errors . 16
6.1.7.3 Application Errors . 16
6.1.8 Feature negotiation . 16
6.1.9 Security . 16
Annex A (normative): OpenAPI specification . 18
A.1 General . 18
A.2 Npanf_ProseKey API . 18
Annex B (informative): Change history . 20
History . 21
ETSI
---------------------- Page: 5 ----------------------
3GPP TS 29.553 version 17.1.0 Release 17 5 ETSI TS 129 553 V17.1.0 (2023-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.
In the present document, modal verbs have the following meanings:
shall indicates a mandatory requirement to do something
shall not indicates an interdiction (prohibition) to do something
The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in
Technical Reports.
The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided
insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced,
non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a
referenced document.
should indicates a recommendation to do something
should not indicates a recommendation not to do something
may indicates permission to do something
need not indicates permission not to do something
The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions
"might not" or "shall not" are used instead, depending upon the meaning intended.
can indicates that something is possible
cannot indicates that something is impossible
The constructions "can" and "cannot" are not substitutes for "may" and "need not".
will indicates that something is certain or expected to happen as a result of action taken by an agency
the behaviour of which is outside the scope of the present document
will not indicates that something is certain or expected not to happen as a result of action taken by an
agency the behaviour of which is outside the scope of the present document
might indicates a likelihood that something will happen as a result of action taken by some agency the
behaviour of which is outside the scope of the present document
ETSI
---------------------- Page: 6 ----------------------
3GPP TS 29.553 version 17.1.0 Release 17 6 ETSI TS 129 553 V17.1.0 (2023-01)
might not indicates a likelihood that something will not happen as a result of action taken by some agency
the behaviour of which is outside the scope of the present document
In addition:
is (or any other verb in the indicative mood) indicates a statement of fact
is not (or any other negative verb in the indicative mood) indicates a statement of fact
The constructions "is" and "is not" do not indicate requirements.
ETSI
---------------------- Page: 7 ----------------------
3GPP TS 29.553 version 17.1.0 Release 17 7 ETSI TS 129 553 V17.1.0 (2023-01)
1 Scope
The present document specifies the stage 3 protocol and data model for the Npanf Service Based Interface. It provides
stage 3 protocol definitions and message flows, and specifies the API for each service offered by the 5G PAnF.
The 5G System stage 2 architecture and procedures are specified in TS 23.501 [2] and TS 23.502 [3].
The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition
are specified in TS 29.500 [4] and TS 29.501 [5].
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 TR 21.905: "Vocabulary for 3GPP Specifications".
[2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2".
[3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2".
[4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3".
[5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3".
[6] OpenAPI: "OpenAPI Specification Version 3.0.0", https://spec.openapis.org/oas/v3.0.0.
[7] 3GPP TR 21.900: "Technical Specification Group working methods".
[8] 3GPP TS 33.501: "Security architecture and procedures for 5G system".
[9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework".
[10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3".
[11] IETF RFC 7540: "Hypertext Transfer Protocol Version 2 (HTTP/2)".
[12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format".
[13] IETF RFC 7807: "Problem Details for HTTP APIs".
[14] 3GPP TS 33.503: "Security Aspects of Proximity based Services (ProSe) in the 5G System
(5GS)".
[15] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3".
ETSI
---------------------- Page: 8 ----------------------
3GPP TS 29.553 version 17.1.0 Release 17 8 ETSI TS 129 553 V17.1.0 (2023-01)
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following
apply. A term defined in the present document takes precedence over the definition of the same term, if any, in
3GPP TR 21.905 [1].
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An
abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in
3GPP TR 21.905 [1].
PAnF Prose Anchor Function
4 Overview
The Prose Anchor Function (PAnF) is the network entity in the 5G Core Network (5GC) supporting security procedure
over Control Plane for the 5G ProSe UE-to-Network relay as specified in 3GPP TS 33.503 [14]. Within the 5GC, the
PAnF offers services to the AUSF via the Npanf service based interface.
Figure 4-1 provides the reference model (in service based interface representation and in reference point
representation), with focus on the PAnF:
Figure 4-1: Reference model – PAnF
The PAnF supports the following functionalities:
- Storage and retrieval of ProSe context information of the 5G ProSe Remote UE;
- Checking whether the 5G ProSe Remote UE is authorized to use the UE-to-Network Relay service.
5 Services offered by the 5G PAnF
5.1 Introduction
Table 5.1-1 shows the PAnF Services and PAnF Service Operations:
ETSI
---------------------- Page: 9 ----------------------
3GPP TS 29.553 version 17.1.0 Release 17 9 ETSI TS 129 553 V17.1.0 (2023-01)
Table 5.1-1: List of 5G PAnF Services
Service Name Service Operations Operation Example
Semantics Consumer(s)
Npanf_ProseKey Register Request/Response AUSF
Retrieve Request/Response AUSF
Table 5.1-2 summarizes the corresponding APIs defined for this specification.
Table 5.1-2: API Descriptions
Service Name Clause Description OpenAPI Specification File apiName Annex
PAnF Prose Key
Npanf_ProseKey 6.1 TS29553_Npanf_ProseKey.yaml npanf_prosekey A.2
Service
5.2 Npanf_ProseKey Service
5.2.1 Service Description
The Npanf_ProseKey service enables an NF to request the PAnF to store the ProSe context information for a 5G ProSe
Remote UE or to request CP-PRUK from the PAnF. The following are the key functionalities of this NF service.
- Store the Prose context information;
- Retrieve the Prose Key.
5.2.2 Service Operations
5.2.2.1 Introduction
The service operations defined for the Npanf_ProseKey service are as follows:
- Register: It allows a consumer NF to store the Prose Context information;
- Retrieve: It provides to the NF service consumer of the CP-PRUK matching input criteria.
5.2.2.2 Register
5.2.2.2.1 General
The Register service operation is invoked by a NF Service Consumer to request the PAnF to store the ProSe context
information for a 5G ProSe Remote UE.
The Register service operation is used during the following procedure:
- PC5 security establishment for 5G ProSe UE-to-Network relay communication over Control Plane (see
3GPP TS 33.503 [14], clause 6.3.3.3.2)
The NF Service Consumer (i.e. AUSF) shall request the PAnF to store the ProSe context information for a 5G ProSe
Remote UE as shown in Figure 5.2.2.2.1-1
ETSI
---------------------- Page: 10 ----------------------
3GPP TS 29.553 version 17.1.0 Release 17 10 ETSI TS 129 553 V17.1.0 (2023-01)
NF service
PAnF
consumer
1. POST…/prose-keys/register (ProseContextInfo)
2a. 204 No Content
2b. 404 Not Found
Figure 5.2.2.2.1-1: Prose Keys registration
1. The NF service consumer (e.g. AUSF) sends a POST request to the resource representing the Prose Context Info
for a 5G ProSe Remote UE.
2a. On success, the PAnF responds with "204 No Content".
2b. If the user does not exist, HTTP status code "404 Not Found" shall be returned including additional error
information in the response body (in the "ProblemDetails" element).
On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error
information should be returned in the POST response body.
5.2.2.3 Retrieve
5.2.2.3.1 General
Figure 5.2.2.3.1-1 shows a scenario where the NF service consumer (e.g. AUSF) sends a request to the PAnF to retrieve
the CP-PRUK. The request contains the CP-PRUK ID and Relay Service Code.
NF Service
PAnF
Consumer
1. POST…/prose-keys/retrieve (ProseKeyRequest)
2a. 200 OK (ProseKeyResponse)
2b. 404 Not Found
Figure 5.2.2.3.1-1: Prose Keys retrieval
1. The NF service consumer (e.g. AUSF) sends a POST request to the resource representing the Prose Key.
2a. On success, the PAnF responds with "200 OK" with the message body containing the ProseKeyResponse.
2b. If the user does not exist, or the ProSe Key does not exist in the in the PAnF, HTTP status code "404 Not Found"
shall be returned and additional error information should be included in the response body (in the
"ProblemDetails" element).
On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error
information should be returned in the POST response body.
ETSI
---------------------- Page: 11 ----------------------
3GPP TS 29.553 version 17.1.0 Release 17 11 ETSI TS 129 553 V17.1.0 (2023-01)
6 API Definitions
6.1 Npanf_ProseKey Service API
6.1.1 Introduction
The Npanf_ProseKey service shall use the Npanf_ProseKey API.
The API URI of the Npanf_ProseKey API shall be:
{apiRoot}//
The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the
Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.:
{apiRoot}///
with the following components:
- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5].
- The shall be "npanf-prosekey".
- The shall be "v1".
- The shall be set as described in clause 6.1.3.
6.1.2 Usage of HTTP
6.1.2.1 General
HTTP/2, IETF RFC 7540 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4].
HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4].
The OpenAPI [6] specification of HTTP messages and content bodies for the Npanf_ProseKey API is contained in
Annex A.
6.1.2.2 HTTP standard headers
6.1.2.2.1 General
See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers.
6.1.2.2.2 Content type
JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as
specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type
"application/json".
"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and
shall be signalled by the content type "application/problem+json", as defined in IETF RFC 7807 [13].
6.1.2.3 HTTP custom headers
The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and
the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported.
ETSI
---------------------- Page: 12 ----------------------
3GPP TS 29.553 version 17.1.0 Release 17 12 ETSI TS 129 553 V17.1.0 (2023-01)
6.1.3 Resources
6.1.3.1 Overview
This clause describes the structure for the Resource URIs and the resources and methods used for the service.
Figure 6.1.3.1-1 depicts the resource URIs structure for the Npanf_ProseKey API.
{apiRoot}/npanf-prosekey/ ...