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 passwd_schema
= {"type": "string", "minLength": 1, "maxLength": 60}
16 nameshort_schema
= {"type": "string", "minLength": 1, "maxLength": 60, "pattern": "^[^,;()'\"]+$"}
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}
52 ns_instantiate_vdu
= {
53 "title": "ns action instantiate input schema for vdu",
54 "$schema": "http://json-schema.org/draft-04/schema#",
65 "vim-volume-id": name_schema
,
67 "required": ["name", "vim-volume-id"],
68 "additionalProperties": False
78 "ip-address": ip_schema
,
79 "mac-address": mac_schema
,
80 "floating-ip-required": bool_schema
,
83 "additionalProperties": False
88 "additionalProperties": False
91 ip_profile_dns_schema
= {
99 "required": ["address"],
100 "additionalProperties": False
104 ip_profile_dhcp_schema
= {
107 "enabled": {"type": "boolean"},
108 "count": integer1_schema
,
109 "start-address": ip_schema
111 "additionalProperties": False,
114 ip_profile_schema
= {
115 "title": "ip profile validation schame",
116 "$schema": "http://json-schema.org/draft-04/schema#",
119 "ip-version": {"enum": ["ipv4", "ipv6"]},
120 "subnet-address": ip_prefix_schema
,
121 "gateway-address": ip_schema
,
122 "dns-server": ip_profile_dns_schema
,
123 "dhcp-params": ip_profile_dhcp_schema
,
127 ip_profile_update_schema
= {
128 "title": "ip profile validation schame",
129 "$schema": "http://json-schema.org/draft-04/schema#",
132 "ip-version": {"enum": ["ipv4", "ipv6"]},
133 "subnet-address": {"oneOf": [null_schema
, ip_prefix_schema
]},
134 "gateway-address": {"oneOf": [null_schema
, ip_schema
]},
135 "dns-server": {"oneOf": [null_schema
, ip_profile_dns_schema
]},
137 "dhcp-params": {"oneOf": [null_schema
, ip_profile_dhcp_schema
]},
139 "additionalProperties": False
142 ns_instantiate_internal_vld
= {
143 "title": "ns action instantiate input schema for vdu",
144 "$schema": "http://json-schema.org/draft-04/schema#",
148 "vim-network-name": name_schema
,
149 "ip-profile": ip_profile_update_schema
,
150 "internal-connection-point": {
156 "id-ref": name_schema
,
157 "ip-address": ip_schema
,
158 # "mac-address": mac_schema,
160 "required": ["id-ref"],
162 "additionalProperties": False
166 "required": ["name"],
168 "additionalProperties": False
172 "title": "ns action instantiate input schema",
173 "$schema": "http://json-schema.org/draft-04/schema#",
176 "nsName": name_schema
,
177 "nsDescription": {"oneOf": [description_schema
, {"type": "null"}]},
179 "vimAccountId": id_schema
,
180 "ssh_keys": {"type": "string"},
188 "member-vnf-index": name_schema
,
189 "vimAccountId": id_schema
,
193 "items": ns_instantiate_vdu
,
198 "items": ns_instantiate_internal_vld
201 "required": ["member-vnf-index"],
203 "additionalProperties": False
212 "name": string_schema
,
213 "vim-network-name": {"OneOf": [string_schema
, object_schema
]},
214 "ip-profile": object_schema
,
215 "vnfd-connection-point-ref": {
221 "member-vnf-index-ref": name_schema
,
222 "vnfd-connection-point-ref": name_schema
,
223 "ip-address": ip_schema
,
224 # "mac-address": mac_schema,
226 "required": ["member-vnf-index-ref", "vnfd-connection-point-ref"],
228 "additionalProperties": False
232 "required": ["name"],
233 "additionalProperties": False
237 "required": ["nsName", "nsdId", "vimAccountId"],
238 "additionalProperties": False
241 ns_action
= { # TODO for the moment it is only contemplated the vnfd primitive execution
242 "title": "ns action input schema",
243 "$schema": "http://json-schema.org/draft-04/schema#",
246 "member_vnf_index": name_schema
,
247 "vnf_member_index": name_schema
, # TODO for backward compatibility. To remove in future
248 "vdu_id": name_schema
,
249 "primitive": name_schema
,
250 "primitive_params": {"type": "object"},
252 "required": ["primitive", "primitive_params"], # TODO add member_vnf_index
253 "additionalProperties": False
255 ns_scale
= { # TODO for the moment it is only VDU-scaling
256 "title": "ns scale input schema",
257 "$schema": "http://json-schema.org/draft-04/schema#",
260 "scaleType": {"enum": ["SCALE_VNF"]},
264 "vnfInstanceId": name_schema
,
265 "scaleVnfType": {"enum": ["SCALE_OUT", 'SCALE_IN']},
269 "scaling-group-descriptor": name_schema
,
270 "member-vnf-index": name_schema
,
271 "scaling-policy": name_schema
,
273 "required": ["scaling-group-descriptor", "member-vnf-index"],
274 "additionalProperties": False
277 "required": ["scaleVnfType", "scaleByStepData"], # vnfInstanceId
278 "additionalProperties": False
280 "scaleTime": time_schema
,
282 "required": ["scaleType", "scaleVnfData"],
283 "additionalProperties": False
287 schema_version
= {"type": "string", "enum": ["1.0"]}
288 vim_account_edit_schema
= {
289 "title": "vim_account edit input schema",
290 "$schema": "http://json-schema.org/draft-04/schema#",
294 "description": description_schema
,
295 "type": nameshort_schema
, # currently "openvim" or "openstack", can be enlarged with plugins
297 "datacenter": name_schema
,
298 "vim_url": description_schema
,
299 "vim_url_admin": description_schema
,
300 "vim_tenant": name_schema
,
301 "vim_tenant_name": name_schema
,
302 "vim_username": nameshort_schema
,
303 "vim_password": nameshort_schema
,
304 "config": {"type": "object"}
306 "additionalProperties": False
308 schema_type
= {"type": "string"}
310 vim_account_new_schema
= {
311 "title": "vim_account creation input schema",
312 "$schema": "http://json-schema.org/draft-04/schema#",
315 "schema_version": schema_version
,
316 "schema_type": schema_type
,
318 "description": description_schema
,
320 "datacenter": name_schema
,
321 "vim_type": {"enum": ["openstack", "openvim", "vmware", "opennebula", "aws"]},
322 "vim_url": description_schema
,
323 # "vim_url_admin": description_schema,
324 # "vim_tenant": name_schema,
325 "vim_tenant_name": name_schema
,
326 "vim_user": nameshort_schema
,
327 "vim_password": nameshort_schema
,
328 "config": {"type": "object"}
330 "required": ["name", "vim_url", "vim_type", "vim_user", "vim_password", "vim_tenant_name"],
331 "additionalProperties": False
337 "description": description_schema
,
338 "dpid": {"type": "string", "pattern": "^[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){7}$"},
341 "type": {"type": "string", "enum": ["opendaylight", "floodlight", "onos"]},
342 "version": {"type": "string", "minLength": 1, "maxLength": 12},
343 "user": nameshort_schema
,
344 "password": passwd_schema
347 "title": "sdn controller information schema",
348 "$schema": "http://json-schema.org/draft-04/schema#",
350 "properties": sdn_properties
,
351 "required": ["name", "port", 'ip', 'dpid', 'type'],
352 "additionalProperties": False
355 "title": "sdn controller update information schema",
356 "$schema": "http://json-schema.org/draft-04/schema#",
358 "properties": sdn_properties
,
359 # "required": ["name", "port", 'ip', 'dpid', 'type'],
360 "additionalProperties": False
362 sdn_port_mapping_schema
= {
363 "$schema": "http://json-schema.org/draft-04/schema#",
364 "title": "sdn port mapping information schema",
369 "compute_node": nameshort_schema
,
376 "switch_port": nameshort_schema
,
377 "switch_mac": mac_schema
383 "required": ["compute_node", "ports"]
386 sdn_external_port_schema
= {
387 "$schema": "http://json-schema.org/draft-04/schema#",
388 "title": "External port ingformation",
391 "port": {"type": "string", "minLength": 1, "maxLength": 60},
399 nbi_new_input_schemas
= {
400 "vim_accounts": vim_account_new_schema
,
401 "sdns": sdn_new_schema
,
402 "ns_instantiate": ns_instantiate
,
403 "ns_action": ns_action
,
407 nbi_edit_input_schemas
= {
408 "vim_accounts": vim_account_edit_schema
,
409 "sdns": sdn_edit_schema
413 class ValidationError(Exception):
417 def validate_input(indata
, item
, new
=True):
419 Validates input data agains json schema
420 :param indata: user input data. Should be a dictionary
421 :param item: can be users, projects, vims, sdns, ns_xxxxx
422 :param new: True if the validation is for creating or False if it is for editing
423 :return: None if ok, raises ValidationError exception otherwise
427 schema_to_use
= nbi_new_input_schemas
.get(item
)
429 schema_to_use
= nbi_edit_input_schemas
.get(item
)
431 js_v(indata
, schema_to_use
)
433 except js_e
.ValidationError
as e
:
435 error_pos
= "at '" + ":".join(map(str, e
.path
)) + "'"
438 raise ValidationError("Format error {} '{}' ".format(error_pos
, e
.message
))