Ocf185 upgrade to release 19

Pelayo Torresrequested to merge
OCF185-upgrade-to-release-19 into staging

Proposers

  • Pelayo Torres (Telefonica)

Description

CAPIF services update to REL 19

References

  1. Reference name
  2. Author1, Author2, Author3, et. al., “My demo using feature,” in Conference-Name Demo Track, 20XX.

Acknowledgements

This work is funded by the European Commission through the HORIZON-JU-SNS-2022 project with Grant Agreement number 101096146.

Merge request reports

services/TS29222_CAPIF_API_Invoker_Management_API/.openapi-generator/FILES

+12 −4
Changes for services/TS29222_CAPIF_API_Invoker_Management_API/.openapi-generator/FILES: 12 added lines, 4 removed lines.
Original line number Diff line number Diff line
@@ -8,13 +8,14 @@ git_push.sh 
api_invoker_management/__init__.py

api_invoker_management/__main__.py

api_invoker_management/controllers/__init__.py

api_invoker_management/controllers/default_controller.py

api_invoker_management/controllers/individual_api_invoker_enrolment_details_controller.py

api_invoker_management/controllers/individual_on_boarded_api_invoker_document_controller.py

api_invoker_management/controllers/on_boarded_api_invokers_collection_controller.py

api_invoker_management/controllers/security_controller.py

api_invoker_management/encoder.py

api_invoker_management/models/__init__.py

api_invoker_management/models/aef_location.py

api_invoker_management/models/aef_profile.py

api_invoker_management/models/api_info.py

api_invoker_management/models/api_invoker_enrolment_details.py

api_invoker_management/models/api_invoker_enrolment_details_patch.py

api_invoker_management/models/api_list.py
@@ -25,6 +26,8 @@ api_invoker_management/models/communication_type.py 
api_invoker_management/models/custom_operation.py

api_invoker_management/models/data_format.py

api_invoker_management/models/ellipsoid_arc.py

api_invoker_management/models/enrol_fail_cause.py

api_invoker_management/models/enrol_fail_reason.py

api_invoker_management/models/gad_shape.py

api_invoker_management/models/geographic_area.py

api_invoker_management/models/geographical_coordinates.py
@@ -37,7 +40,10 @@ api_invoker_management/models/ipv6_address_range.py 
api_invoker_management/models/local2d_point_uncertainty_ellipse.py

api_invoker_management/models/local3d_point_uncertainty_ellipsoid.py

api_invoker_management/models/local_origin.py

api_invoker_management/models/net_slice_id.py

api_invoker_management/models/o_auth_grant_type.py

api_invoker_management/models/onboarding_criteria.py

api_invoker_management/models/onboarding_fail_reason.py

api_invoker_management/models/onboarding_information.py

api_invoker_management/models/onboarding_notification.py

api_invoker_management/models/operation.py
@@ -50,12 +56,14 @@ api_invoker_management/models/polygon.py 
api_invoker_management/models/problem_details.py

api_invoker_management/models/protocol.py

api_invoker_management/models/published_api_path.py

api_invoker_management/models/related_criteria.py

api_invoker_management/models/relative_cartesian_location.py

api_invoker_management/models/resource.py

api_invoker_management/models/security_method.py

api_invoker_management/models/service_api_description.py

api_invoker_management/models/service_kpis.py

api_invoker_management/models/shareable_information.py

api_invoker_management/models/snssai.py

api_invoker_management/models/supported_gad_shapes.py

api_invoker_management/models/uncertainty_ellipse.py

api_invoker_management/models/uncertainty_ellipsoid.py
@@ -63,8 +71,8 @@ api_invoker_management/models/version.py 
api_invoker_management/models/websock_notif_config.py

api_invoker_management/openapi/openapi.yaml

api_invoker_management/test/__init__.py

api_invoker_management/test/test_default_controller.py

api_invoker_management/test/test_individual_api_invoker_enrolment_details_controller.py

api_invoker_management/test/test_individual_on_boarded_api_invoker_document_controller.py

api_invoker_management/test/test_on_boarded_api_invokers_collection_controller.py

api_invoker_management/typing_utils.py

api_invoker_management/util.py

requirements.txt

services/TS29222_CAPIF_API_Invoker_Management_API/api_invoker_management/controllers/default_controller.py→services/TS29222_CAPIF_API_Invoker_Management_API/api_invoker_management/controllers/individual_on_boarded_api_invoker_document_controller.py

+24 −23
Changes for services/TS29222_CAPIF_API_Invoker_Management_API/api_invoker_management/controllers/individual_on_boarded_api_invoker_document_controller.py: 24 added lines, 23 removed lines.
Original line number Diff line number Diff line 
from functools import wraps



from api_invoker_management.models.api_invoker_enrolment_details_patch import \

    APIInvokerEnrolmentDetailsPatch  # noqa: E501

from cryptography import x509

from cryptography.hazmat.backends import default_backend

from flask import current_app, request

from flask_jwt_extended import get_jwt_identity, jwt_required



from ..core.apiinvokerenrolmentdetails import InvokerManagementOperations

from ..core.validate_user import ControlAccess

from ..models.api_invoker_enrolment_details import APIInvokerEnrolmentDetails  # noqa: E501

from ..models.api_invoker_enrolment_details import \

    APIInvokerEnrolmentDetails  # noqa: E501



invoker_operations = InvokerManagementOperations()

valid_user = ControlAccess()
@@ -38,12 +40,12 @@ def cert_validation(): 
    return _cert_validation



@cert_validation()

def onboarded_invokers_onboarding_id_delete(onboarding_id):  # noqa: E501

    """onboarded_invokers_onboarding_id_delete

def delete_ind_onboarded_api_invoker(onboarding_id):  # noqa: E501

    """Delete an existing Individual On-boarded API Invoker resource.



    Deletes an individual API Invoker. # noqa: E501

    Deletes an existing Individual On-boarded API Invoker. # noqa: E501



    :param onboarding_id: String identifying an individual on-boarded API invoker resource

    :param onboarding_id: 

    :type onboarding_id: str



    :rtype: Union[None, Tuple[None, int], Tuple[None, int, Dict[str, str]]
@@ -54,44 +56,43 @@ def onboarded_invokers_onboarding_id_delete(onboarding_id): # noqa: E501 
    return res



@cert_validation()

def onboarded_invokers_onboarding_id_put(onboarding_id, body):  # noqa: E501

    """onboarded_invokers_onboarding_id_put

def modify_ind_api_invoke_enrolment(onboarding_id, body):  # noqa: E501

    """modify_ind_api_invoke_enrolment



    Updates an individual API invoker details. # noqa: E501

     # noqa: E501



    :param onboarding_id: String identifying an individual on-boarded API invoker resource

    :param onboarding_id: 

    :type onboarding_id: str

    :param api_invoker_enrolment_details: representation of the API invoker details to be updated in CAPIF core function

    :type api_invoker_enrolment_details: dict | bytes

    :param api_invoker_enrolment_details_patch: 

    :type api_invoker_enrolment_details_patch: dict | bytes



    :rtype: Union[APIInvokerEnrolmentDetails, Tuple[APIInvokerEnrolmentDetails, int], Tuple[APIInvokerEnrolmentDetails, int, Dict[str, str]]

    """

    current_app.logger.info("Updating invoker")

    if request.is_json:

        body = APIInvokerEnrolmentDetails.from_dict(request.get_json())  # noqa: E501

        body = APIInvokerEnrolmentDetailsPatch.from_dict(request.get_json())  # noqa: E501



    res = invoker_operations.update_apiinvokerenrolmentdetail(onboarding_id,body)

    res = invoker_operations.patch_apiinvokerenrolmentdetail(onboarding_id, body)



    return res



@jwt_required()

def onboarded_invokers_post(body):  # noqa: E501

    """onboarded_invokers_post

@cert_validation()

def update_ind_onboarded_api_invoker(onboarding_id, body):  # noqa: E501

    """Update an existing Individual On-boarded API Invoker resource.



    Creates a new individual API Invoker profile. # noqa: E501

     # noqa: E501



    :param onboarding_id: 

    :type onboarding_id: str

    :param api_invoker_enrolment_details: 

    :type api_invoker_enrolment_details: dict | bytes



    :rtype: Union[APIInvokerEnrolmentDetails, Tuple[APIInvokerEnrolmentDetails, int], Tuple[APIInvokerEnrolmentDetails, int, Dict[str, str]]

    """

    identity = get_jwt_identity()

    username, uuid = identity.split()



    current_app.logger.info("Creating Invoker")

    current_app.logger.info("Updating invoker")

    if request.is_json:

        body = APIInvokerEnrolmentDetails.from_dict(request.get_json())  # noqa: E501



    res = invoker_operations.add_apiinvokerenrolmentdetail(body, username, uuid)

    res = invoker_operations.update_apiinvokerenrolmentdetail(onboarding_id,body)



    return res

services/TS29222_CAPIF_API_Invoker_Management_API/api_invoker_management/controllers/on_boarded_api_invokers_collection_controller.py

0 → 100644
+33 −0
Changes for services/TS29222_CAPIF_API_Invoker_Management_API/api_invoker_management/controllers/on_boarded_api_invokers_collection_controller.py: 33 added lines, 0 removed lines.
Original line number Diff line number Diff line 


from api_invoker_management.models.api_invoker_enrolment_details import \

    APIInvokerEnrolmentDetails  # noqa: E501

from api_invoker_management.models.problem_details import \

    ProblemDetails  # noqa: E501

from flask import current_app, request

from flask_jwt_extended import get_jwt_identity, jwt_required



from ..core.apiinvokerenrolmentdetails import InvokerManagementOperations



invoker_operations = InvokerManagementOperations()



@jwt_required()

def create_onboarded_api_invoker(body):  # noqa: E501

    """Request the Creation of a new On-boarded API Invoker.



     # noqa: E501



    :param api_invoker_enrolment_details: 

    :type api_invoker_enrolment_details: dict | bytes



    :rtype: Union[APIInvokerEnrolmentDetails, Tuple[APIInvokerEnrolmentDetails, int], Tuple[APIInvokerEnrolmentDetails, int, Dict[str, str]]

    """

    identity = get_jwt_identity()

    username, uuid = identity.split()



    current_app.logger.info("Creating Invoker")

    if request.is_json:

        body = APIInvokerEnrolmentDetails.from_dict(request.get_json())  # noqa: E501



    res = invoker_operations.add_apiinvokerenrolmentdetail(body, username, uuid)



    return res

services/TS29222_CAPIF_API_Invoker_Management_API/api_invoker_management/controllers/security_controller.py

+28 −0
Changes for services/TS29222_CAPIF_API_Invoker_Management_API/api_invoker_management/controllers/security_controller.py: 28 added lines, 0 removed lines.
Original line number Diff line number Diff line 




def info_from_oAuth2ClientCredentials(token):

    """

    Validate and decode token.

    Returned value will be passed in 'token_info' parameter of your operation function, if there is one.

    'sub' or 'uid' will be set in 'user' parameter of your operation function, if there is one.

    'scope' or 'scopes' will be passed to scope validation function.



    :param token Token provided by Authorization header

    :type token: str

    :return: Decoded token information or None if token is invalid

    :rtype: dict | None

    """

    return {'scopes': ['read:pets', 'write:pets'], 'uid': 'user_id'}





def validate_scope_oAuth2ClientCredentials(required_scopes, token_scopes):

    """

    Validate required scopes are included in token scope



    :param required_scopes Required scope to access called API

    :type required_scopes: List[str]

    :param token_scopes Scope present in token

    :type token_scopes: List[str]

    :return: True if access to called API is allowed

    :rtype: bool

    """

    return set(required_scopes).issubset(set(token_scopes))

services/TS29222_CAPIF_API_Invoker_Management_API/api_invoker_management/core/apiinvokerenrolmentdetails.py

+5 −4
Changes for services/TS29222_CAPIF_API_Invoker_Management_API/api_invoker_management/core/apiinvokerenrolmentdetails.py: 5 added lines, 4 removed lines.
Original line number Diff line number Diff line
@@ -6,19 +6,20 @@ from datetime import datetime 
import requests

import rfc3987

from api_invoker_management.db.db import MongoDatabse

from api_invoker_management.models.api_invoker_enrolment_details import APIInvokerEnrolmentDetails

from api_invoker_management.models.api_invoker_enrolment_details import \

    APIInvokerEnrolmentDetails

from flask import Response, current_app

from pymongo import ReturnDocument



from ..config import Config

from ..util import dict_to_camel_case, serialize_clean_camel_case, clean_empty

from ..util import clean_empty, dict_to_camel_case, serialize_clean_camel_case

from .auth_manager import AuthManager

from .publisher import Publisher

from .redis_event import RedisEvent

from .redis_internal_event import RedisInternalEvent

from .resources import Resource

from .responses import bad_request_error, forbidden_error, internal_server_error, make_response, not_found_error



from .responses import (bad_request_error, forbidden_error,

                        internal_server_error, make_response, not_found_error)



TOTAL_FEATURES = 4

SUPPORTED_FEATURES_HEX = "0"