Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
from requests.exceptions import RequestsDependencyWarning
import warnings
import json
import requests
from OpenSSL.crypto import (
dump_certificate_request,
dump_privatekey,
PKey,
TYPE_RSA,
X509Req
)
from OpenSSL.SSL import FILETYPE_PEM
import os
import logging
import shutil
import subprocess
from requests.auth import HTTPBasicAuth
import urllib3
urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
warnings.filterwarnings("ignore", category=RequestsDependencyWarning)
# Configuración básica del logger
log_path = 'logs/sdk_logs.log'
log_dir = os.path.dirname(log_path)
if not os.path.exists(log_dir):
os.makedirs(log_dir)
logging.basicConfig(
level=logging.NOTSET, # Nivel mínimo de severidad a registrar
# Formato del mensaje de log
format='%(asctime)s - %(name)s - %(levelname)s - %(message)s',
handlers=[
logging.FileHandler(log_path), # Registra en un archivo
logging.StreamHandler() # También muestra en la consola
]
)
class CAPIFProviderConnector:
"""
Τhis class is responsible for onboarding an exposer (eg. NEF emulator) to CAPIF
"""
def __init__(self, config_file: str):
"""
Inicializa el conector CAPIFProvider con los parámetros especificados en el archivo de configuración.
"""
# Cargar configuración desde archivo si es necesario
config_file = os.path.abspath(config_file)
self.config_path = os.path.dirname(config_file)+"/"
config = self.__load_config_file(config_file)
debug_mode = os.getenv('DEBUG_MODE', config.get(
'debug_mode', 'False')).strip().lower()
if debug_mode == "false":
debug_mode = False
# Inicializar logger
self.logger = logging.getLogger(self.__class__.__name__)
if debug_mode:
self.logger.setLevel(logging.DEBUG)
else:
self.logger.setLevel(logging.WARNING)
urllib_logger = logging.getLogger("urllib3")
if not debug_mode:
urllib_logger.setLevel(logging.WARNING)
else:
urllib_logger.setLevel(logging.DEBUG)
try:
provider_general_folder = os.path.abspath(
os.getenv('PROVIDER_FOLDER', config.get('provider_folder', '')).strip())
capif_host = os.getenv(
'CAPIF_HOST', config.get('capif_host', '')).strip()
capif_register_host = os.getenv(
'REGISTER_HOST', config.get('register_host', '')).strip()
capif_https_port = str(
os.getenv('CAPIF_HTTPS_PORT', config.get('capif_https_port', '')).strip())
capif_register_port = str(os.getenv(
'CAPIF_REGISTER_PORT', config.get('capif_register_port', '')).strip())
capif_provider_username = os.getenv(
'CAPIF_USERNAME', config.get('capif_username', '')).strip()
capif_provider_password = os.getenv(
'CAPIF_PASSWORD', config.get('capif_password', '')).strip()
csr_common_name = os.getenv(
'CSR_COMMON_NAME', config.get('csr_common_name', '')).strip()
csr_organizational_unit = os.getenv(
'CSR_ORGANIZATIONAL_UNIT', config.get('csr_organizational_unit', '')).strip()
csr_organization = os.getenv(
'CSR_ORGANIZATION', config.get('csr_organization', '')).strip()
crs_locality = os.getenv(
'CRS_LOCALITY', config.get('crs_locality', '')).strip()
csr_state_or_province_name = os.getenv('CSR_STATE_OR_PROVINCE_NAME', config.get(
'csr_state_or_province_name', '')).strip()
csr_country_name = os.getenv(
'CSR_COUNTRY_NAME', config.get('csr_country_name', '')).strip()
csr_email_address = os.getenv(
'CSR_EMAIL_ADDRESS', config.get('csr_email_address', '')).strip()
apfs = os.getenv('APFS', config.get('apfs', '')).strip()
aefs = os.getenv('AEFS', config.get('aefs', '')).strip()
api_description_path = os.path.abspath(os.getenv(
'API_DESCRIPTION_PATH', config.get('api_description_path', '')).strip())
if not capif_host:
self.logger.warning(
"CAPIF_HOST is not provided; defaulting to an empty string")
if not capif_provider_username:
self.logger.error(
"CAPIF_PROVIDER_USERNAME is required but not provided")
raise ValueError("CAPIF_PROVIDER_USERNAME is required")
self.provider_folder = os.path.join(
provider_general_folder, capif_provider_username)
os.makedirs(self.provider_folder, exist_ok=True)
self.capif_host = capif_host.strip()
self.capif_provider_username = capif_provider_username
self.capif_provider_password = capif_provider_password
self.capif_register_host = capif_register_host
self.capif_register_port = capif_register_port
self.csr_common_name = csr_common_name
self.csr_organizational_unit = csr_organizational_unit
self.csr_organization = csr_organization
self.crs_locality = crs_locality
self.csr_state_or_province_name = csr_state_or_province_name
self.csr_country_name = csr_country_name
self.csr_email_address = csr_email_address
self.aefs = int(aefs)
self.apfs = int(apfs)
config = config["publish_req"]
self.publish_req = {
"service_api_id": os.getenv('PUBLISH_REQ_SERVICE_API_ID', config.get('service_api_id', '')).strip(),
"publisher_apf_id": os.getenv('PUBLISH_REQ_PUBLISHER_APF_ID', config.get('publisher_apf_id', '')).strip(),
"publisher_aefs_ids": os.getenv('PUBLISH_REQ_PUBLISHER_AEFS_IDS', config.get('publisher_aefs_ids', ''))
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
}
self.api_description_path = api_description_path
self.capif_https_port = str(capif_https_port)
if len(self.capif_https_port) == 0 or int(self.capif_https_port) == 443:
self.capif_https_url = f"https://{capif_host.strip()}/"
else:
self.capif_https_url = f"https://{capif_host.strip()}:{self.capif_https_port.strip()}/"
if len(capif_register_port) == 0:
self.capif_register_url = f"https://{capif_register_host.strip()}:8084/"
else:
self.capif_register_url = f"https://{capif_register_host.strip()}:{capif_register_port.strip()}/"
self.logger.info(
"CAPIFProviderConnector initialized with the capif-sdk-config.json parameters")
except Exception as e:
self.logger.error(f"Error during initialization: {e}")
raise
def __store_certificate(self) -> None:
# Retrieves and stores the cert_server.pem from CAPIF.
self.logger.info(
"Retrieving capif_cert_server.pem, this may take a few minutes.")
cmd = f"openssl s_client -connect {self.capif_host}:{self.capif_https_port} | openssl x509 -text > {self.provider_folder}/capif_cert_server.pem"
try:
# Redirige la salida estándar y de errores a os.devnull para ocultar los logs
with open(os.devnull, 'w') as devnull:
subprocess.run(cmd, shell=True, check=True,
stdout=devnull, stderr=devnull)
cert_file = os.path.join(
self.provider_folder, "capif_cert_server.pem")
if os.path.exists(cert_file) and os.path.getsize(cert_file) > 0:
self.logger.info("cert_server.pem successfully generated!")
else:
self.logger.error("Failed to generate cert_server.pem.")
raise FileNotFoundError(
f"Certificate file not found at {cert_file}")
except subprocess.CalledProcessError as e:
self.logger.error(f"Command failed: {e}")
raise
except Exception as e:
self.logger.error(f"Error occurred: {e}")
raise
def __load_config_file(self, config_file: str):
"""Carga el archivo de configuración."""
try:
with open(config_file, 'r') as file:
return json.load(file)
except FileNotFoundError:
self.logger.warning(
f"Configuration file {config_file} not found. Using defaults or environment variables.")
return {}
def __create_private_and_public_keys(self, api_prov_func_role) -> bytes:
"""
Creates private and public keys in the certificates folder.
:return: The contents of the public key
"""
private_key_path = os.path.join(
self.provider_folder, f"{api_prov_func_role}_private_key.key")
csr_file_path = os.path.join(
self.provider_folder, f"{api_prov_func_role}_public.csr")
# Create key pair
key = PKey()
key.generate_key(TYPE_RSA, 2048)
# Create CSR
req = X509Req()
subject = req.get_subject()
subject.CN = api_prov_func_role.lower()
subject.O = self.csr_organization
subject.OU = self.csr_organizational_unit
subject.L = self.crs_locality
subject.ST = self.csr_state_or_province_name
subject.C = self.csr_country_name
subject.emailAddress = self.csr_email_address
req.set_pubkey(key)
req.sign(key, "sha256")
# Write CSR and private key to files
with open(csr_file_path, "wb") as csr_file:
public_key = dump_certificate_request(FILETYPE_PEM, req)
csr_file.write(public_key)
with open(private_key_path, "wb") as private_key_file:
private_key_file.write(dump_privatekey(FILETYPE_PEM, key))
return public_key
def __onboard_exposer_to_capif(self, access_token, capif_onboarding_url):
self.logger.info(
"Onboarding Provider to CAPIF and waiting signed certificate by giving our public keys to CAPIF")
url = f"{self.capif_https_url}{capif_onboarding_url}"
headers = {
"Authorization": f"Bearer {access_token}",
"Content-Type": "application/json",
}
# Crear la lista de roles sin indexar
roles = ["AMF"]
for n in range(1, self.aefs + 1):
roles.append("AEF")
for n in range(1, self.apfs + 1):
roles.append("APF")
# Construir el payload con los roles sin indexar
payload = {
"apiProvFuncs": [
{"regInfo": {"apiProvPubKey": ""}, "apiProvFuncRole": role,
"apiProvFuncInfo": f"{role.lower()}"}
for role in roles
],
"apiProvDomInfo": "This is provider",
"suppFeat": "fff",
"failReason": "string",
"regSec": access_token,
}
# Generar los roles indexados para la creación de certificados
indexedroles = ["AMF"]
for n in range(1, self.aefs + 1):
indexedroles.append(f"AEF-{n}")
for n in range(1, self.apfs + 1):
indexedroles.append(f"APF-{n}")
# Guardar las claves públicas y generar los certificados con roles indexados
for i, api_func in enumerate(payload["apiProvFuncs"]):
# Generar las claves públicas con el rol indexado, pero no actualizar el payload con el rol indexado
public_key = self.__create_private_and_public_keys(indexedroles[i])
# Asignar la clave pública al payload
api_func["regInfo"]["apiProvPubKey"] = public_key.decode("utf-8")
try:
response = requests.post(
url,
headers=headers,
data=json.dumps(payload),
verify=os.path.join(self.provider_folder, "ca.crt"),
)
response.raise_for_status()
self.logger.info(
"Provider onboarded and signed certificate obtained successfully")
return response.json()
except requests.exceptions.RequestException as e:
self.logger.error(
f"Onboarding failed: {e} - Response: {response.text}")
raise
def __write_to_file(self, onboarding_response, capif_registration_id, publish_url):
self.logger.info("Saving the most relevant onboarding data")
# Generar los roles indexados para la correspondencia
indexedroles = ["AMF"]
for n in range(1, self.aefs + 1):
indexedroles.append(f"AEF-{n}")
for n in range(1, self.apfs + 1):
indexedroles.append(f"APF-{n}")
# Guardar los certificados con los nombres indexados
for i, func_profile in enumerate(onboarding_response["apiProvFuncs"]):
role = indexedroles[i].lower()
cert_path = os.path.join(self.provider_folder, f"{role}.crt")
with open(cert_path, "wb") as cert_file:
cert_file.write(
func_profile["regInfo"]["apiProvCert"].encode("utf-8"))
# Guardar los detalles del proveedor
provider_details_path = os.path.join(
self.provider_folder, "capif_provider_details.json")
with open(provider_details_path, "w") as outfile:
data = {
"capif_registration_id": capif_registration_id,
"publish_url": publish_url,
**{f"{indexedroles[i]}_api_prov_func_id": api_prov_func["apiProvFuncId"]
for i, api_prov_func in enumerate(onboarding_response["apiProvFuncs"])}
}
json.dump(data, outfile, indent=4)
self.logger.info("Data saved")
def __save_capif_ca_root_file_and_get_auth_token(self):
url = f"{self.capif_register_url}getauth"
self.logger.info(
"Saving CAPIF CA root file and getting auth token with user and password given by the CAPIF administrator")
try:
response = requests.get(
url,
headers={"Content-Type": "application/json"},
auth=HTTPBasicAuth(self.capif_provider_username,
self.capif_provider_password),
verify=False
)
response.raise_for_status()
self.logger.info("Authorization acquired successfully")
response_payload = response.json()
ca_root_file_path = os.path.join(self.provider_folder, "ca.crt")
with open(ca_root_file_path, "wb") as ca_root_file:
ca_root_file.write(response_payload["ca_root"].encode("utf-8"))
self.logger.info(
"CAPIF CA root file saved and auth token obtained successfully")
return response_payload
except requests.exceptions.RequestException as e:
self.logger.error(
f"Error acquiring authorization: {e} - Response: {response.text}")
raise
def onboard_provider(self) -> None:
"""
Retrieves and stores the certificate from CAPIF, acquires authorization, and registers the provider.
"""
# Store the certificate
self.__store_certificate()
# Retrieve CA root file and get authorization token
capif_postauth_info = self.__save_capif_ca_root_file_and_get_auth_token()
# Extract necessary information
capif_onboarding_url = capif_postauth_info["ccf_api_onboarding_url"]
access_token = capif_postauth_info["access_token"]
ccf_publish_url = capif_postauth_info["ccf_publish_url"]
# Onboard provider to CAPIF
onboarding_response = self.__onboard_exposer_to_capif(
access_token, capif_onboarding_url
)
# Save onboarding details to file
capif_registration_id = onboarding_response["apiProvDomId"]
self.__write_to_file(
onboarding_response, capif_registration_id, ccf_publish_url
)
def publish_services(self) -> dict:
"""
Publishes services to CAPIF and returns the published services dictionary.
:param service_api_description_json_full_path: The full path of the service_api_description.json containing
the endpoints to be published.
:return: The published services dictionary that was saved in CAPIF.
"""
self.logger.info("Starting the service publication process")
# Load provider details
provider_details_path = os.path.join(
self.provider_folder, "capif_provider_details.json")
self.logger.info(
f"Loading provider details from {provider_details_path}")
provider_details = self.__load_provider_api_details()
publish_url = provider_details["publish_url"]
chosenAPFsandAEFs = self.publish_req
APF_api_prov_func_id = chosenAPFsandAEFs["publisher_apf_id"]
AEFs_list = chosenAPFsandAEFs["publisher_aefs_ids"]
apf_number = None
for key, value in provider_details.items():
if value == APF_api_prov_func_id and key.startswith("APF-"):
apf_inter = key.split("-")[1]
# Obtener el número del APF
apf_number = apf_inter.split("_")[0]
break
if apf_number is None:
self.logger.error(
f"No matching APF found for publisher_apf_id: {APF_api_prov_func_id}")
raise ValueError("Invalid publisher_apf_id")
service_api_description_json_full_path = self.api_description_path
# Leer y modificar la descripción de la API de servicio
self.logger.info(
f"Reading and modifying service API description from {service_api_description_json_full_path}")
try:
with open(service_api_description_json_full_path, "r") as service_file:
data = json.load(service_file)
# Verificamos que el número de AEFs coincide con el número de perfiles
if len(AEFs_list) != len(data.get("aefProfiles", [])):
self.logger.error(
"The number of AEFs in publisher_aefs_ids does not match the number of profiles in aefProfiles")
raise ValueError(
"Mismatch between number of AEFs and profiles")
# Asignamos los AEFs correspondientes
for profile, aef_id in zip(data.get("aefProfiles", []), AEFs_list):
profile["aefId"] = aef_id
self.logger.info(
"Service API description modified successfully")
# Guardamos los cambios en el archivo
with open(service_api_description_json_full_path, "w") as service_file:
json.dump(data, service_file, indent=4)
except FileNotFoundError:
self.logger.error(
f"Service API description file not found: {service_api_description_json_full_path}")
raise
except json.JSONDecodeError as e:
self.logger.error(
f"Error decoding JSON from file {service_api_description_json_full_path}: {e}")
raise
except ValueError as e:
self.logger.error(f"Error with the input data: {e}")
raise
# Publish services
url = f"{self.capif_https_url}{publish_url.replace('<apfId>', APF_api_prov_func_id)}"
cert = (
os.path.join(self.provider_folder, f"apf-{apf_number}.crt"),
os.path.join(self.provider_folder,
f"apf-{apf_number}_private_key.key"),
)
self.logger.info(f"Publishing services to URL: {url}")
try:
response = requests.post(
url,
headers={"Content-Type": "application/json"},
data=json.dumps(data),
cert=cert,
verify=os.path.join(self.provider_folder, "ca.crt"),
)
response.raise_for_status()
self.logger.info("Services published successfully")
# Save response to file
capif_response_text = response.text
capif_response_json = json.loads(capif_response_text)
# Default name if apiName is missing
file_name = capif_response_json.get("apiName", "default_name")
id = capif_response_json.get("apiId", "default_id")
output_path = os.path.join(
self.provider_folder, f"CAPIF-{file_name}-{id}-api.json")
with open(output_path, "w") as outfile:
outfile.write(capif_response_text)
self.logger.info(f"CAPIF response saved to {output_path}")
output_path = os.path.join(
self.provider_folder, "Published-Apis.json")
# Leer el archivo existente de APIs publicados
published_apis = {}
if os.path.exists(output_path):
with open(output_path, "r") as outfile:
published_apis = json.load(outfile)
# Agregar el nuevo API publicado
published_apis[file_name] = id
# Escribir el archivo actualizado de APIs publicados
with open(output_path, "w") as outfile:
json.dump(published_apis, outfile, indent=4)
self.logger.info(
f"API '{file_name}' with ID '{id}' added to Published Apis.")
return json.loads(capif_response_text)
except requests.RequestException as e:
self.logger.error(
f"Request to CAPIF failed: {e} - Response: {response.text}")
raise
except Exception as e:
self.logger.error(
f"Unexpected error during service publication: {e} - Response: {response.text}")
raise
def unpublish_service(self) -> dict:
"""
Publishes services to CAPIF and returns the published services dictionary.
:param service_api_description_json_full_path: The full path of the service_api_description.json containing
the endpoints to be published.
:return: The published services dictionary that was saved in CAPIF.
"""
self.logger.info("Starting the service unpublication process")
provider_details_path = os.path.join(
self.provider_folder, "capif_provider_details.json")
self.logger.info(
f"Loading provider details from {provider_details_path}")
provider_details = self.__load_provider_api_details()
publish_url = provider_details["publish_url"]
# Load provider details
publish = self.publish_req
api_id = "/" + publish["service_api_id"]
APF_api_prov_func_id = publish["publisher_apf_id"]
AEFs_list = publish["publisher_aefs_ids"]
apf_number = None
for key, value in provider_details.items():
if value == APF_api_prov_func_id and key.startswith("APF-"):
apf_inter = key.split("-")[1]
# Obtener el número del APF
apf_number = apf_inter.split("_")[0]
break
if apf_number is None:
self.logger.error(
f"No matching APF found for publisher_apf_id: {APF_api_prov_func_id}")
raise ValueError("Invalid publisher_apf_id")
self.logger.info(
f"Loading provider details from {provider_details_path}")
url = f"{self.capif_https_url}{publish_url.replace('<apfId>', APF_api_prov_func_id)}{api_id}"
cert = (
os.path.join(self.provider_folder, f"apf-{apf_number}.crt"),
os.path.join(self.provider_folder,
f"apf-{apf_number}_private_key.key"),
)
self.logger.info(f"Unpublishing service to URL: {url}")
try:
response = requests.delete(
url,
headers={"Content-Type": "application/json"},
cert=cert,
verify=os.path.join(self.provider_folder, "ca.crt"),
)
response.raise_for_status()
directory = self.provider_folder
# Iterar sobre todos los archivos en el directorio
for filename in os.listdir(directory):
path = os.path.join(directory, filename)
# Verificar si el archivo empieza con 'CAPIF-'
if filename.startswith("CAPIF-") and publish["service_api_id"] in filename:
# Salir del bucle si el archivo es eliminado
os.remove(path)
break
output_path = os.path.join(
self.provider_folder, "Published-Apis.json")
# Leer el archivo existente de APIs publicados
published_apis = {}
if os.path.exists(output_path):
with open(output_path, "r") as outfile:
published_apis = json.load(outfile)
# ID del API que deseas eliminar
# Reemplaza con el ID específico
api_id_to_delete = publish["service_api_id"]
# Buscar y eliminar el API por su ID
api_name_to_delete = None
for name, id in published_apis.items():
if id == api_id_to_delete:
api_name_to_delete = name
break
if api_name_to_delete:
del published_apis[api_name_to_delete]
self.logger.info(
f"API with ID '{api_id_to_delete}' removed from Published Apis.")
else:
self.logger.warning(
f"API with ID '{api_id_to_delete}' not found in Published Apis.")
# Escribir el archivo actualizado de APIs publicados
with open(output_path, "w") as outfile:
json.dump(published_apis, outfile, indent=4)
self.logger.info("Services unpublished successfully")
except requests.RequestException as e:
self.logger.error(
f"Request to CAPIF failed: {e} - Response: {response.text}")
raise
except Exception as e:
self.logger.error(
f"Unexpected error during service unpublication: {e} - Response: {response.text}")
raise
def get_service(self) -> dict:
"""
Publishes services to CAPIF and returns the published services dictionary.
:param service_api_description_json_full_path: The full path of the service_api_description.json containing
the endpoints to be published.
:return: The published services dictionary that was saved in CAPIF.
"""
self.logger.info("Starting the service unpublication process")
provider_details_path = os.path.join(
self.provider_folder, "capif_provider_details.json")
self.logger.info(
f"Loading provider details from {provider_details_path}")
provider_details = self.__load_provider_api_details()
publish_url = provider_details["publish_url"]
chosenAPFsandAEFs = self.publish_req
APF_api_prov_func_id = chosenAPFsandAEFs["publisher_apf_id"]
api_id = "/" + chosenAPFsandAEFs["service_api_id"]
apf_number = None
for key, value in provider_details.items():
if value == APF_api_prov_func_id and key.startswith("APF-"):
apf_inter = key.split("-")[1]
# Obtener el número del APF
apf_number = apf_inter.split("_")[0]
break
if apf_number is None:
self.logger.error(
f"No matching APF found for publisher_apf_id: {APF_api_prov_func_id}")
raise ValueError("Invalid publisher_apf_id")
url = f"{self.capif_https_url}{publish_url.replace('<apfId>', APF_api_prov_func_id)}{api_id}"
cert = (
os.path.join(self.provider_folder, f"apf-{apf_number}.crt"),
os.path.join(self.provider_folder,
f"apf-{apf_number}_private_key.key"),
)
self.logger.info(f"Getting service to URL: {url}")
try:
response = requests.get(
url,
headers={"Content-Type": "application/json"},
cert=cert,
verify=os.path.join(self.provider_folder, "ca.crt"),
)
response.raise_for_status()
self.logger.info("Service received successfully")
path = os.path.join(self.provider_folder, "service_received.json")
with open(path, 'w') as f:
json_data = json.loads(response.text)
json.dump(json_data, f, indent=4)
self.logger.info(f"Service saved in {path}")
except requests.RequestException as e:
self.logger.error(
f"Request to CAPIF failed: {e} - Response: {response.text}")
raise
except Exception as e:
self.logger.error(
f"Unexpected error during service getter: {e} - Response: {response.text}")
raise
def get_all_services(self) -> dict:
"""
Publishes services to CAPIF and returns the published services dictionary.
:param service_api_description_json_full_path: The full path of the service_api_description.json containing
the endpoints to be published.
:return: The published services dictionary that was saved in CAPIF.
"""
self.logger.info("Starting the service publication process")
# Load provider details
provider_details_path = os.path.join(
self.provider_folder, "capif_provider_details.json")
self.logger.info(
f"Loading provider details from {provider_details_path}")
provider_details = self.__load_provider_api_details()
publish_url = provider_details["publish_url"]
chosenAPFsandAEFs = self.publish_req
APF_api_prov_func_id = chosenAPFsandAEFs["publisher_apf_id"]
apf_number = None
for key, value in provider_details.items():
if value == APF_api_prov_func_id and key.startswith("APF-"):
apf_inter = key.split("-")[1]
# Obtener el número del APF
apf_number = apf_inter.split("_")[0]
break
if apf_number is None:
self.logger.error(
f"No matching APF found for publisher_apf_id: {APF_api_prov_func_id}")
raise ValueError("Invalid publisher_apf_id")
# Leer y modificar la descripción de la API de servicio
# Publish services
url = f"{self.capif_https_url}{publish_url.replace('<apfId>', APF_api_prov_func_id)}"
cert = (
os.path.join(self.provider_folder, f"apf-{apf_number}.crt"),
os.path.join(self.provider_folder,
f"apf-{apf_number}_private_key.key"),
)
self.logger.info(f"Getting services to URL: {url}")
try:
response = requests.get(
url,
headers={"Content-Type": "application/json"},
cert=cert,
verify=os.path.join(self.provider_folder, "ca.crt"),
)
response.raise_for_status()
self.logger.info("Services received successfully")
path = os.path.join(self.provider_folder, "service_received.json")
with open(path, 'w') as f:
json_data = json.loads(response.text)
json.dump(json_data, f, indent=4)
self.logger.info(f"Services saved in {path}")
# Save response to file
except requests.RequestException as e:
self.logger.error(
f"Request to CAPIF failed: {e} - Response: {response.text}")
raise
except Exception as e:
self.logger.error(
f"Unexpected error during services reception: {e} - Response: {response.text}")
raise
def update_service(self) -> dict:
"""
Publishes services to CAPIF and returns the published services dictionary.
:param service_api_description_json_full_path: The full path of the service_api_description.json containing
the endpoints to be published.
:return: The published services dictionary that was saved in CAPIF.
"""
self.logger.info("Starting the service publication process")
# Load provider details
# Load provider details
provider_details_path = os.path.join(
self.provider_folder, "capif_provider_details.json")
self.logger.info(
f"Loading provider details from {provider_details_path}")
provider_details = self.__load_provider_api_details()
publish_url = provider_details["publish_url"]
chosenAPFsandAEFs = self.publish_req
APF_api_prov_func_id = chosenAPFsandAEFs["publisher_apf_id"]
AEFs_list = chosenAPFsandAEFs["publisher_aefs_ids"]
apf_number = None
for key, value in provider_details.items():
if value == APF_api_prov_func_id and key.startswith("APF-"):
apf_inter = key.split("-")[1]
# Obtener el número del APF
apf_number = apf_inter.split("_")[0]
break
if apf_number is None:
self.logger.error(
f"No matching APF found for publisher_apf_id: {APF_api_prov_func_id}")
raise ValueError("Invalid publisher_apf_id")
service_api_description_json_full_path = self.api_description_path
# Leer y modificar la descripción de la API de servicio
self.logger.info(
f"Reading and modifying service API description from {service_api_description_json_full_path}")
try:
with open(service_api_description_json_full_path, "r") as service_file:
data = json.load(service_file)
# Verificamos que el número de AEFs coincide con el número de perfiles
if len(AEFs_list) != len(data.get("aefProfiles", [])):
self.logger.error(
"The number of AEFs in publisher_aefs_ids does not match the number of profiles in aefProfiles")
raise ValueError(
"Mismatch between number of AEFs and profiles")
# Asignamos los AEFs correspondientes
for profile, aef_id in zip(data.get("aefProfiles", []), AEFs_list):
profile["aefId"] = aef_id
self.logger.info(
"Service API description modified successfully")
# Guardamos los cambios en el archivo
with open(service_api_description_json_full_path, "w") as service_file:
json.dump(data, service_file, indent=4)
except FileNotFoundError:
self.logger.error(
f"Service API description file not found: {service_api_description_json_full_path}")
raise
except json.JSONDecodeError as e:
self.logger.error(
f"Error decoding JSON from file {service_api_description_json_full_path}: {e}")
raise
except ValueError as e:
self.logger.error(f"Error with the input data: {e}")
raise
api_id = "/" + chosenAPFsandAEFs["service_api_id"]
# Publish services
url = f"{self.capif_https_url}{publish_url.replace('<apfId>', APF_api_prov_func_id)}{api_id}"
cert = (
os.path.join(self.provider_folder, f"apf-{apf_number}.crt"),
os.path.join(self.provider_folder,
f"apf-{apf_number}_private_key.key"),
)
self.logger.info(f"Publishing services to URL: {url}")
try:
response = requests.put(
url,
headers={"Content-Type": "application/json"},
data=json.dumps(data),
cert=cert,
verify=os.path.join(self.provider_folder, "ca.crt"),
)
response.raise_for_status()
self.logger.info("Services updated successfully")
# Save response to file
capif_response_text = response.text
capif_response_json = json.loads(capif_response_text)
# Default name if apiName is missing
file_name = capif_response_json.get("apiName", "default_name")
id = capif_response_json.get("apiId", "default_id")
directory = self.provider_folder
# Iterar sobre todos los archivos en el directorio
for filename in os.listdir(directory):
path = os.path.join(directory, filename)
# Verificar si el archivo empieza con 'CAPIF-'
if filename.startswith("CAPIF-") and id in filename:
# Salir del bucle si el archivo es eliminado
os.remove(path)
break
output_path = os.path.join(
self.provider_folder, f"CAPIF-{file_name}-{id}-api.json")
with open(output_path, "w") as outfile:
outfile.write(capif_response_text)
self.logger.info(f"CAPIF response saved to {output_path}")
output_path = os.path.join(
self.provider_folder, "Published-Apis.json")
# Leer el archivo existente de APIs publicados
published_apis = {}
if os.path.exists(output_path):
with open(output_path, "r") as outfile:
published_apis = json.load(outfile)
keys_to_remove = [key for key,
value in published_apis.items() if value == id]
for key in keys_to_remove:
del published_apis[key]
# Agregar el nuevo API publicado
published_apis[file_name] = id
# Escribir el archivo actualizado de APIs publicados
with open(output_path, "w") as outfile:
json.dump(published_apis, outfile, indent=4)
self.logger.info(
f"API '{file_name}' with ID '{id}' added to Published Apis.")
return json.loads(capif_response_text)
except requests.RequestException as e:
self.logger.error(
f"Request to CAPIF failed: {e} - Response: {response.text}")
raise
except Exception as e:
self.logger.error(
f"Unexpected error during service publication: {e} - Response: {response.text}")
raise
def offboard_provider(self) -> None:
"""
Offboards and deregisters the NEF (Network Exposure Function).
"""
try:
self.offboard_nef()
self.__remove_files()
self.logger.info(
"Provider offboarded and deregistered successfully.")
except Exception as e:
self.logger.error(
f"Failed to offboard and deregister Provider: {e}")
raise
def offboard_nef(self) -> None:
"""
Offboards the NEF (Network Exposure Function) from CAPIF.
"""
try:
self.logger.info("Offboarding the provider")
# Load CAPIF API details
capif_api_details = self.__load_provider_api_details()
url = f"{self.capif_https_url}api-provider-management/v1/registrations/{capif_api_details['capif_registration_id']}"
# Define certificate paths
cert_paths = (
os.path.join(self.provider_folder, "amf.crt"),
os.path.join(self.provider_folder, "AMF_private_key.key")
)
# Send DELETE request to offboard the provider
response = requests.delete(
url,
cert=cert_paths,
verify=os.path.join(self.provider_folder, "ca.crt")
)
response.raise_for_status()
self.logger.info("Offboarding performed successfully")
except requests.exceptions.RequestException as e:
self.logger.error(
f"Error offboarding Provider: {e} - Response: {response.text}")
raise
except Exception as e:
self.logger.error(