docs/overview.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. Copyright (C) 2023 Nordix
   4
   5 #############
   6 Overview
   7 #############
   8
   9 Within Service Management and Exposure the CAPIF Core product is developed. It resides in the "capifcore" folder.
  10
  11 This product is a part of :doc:`NONRTRIC <nonrtric:index>`.
  12
  13 *************
  14 CAPIF
  15 *************
  16
  17 Introduction
  18 ************
  19
  20 CAPIF stands for Common API framework and it was developed by 3GPP to enable a unified Northbound API framework across 3GPP network functions, and to ensure that there is a single and harmonized approach for API development.
  21
  22 Key features in capif includes onboarding and offloading of application functions, service discovery and management, event subscription and notification as well as authorization and authentication.
  23
  24 It was delivered in Rel-15 (Refer to 3GPP TS 23.222 and 3GPP TS 29.222)
  25
  26 Functional entities
  27 ===================
  28
  29 The CAPIF consists of an API provider functions, the CAPIF core functions and API Invoker.
  30
  31 .. image:: ./images/architectureCAPIF.png
  32    :width: 500pt
  33    :alt: High level functional architecture for the CAPIF (3GPP TS 23.222).
  34
  35 CAPIF Core function
  36 ~~~~~~~~~~~~~~~~~~~
  37
  38 The CAPIF core functions support the API invokers to access the service APIs. It consists of the following capabilities:
  39
  40 * Authenticating the API invoker based on the identity and other information required for authentication of the API invoker;
  41 * Supporting mutual authentication with the API invoker;
  42 * Providing authorization for the API invoker prior to accessing the service API;
  43 * Publishing, storing and supporting the discovery of service APIs information;
  44 * Monitoring the service API invocations;
  45 * Onboarding a new API invoker and offboarding an API invoker;
  46 * Supports publishing, discovery of service APIs information with another CAPIF core function in CAPIF interconnection.
  47
  48 API Invoker
  49 ~~~~~~~~~~~
  50
  51 The API invoker is the entity which invokes the CAPIF or service APIs, typically provided by a 3rd party application provider who has service agreement with PLMN operator.
  52
  53 The API invoker supports the following capabilities:
  54
  55 * Triggering API invoker onboarding/offboarding;
  56 * Supporting the authentication by providing the API invoker identity and other information required for authentication of the API invoker;
  57 * Supporting mutual authentication with CAPIF;
  58 * Obtaining the authorization prior to accessing the service API;
  59 * Discovering service APIs information; and
  60 * Invoking the service APIs.
  61
  62
  63 API Provider functions
  64 ~~~~~~~~~~~~~~~~~~~~~~
  65
  66 The API provider functions consists of:
  67
  68 * **API exposing function** is the provider of the service APIs and is also the service communication entry point of the service API to the API invokers. Provides access control, logging, charging, provides authentication and authorization support.
  69 * **API publishing function** is responsible for the capability to publish the service API information of the API provider to the CAPIF core functions in order to enable the discovery of APIs by the API invoker.
  70 * **API management function** is the entity which registers and maintains registration information of the API provider domain functions on the CAPIF core function.
  71
  72 CAPIF core function APIs
  73 ************************
  74
  75 * **CAPIF_Discover_Service_API** API: This API enables the API invoker to communicate with the CAPIF core function to discover the published service API information.
  76 * **CAPIF_Publish_Service_API** API:This API enables the API publishing function to communicate with the CAPIF core function to publish the service API information and manage the published service API information.
  77 * **CAPIF_Events** API: This API enables the API subscribing entity to communicate with the CAPIF core function to subscribe to and unsubscribe from CAPIF events and receive subsequent notification of CAPIF events. This API is used for the subscription to and notifications of those CAPIF events that are not bound to any of the other CAPIF core function APIs.
  78 * **CAPIF_API_invoker_management** API: This API enables the API invoker to communicate with the CAPIF core function to enroll as a registered user of CAPIF and manage the enrollment information.
  79 * **CAPIF_Security** API:This API enables the API invoker to communicate with the CAPIF core function to authenticate and obtain authorization to access service APIs.
  80 * **CAPIF_Monitoring** API: This API enables the API management function to communicate with the CAPIF core function to subscribe to and unsubscribe from CAPIF events related to monitoring and receive subsequent notification of CAPIF monitoring events.
  81 * **CAPIF_Logging_API_Invocation** API: This API enables the API exposing function to communicate with the CAPIF core function to log the information related to service API invocation.
  82 * **CAPIF_Auditing** API: This API enables the API management function to communicate with the CAPIF core function to retrieve the log information related to service API invocation.
  83 * **CAPIF_Access_Control_Policy** API: This API enables the API exposing function to obtain the policy to perform access control on the service API invocations.
  84 * **CAPIF_Routing_Info** API: This API enables the API exposing function to obtain the routing information to forward the API invocation to another API exposing function.
  85 * **CAPIF_API_provider_management** API: This API enables the API Management Function to communicate with the CAPIF core function to register the API provider domain functions as authorized users of the CAPIF functionalities.
  86
  87 The table below lists the CAPIF Core Function APIs.
  88
  89 +-----------------------------------+------------------------------+----------------------------------------------+----------------------------------------------------------------------------------------+
  90 |     **Service Name**              | **Service Operations**       | **Operation Semantics**                      | **Consumer(s)**                                                                        |
  91 +-----------------------------------+------------------------------+----------------------------------------------+----------------------------------------------------------------------------------------+
  92 | CAPIF_Discover_Service_API        | Discover_Service_API         | GET /allServiceAPIs                          | API Invoker, CAPIF core function                                                       |
  93 +-----------------------------------+------------------------------+----------------------------------------------+----------------------------------------------------------------------------------------+
  94 | CAPIF_Publish_Service_API         | Publish_Service_API          | POST /{apfId}/service-apis                   | API Publishing Function, CAPIF core function                                           |
  95 +                                   +------------------------------+----------------------------------------------+----------------------------------------------------------------------------------------+
  96 |                                   | Unpublish_Service_API        | DELETE /{apfId/service-apis/{serviceApiId}   | API Publishing Function, CAPIF core function                                           |
  97 +                                   +------------------------------+----------------------------------------------+----------------------------------------------------------------------------------------+
  98 |                                   | Update_Service_API           | PUT /{apfId/service-apis/{serviceApiId}      | API Publishing Function, CAPIF core function                                           |
  99 +                                   +------------------------------+----------------------------------------------+----------------------------------------------------------------------------------------+
 100 |                                   | Get_Service_API              | GET /{apfId}/service-apis                    | API Publishing Function, CAPIF core function                                           |
 101 +-----------------------------------+------------------------------+----------------------------------------------+----------------------------------------------------------------------------------------+
 102 | CAPIF_Events_API                  | Subscribe_Event              | Subscribe/Notify                             | API Invoker, API Publishing Function, API Management Function, API Exposing Function   |
 103 +                                   +------------------------------+----------------------------------------------+----------------------------------------------------------------------------------------+
 104 |                                   | Notify_Event                 | Subscribe/Notify                             | API Invoker, API Publishing Function, API Management Function, API Exposing Function   |
 105 +                                   +------------------------------+----------------------------------------------+----------------------------------------------------------------------------------------+
 106 |                                   | Unsubscribe_Event            | Subscribe/Notify                             | API Invoker, API Publishing Function, API Management Function, API Exposing Function   |
 107 +-----------------------------------+------------------------------+----------------------------------------------+----------------------------------------------------------------------------------------+
 108 | CAPIF_API_Invoker_Management_API  | Onboard_API_Invoker          | POST /onboardedInvokers                      | API Invoker                                                                            |
 109 +                                   +------------------------------+----------------------------------------------+----------------------------------------------------------------------------------------+
 110 |                                   | Offboard_API_Invoker         | DELETE /onboardedInvokers/{onboardingId}     | API Invoker                                                                            |
 111 +                                   +------------------------------+----------------------------------------------+----------------------------------------------------------------------------------------+
 112 |                                   | Notify_Onboarding_Completion | Subscribe/Notify                             | API Invoker                                                                            |
 113 +                                   +------------------------------+----------------------------------------------+----------------------------------------------------------------------------------------+
 114 |                                   | Update_API_Invoker_Details   | PUT /onboardedInvokers/{onboardingId}        | API Invoker                                                                            |
 115 |                                   +------------------------------+----------------------------------------------+----------------------------------------------------------------------------------------+
 116 |                                   | Notify_Update_Completion     | Subscribe/Notify                             | API Invoker                                                                            |
 117 +-----------------------------------+------------------------------+----------------------------------------------+----------------------------------------------------------------------------------------+
 118 | CAPIF_Security_API                | Obtain_Security_Method       | PUT /trustedInvokers/{apiInvokerId}          | API Invoker                                                                            |
 119 +                                   +------------------------------+----------------------------------------------+----------------------------------------------------------------------------------------+
 120 |                                   | Obtain_Authorization         | POST /securities/{securityId}/token          | API Invoker                                                                            |
 121 +                                   +------------------------------+----------------------------------------------+----------------------------------------------------------------------------------------+
 122 |                                   | Obtain_API_Invoker_Info      | GET /trustedInvokers/{apiInvokerId}          | API exposing function                                                                  |
 123 +                                   +------------------------------+----------------------------------------------+----------------------------------------------------------------------------------------+
 124 |                                   | Revoke_Authorization         | DELETE /trustedInvokers/{apiInvokerId}       | API exposing function                                                                  |
 125 +-----------------------------------+------------------------------+----------------------------------------------+----------------------------------------------------------------------------------------+
 126 | CAPIF_API_Provider_Management_API | Register_API_Provider        | POST /registrations                          | API Management Function                                                                |
 127 +                                   +------------------------------+----------------------------------------------+----------------------------------------------------------------------------------------+
 128 |                                   | Update_API_Provider          | PUT /registrations/{registrationId}          | API Management Function                                                                |
 129 +                                   +------------------------------+----------------------------------------------+----------------------------------------------------------------------------------------+
 130 |                                   | Deregister_API_Provider      | DELETE /registrations/{registrationId}       | API Management Function                                                                |
 131 +-----------------------------------+------------------------------+----------------------------------------------+----------------------------------------------------------------------------------------+
 132 | CAPIF_Monitoring_API              | Event operations             |                                              | API Management Function                                                                |
 133 +-----------------------------------+------------------------------+----------------------------------------------+----------------------------------------------------------------------------------------+
 134 | CAPIF_Logging_API_Invocation_API  | Log_API_Invocation           | POST /{aefId}/logs                           | API exposing function                                                                  |
 135 +-----------------------------------+------------------------------+----------------------------------------------+----------------------------------------------------------------------------------------+
 136 | CAPIF_Auditing_API                | Query_API_Invocation_Log     | GET /apiInvocationLogs                       | API management function                                                                |
 137 +-----------------------------------+------------------------------+----------------------------------------------+----------------------------------------------------------------------------------------+
 138 | CAPIF_Access_Control_Policy_API   | Obtain_Access_Control_Policy | GET /accessControlPolicyList/{serviceApiId}  | API Exposing Function                                                                  |
 139 +-----------------------------------+------------------------------+----------------------------------------------+----------------------------------------------------------------------------------------+
 140 | CAPIF_Routing_Info_API            | Obtain_Routing_Info          | GET /service-apis/{serviceApiId}             | API exposing function                                                                  |
 141 +-----------------------------------+------------------------------+----------------------------------------------+----------------------------------------------------------------------------------------+
 142
 143 Security in CAPIF
 144 *****************
 145
 146 CAPIF establish security requeriments for all the interfaces defined in the specification. There are also security requeriments that are applicable to all CAPIF entities, such as:
 147
 148 - CAPIF shall provide mechanisms to hide the topology of the PLMN trust domain from the API invokers accessing the service APIs from outside the PLMN trust domain.
 149 - CAPIF shall provide mechanisms to hide the topology of the 3rd party API provider trust domain from the API invokers accessing the service APIs from outside the 3rd party API provider trust domain.
 150 - CAPIF shall provide authorization mechanism for service APIs from the 3rd party API providers.
 151 - CAPIF shall support a common security mechanism for all API implementations to provide confidentiality and integrity protection.
 152
 153 The image below shows the functional security model for CAPIF architecture. CAPIF-1, CAPIF-2, CAPIF-3, CAPIF-4, CAPIF-5 and CAPIF-7 are interfaces that lie within the PLMN trust domain while the CAPIF-1e , CAPIF-2e, CAPIF-3e, CAPIF-4e, CAPIF-5e and CAPIF-7e interfaces are CAPIF core and AEF access points for API Invokers outside of the PLMN trust domain.
 154
 155 .. image:: ./images/securitymodel.png
 156    :width: 500pt
 157    :alt: CAPIF functional security model (3GPP TS 33.122).
 158
 159 Authentication and authorization are required for both API invokers that lie within the PLMN trust domain and API invokers that lie outside of the PLMN trust domain. For an API invoker that is outside of the PLMN trust domain, the CAPIF core function in coordination with the API exposing function utilizes the CAPIF-1e, CAPIF-2e and the CAPIF-3 interfaces to onboard, authenticate and authorize the API invoker prior to granting access to CAPIF services.
 160
 161 Security procedures for API invoker onboarding
 162 ==============================================
 163
 164 The API invoker and the CAPIF core function shall establish a secure session.
 165 With a secure session established, the API Invoker sends an Onboard API Invoker Request message to the CAPIF core function. The Onboard API Invoker Request message carries an onboard credential obtained during pre-provisioning of the onboard enrolment information.
 166
 167 .. image:: ./images/Onboardingnewinvoker.svg
 168    :alt: Procedure for API invoker onboarding
 169
 170 The CAPIF core function shall respond with an Onboard API invoker response message. The response shall include the CAPIF core function assigned API invoker ID, API invoker's certificate and the API invoker Onboard_Secret (generated by the CAPIF core function provided by keycloak).
 171
 172 Security method negotiation
 173 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 174
 175 The API invoker and the CAPIF core function shall negotiate a security method that shall be used by the API invoker and the API exposing function for CAPIF-2e interface authentication and protection.
 176
 177 As a pre-condition the API invoker must be onboarded with the CAPIF core function.
 178
 179 After successful mutual authentication on CAPIF-1e interface, the API invoker may send CAPIF-2/2e security capability information to the CAPIF core function in the Security Method Request message, indicating the list of security methods that it supports for each AEF.
 180
 181 The CAPIF core function shall select a security method to be used over CAPIF-2/2e reference point for each requested AEF, taking into account the information sent by the API invoker and send a Security Method Response message to the API invoker indicating the selected security method for each AEF.
 182
 183 API discovery
 184 ~~~~~~~~~~~~~
 185
 186 After successful authentication between API invoker and CAPIF core function, the CAPIF core function shall decide whether the API invoker is authorized to perform discovery based on API invoker ID and discovery policy.