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                         "kdu-deployment-name": name_schema,
 309                     },
 310                     "required": ["kdu_name"],
 311                     "minProperties": 2,
 312                     "additionalProperties": False,
 313                 },
 314             },
 315         },
 316         "required": ["member-vnf-index"],
 317         "minProperties": 2,
 318         "additionalProperties": False,
 319     },
 320 }
 321
 322 ns_instantiate = {
 323     "title": "ns action instantiate input schema",
 324     "$schema": "http://json-schema.org/draft-04/schema#",
 325     "type": "object",
 326     "properties": {
 327         "lcmOperationType": string_schema,
 328         "nsInstanceId": id_schema,
 329         "netsliceInstanceId": id_schema,
 330         "nsName": name_schema,
 331         "nsDescription": {"oneOf": [description_schema, null_schema]},
 332         "nsdId": id_schema,
 333         "vcaId": id_schema,
 334         "vimAccountId": id_schema,
 335         "wimAccountId": {"oneOf": [id_schema, bool_schema, null_schema]},
 336         "placement-engine": string_schema,
 337         "placement-constraints": object_schema,
 338         "additionalParamsForNs": object_schema,
 339         "additionalParamsForVnf": additional_params_for_vnf,
 340         "config-units": integer1_schema,  # number of configuration units of this ns, by default 1
 341         "k8s-namespace": name_schema,
 342         "ssh_keys": {"type": "array", "items": {"type": "string"}},
 343         "timeout_ns_deploy": integer1_schema,
 344         "nsr_id": id_schema,
 345         "vduImage": name_schema,
 346         "vnf": {
 347             "type": "array",
 348             "minItems": 1,
 349             "items": {
 350                 "type": "object",
 351                 "properties": {
 352                     "member-vnf-index": name_schema,
 353                     "vimAccountId": id_schema,
 354                     "vcaId": id_schema,
 355                     "vdu": {
 356                         "type": "array",
 357                         "minItems": 1,
 358                         "items": ns_instantiate_vdu,
 359                     },
 360                     "internal-vld": {
 361                         "type": "array",
 362                         "minItems": 1,
 363                         "items": ns_instantiate_internal_vld,
 364                     },
 365                 },
 366                 "required": ["member-vnf-index"],
 367                 "minProperties": 2,
 368                 "additionalProperties": False,
 369             },
 370         },
 371         "vld": {
 372             "type": "array",
 373             "minItems": 1,
 374             "items": {
 375                 "type": "object",
 376                 "properties": {
 377                     "name": string_schema,
 378                     "vim-network-name": {"oneOf": [string_schema, object_schema]},
 379                     "vim-network-id": {"oneOf": [string_schema, object_schema]},
 380                     "ns-net": object_schema,
 381                     "wimAccountId": {"oneOf": [id_schema, bool_schema, null_schema]},
 382                     "ip-profile": object_schema,
 383                     "provider-network": provider_network_schema,
 384                     "vnfd-connection-point-ref": {
 385                         "type": "array",
 386                         "minItems": 1,
 387                         "items": {
 388                             "type": "object",
 389                             "properties": {
 390                                 "member-vnf-index-ref": name_schema,
 391                                 "vnfd-connection-point-ref": name_schema,
 392                                 "ip-address": ip_schema,
 393                                 # "mac-address": mac_schema,
 394                             },
 395                             "required": [
 396                                 "member-vnf-index-ref",
 397                                 "vnfd-connection-point-ref",
 398                             ],
 399                             "minProperties": 3,
 400                             "additionalProperties": False,
 401                         },
 402                     },
 403                 },
 404                 "required": ["name"],
 405                 "additionalProperties": False,
 406             },
 407         },
 408     },
 409     "required": ["nsName", "nsdId", "vimAccountId"],
 410     "additionalProperties": False,
 411 }
 412
 413 ns_terminate = {
 414     "title": "ns terminate input schema",
 415     "$schema": "http://json-schema.org/draft-04/schema#",
 416     "type": "object",
 417     "properties": {
 418         "lcmOperationType": string_schema,
 419         "nsInstanceId": id_schema,
 420         "autoremove": bool_schema,
 421         "timeout_ns_terminate": integer1_schema,
 422         "skip_terminate_primitives": bool_schema,
 423         "netsliceInstanceId": id_schema,
 424     },
 425     "additionalProperties": False,
 426 }
 427
 428 ns_action = {  # TODO for the moment it is only contemplated the vnfd primitive execution
 429     "title": "ns action input schema",
 430     "$schema": "http://json-schema.org/draft-04/schema#",
 431     "type": "object",
 432     "properties": {
 433         "lcmOperationType": string_schema,
 434         "nsInstanceId": id_schema,
 435         "member_vnf_index": name_schema,
 436         "vnf_member_index": name_schema,  # TODO for backward compatibility. To remove in future
 437         "vdu_id": name_schema,
 438         "vdu_count_index": integer0_schema,
 439         "kdu_name": name_schema,
 440         "primitive": name_schema,
 441         "timeout_ns_action": integer1_schema,
 442         "primitive_params": {"type": "object"},
 443     },
 444     "required": ["primitive", "primitive_params"],  # TODO add member_vnf_index
 445     "additionalProperties": False,
 446 }
 447 ns_scale = {  # TODO for the moment it is only VDU-scaling
 448     "title": "ns scale input schema",
 449     "$schema": "http://json-schema.org/draft-04/schema#",
 450     "type": "object",
 451     "properties": {
 452         "lcmOperationType": string_schema,
 453         "nsInstanceId": id_schema,
 454         "scaleType": {"enum": ["SCALE_VNF"]},
 455         "timeout_ns_scale": integer1_schema,
 456         "scaleVnfData": {
 457             "type": "object",
 458             "properties": {
 459                 "vnfInstanceId": name_schema,
 460                 "scaleVnfType": {"enum": ["SCALE_OUT", "SCALE_IN"]},
 461                 "scaleByStepData": {
 462                     "type": "object",
 463                     "properties": {
 464                         "scaling-group-descriptor": name_schema,
 465                         "member-vnf-index": name_schema,
 466                         "scaling-policy": name_schema,
 467                     },
 468                     "required": ["scaling-group-descriptor", "member-vnf-index"],
 469                     "additionalProperties": False,
 470                 },
 471             },
 472             "required": ["scaleVnfType", "scaleByStepData"],  # vnfInstanceId
 473             "additionalProperties": False,
 474         },
 475         "scaleTime": time_schema,
 476     },
 477     "required": ["scaleType", "scaleVnfData"],
 478     "additionalProperties": False,
 479 }
 480
 481
 482 schema_version = {"type": "string", "enum": ["1.0"]}
 483 schema_type = {"type": "string"}
 484 vim_type = shortname_schema  # {"enum": ["openstack", "openvim", "vmware", "opennebula", "aws", "azure", "fos"]}
 485
 486 vim_account_edit_schema = {
 487     "title": "vim_account edit input schema",
 488     "$schema": "http://json-schema.org/draft-04/schema#",
 489     "type": "object",
 490     "properties": {
 491         "name": name_schema,
 492         "description": description_schema,
 493         "vim": name_schema,
 494         "datacenter": name_schema,
 495         "vim_type": vim_type,
 496         "vim_url": description_schema,
 497         # "vim_url_admin": description_schema,
 498         # "vim_tenant": name_schema,
 499         "vim_tenant_name": name_schema,
 500         "vim_user": shortname_schema,
 501         "vim_password": passwd_schema,
 502         "vca": id_schema,
 503         "config": {"type": "object"},
 504     },
 505     "additionalProperties": False,
 506 }
 507
 508 vim_account_new_schema = {
 509     "title": "vim_account creation input schema",
 510     "$schema": "http://json-schema.org/draft-04/schema#",
 511     "type": "object",
 512     "properties": {
 513         "schema_version": schema_version,
 514         "schema_type": schema_type,
 515         "name": name_schema,
 516         "description": description_schema,
 517         "vim": name_schema,
 518         "datacenter": name_schema,
 519         "vim_type": vim_type,
 520         "vim_url": description_schema,
 521         # "vim_url_admin": description_schema,
 522         # "vim_tenant": name_schema,
 523         "vim_tenant_name": name_schema,
 524         "vim_user": shortname_schema,
 525         "vim_password": passwd_schema,
 526         "vca": id_schema,
 527         "config": {"type": "object"},
 528     },
 529     "required": [
 530         "name",
 531         "vim_url",
 532         "vim_type",
 533         "vim_user",
 534         "vim_password",
 535         "vim_tenant_name",
 536     ],
 537     "additionalProperties": False,
 538 }
 539
 540 wim_type = shortname_schema  # {"enum": ["ietfl2vpn", "onos", "odl", "dynpac", "fake"]}
 541
 542 wim_account_edit_schema = {
 543     "title": "wim_account edit input schema",
 544     "$schema": "http://json-schema.org/draft-04/schema#",
 545     "type": "object",
 546     "properties": {
 547         "name": name_schema,
 548         "description": description_schema,
 549         "wim": name_schema,
 550         "wim_type": wim_type,
 551         "wim_url": description_schema,
 552         "user": shortname_schema,
 553         "password": passwd_schema,
 554         "config": {"type": "object"},
 555     },
 556     "additionalProperties": False,
 557 }
 558
 559 wim_account_new_schema = {
 560     "title": "wim_account creation input schema",
 561     "$schema": "http://json-schema.org/draft-04/schema#",
 562     "type": "object",
 563     "properties": {
 564         "schema_version": schema_version,
 565         "schema_type": schema_type,
 566         "name": name_schema,
 567         "description": description_schema,
 568         "wim": name_schema,
 569         "wim_type": wim_type,
 570         "wim_url": description_schema,
 571         "user": shortname_schema,
 572         "password": passwd_schema,
 573         "config": {
 574             "type": "object",
 575             "patternProperties": {".": {"not": {"type": "null"}}},
 576         },
 577     },
 578     "required": ["name", "wim_url", "wim_type"],
 579     "additionalProperties": False,
 580 }
 581
 582 sdn_properties = {
 583     "name": name_schema,
 584     "type": {"type": "string"},
 585     "url": {"type": "string"},
 586     "user": shortname_schema,
 587     "password": passwd_schema,
 588     "config": {"type": "object"},
 589     "description": description_schema,
 590     # The folowing are deprecated. Maintanied for backward compatibility
 591     "dpid": dpid_Schema,
 592     "ip": ip_schema,
 593     "port": port_schema,
 594     "version": {"type": "string", "minLength": 1, "maxLength": 12},
 595 }
 596 sdn_new_schema = {
 597     "title": "sdn controller information schema",
 598     "$schema": "http://json-schema.org/draft-04/schema#",
 599     "type": "object",
 600     "properties": sdn_properties,
 601     "required": ["name", "type"],
 602     "additionalProperties": False,
 603 }
 604 sdn_edit_schema = {
 605     "title": "sdn controller update information schema",
 606     "$schema": "http://json-schema.org/draft-04/schema#",
 607     "type": "object",
 608     "properties": sdn_properties,
 609     # "required": ["name", "port", 'ip', 'dpid', 'type'],
 610     "additionalProperties": False,
 611 }
 612 sdn_port_mapping_schema = {
 613     "$schema": "http://json-schema.org/draft-04/schema#",
 614     "title": "sdn port mapping information schema",
 615     "type": "array",
 616     "items": {
 617         "type": "object",
 618         "properties": {
 619             "compute_node": shortname_schema,
 620             "ports": {
 621                 "type": "array",
 622                 "items": {
 623                     "type": "object",
 624                     "properties": {
 625                         "pci": pci_extended_schema,
 626                         "switch_port": shortname_schema,
 627                         "switch_mac": mac_schema,
 628                     },
 629                     "required": ["pci"],
 630                 },
 631             },
 632         },
 633         "required": ["compute_node", "ports"],
 634     },
 635 }
 636 sdn_external_port_schema = {
 637     "$schema": "http://json-schema.org/draft-04/schema#",
 638     "title": "External port information",
 639     "type": "object",
 640     "properties": {
 641         "port": {"type": "string", "minLength": 1, "maxLength": 60},
 642         "vlan": vlan_schema,
 643         "mac": mac_schema,
 644     },
 645     "required": ["port"],
 646 }
 647
 648 # K8s Clusters
 649 k8scluster_nets_schema = {
 650     "title": "k8scluster nets input schema",
 651     "$schema": "http://json-schema.org/draft-04/schema#",
 652     "type": "object",
 653     "patternProperties": {".": {"oneOf": [name_schema, null_schema]}},
 654     "minProperties": 1,
 655     "additionalProperties": False,
 656 }
 657 k8scluster_new_schema = {
 658     "title": "k8scluster creation input schema",
 659     "$schema": "http://json-schema.org/draft-04/schema#",
 660     "type": "object",
 661     "properties": {
 662         "schema_version": schema_version,
 663         "schema_type": schema_type,
 664         "name": name_schema,
 665         "description": description_schema,
 666         "credentials": object_schema,
 667         "vim_account": id_schema,
 668         "vca_id": id_schema,
 669         "k8s_version": string_schema,
 670         "nets": k8scluster_nets_schema,
 671         "namespace": name_schema,
 672         "cni": nameshort_list_schema,
 673     },
 674     "required": ["name", "credentials", "vim_account", "k8s_version", "nets"],
 675     "additionalProperties": False,
 676 }
 677 k8scluster_edit_schema = {
 678     "title": "vim_account edit input schema",
 679     "$schema": "http://json-schema.org/draft-04/schema#",
 680     "type": "object",
 681     "properties": {
 682         "name": name_schema,
 683         "description": description_schema,
 684         "credentials": object_schema,
 685         "vim_account": id_schema,
 686         "vca_id": id_schema,
 687         "k8s_version": string_schema,
 688         "nets": k8scluster_nets_schema,
 689         "namespace": name_schema,
 690         "cni": nameshort_list_schema,
 691     },
 692     "additionalProperties": False,
 693 }
 694
 695 # VCA
 696 vca_new_schema = {
 697     "title": "vca creation input schema",
 698     "$schema": "http://json-schema.org/draft-04/schema#",
 699     "type": "object",
 700     "properties": {
 701         "schema_version": schema_version,
 702         "schema_type": schema_type,
 703         "name": name_schema,
 704         "description": description_schema,
 705         "endpoints": description_list_schema,
 706         "user": shortname_schema,
 707         "secret": passwd_schema,
 708         "cacert": long_description_schema,
 709         "lxd-cloud": shortname_schema,
 710         "lxd-credentials": shortname_schema,
 711         "k8s-cloud": shortname_schema,
 712         "k8s-credentials": shortname_schema,
 713         "model-config": object_schema,
 714     },
 715     "required": [
 716         "name",
 717         "endpoints",
 718         "user",
 719         "secret",
 720         "cacert",
 721         "lxd-cloud",
 722         "lxd-credentials",
 723         "k8s-cloud",
 724         "k8s-credentials",
 725     ],
 726     "additionalProperties": False,
 727 }
 728 vca_edit_schema = {
 729     "title": "vca creation input schema",
 730     "$schema": "http://json-schema.org/draft-04/schema#",
 731     "type": "object",
 732     "properties": {
 733         "name": name_schema,
 734         "description": description_schema,
 735         "endpoints": description_list_schema,
 736         "port": integer1_schema,
 737         "user": shortname_schema,
 738         "secret": passwd_schema,
 739         "cacert": long_description_schema,
 740         "lxd-cloud": shortname_schema,
 741         "lxd-credentials": shortname_schema,
 742         "k8s-cloud": shortname_schema,
 743         "k8s-credentials": shortname_schema,
 744         "model-config": object_schema,
 745     },
 746     "additionalProperties": False,
 747 }
 748
 749 # K8s Repos
 750 k8srepo_types = {"enum": ["helm-chart", "juju-bundle"]}
 751 k8srepo_properties = {
 752     "name": name_schema,
 753     "description": description_schema,
 754     "type": k8srepo_types,
 755     "url": description_schema,
 756 }
 757 k8srepo_new_schema = {
 758     "title": "k8scluster creation input schema",
 759     "$schema": "http://json-schema.org/draft-04/schema#",
 760     "type": "object",
 761     "properties": k8srepo_properties,
 762     "required": ["name", "type", "url"],
 763     "additionalProperties": False,
 764 }
 765 k8srepo_edit_schema = {
 766     "title": "vim_account edit input schema",
 767     "$schema": "http://json-schema.org/draft-04/schema#",
 768     "type": "object",
 769     "properties": k8srepo_properties,
 770     "additionalProperties": False,
 771 }
 772
 773 # OSM Repos
 774 osmrepo_types = {"enum": ["osm"]}
 775 osmrepo_properties = {
 776     "name": name_schema,
 777     "description": description_schema,
 778     "type": osmrepo_types,
 779     "url": description_schema
 780     # "user": shortname_schema,
 781     # "password": passwd_schema
 782 }
 783 osmrepo_new_schema = {
 784     "title": "osm repo creation input schema",
 785     "$schema": "http://json-schema.org/draft-04/schema#",
 786     "type": "object",
 787     "properties": osmrepo_properties,
 788     "required": ["name", "type", "url"],
 789     "additionalProperties": False,
 790 }
 791 osmrepo_edit_schema = {
 792     "title": "osm repo edit input schema",
 793     "$schema": "http://json-schema.org/draft-04/schema#",
 794     "type": "object",
 795     "properties": osmrepo_properties,
 796     "additionalProperties": False,
 797 }
 798
 799 # PDUs
 800 pdu_interface = {
 801     "type": "object",
 802     "properties": {
 803         "name": shortname_schema,
 804         "mgmt": bool_schema,
 805         "type": {"enum": ["overlay", "underlay"]},
 806         "ip-address": ip_schema,
 807         # TODO, add user, password, ssh-key
 808         "mac-address": mac_schema,
 809         "vim-network-name": shortname_schema,  # interface is connected to one vim network, or switch port
 810         "vim-network-id": shortname_schema,
 811         # # provide this in case SDN assist must deal with this interface
 812         # "switch-dpid": dpid_Schema,
 813         # "switch-port": shortname_schema,
 814         # "switch-mac": shortname_schema,
 815         # "switch-vlan": vlan_schema,
 816     },
 817     "required": ["name", "mgmt", "ip-address"],
 818     "additionalProperties": False,
 819 }
 820 pdu_new_schema = {
 821     "title": "pdu creation input schema",
 822     "$schema": "http://json-schema.org/draft-04/schema#",
 823     "type": "object",
 824     "properties": {
 825         "name": shortname_schema,
 826         "type": shortname_schema,
 827         "description": description_schema,
 828         "shared": bool_schema,
 829         "vims": nameshort_list_schema,
 830         "vim_accounts": nameshort_list_schema,
 831         "interfaces": {"type": "array", "items": pdu_interface, "minItems": 1},
 832     },
 833     "required": ["name", "type", "interfaces"],
 834     "additionalProperties": False,
 835 }
 836 pdu_edit_schema = {
 837     "title": "pdu edit input schema",
 838     "$schema": "http://json-schema.org/draft-04/schema#",
 839     "type": "object",
 840     "properties": {
 841         "name": shortname_schema,
 842         "type": shortname_schema,
 843         "description": description_schema,
 844         "shared": bool_schema,
 845         "vims": {"oneOf": [array_edition_schema, nameshort_list_schema]},
 846         "vim_accounts": {"oneOf": [array_edition_schema, nameshort_list_schema]},
 847         "interfaces": {
 848             "oneOf": [
 849                 array_edition_schema,
 850                 {"type": "array", "items": pdu_interface, "minItems": 1},
 851             ]
 852         },
 853     },
 854     "additionalProperties": False,
 855     "minProperties": 1,
 856 }
 857
 858 # VNF PKG OPERATIONS
 859 vnfpkgop_new_schema = {
 860     "title": "VNF PKG operation creation input schema",
 861     "$schema": "http://json-schema.org/draft-04/schema#",
 862     "type": "object",
 863     "properties": {
 864         "lcmOperationType": string_schema,
 865         "vnfPkgId": id_schema,
 866         "kdu_name": name_schema,
 867         "primitive": name_schema,
 868         "primitive_params": {"type": "object"},
 869     },
 870     "required": [
 871         "lcmOperationType",
 872         "vnfPkgId",
 873         "kdu_name",
 874         "primitive",
 875         "primitive_params",
 876     ],
 877     "additionalProperties": False,
 878 }
 879
 880 # USERS
 881 project_role_mappings = {
 882     "title": "list pf projects/roles",
 883     "$schema": "http://json-schema.org/draft-04/schema#",
 884     "type": "array",
 885     "items": {
 886         "type": "object",
 887         "properties": {"project": shortname_schema, "role": shortname_schema},
 888         "required": ["project", "role"],
 889         "additionalProperties": False,
 890     },
 891     "minItems": 1,
 892 }
 893 project_role_mappings_optional = {
 894     "title": "list of projects/roles or projects only",
 895     "$schema": "http://json-schema.org/draft-04/schema#",
 896     "type": "array",
 897     "items": {
 898         "type": "object",
 899         "properties": {"project": shortname_schema, "role": shortname_schema},
 900         "required": ["project"],
 901         "additionalProperties": False,
 902     },
 903     "minItems": 1,
 904 }
 905 user_new_schema = {
 906     "$schema": "http://json-schema.org/draft-04/schema#",
 907     "title": "New user schema",
 908     "type": "object",
 909     "properties": {
 910         "username": shortname_schema,
 911         "domain_name": shortname_schema,
 912         "password": passwd_schema,
 913         "projects": nameshort_list_schema,
 914         "project_role_mappings": project_role_mappings,
 915     },
 916     "required": ["username", "password"],
 917     "additionalProperties": False,
 918 }
 919 user_edit_schema = {
 920     "$schema": "http://json-schema.org/draft-04/schema#",
 921     "title": "User edit schema for administrators",
 922     "type": "object",
 923     "properties": {
 924         "password": passwd_schema,
 925         "username": shortname_schema,  # To allow User Name modification
 926         "projects": {"oneOf": [nameshort_list_schema, array_edition_schema]},
 927         "project_role_mappings": project_role_mappings,
 928         "add_project_role_mappings": project_role_mappings,
 929         "remove_project_role_mappings": project_role_mappings_optional,
 930     },
 931     "minProperties": 1,
 932     "additionalProperties": False,
 933 }
 934
 935 # PROJECTS
 936 topics_with_quota = [
 937     "vnfds",
 938     "nsds",
 939     "slice_templates",
 940     "pduds",
 941     "ns_instances",
 942     "slice_instances",
 943     "vim_accounts",
 944     "wim_accounts",
 945     "sdn_controllers",
 946     "k8sclusters",
 947     "vca",
 948     "k8srepos",
 949     "osmrepos",
 950     "ns_subscriptions",
 951 ]
 952 project_new_schema = {
 953     "$schema": "http://json-schema.org/draft-04/schema#",
 954     "title": "New project schema for administrators",
 955     "type": "object",
 956     "properties": {
 957         "name": shortname_schema,
 958         "admin": bool_schema,
 959         "domain_name": shortname_schema,
 960         "quotas": {
 961             "type": "object",
 962             "properties": {topic: integer0_schema for topic in topics_with_quota},
 963             "additionalProperties": False,
 964         },
 965     },
 966     "required": ["name"],
 967     "additionalProperties": False,
 968 }
 969 project_edit_schema = {
 970     "$schema": "http://json-schema.org/draft-04/schema#",
 971     "title": "Project edit schema for administrators",
 972     "type": "object",
 973     "properties": {
 974         "admin": bool_schema,
 975         "name": shortname_schema,  # To allow Project Name modification
 976         "quotas": {
 977             "type": "object",
 978             "properties": {
 979                 topic: {"oneOf": [integer0_schema, null_schema]}
 980                 for topic in topics_with_quota
 981             },
 982             "additionalProperties": False,
 983         },
 984     },
 985     "additionalProperties": False,
 986     "minProperties": 1,
 987 }
 988
 989 # ROLES
 990 roles_new_schema = {
 991     "$schema": "http://json-schema.org/draft-04/schema#",
 992     "title": "New role schema for administrators",
 993     "type": "object",
 994     "properties": {
 995         "name": shortname_schema,
 996         "permissions": {
 997             "type": "object",
 998             "patternProperties": {
 999                 ".": bool_schema,
1000             },
1001             # "minProperties": 1,
1002         },
1003     },
1004     "required": ["name"],
1005     "additionalProperties": False,
1006 }
1007 roles_edit_schema = {
1008     "$schema": "http://json-schema.org/draft-04/schema#",
1009     "title": "Roles edit schema for administrators",
1010     "type": "object",
1011     "properties": {
1012         "name": shortname_schema,
1013         "permissions": {
1014             "type": "object",
1015             "patternProperties": {".": {"oneOf": [bool_schema, null_schema]}},
1016             # "minProperties": 1,
1017         },
1018     },
1019     "additionalProperties": False,
1020     "minProperties": 1,
1021 }
1022
1023 # GLOBAL SCHEMAS
1024
1025 nbi_new_input_schemas = {
1026     "users": user_new_schema,
1027     "projects": project_new_schema,
1028     "vim_accounts": vim_account_new_schema,
1029     "sdns": sdn_new_schema,
1030     "ns_instantiate": ns_instantiate,
1031     "ns_action": ns_action,
1032     "ns_scale": ns_scale,
1033     "pdus": pdu_new_schema,
1034 }
1035
1036 nbi_edit_input_schemas = {
1037     "users": user_edit_schema,
1038     "projects": project_edit_schema,
1039     "vim_accounts": vim_account_edit_schema,
1040     "sdns": sdn_edit_schema,
1041     "pdus": pdu_edit_schema,
1042 }
1043
1044 # NETSLICE SCHEMAS
1045 nsi_subnet_instantiate = deepcopy(ns_instantiate)
1046 nsi_subnet_instantiate["title"] = "netslice subnet instantiation params input schema"
1047 nsi_subnet_instantiate["properties"]["id"] = name_schema
1048 del nsi_subnet_instantiate["required"]
1049
1050 nsi_vld_instantiate = {
1051     "title": "netslice vld instantiation params input schema",
1052     "$schema": "http://json-schema.org/draft-04/schema#",
1053     "type": "object",
1054     "properties": {
1055         "name": string_schema,
1056         "vim-network-name": {"oneOf": [string_schema, object_schema]},
1057         "vim-network-id": {"oneOf": [string_schema, object_schema]},
1058         "ip-profile": object_schema,
1059     },
1060     "required": ["name"],
1061     "additionalProperties": False,
1062 }
1063
1064 nsi_instantiate = {
1065     "title": "netslice action instantiate input schema",
1066     "$schema": "http://json-schema.org/draft-04/schema#",
1067     "type": "object",
1068     "properties": {
1069         "lcmOperationType": string_schema,
1070         "netsliceInstanceId": id_schema,
1071         "nsiName": name_schema,
1072         "nsiDescription": {"oneOf": [description_schema, null_schema]},
1073         "nstId": string_schema,
1074         "vimAccountId": id_schema,
1075         "timeout_nsi_deploy": integer1_schema,
1076         "ssh_keys": {"type": "array", "items": {"type": "string"}},
1077         "nsi_id": id_schema,
1078         "additionalParamsForNsi": object_schema,
1079         "netslice-subnet": {
1080             "type": "array",
1081             "minItems": 1,
1082             "items": nsi_subnet_instantiate,
1083         },
1084         "netslice-vld": {"type": "array", "minItems": 1, "items": nsi_vld_instantiate},
1085     },
1086     "required": ["nsiName", "nstId", "vimAccountId"],
1087     "additionalProperties": False,
1088 }
1089
1090 nsi_action = {}
1091
1092 nsi_terminate = {}
1093
1094 nsinstancesubscriptionfilter_schema = {
1095     "title": "instance identifier schema",
1096     "$schema": "http://json-schema.org/draft-07/schema#",
1097     "type": "object",
1098     "properties": {
1099         "nsdIds": {"type": "array"},
1100         "vnfdIds": {"type": "array"},
1101         "pnfdIds": {"type": "array"},
1102         "nsInstanceIds": {"type": "array"},
1103         "nsInstanceNames": {"type": "array"},
1104     },
1105 }
1106
1107 nslcmsub_schema = {
1108     "title": "nslcmsubscription input schema",
1109     "$schema": "http://json-schema.org/draft-07/schema#",
1110     "type": "object",
1111     "properties": {
1112         "nsInstanceSubscriptionFilter": nsinstancesubscriptionfilter_schema,
1113         "notificationTypes": {
1114             "type": "array",
1115             "items": {
1116                 "enum": [
1117                     "NsLcmOperationOccurrenceNotification",
1118                     "NsChangeNotification",
1119                     "NsIdentifierCreationNotification",
1120                     "NsIdentifierDeletionNotification",
1121                 ]
1122             },
1123         },
1124         "operationTypes": {
1125             "type": "array",
1126             "items": {"enum": ["INSTANTIATE", "SCALE", "TERMINATE", "UPDATE", "HEAL"]},
1127         },
1128         "operationStates": {
1129             "type": "array",
1130             "items": {
1131                 "enum": [
1132                     "PROCESSING",
1133                     "COMPLETED",
1134                     "PARTIALLY_COMPLETED",
1135                     "FAILED",
1136                     "FAILED_TEMP",
1137                     "ROLLING_BACK",
1138                     "ROLLED_BACK",
1139                 ]
1140             },
1141         },
1142         "nsComponentTypes": {"type": "array", "items": {"enum": ["VNF", "NS", "PNF"]}},
1143         "lcmOpNameImpactingNsComponent": {
1144             "type": "array",
1145             "items": {
1146                 "enum": [
1147                     "VNF_INSTANTIATE",
1148                     "VNF_SCALE",
1149                     "VNF_SCALE_TO_LEVEL",
1150                     "VNF_CHANGE_FLAVOUR",
1151                     "VNF_TERMINATE",
1152                     "VNF_HEAL",
1153                     "VNF_OPERATE",
1154                     "VNF_CHANGE_EXT_CONN",
1155                     "VNF_MODIFY_INFO",
1156                     "NS_INSTANTIATE",
1157                     "NS_SCALE",
1158                     "NS_UPDATE",
1159                     "NS_TERMINATE",
1160                     "NS_HEAL",
1161                 ]
1162             },
1163         },
1164         "lcmOpOccStatusImpactingNsComponent": {
1165             "type": "array",
1166             "items": {
1167                 "enum": [
1168                     "START",
1169                     "COMPLETED",
1170                     "PARTIALLY_COMPLETED",
1171                     "FAILED",
1172                     "ROLLED_BACK",
1173                 ]
1174             },
1175         },
1176     },
1177     "allOf": [
1178         {
1179             "if": {
1180                 "properties": {
1181                     "notificationTypes": {
1182                         "contains": {"const": "NsLcmOperationOccurrenceNotification"}
1183                     }
1184                 },
1185             },
1186             "then": {
1187                 "anyOf": [
1188                     {"required": ["operationTypes"]},
1189                     {"required": ["operationStates"]},
1190                 ]
1191             },
1192         },
1193         {
1194             "if": {
1195                 "properties": {
1196                     "notificationTypes": {"contains": {"const": "NsChangeNotification"}}
1197                 },
1198             },
1199             "then": {
1200                 "anyOf": [
1201                     {"required": ["nsComponentTypes"]},
1202                     {"required": ["lcmOpNameImpactingNsComponent"]},
1203                     {"required": ["lcmOpOccStatusImpactingNsComponent"]},
1204                 ]
1205             },
1206         },
1207     ],
1208 }
1209
1210 authentication_schema = {
1211     "title": "authentication schema for subscription",
1212     "$schema": "http://json-schema.org/draft-07/schema#",
1213     "type": "object",
1214     "properties": {
1215         "authType": {"enum": ["basic"]},
1216         "paramsBasic": {
1217             "type": "object",
1218             "properties": {
1219                 "userName": shortname_schema,
1220                 "password": passwd_schema,
1221             },
1222         },
1223     },
1224 }
1225
1226 subscription = {
1227     "title": "subscription input schema",
1228     "$schema": "http://json-schema.org/draft-07/schema#",
1229     "type": "object",
1230     "properties": {
1231         "filter": nslcmsub_schema,
1232         "CallbackUri": description_schema,
1233         "authentication": authentication_schema,
1234     },
1235     "required": ["CallbackUri"],
1236 }
1237
1238
1239 class ValidationError(Exception):
1240     def __init__(self, message, http_code=HTTPStatus.UNPROCESSABLE_ENTITY):
1241         self.http_code = http_code
1242         Exception.__init__(self, message)
1243
1244
1245 def validate_input(indata, schema_to_use):
1246     """
1247     Validates input data against json schema
1248     :param indata: user input data. Should be a dictionary
1249     :param schema_to_use: jsonschema to test
1250     :return: None if ok, raises ValidationError exception on error
1251     """
1252     try:
1253         if schema_to_use:
1254             js_v(indata, schema_to_use)
1255         return None
1256     except js_e.ValidationError as e:
1257         if e.path:
1258             error_pos = "at '" + ":".join(map(str, e.path)) + "'"
1259         else:
1260             error_pos = ""
1261         raise ValidationError("Format error {} '{}' ".format(error_pos, e.message))
1262     except js_e.SchemaError:
1263         raise ValidationError(
1264             "Bad json schema {}".format(schema_to_use),
1265             http_code=HTTPStatus.INTERNAL_SERVER_ERROR,
1266         )
1267
1268
1269 def is_valid_uuid(x):
1270     """
1271     Test for a valid UUID
1272     :param x: string to test
1273     :return: True if x is a valid uuid, False otherwise
1274     """
1275     try:
1276         if UUID(x):
1277             return True
1278     except (TypeError, ValueError, AttributeError):
1279         return False