X-Git-Url: https://osm.etsi.org/gitweb/?p=osm%2FNBI.git;a=blobdiff_plain;f=osm_nbi%2Fvalidation.py;h=ba2451b93f0b39081390575397422d37055d7201;hp=4ffd0b785e7357e045caee78855e78f9553d50ac;hb=044f4317e21a4bb0d6a4a50c8a99a94ed35b8e3f;hpb=cd54a4add397e6f0921a77e97444d32c7a748975 diff --git a/osm_nbi/validation.py b/osm_nbi/validation.py index 4ffd0b7..ba2451b 100644 --- a/osm_nbi/validation.py +++ b/osm_nbi/validation.py @@ -1,6 +1,22 @@ # -*- coding: utf-8 -*- +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +# implied. +# See the License for the specific language governing permissions and +# limitations under the License. + from jsonschema import validate as js_v, exceptions as js_e +from http import HTTPStatus +from copy import deepcopy +from uuid import UUID # To test for valid UUID __author__ = "Alfonso Tierno " __version__ = "0.1" @@ -12,7 +28,7 @@ Validator of input data using JSON schemas for those items that not contains an # Basis schemas patern_name = "^[ -~]+$" -nameshort_schema = {"type": "string", "minLength": 1, "maxLength": 60, "pattern": "^[^,;()\.\$'\"]+$"} +shortname_schema = {"type": "string", "minLength": 1, "maxLength": 60, "pattern": "^[^,;()\\.\\$'\"]+$"} passwd_schema = {"type": "string", "minLength": 1, "maxLength": 60} name_schema = {"type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[^,;()'\"]+$"} string_schema = {"type": "string", "minLength": 1, "maxLength": 255} @@ -24,22 +40,25 @@ null_schema = {"type": "null"} # "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}$" id_schema = {"type": "string", "pattern": "^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$"} time_schema = {"type": "string", "pattern": "^[0-9]{4}-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]([0-5]:){2}"} -pci_schema = {"type": "string", "pattern": "^[0-9a-fA-F]{4}(:[0-9a-fA-F]{2}){2}\.[0-9a-fA-F]$"} +pci_schema = {"type": "string", "pattern": "^[0-9a-fA-F]{4}(:[0-9a-fA-F]{2}){2}\\.[0-9a-fA-F]$"} +# allows [] for wildcards. For that reason huge length limit is set +pci_extended_schema = {"type": "string", "pattern": "^[0-9a-fA-F.:-\\[\\]]{12,40}$"} http_schema = {"type": "string", "pattern": "^https?://[^'\"=]+$"} bandwidth_schema = {"type": "string", "pattern": "^[0-9]+ *([MG]bps)?$"} memory_schema = {"type": "string", "pattern": "^[0-9]+ *([MG]i?[Bb])?$"} integer0_schema = {"type": "integer", "minimum": 0} integer1_schema = {"type": "integer", "minimum": 1} -path_schema = {"type": "string", "pattern": "^(\.){0,2}(/[^/\"':{}\(\)]+)+$"} +path_schema = {"type": "string", "pattern": "^(\\.){0,2}(/[^/\"':{}\\(\\)]+)+$"} vlan_schema = {"type": "integer", "minimum": 1, "maximum": 4095} vlan1000_schema = {"type": "integer", "minimum": 1000, "maximum": 4095} mac_schema = {"type": "string", "pattern": "^[0-9a-fA-F][02468aceACE](:[0-9a-fA-F]{2}){5}$"} # must be unicast: LSB bit of MSB byte ==0 +dpid_Schema = {"type": "string", "pattern": "^[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){7}$"} # mac_schema={"type":"string", "pattern":"^([0-9a-fA-F]{2}:){5}[0-9a-fA-F]{2}$"} ip_schema = {"type": "string", - "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]?)$"} + "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]?)$"} ip_prefix_schema = {"type": "string", - "pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}" + "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]?)/(30|[12]?[0-9])$"} port_schema = {"type": "integer", "minimum": 1, "maximum": 65534} object_schema = {"type": "object"} @@ -51,11 +70,16 @@ size_schema = {"type": "integer", "minimum": 1, "maximum": 100} array_edition_schema = { "type": "object", "patternProperties": { - "^\$": "Any" + "^\\$": {} }, "additionalProperties": False, "minProperties": 1, } +nameshort_list_schema = { + "type": "array", + "minItems": 1, + "items": shortname_schema, +} ns_instantiate_vdu = { @@ -155,6 +179,7 @@ ns_instantiate_internal_vld = { "properties": { "name": name_schema, "vim-network-name": name_schema, + "vim-network-id": name_schema, "ip-profile": ip_profile_update_schema, "internal-connection-point": { "type": "array", @@ -177,17 +202,38 @@ ns_instantiate_internal_vld = { "additionalProperties": False } +additional_params_for_vnf = { + "type": "array", + "items": { + "type": "object", + "properties": { + "member-vnf-index": name_schema, + "additionalParams": object_schema, + }, + "required": ["member-vnf-index", "additionalParams"], + "additionalProperties": False + } + +} + ns_instantiate = { "title": "ns action instantiate input schema", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { + "lcmOperationType": string_schema, + "nsInstanceId": id_schema, + "netsliceInstanceId": id_schema, "nsName": name_schema, - "nsDescription": {"oneOf": [description_schema, {"type": "null"}]}, + "nsDescription": {"oneOf": [description_schema, null_schema]}, "nsdId": id_schema, "vimAccountId": id_schema, - "ssh_keys": {"type": "string"}, + "wimAccountId": {"OneOf": [id_schema, bool_schema, null_schema]}, + "additionalParamsForNs": object_schema, + "additionalParamsForVnf": additional_params_for_vnf, + "ssh_keys": {"type": "array", "items": {"type": "string"}}, "nsr_id": id_schema, + "vduImage": name_schema, "vnf": { "type": "array", "minItems": 1, @@ -220,6 +266,9 @@ ns_instantiate = { "properties": { "name": string_schema, "vim-network-name": {"OneOf": [string_schema, object_schema]}, + "vim-network-id": {"OneOf": [string_schema, object_schema]}, + "ns-net": object_schema, + "wimAccountId": {"OneOf": [id_schema, bool_schema, null_schema]}, "ip-profile": object_schema, "vnfd-connection-point-ref": { "type": "array", @@ -252,9 +301,12 @@ ns_action = { # TODO for the moment it is only contemplated the vnfd primitive "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { + "lcmOperationType": string_schema, + "nsInstanceId": id_schema, "member_vnf_index": name_schema, "vnf_member_index": name_schema, # TODO for backward compatibility. To remove in future "vdu_id": name_schema, + "vdu_count_index": integer0_schema, "primitive": name_schema, "primitive_params": {"type": "object"}, }, @@ -266,6 +318,8 @@ ns_scale = { # TODO for the moment it is only VDU-scaling "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { + "lcmOperationType": string_schema, + "nsInstanceId": id_schema, "scaleType": {"enum": ["SCALE_VNF"]}, "scaleVnfData": { "type": "object", @@ -294,6 +348,7 @@ ns_scale = { # TODO for the moment it is only VDU-scaling schema_version = {"type": "string", "enum": ["1.0"]} +schema_type = {"type": "string"} vim_account_edit_schema = { "title": "vim_account edit input schema", "$schema": "http://json-schema.org/draft-04/schema#", @@ -301,20 +356,19 @@ vim_account_edit_schema = { "properties": { "name": name_schema, "description": description_schema, - "type": nameshort_schema, # currently "openvim" or "openstack", can be enlarged with plugins + "type": shortname_schema, "vim": name_schema, "datacenter": name_schema, "vim_url": description_schema, "vim_url_admin": description_schema, "vim_tenant": name_schema, "vim_tenant_name": name_schema, - "vim_username": nameshort_schema, + "vim_username": shortname_schema, "vim_password": passwd_schema, "config": {"type": "object"} }, "additionalProperties": False } -schema_type = {"type": "string"} vim_account_new_schema = { "title": "vim_account creation input schema", @@ -327,12 +381,12 @@ vim_account_new_schema = { "description": description_schema, "vim": name_schema, "datacenter": name_schema, - "vim_type": {"enum": ["openstack", "openvim", "vmware", "opennebula", "aws"]}, + "vim_type": {"enum": ["openstack", "openvim", "vmware", "opennebula", "aws", "azure"]}, "vim_url": description_schema, # "vim_url_admin": description_schema, # "vim_tenant": name_schema, "vim_tenant_name": name_schema, - "vim_user": nameshort_schema, + "vim_user": shortname_schema, "vim_password": passwd_schema, "config": {"type": "object"} }, @@ -340,16 +394,57 @@ vim_account_new_schema = { "additionalProperties": False } +wim_account_edit_schema = { + "title": "wim_account edit input schema", + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "name": name_schema, + "description": description_schema, + "type": shortname_schema, + "wim": name_schema, + "wim_url": description_schema, + "user": shortname_schema, + "password": passwd_schema, + "config": {"type": "object"} + }, + "additionalProperties": False +} + +wim_account_new_schema = { + "title": "wim_account creation input schema", + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "schema_version": schema_version, + "schema_type": schema_type, + "name": name_schema, + "description": description_schema, + "wim": name_schema, + "wim_type": {"enum": ["tapi", "onos", "odl", "dynpac", "fake"]}, + "wim_url": description_schema, + "user": shortname_schema, + "password": passwd_schema, + "config": { + "type": "object", + "patternProperties": { + ".": {"not": {"type": "null"}} + } + } + }, + "required": ["name", "wim_url", "wim_type"], + "additionalProperties": False +} sdn_properties = { "name": name_schema, "description": description_schema, - "dpid": {"type": "string", "pattern": "^[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){7}$"}, + "dpid": dpid_Schema, "ip": ip_schema, "port": port_schema, "type": {"type": "string", "enum": ["opendaylight", "floodlight", "onos"]}, "version": {"type": "string", "minLength": 1, "maxLength": 12}, - "user": nameshort_schema, + "user": shortname_schema, "password": passwd_schema } sdn_new_schema = { @@ -375,14 +470,14 @@ sdn_port_mapping_schema = { "items": { "type": "object", "properties": { - "compute_node": nameshort_schema, + "compute_node": shortname_schema, "ports": { "type": "array", "items": { "type": "object", "properties": { - "pci": pci_schema, - "switch_port": nameshort_schema, + "pci": pci_extended_schema, + "switch_port": shortname_schema, "switch_mac": mac_schema }, "required": ["pci"] @@ -404,22 +499,99 @@ sdn_external_port_schema = { "required": ["port"] } +# PDUs +pdu_interface = { + "type": "object", + "properties": { + "name": shortname_schema, + "mgmt": bool_schema, + "type": {"enum": ["overlay", 'underlay']}, + "ip-address": ip_schema, + # TODO, add user, password, ssh-key + "mac-address": mac_schema, + "vim-network-name": shortname_schema, # interface is connected to one vim network, or switch port + "vim-network-id": shortname_schema, + # # provide this in case SDN assist must deal with this interface + # "switch-dpid": dpid_Schema, + # "switch-port": shortname_schema, + # "switch-mac": shortname_schema, + # "switch-vlan": vlan_schema, + }, + "required": ["name", "mgmt", "ip-address"], + "additionalProperties": False +} +pdu_new_schema = { + "title": "pdu creation input schema", + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "name": shortname_schema, + "type": shortname_schema, + "description": description_schema, + "shared": bool_schema, + "vims": nameshort_list_schema, + "vim_accounts": nameshort_list_schema, + "interfaces": { + "type": "array", + "items": pdu_interface, + "minItems": 1 + } + }, + "required": ["name", "type", "interfaces"], + "additionalProperties": False +} + +pdu_edit_schema = { + "title": "pdu edit input schema", + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "name": shortname_schema, + "type": shortname_schema, + "description": description_schema, + "shared": bool_schema, + "vims": {"oneOf": [array_edition_schema, nameshort_list_schema]}, + "vim_accounts": {"oneOf": [array_edition_schema, nameshort_list_schema]}, + "interfaces": {"oneOf": [ + array_edition_schema, + { + "type": "array", + "items": pdu_interface, + "minItems": 1 + } + ]} + }, + "additionalProperties": False, + "minProperties": 1 +} + # USERS -user_project_schema = { - "type": "array", - "minItems": 1, - "items": nameshort_schema, +project_role_mapping = { + "title": "", + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "project": shortname_schema, + "role": shortname_schema + }, + "required": ["project", "role"], + "additionalProperties": False } user_new_schema = { "$schema": "http://json-schema.org/draft-04/schema#", "title": "New user schema", "type": "object", "properties": { - "username": nameshort_schema, + "username": shortname_schema, "password": passwd_schema, - "projects": user_project_schema, + "projects": nameshort_list_schema, + "project_role_mappings": { + "type": "array", + "items": project_role_mapping, + "minItems": 1 + }, }, - "required": ["username", "password", "projects"], + "required": ["username", "password"], "additionalProperties": False } user_edit_schema = { @@ -428,13 +600,21 @@ user_edit_schema = { "type": "object", "properties": { "password": passwd_schema, + "username": shortname_schema, # To allow User Name modification "projects": { - "oneOff": [ - user_project_schema, + "oneOf": [ + nameshort_list_schema, array_edition_schema ] }, - } + "project_role_mappings": { + "type": "array", + "items": project_role_mapping, + "minItems": 1 + }, + }, + "minProperties": 1, + "additionalProperties": False } # PROJECTS @@ -443,7 +623,7 @@ project_new_schema = { "title": "New project schema for administrators", "type": "object", "properties": { - "name": nameshort_schema, + "name": shortname_schema, "admin": bool_schema, }, "required": ["name"], @@ -455,7 +635,34 @@ project_edit_schema = { "type": "object", "properties": { "admin": bool_schema, + "name": shortname_schema, # To allow Project Name modification + }, + "additionalProperties": False, + "minProperties": 1 +} + +# ROLES +roles_new_schema = { + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "New role schema for administrators", + "type": "object", + "properties": { + "name": shortname_schema, + "definition": object_schema, }, + "required": ["name"], + "additionalProperties": False +} +roles_edit_schema = { + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Roles edit schema for administrators", + "type": "object", + "properties": { + "_id": id_schema, + "name": shortname_schema, + "definition": object_schema, + }, + "required": ["_id", "name", "definition"], "additionalProperties": False, "minProperties": 1 } @@ -469,34 +676,90 @@ nbi_new_input_schemas = { "sdns": sdn_new_schema, "ns_instantiate": ns_instantiate, "ns_action": ns_action, - "ns_scale": ns_scale + "ns_scale": ns_scale, + "pdus": pdu_new_schema, } nbi_edit_input_schemas = { "users": user_edit_schema, "projects": project_edit_schema, "vim_accounts": vim_account_edit_schema, - "sdns": sdn_edit_schema + "sdns": sdn_edit_schema, + "pdus": pdu_edit_schema, +} + +# NETSLICE SCHEMAS +nsi_subnet_instantiate = deepcopy(ns_instantiate) +nsi_subnet_instantiate["title"] = "netslice subnet instantiation params input schema" +nsi_subnet_instantiate["properties"]["id"] = name_schema +del nsi_subnet_instantiate["required"] + +nsi_vld_instantiate = { + "title": "netslice vld instantiation params input schema", + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "name": string_schema, + "vim-network-name": {"OneOf": [string_schema, object_schema]}, + "vim-network-id": {"OneOf": [string_schema, object_schema]}, + "ip-profile": object_schema, + }, + "required": ["name"], + "additionalProperties": False +} + +nsi_instantiate = { + "title": "netslice action instantiate input schema", + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "lcmOperationType": string_schema, + "nsiInstanceId": id_schema, + "nsiName": name_schema, + "nsiDescription": {"oneOf": [description_schema, null_schema]}, + "nstId": string_schema, + "vimAccountId": id_schema, + "ssh_keys": {"type": "string"}, + "nsi_id": id_schema, + "additionalParamsForNsi": object_schema, + "netslice-subnet": { + "type": "array", + "minItems": 1, + "items": nsi_subnet_instantiate + }, + "netslice-vld": { + "type": "array", + "minItems": 1, + "items": nsi_vld_instantiate + }, + }, + "required": ["nsiName", "nstId", "vimAccountId"], + "additionalProperties": False +} + +nsi_action = { + +} + +nsi_terminate = { + } class ValidationError(Exception): - pass + def __init__(self, message, http_code=HTTPStatus.UNPROCESSABLE_ENTITY): + self.http_code = http_code + Exception.__init__(self, message) -def validate_input(indata, item, new=True): +def validate_input(indata, schema_to_use): """ Validates input data against json schema :param indata: user input data. Should be a dictionary - :param item: can be users, projects, vims, sdns, ns_xxxxx - :param new: True if the validation is for creating or False if it is for editing - :return: None if ok, raises ValidationError exception otherwise + :param schema_to_use: jsonschema to test + :return: None if ok, raises ValidationError exception on error """ try: - if new: - schema_to_use = nbi_new_input_schemas.get(item) - else: - schema_to_use = nbi_edit_input_schemas.get(item) if schema_to_use: js_v(indata, schema_to_use) return None @@ -506,3 +769,18 @@ def validate_input(indata, item, new=True): else: error_pos = "" raise ValidationError("Format error {} '{}' ".format(error_pos, e.message)) + except js_e.SchemaError: + raise ValidationError("Bad json schema {}".format(schema_to_use), http_code=HTTPStatus.INTERNAL_SERVER_ERROR) + + +def is_valid_uuid(x): + """ + Test for a valid UUID + :param x: string to test + :return: True if x is a valid uuid, False otherwise + """ + try: + if UUID(x): + return True + except (TypeError, ValueError): + return False