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