osm_nbi/validation.py

   1 # -*- coding: utf-8 -*-
   2
   3 # Licensed under the Apache License, Version 2.0 (the "License");
   4 # you may not use this file except in compliance with the License.
   5 # You may obtain a copy of the License at
   6 #
   7 #    http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 # Unless required by applicable law or agreed to in writing, software
  10 # distributed under the License is distributed on an "AS IS" BASIS,
  11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
  12 # implied.
  13 # See the License for the specific language governing permissions and
  14 # limitations under the License.
  15
  16 from jsonschema import validate as js_v, exceptions as js_e
  17 from http import HTTPStatus
  18 from copy import deepcopy
  19 from uuid import UUID  # To test for valid UUID
  20
  21 __author__ = "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
  22 __version__ = "0.1"
  23 version_date = "Mar 2018"
  24
  25 """
  26 Validator of input data using JSON schemas for those items that not contains an  OSM yang information model
  27 """
  28
  29 # Basis schemas
  30 patern_name = "^[ -~]+$"
  31 shortname_schema = {
  32     "type": "string",
  33     "minLength": 1,
  34     "maxLength": 60,
  35     "pattern": "^[^,;()\\.\\$'\"]+$",
  36 }
  37 passwd_schema = {"type": "string", "minLength": 1, "maxLength": 60}
  38 name_schema = {
  39     "type": "string",
  40     "minLength": 1,
  41     "maxLength": 255,
  42     "pattern": "^[^,;()'\"]+$",
  43 }
  44 string_schema = {"type": "string", "minLength": 1, "maxLength": 255}
  45 xml_text_schema = {
  46     "type": "string",
  47     "minLength": 1,
  48     "maxLength": 1000,
  49     "pattern": "^[^']+$",
  50 }
  51 description_schema = {
  52     "type": ["string", "null"],
  53     "maxLength": 255,
  54     "pattern": "^[^'\"]+$",
  55 }
  56 long_description_schema = {
  57     "type": ["string", "null"],
  58     "maxLength": 3000,
  59     "pattern": "^[^'\"]+$",
  60 }
  61 id_schema_fake = {"type": "string", "minLength": 2, "maxLength": 36}
  62 bool_schema = {"type": "boolean"}
  63 null_schema = {"type": "null"}
  64 # "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
  65 id_schema = {
  66     "type": "string",
  67     "pattern": "^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$",
  68 }
  69 time_schema = {
  70     "type": "string",
  71     "pattern": "^[0-9]{4}-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]([0-5]:){2}",
  72 }
  73 pci_schema = {
  74     "type": "string",
  75     "pattern": "^[0-9a-fA-F]{4}(:[0-9a-fA-F]{2}){2}\\.[0-9a-fA-F]$",
  76 }
  77 # allows [] for wildcards. For that reason huge length limit is set
  78 pci_extended_schema = {"type": "string", "pattern": "^[0-9a-fA-F.:-\\[\\]]{12,40}$"}
  79 http_schema = {"type": "string", "pattern": "^(https?|http)://[^'\"=]+$"}
  80 bandwidth_schema = {"type": "string", "pattern": "^[0-9]+ *([MG]bps)?$"}
  81 memory_schema = {"type": "string", "pattern": "^[0-9]+ *([MG]i?[Bb])?$"}
  82 integer0_schema = {"type": "integer", "minimum": 0}
  83 integer1_schema = {"type": "integer", "minimum": 1}
  84 path_schema = {"type": "string", "pattern": "^(\\.){0,2}(/[^/\"':{}\\(\\)]+)+$"}
  85 vlan_schema = {"type": "integer", "minimum": 1, "maximum": 4095}
  86 vlan1000_schema = {"type": "integer", "minimum": 1000, "maximum": 4095}
  87 mac_schema = {
  88     "type": "string",
  89     "pattern": "^[0-9a-fA-F][02468aceACE](:[0-9a-fA-F]{2}){5}$",
  90 }  # must be unicast: LSB bit of MSB byte ==0
  91 dpid_Schema = {"type": "string", "pattern": "^[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){7}$"}
  92 # mac_schema={"type":"string", "pattern":"^([0-9a-fA-F]{2}:){5}[0-9a-fA-F]{2}$"}
  93 ip_schema = {
  94     "type": "string",
  95     "pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$",
  96 }
  97 ip_prefix_schema = {
  98     "type": "string",
  99     "pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}"
 100     "(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/(30|[12]?[0-9])$",
 101 }
 102 port_schema = {"type": "integer", "minimum": 1, "maximum": 65534}
 103 object_schema = {"type": "object"}
 104 schema_version_2 = {"type": "integer", "minimum": 2, "maximum": 2}
 105 # schema_version_string={"type":"string","enum": ["0.1", "2", "0.2", "3", "0.3"]}
 106 log_level_schema = {
 107     "type": "string",
 108     "enum": ["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"],
 109 }
 110 checksum_schema = {"type": "string", "pattern": "^[0-9a-fA-F]{32}$"}
 111 size_schema = {"type": "integer", "minimum": 1, "maximum": 100}
 112 array_edition_schema = {
 113     "type": "object",
 114     "patternProperties": {"^\\$": {}},
 115     "additionalProperties": False,
 116     "minProperties": 1,
 117 }
 118 nameshort_list_schema = {
 119     "type": "array",
 120     "minItems": 1,
 121     "items": shortname_schema,
 122 }
 123
 124 description_list_schema = {
 125     "type": "array",
 126     "minItems": 1,
 127     "items": description_schema,
 128 }
 129
 130 ns_instantiate_vdu = {
 131     "title": "ns action instantiate input schema for vdu",
 132     "$schema": "http://json-schema.org/draft-04/schema#",
 133     "type": "object",
 134     "properties": {
 135         "id": name_schema,
 136         "volume": {
 137             "type": "array",
 138             "minItems": 1,
 139             "items": {
 140                 "type": "object",
 141                 "properties": {
 142                     "name": name_schema,
 143                     "vim-volume-id": name_schema,
 144                 },
 145                 "required": ["name", "vim-volume-id"],
 146                 "additionalProperties": False,
 147             },
 148         },
 149         "interface": {
 150             "type": "array",
 151             "minItems": 1,
 152             "items": {
 153                 "type": "object",
 154                 "properties": {
 155                     "name": name_schema,
 156                     "ip-address": ip_schema,
 157                     "mac-address": mac_schema,
 158                     "floating-ip-required": bool_schema,
 159                 },
 160                 "required": ["name"],
 161                 "additionalProperties": False,
 162             },
 163         },
 164     },
 165     "required": ["id"],
 166     "additionalProperties": False,
 167 }
 168
 169 ip_profile_dns_schema = {
 170     "type": "array",
 171     "minItems": 1,
 172     "items": {
 173         "type": "object",
 174         "properties": {
 175             "address": ip_schema,
 176         },
 177         "required": ["address"],
 178         "additionalProperties": False,
 179     },
 180 }
 181
 182 ip_profile_dhcp_schema = {
 183     "type": "object",
 184     "properties": {
 185         "enabled": {"type": "boolean"},
 186         "count": integer1_schema,
 187         "start-address": ip_schema,
 188     },
 189     "additionalProperties": False,
 190 }
 191
 192 ip_profile_schema = {
 193     "title": "ip profile validation schema",
 194     "$schema": "http://json-schema.org/draft-04/schema#",
 195     "type": "object",
 196     "properties": {
 197         "ip-version": {"enum": ["ipv4", "ipv6"]},
 198         "subnet-address": ip_prefix_schema,
 199         "gateway-address": ip_schema,
 200         "dns-server": ip_profile_dns_schema,
 201         "dhcp-params": ip_profile_dhcp_schema,
 202     },
 203 }
 204
 205 ip_profile_update_schema = {
 206     "title": "ip profile validation schema",
 207     "$schema": "http://json-schema.org/draft-04/schema#",
 208     "type": "object",
 209     "properties": {
 210         "ip-version": {"enum": ["ipv4", "ipv6"]},
 211         "subnet-address": {"oneOf": [null_schema, ip_prefix_schema]},
 212         "gateway-address": {"oneOf": [null_schema, ip_schema]},
 213         "dns-server": {"oneOf": [null_schema, ip_profile_dns_schema]},
 214         "dhcp-params": {"oneOf": [null_schema, ip_profile_dhcp_schema]},
 215     },
 216     "additionalProperties": False,
 217 }
 218
 219 provider_network_schema = {
 220     "title": "provider network validation schema",
 221     "$schema": "http://json-schema.org/draft-04/schema#",
 222     "type": "object",
 223     "properties": {
 224         "physical-network": name_schema,
 225         "segmentation-id": name_schema,
 226         "sdn-ports": {  # external ports to append to the SDN-assist network
 227             "type": "array",
 228             "items": {
 229                 "type": "object",
 230                 "properties": {
 231                     "switch_id": shortname_schema,
 232                     "switch_port": shortname_schema,
 233                     "mac_address": mac_schema,
 234                     "vlan": vlan_schema,
 235                 },
 236                 "additionalProperties": True,
 237             },
 238         },
 239         "network-type": shortname_schema,
 240     },
 241     "additionalProperties": True,
 242 }
 243
 244 ns_instantiate_internal_vld = {
 245     "title": "ns action instantiate input schema for vdu",
 246     "$schema": "http://json-schema.org/draft-04/schema#",
 247     "type": "object",
 248     "properties": {
 249         "name": name_schema,
 250         "vim-network-name": name_schema,
 251         "vim-network-id": name_schema,
 252         "ip-profile": ip_profile_update_schema,
 253         "provider-network": provider_network_schema,
 254         "internal-connection-point": {
 255             "type": "array",
 256             "minItems": 1,
 257             "items": {
 258                 "type": "object",
 259                 "properties": {
 260                     "id-ref": name_schema,
 261                     "ip-address": ip_schema,
 262                     # "mac-address": mac_schema,
 263                 },
 264                 "required": ["id-ref"],
 265                 "minProperties": 2,
 266                 "additionalProperties": False,
 267             },
 268         },
 269     },
 270     "required": ["name"],
 271     "minProperties": 2,
 272     "additionalProperties": False,
 273 }
 274
 275 additional_params_for_vnf = {
 276     "type": "array",
 277     "items": {
 278         "type": "object",
 279         "properties": {
 280             "member-vnf-index": name_schema,
 281             "additionalParams": object_schema,
 282             "k8s-namespace": name_schema,
 283             "config-units": integer1_schema,  # number of configuration units of this vnf, by default 1
 284             "additionalParamsForVdu": {
 285                 "type": "array",
 286                 "items": {
 287                     "type": "object",
 288                     "properties": {
 289                         "vdu_id": name_schema,
 290                         "additionalParams": object_schema,
 291                         "config-units": integer1_schema,  # number of configuration units of this vdu, by default 1
 292                     },
 293                     "required": ["vdu_id"],
 294                     "minProperties": 2,
 295                     "additionalProperties": False,
 296                 },
 297             },
 298             "additionalParamsForKdu": {
 299                 "type": "array",
 300                 "items": {
 301                     "type": "object",
 302                     "properties": {
 303                         "kdu_name": name_schema,
 304                         "additionalParams": object_schema,
 305                         "kdu_model": name_schema,
 306                         "k8s-namespace": name_schema,
 307                         "config-units": integer1_schema,  # number of configuration units of this knf, by default 1
 308                     },
 309                     "required": ["kdu_name"],
 310                     "minProperties": 2,
 311                     "additionalProperties": False,
 312                 },
 313             },
 314         },
 315         "required": ["member-vnf-index"],
 316         "minProperties": 2,
 317         "additionalProperties": False,
 318     },
 319 }
 320
 321 ns_instantiate = {
 322     "title": "ns action instantiate input schema",
 323     "$schema": "http://json-schema.org/draft-04/schema#",
 324     "type": "object",
 325     "properties": {
 326         "lcmOperationType": string_schema,
 327         "nsInstanceId": id_schema,
 328         "netsliceInstanceId": id_schema,
 329         "nsName": name_schema,
 330         "nsDescription": {"oneOf": [description_schema, null_schema]},
 331         "nsdId": id_schema,
 332         "vcaId": id_schema,
 333         "vimAccountId": id_schema,
 334         "wimAccountId": {"oneOf": [id_schema, bool_schema, null_schema]},
 335         "placement-engine": string_schema,
 336         "placement-constraints": object_schema,
 337         "additionalParamsForNs": object_schema,
 338         "additionalParamsForVnf": additional_params_for_vnf,
 339         "config-units": integer1_schema,  # number of configuration units of this ns, by default 1
 340         "k8s-namespace": name_schema,
 341         "ssh_keys": {"type": "array", "items": {"type": "string"}},
 342         "timeout_ns_deploy": integer1_schema,
 343         "nsr_id": id_schema,
 344         "vduImage": name_schema,
 345         "vnf": {
 346             "type": "array",
 347             "minItems": 1,
 348             "items": {
 349                 "type": "object",
 350                 "properties": {
 351                     "member-vnf-index": name_schema,
 352                     "vimAccountId": id_schema,
 353                     "vcaId": id_schema,
 354                     "vdu": {
 355                         "type": "array",
 356                         "minItems": 1,
 357                         "items": ns_instantiate_vdu,
 358                     },
 359                     "internal-vld": {
 360                         "type": "array",
 361                         "minItems": 1,
 362                         "items": ns_instantiate_internal_vld,
 363                     },
 364                 },
 365                 "required": ["member-vnf-index"],
 366                 "minProperties": 2,
 367                 "additionalProperties": False,
 368             },
 369         },
 370         "vld": {
 371             "type": "array",
 372             "minItems": 1,
 373             "items": {
 374                 "type": "object",
 375                 "properties": {
 376                     "name": string_schema,
 377                     "vim-network-name": {"oneOf": [string_schema, object_schema]},
 378                     "vim-network-id": {"oneOf": [string_schema, object_schema]},
 379                     "ns-net": object_schema,
 380                     "wimAccountId": {"oneOf": [id_schema, bool_schema, null_schema]},
 381                     "ip-profile": object_schema,
 382                     "provider-network": provider_network_schema,
 383                     "vnfd-connection-point-ref": {
 384                         "type": "array",
 385                         "minItems": 1,
 386                         "items": {
 387                             "type": "object",
 388                             "properties": {
 389                                 "member-vnf-index-ref": name_schema,
 390                                 "vnfd-connection-point-ref": name_schema,
 391                                 "ip-address": ip_schema,
 392                                 # "mac-address": mac_schema,
 393                             },
 394                             "required": [
 395                                 "member-vnf-index-ref",
 396                                 "vnfd-connection-point-ref",
 397                             ],
 398                             "minProperties": 3,
 399                             "additionalProperties": False,
 400                         },
 401                     },
 402                 },
 403                 "required": ["name"],
 404                 "additionalProperties": False,
 405             },
 406         },
 407     },
 408     "required": ["nsName", "nsdId", "vimAccountId"],
 409     "additionalProperties": False,
 410 }
 411
 412 ns_terminate = {
 413     "title": "ns terminate input schema",
 414     "$schema": "http://json-schema.org/draft-04/schema#",
 415     "type": "object",
 416     "properties": {
 417         "lcmOperationType": string_schema,
 418         "nsInstanceId": id_schema,
 419         "autoremove": bool_schema,
 420         "timeout_ns_terminate": integer1_schema,
 421         "skip_terminate_primitives": bool_schema,
 422         "netsliceInstanceId": id_schema,
 423     },
 424     "additionalProperties": False,
 425 }
 426
 427 ns_action = {  # TODO for the moment it is only contemplated the vnfd primitive execution
 428     "title": "ns action input schema",
 429     "$schema": "http://json-schema.org/draft-04/schema#",
 430     "type": "object",
 431     "properties": {
 432         "lcmOperationType": string_schema,
 433         "nsInstanceId": id_schema,
 434         "member_vnf_index": name_schema,
 435         "vnf_member_index": name_schema,  # TODO for backward compatibility. To remove in future
 436         "vdu_id": name_schema,
 437         "vdu_count_index": integer0_schema,
 438         "kdu_name": name_schema,
 439         "primitive": name_schema,
 440         "timeout_ns_action": integer1_schema,
 441         "primitive_params": {"type": "object"},
 442     },
 443     "required": ["primitive", "primitive_params"],  # TODO add member_vnf_index
 444     "additionalProperties": False,
 445 }
 446 ns_scale = {  # TODO for the moment it is only VDU-scaling
 447     "title": "ns scale input schema",
 448     "$schema": "http://json-schema.org/draft-04/schema#",
 449     "type": "object",
 450     "properties": {
 451         "lcmOperationType": string_schema,
 452         "nsInstanceId": id_schema,
 453         "scaleType": {"enum": ["SCALE_VNF"]},
 454         "timeout_ns_scale": integer1_schema,
 455         "scaleVnfData": {
 456             "type": "object",
 457             "properties": {
 458                 "vnfInstanceId": name_schema,
 459                 "scaleVnfType": {"enum": ["SCALE_OUT", "SCALE_IN"]},
 460                 "scaleByStepData": {
 461                     "type": "object",
 462                     "properties": {
 463                         "scaling-group-descriptor": name_schema,
 464                         "member-vnf-index": name_schema,
 465                         "scaling-policy": name_schema,
 466                     },
 467                     "required": ["scaling-group-descriptor", "member-vnf-index"],
 468                     "additionalProperties": False,
 469                 },
 470             },
 471             "required": ["scaleVnfType", "scaleByStepData"],  # vnfInstanceId
 472             "additionalProperties": False,
 473         },
 474         "scaleTime": time_schema,
 475     },
 476     "required": ["scaleType", "scaleVnfData"],
 477     "additionalProperties": False,
 478 }
 479
 480
 481 schema_version = {"type": "string", "enum": ["1.0"]}
 482 schema_type = {"type": "string"}
 483 vim_type = shortname_schema  # {"enum": ["openstack", "openvim", "vmware", "opennebula", "aws", "azure", "fos"]}
 484
 485 vim_account_edit_schema = {
 486     "title": "vim_account edit input schema",
 487     "$schema": "http://json-schema.org/draft-04/schema#",
 488     "type": "object",
 489     "properties": {
 490         "name": name_schema,
 491         "description": description_schema,
 492         "vim": name_schema,
 493         "datacenter": name_schema,
 494         "vim_type": vim_type,
 495         "vim_url": description_schema,
 496         # "vim_url_admin": description_schema,
 497         # "vim_tenant": name_schema,
 498         "vim_tenant_name": name_schema,
 499         "vim_user": shortname_schema,
 500         "vim_password": passwd_schema,
 501         "vca": id_schema,
 502         "config": {"type": "object"},
 503     },
 504     "additionalProperties": False,
 505 }
 506
 507 vim_account_new_schema = {
 508     "title": "vim_account creation input schema",
 509     "$schema": "http://json-schema.org/draft-04/schema#",
 510     "type": "object",
 511     "properties": {
 512         "schema_version": schema_version,
 513         "schema_type": schema_type,
 514         "name": name_schema,
 515         "description": description_schema,
 516         "vim": name_schema,
 517         "datacenter": name_schema,
 518         "vim_type": vim_type,
 519         "vim_url": description_schema,
 520         # "vim_url_admin": description_schema,
 521         # "vim_tenant": name_schema,
 522         "vim_tenant_name": name_schema,
 523         "vim_user": shortname_schema,
 524         "vim_password": passwd_schema,
 525         "vca": id_schema,
 526         "config": {"type": "object"},
 527     },
 528     "required": [
 529         "name",
 530         "vim_url",
 531         "vim_type",
 532         "vim_user",
 533         "vim_password",
 534         "vim_tenant_name",
 535     ],
 536     "additionalProperties": False,
 537 }
 538
 539 wim_type = shortname_schema  # {"enum": ["ietfl2vpn", "onos", "odl", "dynpac", "fake"]}
 540
 541 wim_account_edit_schema = {
 542     "title": "wim_account edit input schema",
 543     "$schema": "http://json-schema.org/draft-04/schema#",
 544     "type": "object",
 545     "properties": {
 546         "name": name_schema,
 547         "description": description_schema,
 548         "wim": name_schema,
 549         "wim_type": wim_type,
 550         "wim_url": description_schema,
 551         "user": shortname_schema,
 552         "password": passwd_schema,
 553         "config": {"type": "object"},
 554     },
 555     "additionalProperties": False,
 556 }
 557
 558 wim_account_new_schema = {
 559     "title": "wim_account creation input schema",
 560     "$schema": "http://json-schema.org/draft-04/schema#",
 561     "type": "object",
 562     "properties": {
 563         "schema_version": schema_version,
 564         "schema_type": schema_type,
 565         "name": name_schema,
 566         "description": description_schema,
 567         "wim": name_schema,
 568         "wim_type": wim_type,
 569         "wim_url": description_schema,
 570         "user": shortname_schema,
 571         "password": passwd_schema,
 572         "config": {
 573             "type": "object",
 574             "patternProperties": {".": {"not": {"type": "null"}}},
 575         },
 576     },
 577     "required": ["name", "wim_url", "wim_type"],
 578     "additionalProperties": False,
 579 }
 580
 581 sdn_properties = {
 582     "name": name_schema,
 583     "type": {"type": "string"},
 584     "url": {"type": "string"},
 585     "user": shortname_schema,
 586     "password": passwd_schema,
 587     "config": {"type": "object"},
 588     "description": description_schema,
 589     # The folowing are deprecated. Maintanied for backward compatibility
 590     "dpid": dpid_Schema,
 591     "ip": ip_schema,
 592     "port": port_schema,
 593     "version": {"type": "string", "minLength": 1, "maxLength": 12},
 594 }
 595 sdn_new_schema = {
 596     "title": "sdn controller information schema",
 597     "$schema": "http://json-schema.org/draft-04/schema#",
 598     "type": "object",
 599     "properties": sdn_properties,
 600     "required": ["name", "type"],
 601     "additionalProperties": False,
 602 }
 603 sdn_edit_schema = {
 604     "title": "sdn controller update information schema",
 605     "$schema": "http://json-schema.org/draft-04/schema#",
 606     "type": "object",
 607     "properties": sdn_properties,
 608     # "required": ["name", "port", 'ip', 'dpid', 'type'],
 609     "additionalProperties": False,
 610 }
 611 sdn_port_mapping_schema = {
 612     "$schema": "http://json-schema.org/draft-04/schema#",
 613     "title": "sdn port mapping information schema",
 614     "type": "array",
 615     "items": {
 616         "type": "object",
 617         "properties": {
 618             "compute_node": shortname_schema,
 619             "ports": {
 620                 "type": "array",
 621                 "items": {
 622                     "type": "object",
 623                     "properties": {
 624                         "pci": pci_extended_schema,
 625                         "switch_port": shortname_schema,
 626                         "switch_mac": mac_schema,
 627                     },
 628                     "required": ["pci"],
 629                 },
 630             },
 631         },
 632         "required": ["compute_node", "ports"],
 633     },
 634 }
 635 sdn_external_port_schema = {
 636     "$schema": "http://json-schema.org/draft-04/schema#",
 637     "title": "External port information",
 638     "type": "object",
 639     "properties": {
 640         "port": {"type": "string", "minLength": 1, "maxLength": 60},
 641         "vlan": vlan_schema,
 642         "mac": mac_schema,
 643     },
 644     "required": ["port"],
 645 }
 646
 647 # K8s Clusters
 648 k8scluster_nets_schema = {
 649     "title": "k8scluster nets input schema",
 650     "$schema": "http://json-schema.org/draft-04/schema#",
 651     "type": "object",
 652     "patternProperties": {".": {"oneOf": [name_schema, null_schema]}},
 653     "minProperties": 1,
 654     "additionalProperties": False,
 655 }
 656 k8scluster_new_schema = {
 657     "title": "k8scluster creation input schema",
 658     "$schema": "http://json-schema.org/draft-04/schema#",
 659     "type": "object",
 660     "properties": {
 661         "schema_version": schema_version,
 662         "schema_type": schema_type,
 663         "name": name_schema,
 664         "description": description_schema,
 665         "credentials": object_schema,
 666         "vim_account": id_schema,
 667         "vca_id": id_schema,
 668         "k8s_version": string_schema,
 669         "nets": k8scluster_nets_schema,
 670         "namespace": name_schema,
 671         "cni": nameshort_list_schema,
 672     },
 673     "required": ["name", "credentials", "vim_account", "k8s_version", "nets"],
 674     "additionalProperties": False,
 675 }
 676 k8scluster_edit_schema = {
 677     "title": "vim_account edit input schema",
 678     "$schema": "http://json-schema.org/draft-04/schema#",
 679     "type": "object",
 680     "properties": {
 681         "name": name_schema,
 682         "description": description_schema,
 683         "credentials": object_schema,
 684         "vim_account": id_schema,
 685         "vca_id": id_schema,
 686         "k8s_version": string_schema,
 687         "nets": k8scluster_nets_schema,
 688         "namespace": name_schema,
 689         "cni": nameshort_list_schema,
 690     },
 691     "additionalProperties": False,
 692 }
 693
 694 # VCA
 695 vca_new_schema = {
 696     "title": "vca creation input schema",
 697     "$schema": "http://json-schema.org/draft-04/schema#",
 698     "type": "object",
 699     "properties": {
 700         "schema_version": schema_version,
 701         "schema_type": schema_type,
 702         "name": name_schema,
 703         "description": description_schema,
 704         "endpoints": description_list_schema,
 705         "user": shortname_schema,
 706         "secret": passwd_schema,
 707         "cacert": long_description_schema,
 708         "lxd-cloud": shortname_schema,
 709         "lxd-credentials": shortname_schema,
 710         "k8s-cloud": shortname_schema,
 711         "k8s-credentials": shortname_schema,
 712         "model-config": object_schema,
 713     },
 714     "required": [
 715         "name",
 716         "endpoints",
 717         "user",
 718         "secret",
 719         "cacert",
 720         "lxd-cloud",
 721         "lxd-credentials",
 722         "k8s-cloud",
 723         "k8s-credentials",
 724     ],
 725     "additionalProperties": False,
 726 }
 727 vca_edit_schema = {
 728     "title": "vca creation input schema",
 729     "$schema": "http://json-schema.org/draft-04/schema#",
 730     "type": "object",
 731     "properties": {
 732         "name": name_schema,
 733         "description": description_schema,
 734         "endpoints": description_list_schema,
 735         "port": integer1_schema,
 736         "user": shortname_schema,
 737         "secret": passwd_schema,
 738         "cacert": long_description_schema,
 739         "lxd-cloud": shortname_schema,
 740         "lxd-credentials": shortname_schema,
 741         "k8s-cloud": shortname_schema,
 742         "k8s-credentials": shortname_schema,
 743         "model-config": object_schema,
 744     },
 745     "additionalProperties": False,
 746 }
 747
 748 # K8s Repos
 749 k8srepo_types = {"enum": ["helm-chart", "juju-bundle"]}
 750 k8srepo_properties = {
 751     "name": name_schema,
 752     "description": description_schema,
 753     "type": k8srepo_types,
 754     "url": description_schema,
 755 }
 756 k8srepo_new_schema = {
 757     "title": "k8scluster creation input schema",
 758     "$schema": "http://json-schema.org/draft-04/schema#",
 759     "type": "object",
 760     "properties": k8srepo_properties,
 761     "required": ["name", "type", "url"],
 762     "additionalProperties": False,
 763 }
 764 k8srepo_edit_schema = {
 765     "title": "vim_account edit input schema",
 766     "$schema": "http://json-schema.org/draft-04/schema#",
 767     "type": "object",
 768     "properties": k8srepo_properties,
 769     "additionalProperties": False,
 770 }
 771
 772 # OSM Repos
 773 osmrepo_types = {"enum": ["osm"]}
 774 osmrepo_properties = {
 775     "name": name_schema,
 776     "description": description_schema,
 777     "type": osmrepo_types,
 778     "url": description_schema
 779     # "user": shortname_schema,
 780     # "password": passwd_schema
 781 }
 782 osmrepo_new_schema = {
 783     "title": "osm repo creation input schema",
 784     "$schema": "http://json-schema.org/draft-04/schema#",
 785     "type": "object",
 786     "properties": osmrepo_properties,
 787     "required": ["name", "type", "url"],
 788     "additionalProperties": False,
 789 }
 790 osmrepo_edit_schema = {
 791     "title": "osm repo edit input schema",
 792     "$schema": "http://json-schema.org/draft-04/schema#",
 793     "type": "object",
 794     "properties": osmrepo_properties,
 795     "additionalProperties": False,
 796 }
 797
 798 # PDUs
 799 pdu_interface = {
 800     "type": "object",
 801     "properties": {
 802         "name": shortname_schema,
 803         "mgmt": bool_schema,
 804         "type": {"enum": ["overlay", "underlay"]},
 805         "ip-address": ip_schema,
 806         # TODO, add user, password, ssh-key
 807         "mac-address": mac_schema,
 808         "vim-network-name": shortname_schema,  # interface is connected to one vim network, or switch port
 809         "vim-network-id": shortname_schema,
 810         # # provide this in case SDN assist must deal with this interface
 811         # "switch-dpid": dpid_Schema,
 812         # "switch-port": shortname_schema,
 813         # "switch-mac": shortname_schema,
 814         # "switch-vlan": vlan_schema,
 815     },
 816     "required": ["name", "mgmt", "ip-address"],
 817     "additionalProperties": False,
 818 }
 819 pdu_new_schema = {
 820     "title": "pdu creation input schema",
 821     "$schema": "http://json-schema.org/draft-04/schema#",
 822     "type": "object",
 823     "properties": {
 824         "name": shortname_schema,
 825         "type": shortname_schema,
 826         "description": description_schema,
 827         "shared": bool_schema,
 828         "vims": nameshort_list_schema,
 829         "vim_accounts": nameshort_list_schema,
 830         "interfaces": {"type": "array", "items": pdu_interface, "minItems": 1},
 831     },
 832     "required": ["name", "type", "interfaces"],
 833     "additionalProperties": False,
 834 }
 835 pdu_edit_schema = {
 836     "title": "pdu edit input schema",
 837     "$schema": "http://json-schema.org/draft-04/schema#",
 838     "type": "object",
 839     "properties": {
 840         "name": shortname_schema,
 841         "type": shortname_schema,
 842         "description": description_schema,
 843         "shared": bool_schema,
 844         "vims": {"oneOf": [array_edition_schema, nameshort_list_schema]},
 845         "vim_accounts": {"oneOf": [array_edition_schema, nameshort_list_schema]},
 846         "interfaces": {
 847             "oneOf": [
 848                 array_edition_schema,
 849                 {"type": "array", "items": pdu_interface, "minItems": 1},
 850             ]
 851         },
 852     },
 853     "additionalProperties": False,
 854     "minProperties": 1,
 855 }
 856
 857 # VNF PKG OPERATIONS
 858 vnfpkgop_new_schema = {
 859     "title": "VNF PKG operation creation input schema",
 860     "$schema": "http://json-schema.org/draft-04/schema#",
 861     "type": "object",
 862     "properties": {
 863         "lcmOperationType": string_schema,
 864         "vnfPkgId": id_schema,
 865         "kdu_name": name_schema,
 866         "primitive": name_schema,
 867         "primitive_params": {"type": "object"},
 868     },
 869     "required": [
 870         "lcmOperationType",
 871         "vnfPkgId",
 872         "kdu_name",
 873         "primitive",
 874         "primitive_params",
 875     ],
 876     "additionalProperties": False,
 877 }
 878
 879 # USERS
 880 project_role_mappings = {
 881     "title": "list pf projects/roles",
 882     "$schema": "http://json-schema.org/draft-04/schema#",
 883     "type": "array",
 884     "items": {
 885         "type": "object",
 886         "properties": {"project": shortname_schema, "role": shortname_schema},
 887         "required": ["project", "role"],
 888         "additionalProperties": False,
 889     },
 890     "minItems": 1,
 891 }
 892 project_role_mappings_optional = {
 893     "title": "list of projects/roles or projects only",
 894     "$schema": "http://json-schema.org/draft-04/schema#",
 895     "type": "array",
 896     "items": {
 897         "type": "object",
 898         "properties": {"project": shortname_schema, "role": shortname_schema},
 899         "required": ["project"],
 900         "additionalProperties": False,
 901     },
 902     "minItems": 1,
 903 }
 904 user_new_schema = {
 905     "$schema": "http://json-schema.org/draft-04/schema#",
 906     "title": "New user schema",
 907     "type": "object",
 908     "properties": {
 909         "username": shortname_schema,
 910         "domain_name": shortname_schema,
 911         "password": passwd_schema,
 912         "projects": nameshort_list_schema,
 913         "project_role_mappings": project_role_mappings,
 914     },
 915     "required": ["username", "password"],
 916     "additionalProperties": False,
 917 }
 918 user_edit_schema = {
 919     "$schema": "http://json-schema.org/draft-04/schema#",
 920     "title": "User edit schema for administrators",
 921     "type": "object",
 922     "properties": {
 923         "password": passwd_schema,
 924         "username": shortname_schema,  # To allow User Name modification
 925         "projects": {"oneOf": [nameshort_list_schema, array_edition_schema]},
 926         "project_role_mappings": project_role_mappings,
 927         "add_project_role_mappings": project_role_mappings,
 928         "remove_project_role_mappings": project_role_mappings_optional,
 929     },
 930     "minProperties": 1,
 931     "additionalProperties": False,
 932 }
 933
 934 # PROJECTS
 935 topics_with_quota = [
 936     "vnfds",
 937     "nsds",
 938     "slice_templates",
 939     "pduds",
 940     "ns_instances",
 941     "slice_instances",
 942     "vim_accounts",
 943     "wim_accounts",
 944     "sdn_controllers",
 945     "k8sclusters",
 946     "vca",
 947     "k8srepos",
 948     "osmrepos",
 949     "ns_subscriptions",
 950 ]
 951 project_new_schema = {
 952     "$schema": "http://json-schema.org/draft-04/schema#",
 953     "title": "New project schema for administrators",
 954     "type": "object",
 955     "properties": {
 956         "name": shortname_schema,
 957         "admin": bool_schema,
 958         "domain_name": shortname_schema,
 959         "quotas": {
 960             "type": "object",
 961             "properties": {topic: integer0_schema for topic in topics_with_quota},
 962             "additionalProperties": False,
 963         },
 964     },
 965     "required": ["name"],
 966     "additionalProperties": False,
 967 }
 968 project_edit_schema = {
 969     "$schema": "http://json-schema.org/draft-04/schema#",
 970     "title": "Project edit schema for administrators",
 971     "type": "object",
 972     "properties": {
 973         "admin": bool_schema,
 974         "name": shortname_schema,  # To allow Project Name modification
 975         "quotas": {
 976             "type": "object",
 977             "properties": {
 978                 topic: {"oneOf": [integer0_schema, null_schema]}
 979                 for topic in topics_with_quota
 980             },
 981             "additionalProperties": False,
 982         },
 983     },
 984     "additionalProperties": False,
 985     "minProperties": 1,
 986 }
 987
 988 # ROLES
 989 roles_new_schema = {
 990     "$schema": "http://json-schema.org/draft-04/schema#",
 991     "title": "New role schema for administrators",
 992     "type": "object",
 993     "properties": {
 994         "name": shortname_schema,
 995         "permissions": {
 996             "type": "object",
 997             "patternProperties": {
 998                 ".": bool_schema,
 999             },
1000             # "minProperties": 1,
1001         },
1002     },
1003     "required": ["name"],
1004     "additionalProperties": False,
1005 }
1006 roles_edit_schema = {
1007     "$schema": "http://json-schema.org/draft-04/schema#",
1008     "title": "Roles edit schema for administrators",
1009     "type": "object",
1010     "properties": {
1011         "name": shortname_schema,
1012         "permissions": {
1013             "type": "object",
1014             "patternProperties": {".": {"oneOf": [bool_schema, null_schema]}},
1015             # "minProperties": 1,
1016         },
1017     },
1018     "additionalProperties": False,
1019     "minProperties": 1,
1020 }
1021
1022 # GLOBAL SCHEMAS
1023
1024 nbi_new_input_schemas = {
1025     "users": user_new_schema,
1026     "projects": project_new_schema,
1027     "vim_accounts": vim_account_new_schema,
1028     "sdns": sdn_new_schema,
1029     "ns_instantiate": ns_instantiate,
1030     "ns_action": ns_action,
1031     "ns_scale": ns_scale,
1032     "pdus": pdu_new_schema,
1033 }
1034
1035 nbi_edit_input_schemas = {
1036     "users": user_edit_schema,
1037     "projects": project_edit_schema,
1038     "vim_accounts": vim_account_edit_schema,
1039     "sdns": sdn_edit_schema,
1040     "pdus": pdu_edit_schema,
1041 }
1042
1043 # NETSLICE SCHEMAS
1044 nsi_subnet_instantiate = deepcopy(ns_instantiate)
1045 nsi_subnet_instantiate["title"] = "netslice subnet instantiation params input schema"
1046 nsi_subnet_instantiate["properties"]["id"] = name_schema
1047 del nsi_subnet_instantiate["required"]
1048
1049 nsi_vld_instantiate = {
1050     "title": "netslice vld instantiation params input schema",
1051     "$schema": "http://json-schema.org/draft-04/schema#",
1052     "type": "object",
1053     "properties": {
1054         "name": string_schema,
1055         "vim-network-name": {"oneOf": [string_schema, object_schema]},
1056         "vim-network-id": {"oneOf": [string_schema, object_schema]},
1057         "ip-profile": object_schema,
1058     },
1059     "required": ["name"],
1060     "additionalProperties": False,
1061 }
1062
1063 nsi_instantiate = {
1064     "title": "netslice action instantiate input schema",
1065     "$schema": "http://json-schema.org/draft-04/schema#",
1066     "type": "object",
1067     "properties": {
1068         "lcmOperationType": string_schema,
1069         "netsliceInstanceId": id_schema,
1070         "nsiName": name_schema,
1071         "nsiDescription": {"oneOf": [description_schema, null_schema]},
1072         "nstId": string_schema,
1073         "vimAccountId": id_schema,
1074         "timeout_nsi_deploy": integer1_schema,
1075         "ssh_keys": {"type": "array", "items": {"type": "string"}},
1076         "nsi_id": id_schema,
1077         "additionalParamsForNsi": object_schema,
1078         "netslice-subnet": {
1079             "type": "array",
1080             "minItems": 1,
1081             "items": nsi_subnet_instantiate,
1082         },
1083         "netslice-vld": {"type": "array", "minItems": 1, "items": nsi_vld_instantiate},
1084     },
1085     "required": ["nsiName", "nstId", "vimAccountId"],
1086     "additionalProperties": False,
1087 }
1088
1089 nsi_action = {}
1090
1091 nsi_terminate = {}
1092
1093 nsinstancesubscriptionfilter_schema = {
1094     "title": "instance identifier schema",
1095     "$schema": "http://json-schema.org/draft-07/schema#",
1096     "type": "object",
1097     "properties": {
1098         "nsdIds": {"type": "array"},
1099         "vnfdIds": {"type": "array"},
1100         "pnfdIds": {"type": "array"},
1101         "nsInstanceIds": {"type": "array"},
1102         "nsInstanceNames": {"type": "array"},
1103     },
1104 }
1105
1106 nslcmsub_schema = {
1107     "title": "nslcmsubscription input schema",
1108     "$schema": "http://json-schema.org/draft-07/schema#",
1109     "type": "object",
1110     "properties": {
1111         "nsInstanceSubscriptionFilter": nsinstancesubscriptionfilter_schema,
1112         "notificationTypes": {
1113             "type": "array",
1114             "items": {
1115                 "enum": [
1116                     "NsLcmOperationOccurrenceNotification",
1117                     "NsChangeNotification",
1118                     "NsIdentifierCreationNotification",
1119                     "NsIdentifierDeletionNotification",
1120                 ]
1121             },
1122         },
1123         "operationTypes": {
1124             "type": "array",
1125             "items": {"enum": ["INSTANTIATE", "SCALE", "TERMINATE", "UPDATE", "HEAL"]},
1126         },
1127         "operationStates": {
1128             "type": "array",
1129             "items": {
1130                 "enum": [
1131                     "PROCESSING",
1132                     "COMPLETED",
1133                     "PARTIALLY_COMPLETED",
1134                     "FAILED",
1135                     "FAILED_TEMP",
1136                     "ROLLING_BACK",
1137                     "ROLLED_BACK",
1138                 ]
1139             },
1140         },
1141         "nsComponentTypes": {"type": "array", "items": {"enum": ["VNF", "NS", "PNF"]}},
1142         "lcmOpNameImpactingNsComponent": {
1143             "type": "array",
1144             "items": {
1145                 "enum": [
1146                     "VNF_INSTANTIATE",
1147                     "VNF_SCALE",
1148                     "VNF_SCALE_TO_LEVEL",
1149                     "VNF_CHANGE_FLAVOUR",
1150                     "VNF_TERMINATE",
1151                     "VNF_HEAL",
1152                     "VNF_OPERATE",
1153                     "VNF_CHANGE_EXT_CONN",
1154                     "VNF_MODIFY_INFO",
1155                     "NS_INSTANTIATE",
1156                     "NS_SCALE",
1157                     "NS_UPDATE",
1158                     "NS_TERMINATE",
1159                     "NS_HEAL",
1160                 ]
1161             },
1162         },
1163         "lcmOpOccStatusImpactingNsComponent": {
1164             "type": "array",
1165             "items": {
1166                 "enum": [
1167                     "START",
1168                     "COMPLETED",
1169                     "PARTIALLY_COMPLETED",
1170                     "FAILED",
1171                     "ROLLED_BACK",
1172                 ]
1173             },
1174         },
1175     },
1176     "allOf": [
1177         {
1178             "if": {
1179                 "properties": {
1180                     "notificationTypes": {
1181                         "contains": {"const": "NsLcmOperationOccurrenceNotification"}
1182                     }
1183                 },
1184             },
1185             "then": {
1186                 "anyOf": [
1187                     {"required": ["operationTypes"]},
1188                     {"required": ["operationStates"]},
1189                 ]
1190             },
1191         },
1192         {
1193             "if": {
1194                 "properties": {
1195                     "notificationTypes": {"contains": {"const": "NsChangeNotification"}}
1196                 },
1197             },
1198             "then": {
1199                 "anyOf": [
1200                     {"required": ["nsComponentTypes"]},
1201                     {"required": ["lcmOpNameImpactingNsComponent"]},
1202                     {"required": ["lcmOpOccStatusImpactingNsComponent"]},
1203                 ]
1204             },
1205         },
1206     ],
1207 }
1208
1209 authentication_schema = {
1210     "title": "authentication schema for subscription",
1211     "$schema": "http://json-schema.org/draft-07/schema#",
1212     "type": "object",
1213     "properties": {
1214         "authType": {"enum": ["basic"]},
1215         "paramsBasic": {
1216             "type": "object",
1217             "properties": {
1218                 "userName": shortname_schema,
1219                 "password": passwd_schema,
1220             },
1221         },
1222     },
1223 }
1224
1225 subscription = {
1226     "title": "subscription input schema",
1227     "$schema": "http://json-schema.org/draft-07/schema#",
1228     "type": "object",
1229     "properties": {
1230         "filter": nslcmsub_schema,
1231         "CallbackUri": description_schema,
1232         "authentication": authentication_schema,
1233     },
1234     "required": ["CallbackUri"],
1235 }
1236
1237
1238 class ValidationError(Exception):
1239     def __init__(self, message, http_code=HTTPStatus.UNPROCESSABLE_ENTITY):
1240         self.http_code = http_code
1241         Exception.__init__(self, message)
1242
1243
1244 def validate_input(indata, schema_to_use):
1245     """
1246     Validates input data against json schema
1247     :param indata: user input data. Should be a dictionary
1248     :param schema_to_use: jsonschema to test
1249     :return: None if ok, raises ValidationError exception on error
1250     """
1251     try:
1252         if schema_to_use:
1253             js_v(indata, schema_to_use)
1254         return None
1255     except js_e.ValidationError as e:
1256         if e.path:
1257             error_pos = "at '" + ":".join(map(str, e.path)) + "'"
1258         else:
1259             error_pos = ""
1260         raise ValidationError("Format error {} '{}' ".format(error_pos, e.message))
1261     except js_e.SchemaError:
1262         raise ValidationError(
1263             "Bad json schema {}".format(schema_to_use),
1264             http_code=HTTPStatus.INTERNAL_SERVER_ERROR,
1265         )
1266
1267
1268 def is_valid_uuid(x):
1269     """
1270     Test for a valid UUID
1271     :param x: string to test
1272     :return: True if x is a valid uuid, False otherwise
1273     """
1274     try:
1275         if UUID(x):
1276             return True
1277     except (TypeError, ValueError, AttributeError):
1278         return False