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 xml_text_schema
= {"type": "string", "minLength": 1, "maxLength": 1000, "pattern": "^[^']+$"}
19 description_schema
= {"type": ["string", "null"], "maxLength": 255, "pattern": "^[^'\"]+$"}
20 id_schema_fake
= {"type": "string", "minLength": 2,
22 # "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}$"
23 id_schema
= {"type": "string", "pattern": "^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$"}
24 pci_schema
= {"type": "string", "pattern": "^[0-9a-fA-F]{4}(:[0-9a-fA-F]{2}){2}\.[0-9a-fA-F]$"}
25 http_schema
= {"type": "string", "pattern": "^https?://[^'\"=]+$"}
26 bandwidth_schema
= {"type": "string", "pattern": "^[0-9]+ *([MG]bps)?$"}
27 memory_schema
= {"type": "string", "pattern": "^[0-9]+ *([MG]i?[Bb])?$"}
28 integer0_schema
= {"type": "integer", "minimum": 0}
29 integer1_schema
= {"type": "integer", "minimum": 1}
30 path_schema
= {"type": "string", "pattern": "^(\.){0,2}(/[^/\"':{}\(\)]+)+$"}
31 vlan_schema
= {"type": "integer", "minimum": 1, "maximum": 4095}
32 vlan1000_schema
= {"type": "integer", "minimum": 1000, "maximum": 4095}
33 mac_schema
= {"type": "string",
34 "pattern": "^[0-9a-fA-F][02468aceACE](:[0-9a-fA-F]{2}){5}$"} # must be unicast: LSB bit of MSB byte ==0
35 # mac_schema={"type":"string", "pattern":"^([0-9a-fA-F]{2}:){5}[0-9a-fA-F]{2}$"}
36 ip_schema
= {"type": "string",
37 "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]?)$"}
38 ip_prefix_schema
= {"type": "string",
39 "pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}"
40 "(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/(30|[12]?[0-9])$"}
41 port_schema
= {"type": "integer", "minimum": 1, "maximum": 65534}
42 object_schema
= {"type": "object"}
43 schema_version_2
= {"type": "integer", "minimum": 2, "maximum": 2}
44 # schema_version_string={"type":"string","enum": ["0.1", "2", "0.2", "3", "0.3"]}
45 log_level_schema
= {"type": "string", "enum": ["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"]}
46 checksum_schema
= {"type": "string", "pattern": "^[0-9a-fA-F]{32}$"}
47 size_schema
= {"type": "integer", "minimum": 1, "maximum": 100}
51 "title": "ns action instantiate input schema",
52 "$schema": "http://json-schema.org/draft-04/schema#",
55 ns_action
= { # TODO for the moment it is only contemplated the vnfd primitive execution
56 "title": "ns action update input schema",
57 "$schema": "http://json-schema.org/draft-04/schema#",
60 "member_vnf_index": name_schema
,
61 "vnf_member_index": name_schema
, # TODO for backward compatibility. To remove in future
62 "primitive": name_schema
,
63 "primitive_params": {"type": "object"},
65 "required": ["primitive", "primitive_params"], # TODO add member_vnf_index
66 "additionalProperties": False
70 schema_version
= {"type": "string", "enum": ["1.0"]}
71 vim_account_edit_schema
= {
72 "title": "vim_account edit input schema",
73 "$schema": "http://json-schema.org/draft-04/schema#",
77 "description": description_schema
,
78 "type": nameshort_schema
, # currently "openvim" or "openstack", can be enlarged with plugins
80 "datacenter": name_schema
,
81 "vim_url": description_schema
,
82 "vim_url_admin": description_schema
,
83 "vim_tenant": name_schema
,
84 "vim_tenant_name": name_schema
,
85 "vim_username": nameshort_schema
,
86 "vim_password": nameshort_schema
,
87 "config": {"type": "object"}
89 "additionalProperties": False
91 schema_type
= {"type": "string"}
93 vim_account_new_schema
= {
94 "title": "vim_account creation input schema",
95 "$schema": "http://json-schema.org/draft-04/schema#",
98 "schema_version": schema_version
,
99 "schema_type": schema_type
,
101 "description": description_schema
,
103 "datacenter": name_schema
,
104 "vim_type": {"enum": ["openstack", "openvim", "vmware", "opennebula", "aws"]},
105 "vim_url": description_schema
,
106 # "vim_url_admin": description_schema,
107 # "vim_tenant": name_schema,
108 "vim_tenant_name": name_schema
,
109 "vim_user": nameshort_schema
,
110 "vim_password": nameshort_schema
,
111 "config": {"type": "object"}
113 "required": ["name", "vim_url", "vim_type", "vim_user", "vim_password", "vim_tenant_name"],
114 "additionalProperties": False
120 "description": description_schema
,
121 "dpid": {"type": "string", "pattern": "^[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){7}$"},
124 "type": {"type": "string", "enum": ["opendaylight", "floodlight", "onos"]},
125 "version": {"type": "string", "minLength": 1, "maxLength": 12},
126 "user": nameshort_schema
,
127 "password": passwd_schema
130 "title": "sdn controller information schema",
131 "$schema": "http://json-schema.org/draft-04/schema#",
133 "properties": sdn_properties
,
134 "required": ["name", "port", 'ip', 'dpid', 'type'],
135 "additionalProperties": False
138 "title": "sdn controller update information schema",
139 "$schema": "http://json-schema.org/draft-04/schema#",
141 "properties": sdn_properties
,
142 # "required": ["name", "port", 'ip', 'dpid', 'type'],
143 "additionalProperties": False
145 sdn_port_mapping_schema
= {
146 "$schema": "http://json-schema.org/draft-04/schema#",
147 "title": "sdn port mapping information schema",
152 "compute_node": nameshort_schema
,
159 "switch_port": nameshort_schema
,
160 "switch_mac": mac_schema
166 "required": ["compute_node", "ports"]
169 sdn_external_port_schema
= {
170 "$schema": "http://json-schema.org/draft-04/schema#",
171 "title": "External port ingformation",
174 "port": {"type": "string", "minLength": 1, "maxLength": 60},
182 nbi_new_input_schemas
= {
183 "vim_accounts": vim_account_new_schema
,
184 "sdns": sdn_new_schema
,
185 "ns_instantiate": ns_instantiate
,
186 "ns_action": ns_action
,
189 nbi_edit_input_schemas
= {
190 "vim_accounts": vim_account_edit_schema
,
191 "sdns": sdn_edit_schema
195 class ValidationError(Exception):
199 def validate_input(indata
, item
, new
=True):
201 Validates input data agains json schema
202 :param indata: user input data. Should be a dictionary
203 :param item: can be users, projects, vims, sdns, ns_xxxxx
204 :param new: True if the validation is for creating or False if it is for editing
205 :return: None if ok, raises ValidationError exception otherwise
209 schema_to_use
= nbi_new_input_schemas
.get(item
)
211 schema_to_use
= nbi_edit_input_schemas
.get(item
)
213 js_v(indata
, schema_to_use
)
215 except js_e
.ValidationError
as e
:
217 error_pos
= "at '" + ":".join(e
.path
) + "'"
220 raise ValidationError("Format error {} '{}' ".format(error_pos
, e
))