1 # -*- coding: utf-8 -*-
3 from jsonschema
import validate
as js_v
, exceptions
as js_e
5 __author__
= "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
7 version_date
= "Mar 2018"
10 Validator of input data using JSON schemas for those items that not contains an OSM yang information model
14 patern_name
= "^[ -~]+$"
15 nameshort_schema
= {"type": "string", "minLength": 1, "maxLength": 60, "pattern": "^[^,;()\.\$'\"]+$"}
16 passwd_schema
= {"type": "string", "minLength": 1, "maxLength": 60}
17 name_schema
= {"type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[^,;()'\"]+$"}
18 string_schema
= {"type": "string", "minLength": 1, "maxLength": 255}
19 xml_text_schema
= {"type": "string", "minLength": 1, "maxLength": 1000, "pattern": "^[^']+$"}
20 description_schema
= {"type": ["string", "null"], "maxLength": 255, "pattern": "^[^'\"]+$"}
21 id_schema_fake
= {"type": "string", "minLength": 2, "maxLength": 36}
22 bool_schema
= {"type": "boolean"}
23 null_schema
= {"type": "null"}
24 # "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}$"
25 id_schema
= {"type": "string", "pattern": "^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$"}
26 time_schema
= {"type": "string", "pattern": "^[0-9]{4}-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]([0-5]:){2}"}
27 pci_schema
= {"type": "string", "pattern": "^[0-9a-fA-F]{4}(:[0-9a-fA-F]{2}){2}\.[0-9a-fA-F]$"}
28 http_schema
= {"type": "string", "pattern": "^https?://[^'\"=]+$"}
29 bandwidth_schema
= {"type": "string", "pattern": "^[0-9]+ *([MG]bps)?$"}
30 memory_schema
= {"type": "string", "pattern": "^[0-9]+ *([MG]i?[Bb])?$"}
31 integer0_schema
= {"type": "integer", "minimum": 0}
32 integer1_schema
= {"type": "integer", "minimum": 1}
33 path_schema
= {"type": "string", "pattern": "^(\.){0,2}(/[^/\"':{}\(\)]+)+$"}
34 vlan_schema
= {"type": "integer", "minimum": 1, "maximum": 4095}
35 vlan1000_schema
= {"type": "integer", "minimum": 1000, "maximum": 4095}
36 mac_schema
= {"type": "string",
37 "pattern": "^[0-9a-fA-F][02468aceACE](:[0-9a-fA-F]{2}){5}$"} # must be unicast: LSB bit of MSB byte ==0
38 # mac_schema={"type":"string", "pattern":"^([0-9a-fA-F]{2}:){5}[0-9a-fA-F]{2}$"}
39 ip_schema
= {"type": "string",
40 "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]?)$"}
41 ip_prefix_schema
= {"type": "string",
42 "pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}"
43 "(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/(30|[12]?[0-9])$"}
44 port_schema
= {"type": "integer", "minimum": 1, "maximum": 65534}
45 object_schema
= {"type": "object"}
46 schema_version_2
= {"type": "integer", "minimum": 2, "maximum": 2}
47 # schema_version_string={"type":"string","enum": ["0.1", "2", "0.2", "3", "0.3"]}
48 log_level_schema
= {"type": "string", "enum": ["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"]}
49 checksum_schema
= {"type": "string", "pattern": "^[0-9a-fA-F]{32}$"}
50 size_schema
= {"type": "integer", "minimum": 1, "maximum": 100}
51 array_edition_schema
= {
53 "patternProperties": {
56 "additionalProperties": False,
61 ns_instantiate_vdu
= {
62 "title": "ns action instantiate input schema for vdu",
63 "$schema": "http://json-schema.org/draft-04/schema#",
74 "vim-volume-id": name_schema
,
76 "required": ["name", "vim-volume-id"],
77 "additionalProperties": False
87 "ip-address": ip_schema
,
88 "mac-address": mac_schema
,
89 "floating-ip-required": bool_schema
,
92 "additionalProperties": False
97 "additionalProperties": False
100 ip_profile_dns_schema
= {
106 "address": ip_schema
,
108 "required": ["address"],
109 "additionalProperties": False
113 ip_profile_dhcp_schema
= {
116 "enabled": {"type": "boolean"},
117 "count": integer1_schema
,
118 "start-address": ip_schema
120 "additionalProperties": False,
123 ip_profile_schema
= {
124 "title": "ip profile validation schame",
125 "$schema": "http://json-schema.org/draft-04/schema#",
128 "ip-version": {"enum": ["ipv4", "ipv6"]},
129 "subnet-address": ip_prefix_schema
,
130 "gateway-address": ip_schema
,
131 "dns-server": ip_profile_dns_schema
,
132 "dhcp-params": ip_profile_dhcp_schema
,
136 ip_profile_update_schema
= {
137 "title": "ip profile validation schame",
138 "$schema": "http://json-schema.org/draft-04/schema#",
141 "ip-version": {"enum": ["ipv4", "ipv6"]},
142 "subnet-address": {"oneOf": [null_schema
, ip_prefix_schema
]},
143 "gateway-address": {"oneOf": [null_schema
, ip_schema
]},
144 "dns-server": {"oneOf": [null_schema
, ip_profile_dns_schema
]},
146 "dhcp-params": {"oneOf": [null_schema
, ip_profile_dhcp_schema
]},
148 "additionalProperties": False
151 ns_instantiate_internal_vld
= {
152 "title": "ns action instantiate input schema for vdu",
153 "$schema": "http://json-schema.org/draft-04/schema#",
157 "vim-network-name": name_schema
,
158 "ip-profile": ip_profile_update_schema
,
159 "internal-connection-point": {
165 "id-ref": name_schema
,
166 "ip-address": ip_schema
,
167 # "mac-address": mac_schema,
169 "required": ["id-ref"],
171 "additionalProperties": False
175 "required": ["name"],
177 "additionalProperties": False
181 "title": "ns action instantiate input schema",
182 "$schema": "http://json-schema.org/draft-04/schema#",
185 "nsName": name_schema
,
186 "nsDescription": {"oneOf": [description_schema
, {"type": "null"}]},
188 "vimAccountId": id_schema
,
189 "ssh_keys": {"type": "string"},
197 "member-vnf-index": name_schema
,
198 "vimAccountId": id_schema
,
202 "items": ns_instantiate_vdu
,
207 "items": ns_instantiate_internal_vld
210 "required": ["member-vnf-index"],
212 "additionalProperties": False
221 "name": string_schema
,
222 "vim-network-name": {"OneOf": [string_schema
, object_schema
]},
223 "ip-profile": object_schema
,
224 "vnfd-connection-point-ref": {
230 "member-vnf-index-ref": name_schema
,
231 "vnfd-connection-point-ref": name_schema
,
232 "ip-address": ip_schema
,
233 # "mac-address": mac_schema,
235 "required": ["member-vnf-index-ref", "vnfd-connection-point-ref"],
237 "additionalProperties": False
241 "required": ["name"],
242 "additionalProperties": False
246 "required": ["nsName", "nsdId", "vimAccountId"],
247 "additionalProperties": False
250 ns_action
= { # TODO for the moment it is only contemplated the vnfd primitive execution
251 "title": "ns action input schema",
252 "$schema": "http://json-schema.org/draft-04/schema#",
255 "member_vnf_index": name_schema
,
256 "vnf_member_index": name_schema
, # TODO for backward compatibility. To remove in future
257 "vdu_id": name_schema
,
258 "primitive": name_schema
,
259 "primitive_params": {"type": "object"},
261 "required": ["primitive", "primitive_params"], # TODO add member_vnf_index
262 "additionalProperties": False
264 ns_scale
= { # TODO for the moment it is only VDU-scaling
265 "title": "ns scale input schema",
266 "$schema": "http://json-schema.org/draft-04/schema#",
269 "scaleType": {"enum": ["SCALE_VNF"]},
273 "vnfInstanceId": name_schema
,
274 "scaleVnfType": {"enum": ["SCALE_OUT", 'SCALE_IN']},
278 "scaling-group-descriptor": name_schema
,
279 "member-vnf-index": name_schema
,
280 "scaling-policy": name_schema
,
282 "required": ["scaling-group-descriptor", "member-vnf-index"],
283 "additionalProperties": False
286 "required": ["scaleVnfType", "scaleByStepData"], # vnfInstanceId
287 "additionalProperties": False
289 "scaleTime": time_schema
,
291 "required": ["scaleType", "scaleVnfData"],
292 "additionalProperties": False
296 schema_version
= {"type": "string", "enum": ["1.0"]}
297 vim_account_edit_schema
= {
298 "title": "vim_account edit input schema",
299 "$schema": "http://json-schema.org/draft-04/schema#",
303 "description": description_schema
,
304 "type": nameshort_schema
, # currently "openvim" or "openstack", can be enlarged with plugins
306 "datacenter": name_schema
,
307 "vim_url": description_schema
,
308 "vim_url_admin": description_schema
,
309 "vim_tenant": name_schema
,
310 "vim_tenant_name": name_schema
,
311 "vim_username": nameshort_schema
,
312 "vim_password": passwd_schema
,
313 "config": {"type": "object"}
315 "additionalProperties": False
317 schema_type
= {"type": "string"}
319 vim_account_new_schema
= {
320 "title": "vim_account creation input schema",
321 "$schema": "http://json-schema.org/draft-04/schema#",
324 "schema_version": schema_version
,
325 "schema_type": schema_type
,
327 "description": description_schema
,
329 "datacenter": name_schema
,
330 "vim_type": {"enum": ["openstack", "openvim", "vmware", "opennebula", "aws"]},
331 "vim_url": description_schema
,
332 # "vim_url_admin": description_schema,
333 # "vim_tenant": name_schema,
334 "vim_tenant_name": name_schema
,
335 "vim_user": nameshort_schema
,
336 "vim_password": passwd_schema
,
337 "config": {"type": "object"}
339 "required": ["name", "vim_url", "vim_type", "vim_user", "vim_password", "vim_tenant_name"],
340 "additionalProperties": False
346 "description": description_schema
,
347 "dpid": {"type": "string", "pattern": "^[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){7}$"},
350 "type": {"type": "string", "enum": ["opendaylight", "floodlight", "onos"]},
351 "version": {"type": "string", "minLength": 1, "maxLength": 12},
352 "user": nameshort_schema
,
353 "password": passwd_schema
356 "title": "sdn controller information schema",
357 "$schema": "http://json-schema.org/draft-04/schema#",
359 "properties": sdn_properties
,
360 "required": ["name", "port", 'ip', 'dpid', 'type'],
361 "additionalProperties": False
364 "title": "sdn controller update information schema",
365 "$schema": "http://json-schema.org/draft-04/schema#",
367 "properties": sdn_properties
,
368 # "required": ["name", "port", 'ip', 'dpid', 'type'],
369 "additionalProperties": False
371 sdn_port_mapping_schema
= {
372 "$schema": "http://json-schema.org/draft-04/schema#",
373 "title": "sdn port mapping information schema",
378 "compute_node": nameshort_schema
,
385 "switch_port": nameshort_schema
,
386 "switch_mac": mac_schema
392 "required": ["compute_node", "ports"]
395 sdn_external_port_schema
= {
396 "$schema": "http://json-schema.org/draft-04/schema#",
397 "title": "External port information",
400 "port": {"type": "string", "minLength": 1, "maxLength": 60},
408 user_project_schema
= {
411 "items": nameshort_schema
,
414 "$schema": "http://json-schema.org/draft-04/schema#",
415 "title": "New user schema",
418 "username": nameshort_schema
,
419 "password": passwd_schema
,
420 "projects": user_project_schema
,
422 "required": ["username", "password", "projects"],
423 "additionalProperties": False
426 "$schema": "http://json-schema.org/draft-04/schema#",
427 "title": "User edit schema for administrators",
430 "password": passwd_schema
,
441 project_new_schema
= {
442 "$schema": "http://json-schema.org/draft-04/schema#",
443 "title": "New project schema for administrators",
446 "name": nameshort_schema
,
447 "admin": bool_schema
,
449 "required": ["name"],
450 "additionalProperties": False
452 project_edit_schema
= {
453 "$schema": "http://json-schema.org/draft-04/schema#",
454 "title": "Project edit schema for administrators",
457 "admin": bool_schema
,
459 "additionalProperties": False,
465 nbi_new_input_schemas
= {
466 "users": user_new_schema
,
467 "projects": project_new_schema
,
468 "vim_accounts": vim_account_new_schema
,
469 "sdns": sdn_new_schema
,
470 "ns_instantiate": ns_instantiate
,
471 "ns_action": ns_action
,
475 nbi_edit_input_schemas
= {
476 "users": user_edit_schema
,
477 "projects": project_edit_schema
,
478 "vim_accounts": vim_account_edit_schema
,
479 "sdns": sdn_edit_schema
483 class ValidationError(Exception):
487 def validate_input(indata
, item
, new
=True):
489 Validates input data against json schema
490 :param indata: user input data. Should be a dictionary
491 :param item: can be users, projects, vims, sdns, ns_xxxxx
492 :param new: True if the validation is for creating or False if it is for editing
493 :return: None if ok, raises ValidationError exception otherwise
497 schema_to_use
= nbi_new_input_schemas
.get(item
)
499 schema_to_use
= nbi_edit_input_schemas
.get(item
)
501 js_v(indata
, schema_to_use
)
503 except js_e
.ValidationError
as e
:
505 error_pos
= "at '" + ":".join(map(str, e
.path
)) + "'"
508 raise ValidationError("Format error {} '{}' ".format(error_pos
, e
.message
))