1 # -*- coding: utf-8 -*-
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
7 # http://www.apache.org/licenses/LICENSE-2.0
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
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
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
21 __author__
= "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
23 version_date
= "Mar 2018"
26 Validator of input data using JSON schemas for those items that not contains an OSM yang information model
30 patern_name
= "^[ -~]+$"
31 shortname_schema
= {"type": "string", "minLength": 1, "maxLength": 60, "pattern": "^[^,;()\\.\\$'\"]+$"}
32 passwd_schema
= {"type": "string", "minLength": 1, "maxLength": 60}
33 name_schema
= {"type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[^,;()'\"]+$"}
34 string_schema
= {"type": "string", "minLength": 1, "maxLength": 255}
35 xml_text_schema
= {"type": "string", "minLength": 1, "maxLength": 1000, "pattern": "^[^']+$"}
36 description_schema
= {"type": ["string", "null"], "maxLength": 255, "pattern": "^[^'\"]+$"}
37 id_schema_fake
= {"type": "string", "minLength": 2, "maxLength": 36}
38 bool_schema
= {"type": "boolean"}
39 null_schema
= {"type": "null"}
40 # "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}$"
41 id_schema
= {"type": "string", "pattern": "^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$"}
42 time_schema
= {"type": "string", "pattern": "^[0-9]{4}-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]([0-5]:){2}"}
43 pci_schema
= {"type": "string", "pattern": "^[0-9a-fA-F]{4}(:[0-9a-fA-F]{2}){2}\\.[0-9a-fA-F]$"}
44 # allows [] for wildcards. For that reason huge length limit is set
45 pci_extended_schema
= {"type": "string", "pattern": "^[0-9a-fA-F.:-\\[\\]]{12,40}$"}
46 http_schema
= {"type": "string", "pattern": "^https?://[^'\"=]+$"}
47 bandwidth_schema
= {"type": "string", "pattern": "^[0-9]+ *([MG]bps)?$"}
48 memory_schema
= {"type": "string", "pattern": "^[0-9]+ *([MG]i?[Bb])?$"}
49 integer0_schema
= {"type": "integer", "minimum": 0}
50 integer1_schema
= {"type": "integer", "minimum": 1}
51 path_schema
= {"type": "string", "pattern": "^(\\.){0,2}(/[^/\"':{}\\(\\)]+)+$"}
52 vlan_schema
= {"type": "integer", "minimum": 1, "maximum": 4095}
53 vlan1000_schema
= {"type": "integer", "minimum": 1000, "maximum": 4095}
54 mac_schema
= {"type": "string",
55 "pattern": "^[0-9a-fA-F][02468aceACE](:[0-9a-fA-F]{2}){5}$"} # must be unicast: LSB bit of MSB byte ==0
56 dpid_Schema
= {"type": "string", "pattern": "^[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){7}$"}
57 # mac_schema={"type":"string", "pattern":"^([0-9a-fA-F]{2}:){5}[0-9a-fA-F]{2}$"}
58 ip_schema
= {"type": "string",
59 "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]?)$"}
60 ip_prefix_schema
= {"type": "string",
61 "pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}"
62 "(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/(30|[12]?[0-9])$"}
63 port_schema
= {"type": "integer", "minimum": 1, "maximum": 65534}
64 object_schema
= {"type": "object"}
65 schema_version_2
= {"type": "integer", "minimum": 2, "maximum": 2}
66 # schema_version_string={"type":"string","enum": ["0.1", "2", "0.2", "3", "0.3"]}
67 log_level_schema
= {"type": "string", "enum": ["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"]}
68 checksum_schema
= {"type": "string", "pattern": "^[0-9a-fA-F]{32}$"}
69 size_schema
= {"type": "integer", "minimum": 1, "maximum": 100}
70 array_edition_schema
= {
72 "patternProperties": {
75 "additionalProperties": False,
78 nameshort_list_schema
= {
81 "items": shortname_schema
,
85 ns_instantiate_vdu
= {
86 "title": "ns action instantiate input schema for vdu",
87 "$schema": "http://json-schema.org/draft-04/schema#",
98 "vim-volume-id": name_schema
,
100 "required": ["name", "vim-volume-id"],
101 "additionalProperties": False
111 "ip-address": ip_schema
,
112 "mac-address": mac_schema
,
113 "floating-ip-required": bool_schema
,
115 "required": ["name"],
116 "additionalProperties": False
121 "additionalProperties": False
124 ip_profile_dns_schema
= {
130 "address": ip_schema
,
132 "required": ["address"],
133 "additionalProperties": False
137 ip_profile_dhcp_schema
= {
140 "enabled": {"type": "boolean"},
141 "count": integer1_schema
,
142 "start-address": ip_schema
144 "additionalProperties": False,
147 ip_profile_schema
= {
148 "title": "ip profile validation schame",
149 "$schema": "http://json-schema.org/draft-04/schema#",
152 "ip-version": {"enum": ["ipv4", "ipv6"]},
153 "subnet-address": ip_prefix_schema
,
154 "gateway-address": ip_schema
,
155 "dns-server": ip_profile_dns_schema
,
156 "dhcp-params": ip_profile_dhcp_schema
,
160 ip_profile_update_schema
= {
161 "title": "ip profile validation schame",
162 "$schema": "http://json-schema.org/draft-04/schema#",
165 "ip-version": {"enum": ["ipv4", "ipv6"]},
166 "subnet-address": {"oneOf": [null_schema
, ip_prefix_schema
]},
167 "gateway-address": {"oneOf": [null_schema
, ip_schema
]},
168 "dns-server": {"oneOf": [null_schema
, ip_profile_dns_schema
]},
170 "dhcp-params": {"oneOf": [null_schema
, ip_profile_dhcp_schema
]},
172 "additionalProperties": False
175 ns_instantiate_internal_vld
= {
176 "title": "ns action instantiate input schema for vdu",
177 "$schema": "http://json-schema.org/draft-04/schema#",
181 "vim-network-name": name_schema
,
182 "vim-network-id": name_schema
,
183 "ip-profile": ip_profile_update_schema
,
184 "internal-connection-point": {
190 "id-ref": name_schema
,
191 "ip-address": ip_schema
,
192 # "mac-address": mac_schema,
194 "required": ["id-ref"],
196 "additionalProperties": False
200 "required": ["name"],
202 "additionalProperties": False
205 additional_params_for_vnf
= {
210 "member-vnf-index": name_schema
,
211 "additionalParams": object_schema
,
213 "required": ["member-vnf-index", "additionalParams"],
214 "additionalProperties": False
220 "title": "ns action instantiate input schema",
221 "$schema": "http://json-schema.org/draft-04/schema#",
224 "lcmOperationType": string_schema
,
225 "nsInstanceId": id_schema
,
226 "netsliceInstanceId": id_schema
,
227 "nsName": name_schema
,
228 "nsDescription": {"oneOf": [description_schema
, null_schema
]},
230 "vimAccountId": id_schema
,
231 "wimAccountId": {"OneOf": [id_schema
, bool_schema
, null_schema
]},
232 "additionalParamsForNs": object_schema
,
233 "additionalParamsForVnf": additional_params_for_vnf
,
234 "ssh_keys": {"type": "array", "items": {"type": "string"}},
236 "vduImage": name_schema
,
243 "member-vnf-index": name_schema
,
244 "vimAccountId": id_schema
,
248 "items": ns_instantiate_vdu
,
253 "items": ns_instantiate_internal_vld
256 "required": ["member-vnf-index"],
258 "additionalProperties": False
267 "name": string_schema
,
268 "vim-network-name": {"OneOf": [string_schema
, object_schema
]},
269 "vim-network-id": {"OneOf": [string_schema
, object_schema
]},
270 "ns-net": object_schema
,
271 "wimAccountId": {"OneOf": [id_schema
, bool_schema
, null_schema
]},
272 "ip-profile": object_schema
,
273 "vnfd-connection-point-ref": {
279 "member-vnf-index-ref": name_schema
,
280 "vnfd-connection-point-ref": name_schema
,
281 "ip-address": ip_schema
,
282 # "mac-address": mac_schema,
284 "required": ["member-vnf-index-ref", "vnfd-connection-point-ref"],
286 "additionalProperties": False
290 "required": ["name"],
291 "additionalProperties": False
295 "required": ["nsName", "nsdId", "vimAccountId"],
296 "additionalProperties": False
299 ns_action
= { # TODO for the moment it is only contemplated the vnfd primitive execution
300 "title": "ns action input schema",
301 "$schema": "http://json-schema.org/draft-04/schema#",
304 "lcmOperationType": string_schema
,
305 "nsInstanceId": id_schema
,
306 "member_vnf_index": name_schema
,
307 "vnf_member_index": name_schema
, # TODO for backward compatibility. To remove in future
308 "vdu_id": name_schema
,
309 "vdu_count_index": integer0_schema
,
310 "primitive": name_schema
,
311 "primitive_params": {"type": "object"},
313 "required": ["primitive", "primitive_params"], # TODO add member_vnf_index
314 "additionalProperties": False
316 ns_scale
= { # TODO for the moment it is only VDU-scaling
317 "title": "ns scale input schema",
318 "$schema": "http://json-schema.org/draft-04/schema#",
321 "lcmOperationType": string_schema
,
322 "nsInstanceId": id_schema
,
323 "scaleType": {"enum": ["SCALE_VNF"]},
327 "vnfInstanceId": name_schema
,
328 "scaleVnfType": {"enum": ["SCALE_OUT", 'SCALE_IN']},
332 "scaling-group-descriptor": name_schema
,
333 "member-vnf-index": name_schema
,
334 "scaling-policy": name_schema
,
336 "required": ["scaling-group-descriptor", "member-vnf-index"],
337 "additionalProperties": False
340 "required": ["scaleVnfType", "scaleByStepData"], # vnfInstanceId
341 "additionalProperties": False
343 "scaleTime": time_schema
,
345 "required": ["scaleType", "scaleVnfData"],
346 "additionalProperties": False
350 schema_version
= {"type": "string", "enum": ["1.0"]}
351 schema_type
= {"type": "string"}
352 vim_type
= {"enum": ["openstack", "openvim", "vmware", "opennebula", "aws", "azure", "fos"]}
354 vim_account_edit_schema
= {
355 "title": "vim_account edit input schema",
356 "$schema": "http://json-schema.org/draft-04/schema#",
360 "description": description_schema
,
362 "datacenter": name_schema
,
363 "vim_type": vim_type
,
364 "vim_url": description_schema
,
365 # "vim_url_admin": description_schema,
366 # "vim_tenant": name_schema,
367 "vim_tenant_name": name_schema
,
368 "vim_user": shortname_schema
,
369 "vim_password": passwd_schema
,
370 "config": {"type": "object"}
372 "additionalProperties": False
375 vim_account_new_schema
= {
376 "title": "vim_account creation input schema",
377 "$schema": "http://json-schema.org/draft-04/schema#",
380 "schema_version": schema_version
,
381 "schema_type": schema_type
,
383 "description": description_schema
,
385 "datacenter": name_schema
,
386 "vim_type": vim_type
,
387 "vim_url": description_schema
,
388 # "vim_url_admin": description_schema,
389 # "vim_tenant": name_schema,
390 "vim_tenant_name": name_schema
,
391 "vim_user": shortname_schema
,
392 "vim_password": passwd_schema
,
393 "config": {"type": "object"}
395 "required": ["name", "vim_url", "vim_type", "vim_user", "vim_password", "vim_tenant_name"],
396 "additionalProperties": False
399 wim_type
= {"enum": ["tapi", "onos", "odl", "dynpac", "fake"]}
401 wim_account_edit_schema
= {
402 "title": "wim_account edit input schema",
403 "$schema": "http://json-schema.org/draft-04/schema#",
407 "description": description_schema
,
409 "wim_type": wim_type
,
410 "wim_url": description_schema
,
411 "user": shortname_schema
,
412 "password": passwd_schema
,
413 "config": {"type": "object"}
415 "additionalProperties": False
418 wim_account_new_schema
= {
419 "title": "wim_account creation input schema",
420 "$schema": "http://json-schema.org/draft-04/schema#",
423 "schema_version": schema_version
,
424 "schema_type": schema_type
,
426 "description": description_schema
,
428 "wim_type": wim_type
,
429 "wim_url": description_schema
,
430 "user": shortname_schema
,
431 "password": passwd_schema
,
434 "patternProperties": {
435 ".": {"not": {"type": "null"}}
439 "required": ["name", "wim_url", "wim_type"],
440 "additionalProperties": False
445 "description": description_schema
,
449 "type": {"type": "string", "enum": ["opendaylight", "floodlight", "onos"]},
450 "version": {"type": "string", "minLength": 1, "maxLength": 12},
451 "user": shortname_schema
,
452 "password": passwd_schema
455 "title": "sdn controller information schema",
456 "$schema": "http://json-schema.org/draft-04/schema#",
458 "properties": sdn_properties
,
459 "required": ["name", "port", 'ip', 'dpid', 'type'],
460 "additionalProperties": False
463 "title": "sdn controller update information schema",
464 "$schema": "http://json-schema.org/draft-04/schema#",
466 "properties": sdn_properties
,
467 # "required": ["name", "port", 'ip', 'dpid', 'type'],
468 "additionalProperties": False
470 sdn_port_mapping_schema
= {
471 "$schema": "http://json-schema.org/draft-04/schema#",
472 "title": "sdn port mapping information schema",
477 "compute_node": shortname_schema
,
483 "pci": pci_extended_schema
,
484 "switch_port": shortname_schema
,
485 "switch_mac": mac_schema
491 "required": ["compute_node", "ports"]
494 sdn_external_port_schema
= {
495 "$schema": "http://json-schema.org/draft-04/schema#",
496 "title": "External port information",
499 "port": {"type": "string", "minLength": 1, "maxLength": 60},
510 "name": shortname_schema
,
512 "type": {"enum": ["overlay", 'underlay']},
513 "ip-address": ip_schema
,
514 # TODO, add user, password, ssh-key
515 "mac-address": mac_schema
,
516 "vim-network-name": shortname_schema
, # interface is connected to one vim network, or switch port
517 "vim-network-id": shortname_schema
,
518 # # provide this in case SDN assist must deal with this interface
519 # "switch-dpid": dpid_Schema,
520 # "switch-port": shortname_schema,
521 # "switch-mac": shortname_schema,
522 # "switch-vlan": vlan_schema,
524 "required": ["name", "mgmt", "ip-address"],
525 "additionalProperties": False
528 "title": "pdu creation input schema",
529 "$schema": "http://json-schema.org/draft-04/schema#",
532 "name": shortname_schema
,
533 "type": shortname_schema
,
534 "description": description_schema
,
535 "shared": bool_schema
,
536 "vims": nameshort_list_schema
,
537 "vim_accounts": nameshort_list_schema
,
540 "items": pdu_interface
,
544 "required": ["name", "type", "interfaces"],
545 "additionalProperties": False
549 "title": "pdu edit input schema",
550 "$schema": "http://json-schema.org/draft-04/schema#",
553 "name": shortname_schema
,
554 "type": shortname_schema
,
555 "description": description_schema
,
556 "shared": bool_schema
,
557 "vims": {"oneOf": [array_edition_schema
, nameshort_list_schema
]},
558 "vim_accounts": {"oneOf": [array_edition_schema
, nameshort_list_schema
]},
559 "interfaces": {"oneOf": [
560 array_edition_schema
,
563 "items": pdu_interface
,
568 "additionalProperties": False,
573 project_role_mappings
= {
574 "title": "list pf projects/roles",
575 "$schema": "http://json-schema.org/draft-04/schema#",
580 "project": shortname_schema
,
581 "role": shortname_schema
583 "required": ["project", "role"],
584 "additionalProperties": False
588 project_role_mappings_optional
= {
589 "title": "list of projects/roles or projects only",
590 "$schema": "http://json-schema.org/draft-04/schema#",
595 "project": shortname_schema
,
596 "role": shortname_schema
598 "required": ["project"],
599 "additionalProperties": False
604 "$schema": "http://json-schema.org/draft-04/schema#",
605 "title": "New user schema",
608 "username": shortname_schema
,
609 "password": passwd_schema
,
610 "projects": nameshort_list_schema
,
611 "project_role_mappings": project_role_mappings
,
613 "required": ["username", "password"],
614 "additionalProperties": False
617 "$schema": "http://json-schema.org/draft-04/schema#",
618 "title": "User edit schema for administrators",
621 "password": passwd_schema
,
622 "username": shortname_schema
, # To allow User Name modification
625 nameshort_list_schema
,
629 "project_role_mappings": project_role_mappings
,
630 "add_project_role_mappings": project_role_mappings
,
631 "remove_project_role_mappings": project_role_mappings_optional
,
634 "additionalProperties": False
638 topics_with_quota
= ["vnfds", "nsds", "nsts", "pdus", "nsrs", "nsis", "vim_accounts", "wim_accounts", "sdns"]
639 project_new_schema
= {
640 "$schema": "http://json-schema.org/draft-04/schema#",
641 "title": "New project schema for administrators",
644 "name": shortname_schema
,
645 "admin": bool_schema
,
648 "properties": {topic
: integer0_schema
for topic
in topics_with_quota
},
649 "additionalProperties": False
652 "required": ["name"],
653 "additionalProperties": False
655 project_edit_schema
= {
656 "$schema": "http://json-schema.org/draft-04/schema#",
657 "title": "Project edit schema for administrators",
660 "admin": bool_schema
,
661 "name": shortname_schema
, # To allow Project Name modification
664 "properties": {topic
: {"oneOf": [integer0_schema
, null_schema
]} for topic
in topics_with_quota
},
665 "additionalProperties": False
668 "additionalProperties": False,
674 "$schema": "http://json-schema.org/draft-04/schema#",
675 "title": "New role schema for administrators",
678 "name": shortname_schema
,
681 "patternProperties": {
684 # "minProperties": 1,
687 "required": ["name"],
688 "additionalProperties": False
690 roles_edit_schema
= {
691 "$schema": "http://json-schema.org/draft-04/schema#",
692 "title": "Roles edit schema for administrators",
695 "name": shortname_schema
,
698 "patternProperties": {
700 "oneOf": [bool_schema
, null_schema
]
703 # "minProperties": 1,
706 "additionalProperties": False,
712 nbi_new_input_schemas
= {
713 "users": user_new_schema
,
714 "projects": project_new_schema
,
715 "vim_accounts": vim_account_new_schema
,
716 "sdns": sdn_new_schema
,
717 "ns_instantiate": ns_instantiate
,
718 "ns_action": ns_action
,
719 "ns_scale": ns_scale
,
720 "pdus": pdu_new_schema
,
723 nbi_edit_input_schemas
= {
724 "users": user_edit_schema
,
725 "projects": project_edit_schema
,
726 "vim_accounts": vim_account_edit_schema
,
727 "sdns": sdn_edit_schema
,
728 "pdus": pdu_edit_schema
,
732 nsi_subnet_instantiate
= deepcopy(ns_instantiate
)
733 nsi_subnet_instantiate
["title"] = "netslice subnet instantiation params input schema"
734 nsi_subnet_instantiate
["properties"]["id"] = name_schema
735 del nsi_subnet_instantiate
["required"]
737 nsi_vld_instantiate
= {
738 "title": "netslice vld instantiation params input schema",
739 "$schema": "http://json-schema.org/draft-04/schema#",
742 "name": string_schema
,
743 "vim-network-name": {"OneOf": [string_schema
, object_schema
]},
744 "vim-network-id": {"OneOf": [string_schema
, object_schema
]},
745 "ip-profile": object_schema
,
747 "required": ["name"],
748 "additionalProperties": False
752 "title": "netslice action instantiate input schema",
753 "$schema": "http://json-schema.org/draft-04/schema#",
756 "lcmOperationType": string_schema
,
757 "netsliceInstanceId": id_schema
,
758 "nsiName": name_schema
,
759 "nsiDescription": {"oneOf": [description_schema
, null_schema
]},
760 "nstId": string_schema
,
761 "vimAccountId": id_schema
,
762 "ssh_keys": {"type": "string"},
764 "additionalParamsForNsi": object_schema
,
768 "items": nsi_subnet_instantiate
773 "items": nsi_vld_instantiate
776 "required": ["nsiName", "nstId", "vimAccountId"],
777 "additionalProperties": False
789 class ValidationError(Exception):
790 def __init__(self
, message
, http_code
=HTTPStatus
.UNPROCESSABLE_ENTITY
):
791 self
.http_code
= http_code
792 Exception.__init
__(self
, message
)
795 def validate_input(indata
, schema_to_use
):
797 Validates input data against json schema
798 :param indata: user input data. Should be a dictionary
799 :param schema_to_use: jsonschema to test
800 :return: None if ok, raises ValidationError exception on error
804 js_v(indata
, schema_to_use
)
806 except js_e
.ValidationError
as e
:
808 error_pos
= "at '" + ":".join(map(str, e
.path
)) + "'"
811 raise ValidationError("Format error {} '{}' ".format(error_pos
, e
.message
))
812 except js_e
.SchemaError
:
813 raise ValidationError("Bad json schema {}".format(schema_to_use
), http_code
=HTTPStatus
.INTERNAL_SERVER_ERROR
)
816 def is_valid_uuid(x
):
818 Test for a valid UUID
819 :param x: string to test
820 :return: True if x is a valid uuid, False otherwise
825 except (TypeError, ValueError, AttributeError):