1 /*************************************************************************
3 * Copyright 2022 highstreet technologies GmbH and others
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 ***************************************************************************/
20 #include "ves_o1_pnf_registration.h"
21 #include "utils/log_utils.h"
22 #include "utils/sys_utils.h"
23 #include "utils/rand_utils.h"
24 #include "utils/http_client.h"
25 #include "utils/nts_utils.h"
30 #include "core/session.h"
31 #include "core/framework.h"
32 #include "core/xpath.h"
34 static int ves_o1_pnf_sequence_number = 0;
35 static pthread_t ves_o1_pnf_registration_thread;
36 static void* ves_o1_pnf_registration_thread_routine(void *arg);
37 static int ves_o1_pnf_registration_send(sr_session_ctx_t *current_session, const char *nf_ip_v4_address, const char *nf_ip_v6_address, int nf_port, nts_mount_point_addressing_method_t mp, bool is_tls);
38 static cJSON* ves_create_o1_pnf_registration_fields(const char *nf_ip_v4_address, const char *nf_ip_v6_address, int nf_port, bool is_tls);
40 static int ves_o1_pnf_registration_status = 0;
42 int ves_o1_pnf_registration_feature_get_status(void) {
43 return ves_o1_pnf_registration_status;
46 int ves_o1_pnf_registration_feature_start(sr_session_ctx_t *current_session) {
47 assert(current_session);
49 ves_o1_pnf_sequence_number = 0;
53 bool o1_pnf_registration_enabled = false;
54 if(strlen(framework_environment.nts.nf_standalone_start_features)) {
55 o1_pnf_registration_enabled = true;
58 rc = sr_get_item(current_session, NTS_NF_VES_O1_PNF_REGISTRATION_SCHEMA_XPATH, 0, &value);
60 o1_pnf_registration_enabled = value->data.bool_val;
63 else if(rc != SR_ERR_NOT_FOUND) {
64 log_error("sr_get_item failed\n");
65 return NTS_ERR_FAILED;
69 if(o1_pnf_registration_enabled == false) {
70 log_add_verbose(2, "O1 PNF registration (stndDefined) is disabled\n");
74 if(pthread_create(&ves_o1_pnf_registration_thread, 0, ves_o1_pnf_registration_thread_routine, current_session)) {
75 log_error("could not create thread for o1 pnf registration\n");
76 return NTS_ERR_FAILED;
82 static void* ves_o1_pnf_registration_thread_routine(void *arg) {
83 sr_session_ctx_t *current_session = arg;
85 int ssh_base_port = 0;
86 int tls_base_port = 0;
87 char nf_ip_v4_address[128];
88 char nf_ip_v6_address[128];
90 nf_ip_v4_address[0] = 0;
91 nf_ip_v6_address[0] = 0;
93 nts_mount_point_addressing_method_t mp = nts_mount_point_addressing_method_get(current_session);
94 if(mp == UNKNOWN_MAPPING) {
95 log_error("mount-point-addressing-method failed\n");
96 return (void*)NTS_ERR_FAILED;
98 else if(mp == DOCKER_MAPPING) {
99 if (framework_environment.settings.ip_v4 != 0) {
100 strcpy(nf_ip_v4_address, framework_environment.settings.ip_v4);
102 if (framework_environment.settings.ip_v6 && framework_environment.settings.ip_v6_enabled) {
103 strcpy(nf_ip_v6_address, framework_environment.settings.ip_v6);
106 ssh_base_port = STANDARD_NETCONF_PORT;
107 tls_base_port = ssh_base_port + framework_environment.settings.ssh_connections;
110 if(framework_environment.settings.ip_v6_enabled) {
111 strcpy(nf_ip_v6_address, framework_environment.host.ip);
114 strcpy(nf_ip_v4_address, framework_environment.host.ip);
117 ssh_base_port = framework_environment.host.ssh_base_port;
118 tls_base_port = framework_environment.host.tls_base_port;
121 uint32_t total_regs = 0;
128 regs = (struct regs_s *)malloc(sizeof(struct regs_s) * (1 + framework_environment.settings.ssh_connections + framework_environment.settings.tls_connections));
130 log_error("malloc failed\n");
131 return (void*)NTS_ERR_FAILED;
135 if((framework_environment.settings.ssh_connections + framework_environment.settings.tls_connections) > 1) {
136 for(int port = ssh_base_port; port < ssh_base_port + framework_environment.settings.ssh_connections; port++) {
137 regs[total_regs].sent = false;
138 regs[total_regs].port = port;
139 regs[total_regs].is_tls = false;
143 for(int port = tls_base_port; port < tls_base_port + framework_environment.settings.tls_connections; port++) {
144 regs[total_regs].sent = false;
145 regs[total_regs].port = port;
146 regs[total_regs].is_tls = true;
152 if(framework_environment.settings.tls_connections == 0) {
159 regs[total_regs].sent = false;
160 regs[total_regs].port = 0;
161 regs[total_regs].is_tls = tls;
165 uint32_t remaining = total_regs;
167 for(int i = 0; i < total_regs; i++) {
168 if(regs[i].sent == false) {
169 uint16_t port = regs[i].port;
170 bool is_tls = regs[i].is_tls;
171 int rc = ves_o1_pnf_registration_send(current_session, nf_ip_v4_address, nf_ip_v6_address, port, mp, is_tls);
172 if(rc == NTS_ERR_OK) {
177 log_error("O1 pnfRegistration (stndDefined) failed for ipv4=%s ipv6=%s port=%d is_tls=%d\n", nf_ip_v4_address, nf_ip_v6_address, port, is_tls);
182 log_error("O1 pnfRegistration (stndDefined) could not register all ports; retrying in 5 seconds...\n");
187 log_add_verbose(2, "O1 PNF registration (stndDefined) finished\n");
188 ves_o1_pnf_registration_status = 1;
193 static int ves_o1_pnf_registration_send(sr_session_ctx_t *current_session, const char *nf_ip_v4_address, const char *nf_ip_v6_address, int nf_port, nts_mount_point_addressing_method_t mp, bool is_tls) {
194 assert(current_session);
196 cJSON *post_data_json = cJSON_CreateObject();
197 if(post_data_json == 0) {
198 log_error("could not create cJSON object\n");
199 return NTS_ERR_FAILED;
202 cJSON *event = cJSON_CreateObject();
204 log_error("could not create cJSON object\n");
205 cJSON_Delete(post_data_json);
206 return NTS_ERR_FAILED;
209 if(cJSON_AddItemToObject(post_data_json, "event", event) == 0) {
210 log_error("cJSON_AddItemToObject failed\n");
211 cJSON_Delete(post_data_json);
212 return NTS_ERR_FAILED;
215 char *hostname_string = framework_environment.settings.hostname;
216 cJSON *common_event_header = ves_create_common_event_header_721("stndDefined", "o1-notify-pnf-registration", hostname_string, nf_port, "Low", ves_o1_pnf_sequence_number++, "o1-notify-pnf-registration");
217 if(common_event_header == 0) {
218 log_error("could not create cJSON object\n");
219 cJSON_Delete(post_data_json);
220 return NTS_ERR_FAILED;
224 if(mp == DOCKER_MAPPING) {
225 nf_port = STANDARD_NETCONF_PORT;
229 nf_port = framework_environment.host.tls_base_port;
232 nf_port = framework_environment.host.ssh_base_port;
237 if(cJSON_AddItemToObject(event, "commonEventHeader", common_event_header) == 0) {
238 log_error("cJSON_AddItemToObject failed\n");
239 cJSON_Delete(post_data_json);
240 return NTS_ERR_FAILED;
243 cJSON *o1_pnf_registration_fields = ves_create_o1_pnf_registration_fields(nf_ip_v4_address, nf_ip_v6_address, nf_port, is_tls);
244 if(o1_pnf_registration_fields == 0) {
245 log_error("could not create cJSON object\n");
246 cJSON_Delete(post_data_json);
247 return NTS_ERR_FAILED;
250 if(cJSON_AddItemToObject(event, "stndDefinedFields", o1_pnf_registration_fields) == 0) {
251 log_error("cJSON_AddItemToObject failed\n");
252 cJSON_Delete(post_data_json);
253 return NTS_ERR_FAILED;
256 char *post_data = cJSON_PrintUnformatted(post_data_json);
257 cJSON_Delete(post_data_json);
259 log_error("cJSON_PrintUnformatted failed\n");
260 return NTS_ERR_FAILED;
264 ves_details_t *ves_details = ves_endpoint_details_get(current_session, 0);
266 log_error("ves_endpoint_details_get failed\n");
268 return NTS_ERR_FAILED;
271 int rc = http_request(ves_details->url, ves_details->username, ves_details->password, "POST", post_data, 0, 0);
272 ves_details_free(ves_details);
275 if(rc != NTS_ERR_OK) {
276 log_error("http_request failed\n");
277 return NTS_ERR_FAILED;
283 static cJSON* ves_create_o1_pnf_registration_fields(const char *nf_ip_v4_address, const char *nf_ip_v6_address, int nf_port, bool is_tls) {
285 cJSON *stnd_defined_fields = cJSON_CreateObject();
286 if(stnd_defined_fields == 0) {
287 log_error("could not create JSON object\n");
291 if(cJSON_AddStringToObject(stnd_defined_fields, "stndDefinedFieldsVersion", "1.0") == 0) {
292 log_error("cJSON_AddItemToObject failed\n");
293 cJSON_Delete(stnd_defined_fields);
297 if(cJSON_AddStringToObject(stnd_defined_fields, "schemaReference", "https://gerrit.o-ran-sc.org/r/gitweb?p=scp/oam/modeling.git;a=blob;f=data-model/yang/working/o-ran-sc/template/yes-o1-notify-pnf-registration.yang#/components/schemas/o1-notify-pnf-registration") == 0) {
298 log_error("cJSON_AddItemToObject failed\n");
299 cJSON_Delete(stnd_defined_fields);
303 cJSON *data = cJSON_CreateObject();
305 log_error("could not create JSON object\n");
306 cJSON_Delete(stnd_defined_fields);
309 cJSON_AddItemToObject(stnd_defined_fields, "data", data);
311 if(cJSON_AddStringToObject(data, "object-class", "manged-function") == 0) {
312 log_error("cJSON_AddItemToObject failed\n");
313 cJSON_Delete(stnd_defined_fields);
317 if(cJSON_AddStringToObject(data, "object-instance", "YES-API-PROVIDER") == 0) {
318 log_error("cJSON_AddItemToObject failed\n");
319 cJSON_Delete(stnd_defined_fields);
323 if(cJSON_AddNumberToObject(data, "notification-identifier", (double)(0)) == 0) {
324 log_error("cJSON_AddItemToObject failed\n");
325 cJSON_Delete(stnd_defined_fields);
329 if(cJSON_AddStringToObject(data, "notification-type", "o1-notify-pnf-registration") == 0) {
330 log_error("cJSON_AddItemToObject failed\n");
331 cJSON_Delete(stnd_defined_fields);
335 char *current_date_and_time = get_current_date_and_time();
336 if(current_date_and_time == 0) {
337 log_error("get_current_date_and_time failed\n");
338 cJSON_Delete(stnd_defined_fields);
342 if(cJSON_AddStringToObject(data, "event-time", current_date_and_time) == 0) {
343 log_error("cJSON_AddItemToObject failed\n");
344 cJSON_Delete(stnd_defined_fields);
345 free(current_date_and_time);
348 free(current_date_and_time);
350 if(cJSON_AddStringToObject(data, "system-distinguished-name", "DN:managed-element=YES-API-PROVIDER") == 0) {
351 log_error("cJSON_AddItemToObject failed\n");
352 cJSON_Delete(stnd_defined_fields);
356 if(cJSON_AddStringToObject(data, "o1-specification-version", "v07.00") == 0) {
357 log_error("cJSON_AddItemToObject failed\n");
358 cJSON_Delete(stnd_defined_fields);
362 char serial_number[512];
363 sprintf(serial_number, "%s-%s-%d-Simulated Device Melacon", framework_environment.settings.hostname, nf_ip_v4_address, nf_port);
365 if(cJSON_AddStringToObject(data, "serial-number", serial_number) == 0) {
366 log_error("cJSON_AddItemToObject failed\n");
367 cJSON_Delete(stnd_defined_fields);
371 if(cJSON_AddNumberToObject(data, "vendor-pen", (double)(57272)) == 0) {
372 log_error("cJSON_AddItemToObject failed\n");
373 cJSON_Delete(stnd_defined_fields);
377 if (!framework_environment.settings.ip_v6_enabled) {
378 if (nf_ip_v4_address != 0 && strlen(nf_ip_v4_address) > 0) {
379 if(cJSON_AddStringToObject(data, "oam-host", nf_ip_v4_address) == 0) {
380 log_error("cJSON_AddItemToObject failed\n");
381 cJSON_Delete(stnd_defined_fields);
387 if (nf_ip_v6_address != 0 && strlen(nf_ip_v6_address) > 0) {
388 if(cJSON_AddStringToObject(data, "oam-host", nf_ip_v6_address) == 0) {
389 log_error("cJSON_AddItemToObject failed\n");
390 cJSON_Delete(stnd_defined_fields);
396 if(cJSON_AddNumberToObject(data, "oam-port", (double)(nf_port)) == 0) {
397 log_error("cJSON_AddItemToObject failed\n");
398 cJSON_Delete(stnd_defined_fields);
402 char *mac_addr = rand_mac_address();
404 log_error("rand_mac_address failed\n")
405 cJSON_Delete(stnd_defined_fields);
409 if(cJSON_AddStringToObject(data, "mac-address", mac_addr) == 0) {
410 log_error("cJSON_AddItemToObject failed\n");
411 cJSON_Delete(stnd_defined_fields);
417 if(cJSON_AddStringToObject(data, "unit-family", "O-RAN-SC SIM") == 0) {
418 log_error("cJSON_AddItemToObject failed\n");
419 cJSON_Delete(stnd_defined_fields);
423 if(cJSON_AddStringToObject(data, "unit-type", "O1-Interface") == 0) {
424 log_error("cJSON_AddItemToObject failed\n");
425 cJSON_Delete(stnd_defined_fields);
429 if(cJSON_AddStringToObject(data, "model-number", "1859a6ea-2520-11ed-861d-0242ac120002") == 0) {
430 log_error("cJSON_AddItemToObject failed\n");
431 cJSON_Delete(stnd_defined_fields);
435 if(cJSON_AddStringToObject(data, "software-version", "G-Release") == 0) {
436 log_error("cJSON_AddItemToObject failed\n");
437 cJSON_Delete(stnd_defined_fields);
441 if(cJSON_AddStringToObject(data, "restart-reason", "External trigger") == 0) {
442 log_error("cJSON_AddItemToObject failed\n");
443 cJSON_Delete(stnd_defined_fields);
447 if(cJSON_AddStringToObject(data, "manufacture-date", "2022-08-26Z") == 0) {
448 log_error("cJSON_AddItemToObject failed\n");
449 cJSON_Delete(stnd_defined_fields);
453 if(cJSON_AddStringToObject(data, "last-service-date", "2022-08-26Z") == 0) {
454 log_error("cJSON_AddItemToObject failed\n");
455 cJSON_Delete(stnd_defined_fields);
459 if(cJSON_AddStringToObject(data, "username", "netconf") == 0) {
460 log_error("cJSON_AddItemToObject failed\n");
461 cJSON_Delete(stnd_defined_fields);
466 //TLS specific configuration
467 if(cJSON_AddStringToObject(data, "transport-protocol", "tls") == 0) {
468 log_error("cJSON_AddItemToObject failed\n");
469 cJSON_Delete(stnd_defined_fields);
473 if(cJSON_AddStringToObject(data, "key-reference", KS_KEY_NAME) == 0) {
474 log_error("cJSON_AddItemToObject failed\n");
475 cJSON_Delete(stnd_defined_fields);
480 //SSH specific configuration
481 if(cJSON_AddStringToObject(data, "transport-protocol", "ssh") == 0) {
482 log_error("cJSON_AddItemToObject failed\n");
483 cJSON_Delete(stnd_defined_fields);
487 // hardcoded password here
488 if(cJSON_AddStringToObject(data, "password", "netconf!") == 0) {
489 log_error("cJSON_AddItemToObject failed\n");
490 cJSON_Delete(stnd_defined_fields);
495 if(cJSON_AddFalseToObject(data, "reconnect-on-changed-schema") == 0) {
496 log_error("cJSON_AddItemToObject failed\n");
497 cJSON_Delete(stnd_defined_fields);
501 if(cJSON_AddNumberToObject(data, "connection-timeout", (double)(20000)) == 0) {
502 log_error("cJSON_AddItemToObject failed\n");
503 cJSON_Delete(stnd_defined_fields);
507 if(cJSON_AddNumberToObject(data, "max-connection-attempts", (double)(100)) == 0) {
508 log_error("cJSON_AddItemToObject failed\n");
509 cJSON_Delete(stnd_defined_fields);
513 if(cJSON_AddNumberToObject(data, "between-attempts-timeout", (double)(2000)) == 0) {
514 log_error("cJSON_AddItemToObject failed\n");
515 cJSON_Delete(stnd_defined_fields);
519 if(cJSON_AddNumberToObject(data, "sleep-factor", (double)(1.5)) == 0) {
520 log_error("cJSON_AddItemToObject failed\n");
521 cJSON_Delete(stnd_defined_fields);
525 if(cJSON_AddNumberToObject(data, "keepalive-delay", (double)(120)) == 0) {
526 log_error("cJSON_AddItemToObject failed\n");
527 cJSON_Delete(stnd_defined_fields);
531 return stnd_defined_fields;