blob: 761ee2089fe2e81a9c35753ec4c7a1d60706a858 [file] [log] [blame]
tierno0f98af52018-03-19 10:28:22 +01001# -*- coding: utf-8 -*-
2
tiernod125caf2018-11-22 16:05:54 +00003# 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
6#
7# http://www.apache.org/licenses/LICENSE-2.0
8#
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
12# implied.
13# See the License for the specific language governing permissions and
14# limitations under the License.
15
tierno0f98af52018-03-19 10:28:22 +010016from jsonschema import validate as js_v, exceptions as js_e
tierno36ec8602018-11-02 17:27:11 +010017from http import HTTPStatus
garciadeblasdaf8cc52018-11-30 14:17:20 +010018from copy import deepcopy
delacruzramoc061f562019-04-05 11:00:02 +020019from uuid import UUID # To test for valid UUID
tierno0f98af52018-03-19 10:28:22 +010020
21__author__ = "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
22__version__ = "0.1"
23version_date = "Mar 2018"
24
25"""
26Validator of input data using JSON schemas for those items that not contains an OSM yang information model
27"""
28
29# Basis schemas
30patern_name = "^[ -~]+$"
tiernofd160572019-01-21 10:41:37 +000031shortname_schema = {"type": "string", "minLength": 1, "maxLength": 60, "pattern": "^[^,;()\\.\\$'\"]+$"}
tierno0f98af52018-03-19 10:28:22 +010032passwd_schema = {"type": "string", "minLength": 1, "maxLength": 60}
tierno0f98af52018-03-19 10:28:22 +010033name_schema = {"type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[^,;()'\"]+$"}
tierno0da52252018-06-27 15:47:22 +020034string_schema = {"type": "string", "minLength": 1, "maxLength": 255}
tierno0f98af52018-03-19 10:28:22 +010035xml_text_schema = {"type": "string", "minLength": 1, "maxLength": 1000, "pattern": "^[^']+$"}
36description_schema = {"type": ["string", "null"], "maxLength": 255, "pattern": "^[^'\"]+$"}
tierno441dbbf2018-07-10 12:52:48 +020037id_schema_fake = {"type": "string", "minLength": 2, "maxLength": 36}
38bool_schema = {"type": "boolean"}
39null_schema = {"type": "null"}
tierno2236d202018-05-16 19:05:16 +020040# "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}$"
tierno0f98af52018-03-19 10:28:22 +010041id_schema = {"type": "string", "pattern": "^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$"}
tiernof759d822018-06-11 18:54:54 +020042time_schema = {"type": "string", "pattern": "^[0-9]{4}-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]([0-5]:){2}"}
tierno87006042018-10-24 12:50:20 +020043pci_schema = {"type": "string", "pattern": "^[0-9a-fA-F]{4}(:[0-9a-fA-F]{2}){2}\\.[0-9a-fA-F]$"}
tierno42fce592018-11-02 09:23:43 +010044# allows [] for wildcards. For that reason huge length limit is set
45pci_extended_schema = {"type": "string", "pattern": "^[0-9a-fA-F.:-\\[\\]]{12,40}$"}
tierno0f98af52018-03-19 10:28:22 +010046http_schema = {"type": "string", "pattern": "^https?://[^'\"=]+$"}
47bandwidth_schema = {"type": "string", "pattern": "^[0-9]+ *([MG]bps)?$"}
48memory_schema = {"type": "string", "pattern": "^[0-9]+ *([MG]i?[Bb])?$"}
49integer0_schema = {"type": "integer", "minimum": 0}
50integer1_schema = {"type": "integer", "minimum": 1}
tierno87006042018-10-24 12:50:20 +020051path_schema = {"type": "string", "pattern": "^(\\.){0,2}(/[^/\"':{}\\(\\)]+)+$"}
tierno0f98af52018-03-19 10:28:22 +010052vlan_schema = {"type": "integer", "minimum": 1, "maximum": 4095}
53vlan1000_schema = {"type": "integer", "minimum": 1000, "maximum": 4095}
54mac_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
tiernocb83c942018-09-24 17:28:13 +020056dpid_Schema = {"type": "string", "pattern": "^[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){7}$"}
tierno0f98af52018-03-19 10:28:22 +010057# mac_schema={"type":"string", "pattern":"^([0-9a-fA-F]{2}:){5}[0-9a-fA-F]{2}$"}
58ip_schema = {"type": "string",
tierno87006042018-10-24 12:50:20 +020059 "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]?)$"}
tierno0f98af52018-03-19 10:28:22 +010060ip_prefix_schema = {"type": "string",
tierno87006042018-10-24 12:50:20 +020061 "pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}"
tierno2236d202018-05-16 19:05:16 +020062 "(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/(30|[12]?[0-9])$"}
tierno0f98af52018-03-19 10:28:22 +010063port_schema = {"type": "integer", "minimum": 1, "maximum": 65534}
64object_schema = {"type": "object"}
65schema_version_2 = {"type": "integer", "minimum": 2, "maximum": 2}
66# schema_version_string={"type":"string","enum": ["0.1", "2", "0.2", "3", "0.3"]}
67log_level_schema = {"type": "string", "enum": ["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"]}
68checksum_schema = {"type": "string", "pattern": "^[0-9a-fA-F]{32}$"}
69size_schema = {"type": "integer", "minimum": 1, "maximum": 100}
tiernocd54a4a2018-09-12 16:40:35 +020070array_edition_schema = {
71 "type": "object",
72 "patternProperties": {
tiernofd160572019-01-21 10:41:37 +000073 "^\\$": {}
tiernocd54a4a2018-09-12 16:40:35 +020074 },
75 "additionalProperties": False,
76 "minProperties": 1,
77}
tiernocb83c942018-09-24 17:28:13 +020078nameshort_list_schema = {
79 "type": "array",
80 "minItems": 1,
tiernofd160572019-01-21 10:41:37 +000081 "items": shortname_schema,
tiernocb83c942018-09-24 17:28:13 +020082}
tiernocd54a4a2018-09-12 16:40:35 +020083
tierno0f98af52018-03-19 10:28:22 +010084
tierno441dbbf2018-07-10 12:52:48 +020085ns_instantiate_vdu = {
86 "title": "ns action instantiate input schema for vdu",
87 "$schema": "http://json-schema.org/draft-04/schema#",
88 "type": "object",
89 "properties": {
90 "id": name_schema,
91 "volume": {
92 "type": "array",
93 "minItems": 1,
94 "items": {
95 "type": "object",
96 "properties": {
97 "name": name_schema,
98 "vim-volume-id": name_schema,
99 },
100 "required": ["name", "vim-volume-id"],
101 "additionalProperties": False
102 }
103 },
104 "interface": {
105 "type": "array",
106 "minItems": 1,
107 "items": {
108 "type": "object",
109 "properties": {
110 "name": name_schema,
111 "ip-address": ip_schema,
112 "mac-address": mac_schema,
113 "floating-ip-required": bool_schema,
114 },
115 "required": ["name"],
116 "additionalProperties": False
117 }
118 }
119 },
120 "required": ["id"],
121 "additionalProperties": False
122}
123
124ip_profile_dns_schema = {
125 "type": "array",
126 "minItems": 1,
127 "items": {
128 "type": "object",
129 "properties": {
130 "address": ip_schema,
131 },
132 "required": ["address"],
133 "additionalProperties": False
134 }
135}
136
137ip_profile_dhcp_schema = {
138 "type": "object",
139 "properties": {
140 "enabled": {"type": "boolean"},
141 "count": integer1_schema,
142 "start-address": ip_schema
143 },
144 "additionalProperties": False,
145}
146
147ip_profile_schema = {
148 "title": "ip profile validation schame",
149 "$schema": "http://json-schema.org/draft-04/schema#",
150 "type": "object",
151 "properties": {
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,
157 }
158}
159
160ip_profile_update_schema = {
161 "title": "ip profile validation schame",
162 "$schema": "http://json-schema.org/draft-04/schema#",
163 "type": "object",
164 "properties": {
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]},
169
170 "dhcp-params": {"oneOf": [null_schema, ip_profile_dhcp_schema]},
171 },
172 "additionalProperties": False
173}
174
175ns_instantiate_internal_vld = {
176 "title": "ns action instantiate input schema for vdu",
177 "$schema": "http://json-schema.org/draft-04/schema#",
178 "type": "object",
179 "properties": {
180 "name": name_schema,
181 "vim-network-name": name_schema,
gcalvino17d5b732018-12-17 16:26:21 +0100182 "vim-network-id": name_schema,
tierno441dbbf2018-07-10 12:52:48 +0200183 "ip-profile": ip_profile_update_schema,
184 "internal-connection-point": {
185 "type": "array",
186 "minItems": 1,
187 "items": {
188 "type": "object",
189 "properties": {
190 "id-ref": name_schema,
191 "ip-address": ip_schema,
tiernob7c6f2a2018-09-03 14:32:10 +0200192 # "mac-address": mac_schema,
tierno441dbbf2018-07-10 12:52:48 +0200193 },
tiernob7c6f2a2018-09-03 14:32:10 +0200194 "required": ["id-ref"],
195 "minProperties": 2,
tierno441dbbf2018-07-10 12:52:48 +0200196 "additionalProperties": False
197 },
198 }
199 },
200 "required": ["name"],
201 "minProperties": 2,
202 "additionalProperties": False
203}
tierno65acb4d2018-04-06 16:42:40 +0200204
tiernofd160572019-01-21 10:41:37 +0000205additional_params_for_vnf = {
206 "type": "array",
207 "items": {
208 "type": "object",
209 "properties": {
210 "member-vnf-index": name_schema,
211 "additionalParams": object_schema,
212 },
213 "required": ["member-vnf-index", "additionalParams"],
214 "additionalProperties": False
215 }
216
217}
218
tierno65acb4d2018-04-06 16:42:40 +0200219ns_instantiate = {
220 "title": "ns action instantiate input schema",
221 "$schema": "http://json-schema.org/draft-04/schema#",
222 "type": "object",
tierno0da52252018-06-27 15:47:22 +0200223 "properties": {
tiernob24258a2018-10-04 18:39:49 +0200224 "lcmOperationType": string_schema,
225 "nsInstanceId": id_schema,
Felipe Vicens07f31722018-10-29 15:16:44 +0100226 "netsliceInstanceId": id_schema,
tierno0da52252018-06-27 15:47:22 +0200227 "nsName": name_schema,
tierno4f9d4ae2019-03-20 17:24:11 +0000228 "nsDescription": {"oneOf": [description_schema, null_schema]},
tierno0da52252018-06-27 15:47:22 +0200229 "nsdId": id_schema,
230 "vimAccountId": id_schema,
tierno4f9d4ae2019-03-20 17:24:11 +0000231 "wimAccountId": {"OneOf": [id_schema, bool_schema, null_schema]},
tiernobee085c2018-12-12 17:03:04 +0000232 "additionalParamsForNs": object_schema,
tiernofd160572019-01-21 10:41:37 +0000233 "additionalParamsForVnf": additional_params_for_vnf,
tiernofc5089c2018-10-31 09:28:11 +0100234 "ssh_keys": {"type": "array", "items": {"type": "string"}},
tierno441dbbf2018-07-10 12:52:48 +0200235 "nsr_id": id_schema,
tiernocc103432018-10-19 14:10:35 +0200236 "vduImage": name_schema,
tierno0da52252018-06-27 15:47:22 +0200237 "vnf": {
238 "type": "array",
239 "minItems": 1,
240 "items": {
241 "type": "object",
242 "properties": {
243 "member-vnf-index": name_schema,
244 "vimAccountId": id_schema,
tierno441dbbf2018-07-10 12:52:48 +0200245 "vdu": {
246 "type": "array",
247 "minItems": 1,
248 "items": ns_instantiate_vdu,
249 },
250 "internal-vld": {
251 "type": "array",
252 "minItems": 1,
253 "items": ns_instantiate_internal_vld
254 }
tierno0da52252018-06-27 15:47:22 +0200255 },
tierno441dbbf2018-07-10 12:52:48 +0200256 "required": ["member-vnf-index"],
257 "minProperties": 2,
258 "additionalProperties": False
tierno0da52252018-06-27 15:47:22 +0200259 }
260 },
261 "vld": {
262 "type": "array",
263 "minItems": 1,
264 "items": {
265 "type": "object",
266 "properties": {
267 "name": string_schema,
268 "vim-network-name": {"OneOf": [string_schema, object_schema]},
gcalvino17d5b732018-12-17 16:26:21 +0100269 "vim-network-id": {"OneOf": [string_schema, object_schema]},
Felipe Vicens09e65422019-01-22 15:06:46 +0100270 "ns-net": object_schema,
tierno4f9d4ae2019-03-20 17:24:11 +0000271 "wimAccountId": {"OneOf": [id_schema, bool_schema, null_schema]},
tierno0da52252018-06-27 15:47:22 +0200272 "ip-profile": object_schema,
tiernob7c6f2a2018-09-03 14:32:10 +0200273 "vnfd-connection-point-ref": {
274 "type": "array",
275 "minItems": 1,
276 "items": {
277 "type": "object",
278 "properties": {
279 "member-vnf-index-ref": name_schema,
280 "vnfd-connection-point-ref": name_schema,
281 "ip-address": ip_schema,
282 # "mac-address": mac_schema,
283 },
284 "required": ["member-vnf-index-ref", "vnfd-connection-point-ref"],
285 "minProperties": 3,
286 "additionalProperties": False
287 },
288 }
tierno0da52252018-06-27 15:47:22 +0200289 },
tierno441dbbf2018-07-10 12:52:48 +0200290 "required": ["name"],
291 "additionalProperties": False
tierno0da52252018-06-27 15:47:22 +0200292 }
293 },
294 },
tierno441dbbf2018-07-10 12:52:48 +0200295 "required": ["nsName", "nsdId", "vimAccountId"],
296 "additionalProperties": False
tierno65acb4d2018-04-06 16:42:40 +0200297}
tierno0da52252018-06-27 15:47:22 +0200298
tierno65acb4d2018-04-06 16:42:40 +0200299ns_action = { # TODO for the moment it is only contemplated the vnfd primitive execution
tiernof759d822018-06-11 18:54:54 +0200300 "title": "ns action input schema",
tierno65acb4d2018-04-06 16:42:40 +0200301 "$schema": "http://json-schema.org/draft-04/schema#",
302 "type": "object",
303 "properties": {
tiernob24258a2018-10-04 18:39:49 +0200304 "lcmOperationType": string_schema,
305 "nsInstanceId": id_schema,
tiernof5298be2018-05-16 14:43:57 +0200306 "member_vnf_index": name_schema,
307 "vnf_member_index": name_schema, # TODO for backward compatibility. To remove in future
tierno7ce1db92018-07-25 12:50:52 +0200308 "vdu_id": name_schema,
tiernof0637052019-03-07 16:26:47 +0000309 "vdu_count_index": integer0_schema,
tierno65acb4d2018-04-06 16:42:40 +0200310 "primitive": name_schema,
311 "primitive_params": {"type": "object"},
312 },
tiernof5298be2018-05-16 14:43:57 +0200313 "required": ["primitive", "primitive_params"], # TODO add member_vnf_index
tierno65acb4d2018-04-06 16:42:40 +0200314 "additionalProperties": False
315}
tiernof759d822018-06-11 18:54:54 +0200316ns_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#",
319 "type": "object",
320 "properties": {
tiernob24258a2018-10-04 18:39:49 +0200321 "lcmOperationType": string_schema,
322 "nsInstanceId": id_schema,
tiernof759d822018-06-11 18:54:54 +0200323 "scaleType": {"enum": ["SCALE_VNF"]},
324 "scaleVnfData": {
325 "type": "object",
326 "properties": {
327 "vnfInstanceId": name_schema,
328 "scaleVnfType": {"enum": ["SCALE_OUT", 'SCALE_IN']},
329 "scaleByStepData": {
330 "type": "object",
331 "properties": {
332 "scaling-group-descriptor": name_schema,
333 "member-vnf-index": name_schema,
334 "scaling-policy": name_schema,
335 },
336 "required": ["scaling-group-descriptor", "member-vnf-index"],
337 "additionalProperties": False
338 },
339 },
340 "required": ["scaleVnfType", "scaleByStepData"], # vnfInstanceId
341 "additionalProperties": False
342 },
343 "scaleTime": time_schema,
344 },
345 "required": ["scaleType", "scaleVnfData"],
346 "additionalProperties": False
347}
tierno65acb4d2018-04-06 16:42:40 +0200348
349
tierno0f98af52018-03-19 10:28:22 +0100350schema_version = {"type": "string", "enum": ["1.0"]}
tierno55ba2e62018-12-11 17:22:22 +0000351schema_type = {"type": "string"}
delacruzramo3a144c92019-10-25 09:46:33 +0200352vim_type = {"enum": ["openstack", "openvim", "vmware", "opennebula", "aws", "azure", "fos"]}
353
tierno09c073e2018-04-26 13:36:48 +0200354vim_account_edit_schema = {
355 "title": "vim_account edit input schema",
356 "$schema": "http://json-schema.org/draft-04/schema#",
357 "type": "object",
358 "properties": {
359 "name": name_schema,
360 "description": description_schema,
tierno09c073e2018-04-26 13:36:48 +0200361 "vim": name_schema,
362 "datacenter": name_schema,
delacruzramo3a144c92019-10-25 09:46:33 +0200363 "vim_type": vim_type,
tierno09c073e2018-04-26 13:36:48 +0200364 "vim_url": description_schema,
delacruzramo3a144c92019-10-25 09:46:33 +0200365 # "vim_url_admin": description_schema,
366 # "vim_tenant": name_schema,
tierno09c073e2018-04-26 13:36:48 +0200367 "vim_tenant_name": name_schema,
delacruzramo3a144c92019-10-25 09:46:33 +0200368 "vim_user": shortname_schema,
tiernocd54a4a2018-09-12 16:40:35 +0200369 "vim_password": passwd_schema,
tierno09c073e2018-04-26 13:36:48 +0200370 "config": {"type": "object"}
371 },
372 "additionalProperties": False
373}
tierno0f98af52018-03-19 10:28:22 +0100374
tierno09c073e2018-04-26 13:36:48 +0200375vim_account_new_schema = {
376 "title": "vim_account creation input schema",
tierno0f98af52018-03-19 10:28:22 +0100377 "$schema": "http://json-schema.org/draft-04/schema#",
378 "type": "object",
379 "properties": {
380 "schema_version": schema_version,
381 "schema_type": schema_type,
382 "name": name_schema,
383 "description": description_schema,
tierno09c073e2018-04-26 13:36:48 +0200384 "vim": name_schema,
385 "datacenter": name_schema,
delacruzramo3a144c92019-10-25 09:46:33 +0200386 "vim_type": vim_type,
tierno0f98af52018-03-19 10:28:22 +0100387 "vim_url": description_schema,
388 # "vim_url_admin": description_schema,
389 # "vim_tenant": name_schema,
390 "vim_tenant_name": name_schema,
tiernofd160572019-01-21 10:41:37 +0000391 "vim_user": shortname_schema,
tiernocd54a4a2018-09-12 16:40:35 +0200392 "vim_password": passwd_schema,
tierno0f98af52018-03-19 10:28:22 +0100393 "config": {"type": "object"}
394 },
395 "required": ["name", "vim_url", "vim_type", "vim_user", "vim_password", "vim_tenant_name"],
396 "additionalProperties": False
397}
tierno0f98af52018-03-19 10:28:22 +0100398
delacruzramo3a144c92019-10-25 09:46:33 +0200399wim_type = {"enum": ["tapi", "onos", "odl", "dynpac", "fake"]}
400
tierno55ba2e62018-12-11 17:22:22 +0000401wim_account_edit_schema = {
402 "title": "wim_account edit input schema",
403 "$schema": "http://json-schema.org/draft-04/schema#",
404 "type": "object",
405 "properties": {
406 "name": name_schema,
407 "description": description_schema,
tierno55ba2e62018-12-11 17:22:22 +0000408 "wim": name_schema,
delacruzramo3a144c92019-10-25 09:46:33 +0200409 "wim_type": wim_type,
tierno55ba2e62018-12-11 17:22:22 +0000410 "wim_url": description_schema,
tiernofd160572019-01-21 10:41:37 +0000411 "user": shortname_schema,
tierno55ba2e62018-12-11 17:22:22 +0000412 "password": passwd_schema,
413 "config": {"type": "object"}
414 },
415 "additionalProperties": False
416}
417
418wim_account_new_schema = {
419 "title": "wim_account creation input schema",
420 "$schema": "http://json-schema.org/draft-04/schema#",
421 "type": "object",
422 "properties": {
423 "schema_version": schema_version,
424 "schema_type": schema_type,
425 "name": name_schema,
426 "description": description_schema,
427 "wim": name_schema,
delacruzramo3a144c92019-10-25 09:46:33 +0200428 "wim_type": wim_type,
tierno55ba2e62018-12-11 17:22:22 +0000429 "wim_url": description_schema,
tiernofd160572019-01-21 10:41:37 +0000430 "user": shortname_schema,
tierno55ba2e62018-12-11 17:22:22 +0000431 "password": passwd_schema,
tiernof0637052019-03-07 16:26:47 +0000432 "config": {
433 "type": "object",
434 "patternProperties": {
435 ".": {"not": {"type": "null"}}
436 }
437 }
tierno55ba2e62018-12-11 17:22:22 +0000438 },
439 "required": ["name", "wim_url", "wim_type"],
440 "additionalProperties": False
441}
tierno0f98af52018-03-19 10:28:22 +0100442
443sdn_properties = {
444 "name": name_schema,
tiernocfb07c62018-05-10 18:30:51 +0200445 "description": description_schema,
tiernocb83c942018-09-24 17:28:13 +0200446 "dpid": dpid_Schema,
tierno0f98af52018-03-19 10:28:22 +0100447 "ip": ip_schema,
448 "port": port_schema,
449 "type": {"type": "string", "enum": ["opendaylight", "floodlight", "onos"]},
450 "version": {"type": "string", "minLength": 1, "maxLength": 12},
tiernofd160572019-01-21 10:41:37 +0000451 "user": shortname_schema,
tierno0f98af52018-03-19 10:28:22 +0100452 "password": passwd_schema
453}
454sdn_new_schema = {
455 "title": "sdn controller information schema",
456 "$schema": "http://json-schema.org/draft-04/schema#",
457 "type": "object",
458 "properties": sdn_properties,
459 "required": ["name", "port", 'ip', 'dpid', 'type'],
460 "additionalProperties": False
461}
462sdn_edit_schema = {
463 "title": "sdn controller update information schema",
464 "$schema": "http://json-schema.org/draft-04/schema#",
465 "type": "object",
466 "properties": sdn_properties,
tiernocfb07c62018-05-10 18:30:51 +0200467 # "required": ["name", "port", 'ip', 'dpid', 'type'],
tierno0f98af52018-03-19 10:28:22 +0100468 "additionalProperties": False
469}
470sdn_port_mapping_schema = {
471 "$schema": "http://json-schema.org/draft-04/schema#",
472 "title": "sdn port mapping information schema",
473 "type": "array",
474 "items": {
475 "type": "object",
476 "properties": {
tiernofd160572019-01-21 10:41:37 +0000477 "compute_node": shortname_schema,
tierno0f98af52018-03-19 10:28:22 +0100478 "ports": {
479 "type": "array",
480 "items": {
481 "type": "object",
482 "properties": {
tierno42fce592018-11-02 09:23:43 +0100483 "pci": pci_extended_schema,
tiernofd160572019-01-21 10:41:37 +0000484 "switch_port": shortname_schema,
tierno0f98af52018-03-19 10:28:22 +0100485 "switch_mac": mac_schema
486 },
487 "required": ["pci"]
488 }
489 }
490 },
491 "required": ["compute_node", "ports"]
492 }
493}
494sdn_external_port_schema = {
495 "$schema": "http://json-schema.org/draft-04/schema#",
tiernocd54a4a2018-09-12 16:40:35 +0200496 "title": "External port information",
tierno0f98af52018-03-19 10:28:22 +0100497 "type": "object",
498 "properties": {
499 "port": {"type": "string", "minLength": 1, "maxLength": 60},
500 "vlan": vlan_schema,
501 "mac": mac_schema
502 },
503 "required": ["port"]
504}
505
tiernocb83c942018-09-24 17:28:13 +0200506# PDUs
507pdu_interface = {
508 "type": "object",
509 "properties": {
tiernofd160572019-01-21 10:41:37 +0000510 "name": shortname_schema,
tiernocb83c942018-09-24 17:28:13 +0200511 "mgmt": bool_schema,
512 "type": {"enum": ["overlay", 'underlay']},
tierno36ec8602018-11-02 17:27:11 +0100513 "ip-address": ip_schema,
tiernocb83c942018-09-24 17:28:13 +0200514 # TODO, add user, password, ssh-key
tierno36ec8602018-11-02 17:27:11 +0100515 "mac-address": mac_schema,
tiernofd160572019-01-21 10:41:37 +0000516 "vim-network-name": shortname_schema, # interface is connected to one vim network, or switch port
517 "vim-network-id": shortname_schema,
tierno36ec8602018-11-02 17:27:11 +0100518 # # provide this in case SDN assist must deal with this interface
519 # "switch-dpid": dpid_Schema,
tiernofd160572019-01-21 10:41:37 +0000520 # "switch-port": shortname_schema,
521 # "switch-mac": shortname_schema,
tierno36ec8602018-11-02 17:27:11 +0100522 # "switch-vlan": vlan_schema,
tiernocb83c942018-09-24 17:28:13 +0200523 },
tierno36ec8602018-11-02 17:27:11 +0100524 "required": ["name", "mgmt", "ip-address"],
tiernocb83c942018-09-24 17:28:13 +0200525 "additionalProperties": False
tiernocd54a4a2018-09-12 16:40:35 +0200526}
tiernocb83c942018-09-24 17:28:13 +0200527pdu_new_schema = {
528 "title": "pdu creation input schema",
529 "$schema": "http://json-schema.org/draft-04/schema#",
530 "type": "object",
531 "properties": {
tiernofd160572019-01-21 10:41:37 +0000532 "name": shortname_schema,
533 "type": shortname_schema,
tiernocb83c942018-09-24 17:28:13 +0200534 "description": description_schema,
535 "shared": bool_schema,
536 "vims": nameshort_list_schema,
537 "vim_accounts": nameshort_list_schema,
538 "interfaces": {
539 "type": "array",
tierno36ec8602018-11-02 17:27:11 +0100540 "items": pdu_interface,
tiernocb83c942018-09-24 17:28:13 +0200541 "minItems": 1
542 }
543 },
544 "required": ["name", "type", "interfaces"],
545 "additionalProperties": False
546}
547
548pdu_edit_schema = {
549 "title": "pdu edit input schema",
550 "$schema": "http://json-schema.org/draft-04/schema#",
551 "type": "object",
552 "properties": {
tiernofd160572019-01-21 10:41:37 +0000553 "name": shortname_schema,
554 "type": shortname_schema,
tiernocb83c942018-09-24 17:28:13 +0200555 "description": description_schema,
556 "shared": bool_schema,
garciadeblas84bdd552018-11-30 22:59:45 +0100557 "vims": {"oneOf": [array_edition_schema, nameshort_list_schema]},
558 "vim_accounts": {"oneOf": [array_edition_schema, nameshort_list_schema]},
559 "interfaces": {"oneOf": [
tiernocb83c942018-09-24 17:28:13 +0200560 array_edition_schema,
561 {
562 "type": "array",
tierno36ec8602018-11-02 17:27:11 +0100563 "items": pdu_interface,
tiernocb83c942018-09-24 17:28:13 +0200564 "minItems": 1
565 }
566 ]}
567 },
568 "additionalProperties": False,
569 "minProperties": 1
570}
571
572# USERS
tiernocf042d32019-06-13 09:06:40 +0000573project_role_mappings = {
574 "title": "list pf projects/roles",
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100575 "$schema": "http://json-schema.org/draft-04/schema#",
tiernocf042d32019-06-13 09:06:40 +0000576 "type": "array",
577 "items": {
578 "type": "object",
579 "properties": {
580 "project": shortname_schema,
581 "role": shortname_schema
582 },
583 "required": ["project", "role"],
584 "additionalProperties": False
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100585 },
tiernocf042d32019-06-13 09:06:40 +0000586 "minItems": 1
587}
588project_role_mappings_optional = {
589 "title": "list of projects/roles or projects only",
590 "$schema": "http://json-schema.org/draft-04/schema#",
591 "type": "array",
592 "items": {
593 "type": "object",
594 "properties": {
595 "project": shortname_schema,
596 "role": shortname_schema
597 },
598 "required": ["project"],
599 "additionalProperties": False
600 },
601 "minItems": 1
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100602}
tiernocd54a4a2018-09-12 16:40:35 +0200603user_new_schema = {
604 "$schema": "http://json-schema.org/draft-04/schema#",
605 "title": "New user schema",
606 "type": "object",
607 "properties": {
tiernofd160572019-01-21 10:41:37 +0000608 "username": shortname_schema,
tiernocd54a4a2018-09-12 16:40:35 +0200609 "password": passwd_schema,
tiernocb83c942018-09-24 17:28:13 +0200610 "projects": nameshort_list_schema,
tiernocf042d32019-06-13 09:06:40 +0000611 "project_role_mappings": project_role_mappings,
tiernocd54a4a2018-09-12 16:40:35 +0200612 },
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100613 "required": ["username", "password"],
tiernocd54a4a2018-09-12 16:40:35 +0200614 "additionalProperties": False
615}
616user_edit_schema = {
617 "$schema": "http://json-schema.org/draft-04/schema#",
618 "title": "User edit schema for administrators",
619 "type": "object",
620 "properties": {
621 "password": passwd_schema,
delacruzramoc061f562019-04-05 11:00:02 +0200622 "username": shortname_schema, # To allow User Name modification
tiernocd54a4a2018-09-12 16:40:35 +0200623 "projects": {
garciadeblas84bdd552018-11-30 22:59:45 +0100624 "oneOf": [
tiernocb83c942018-09-24 17:28:13 +0200625 nameshort_list_schema,
tiernocd54a4a2018-09-12 16:40:35 +0200626 array_edition_schema
627 ]
628 },
tiernocf042d32019-06-13 09:06:40 +0000629 "project_role_mappings": project_role_mappings,
630 "add_project_role_mappings": project_role_mappings,
631 "remove_project_role_mappings": project_role_mappings_optional,
tiernocb83c942018-09-24 17:28:13 +0200632 },
633 "minProperties": 1,
634 "additionalProperties": False
tiernocd54a4a2018-09-12 16:40:35 +0200635}
636
637# PROJECTS
delacruzramo32bab472019-09-13 12:24:22 +0200638topics_with_quota = ["vnfds", "nsds", "nsts", "pdus", "nsrs", "nsis", "vim_accounts", "wim_accounts", "sdns"]
tiernocd54a4a2018-09-12 16:40:35 +0200639project_new_schema = {
640 "$schema": "http://json-schema.org/draft-04/schema#",
641 "title": "New project schema for administrators",
642 "type": "object",
643 "properties": {
tiernofd160572019-01-21 10:41:37 +0000644 "name": shortname_schema,
tiernocd54a4a2018-09-12 16:40:35 +0200645 "admin": bool_schema,
delacruzramo32bab472019-09-13 12:24:22 +0200646 "quotas": {
647 "type": "object",
648 "properties": {topic: integer0_schema for topic in topics_with_quota},
649 "additionalProperties": False
650 },
tiernocd54a4a2018-09-12 16:40:35 +0200651 },
652 "required": ["name"],
653 "additionalProperties": False
654}
655project_edit_schema = {
656 "$schema": "http://json-schema.org/draft-04/schema#",
657 "title": "Project edit schema for administrators",
658 "type": "object",
659 "properties": {
660 "admin": bool_schema,
delacruzramoc061f562019-04-05 11:00:02 +0200661 "name": shortname_schema, # To allow Project Name modification
delacruzramo32bab472019-09-13 12:24:22 +0200662 "quotas": {
663 "type": "object",
664 "properties": {topic: {"oneOf": [integer0_schema, null_schema]} for topic in topics_with_quota},
665 "additionalProperties": False
666 },
tiernocd54a4a2018-09-12 16:40:35 +0200667 },
668 "additionalProperties": False,
669 "minProperties": 1
670}
671
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100672# ROLES
673roles_new_schema = {
674 "$schema": "http://json-schema.org/draft-04/schema#",
675 "title": "New role schema for administrators",
676 "type": "object",
677 "properties": {
678 "name": shortname_schema,
tierno1f029d82019-06-13 22:37:04 +0000679 "permissions": {
680 "type": "object",
681 "patternProperties": {
682 ".": bool_schema,
683 },
684 # "minProperties": 1,
685 }
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100686 },
tierno1f029d82019-06-13 22:37:04 +0000687 "required": ["name"],
688 "additionalProperties": False
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100689}
690roles_edit_schema = {
691 "$schema": "http://json-schema.org/draft-04/schema#",
692 "title": "Roles edit schema for administrators",
693 "type": "object",
694 "properties": {
tierno1f029d82019-06-13 22:37:04 +0000695 "name": shortname_schema,
696 "permissions": {
697 "type": "object",
698 "patternProperties": {
699 ".": {
700 "oneOf": [bool_schema, null_schema]
701 }
702 },
703 # "minProperties": 1,
704 }
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100705 },
tierno1f029d82019-06-13 22:37:04 +0000706 "additionalProperties": False,
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100707 "minProperties": 1
708}
709
tiernocd54a4a2018-09-12 16:40:35 +0200710# GLOBAL SCHEMAS
tierno0f98af52018-03-19 10:28:22 +0100711
712nbi_new_input_schemas = {
tiernocd54a4a2018-09-12 16:40:35 +0200713 "users": user_new_schema,
714 "projects": project_new_schema,
tierno09c073e2018-04-26 13:36:48 +0200715 "vim_accounts": vim_account_new_schema,
tierno65acb4d2018-04-06 16:42:40 +0200716 "sdns": sdn_new_schema,
717 "ns_instantiate": ns_instantiate,
718 "ns_action": ns_action,
tiernocb83c942018-09-24 17:28:13 +0200719 "ns_scale": ns_scale,
720 "pdus": pdu_new_schema,
tierno0f98af52018-03-19 10:28:22 +0100721}
722
723nbi_edit_input_schemas = {
tiernocd54a4a2018-09-12 16:40:35 +0200724 "users": user_edit_schema,
725 "projects": project_edit_schema,
tierno09c073e2018-04-26 13:36:48 +0200726 "vim_accounts": vim_account_edit_schema,
tiernocb83c942018-09-24 17:28:13 +0200727 "sdns": sdn_edit_schema,
728 "pdus": pdu_edit_schema,
tierno0f98af52018-03-19 10:28:22 +0100729}
730
Felipe Vicens07f31722018-10-29 15:16:44 +0100731# NETSLICE SCHEMAS
tierno032916c2019-03-22 13:27:12 +0000732nsi_subnet_instantiate = deepcopy(ns_instantiate)
733nsi_subnet_instantiate["title"] = "netslice subnet instantiation params input schema"
734nsi_subnet_instantiate["properties"]["id"] = name_schema
735del nsi_subnet_instantiate["required"]
garciadeblasdaf8cc52018-11-30 14:17:20 +0100736
737nsi_vld_instantiate = {
738 "title": "netslice vld instantiation params input schema",
739 "$schema": "http://json-schema.org/draft-04/schema#",
740 "type": "object",
741 "properties": {
742 "name": string_schema,
743 "vim-network-name": {"OneOf": [string_schema, object_schema]},
gcalvino17d5b732018-12-17 16:26:21 +0100744 "vim-network-id": {"OneOf": [string_schema, object_schema]},
garciadeblasdaf8cc52018-11-30 14:17:20 +0100745 "ip-profile": object_schema,
746 },
delacruzramoc061f562019-04-05 11:00:02 +0200747 "required": ["name"],
garciadeblasdaf8cc52018-11-30 14:17:20 +0100748 "additionalProperties": False
749}
750
Felipe Vicens07f31722018-10-29 15:16:44 +0100751nsi_instantiate = {
752 "title": "netslice action instantiate input schema",
753 "$schema": "http://json-schema.org/draft-04/schema#",
754 "type": "object",
755 "properties": {
756 "lcmOperationType": string_schema,
Felipe Vicens126af572019-06-05 19:13:04 +0200757 "netsliceInstanceId": id_schema,
Felipe Vicens07f31722018-10-29 15:16:44 +0100758 "nsiName": name_schema,
tierno4f9d4ae2019-03-20 17:24:11 +0000759 "nsiDescription": {"oneOf": [description_schema, null_schema]},
tierno9e5eea32018-11-29 09:42:09 +0000760 "nstId": string_schema,
Felipe Vicens07f31722018-10-29 15:16:44 +0100761 "vimAccountId": id_schema,
762 "ssh_keys": {"type": "string"},
763 "nsi_id": id_schema,
tierno032916c2019-03-22 13:27:12 +0000764 "additionalParamsForNsi": object_schema,
garciadeblasdaf8cc52018-11-30 14:17:20 +0100765 "netslice-subnet": {
Felipe Vicens07f31722018-10-29 15:16:44 +0100766 "type": "array",
767 "minItems": 1,
tierno032916c2019-03-22 13:27:12 +0000768 "items": nsi_subnet_instantiate
garciadeblasdaf8cc52018-11-30 14:17:20 +0100769 },
770 "netslice-vld": {
771 "type": "array",
772 "minItems": 1,
773 "items": nsi_vld_instantiate
Felipe Vicens07f31722018-10-29 15:16:44 +0100774 },
775 },
Felipe Vicensc8bbaaa2018-12-01 04:42:40 +0100776 "required": ["nsiName", "nstId", "vimAccountId"],
Felipe Vicens07f31722018-10-29 15:16:44 +0100777 "additionalProperties": False
778}
779
780nsi_action = {
781
782}
783
784nsi_terminate = {
delacruzramoc061f562019-04-05 11:00:02 +0200785
Felipe Vicens07f31722018-10-29 15:16:44 +0100786}
787
tierno0f98af52018-03-19 10:28:22 +0100788
789class ValidationError(Exception):
tierno36ec8602018-11-02 17:27:11 +0100790 def __init__(self, message, http_code=HTTPStatus.UNPROCESSABLE_ENTITY):
791 self.http_code = http_code
792 Exception.__init__(self, message)
tierno0f98af52018-03-19 10:28:22 +0100793
794
tiernob24258a2018-10-04 18:39:49 +0200795def validate_input(indata, schema_to_use):
tierno0f98af52018-03-19 10:28:22 +0100796 """
tiernocd54a4a2018-09-12 16:40:35 +0200797 Validates input data against json schema
tierno0f98af52018-03-19 10:28:22 +0100798 :param indata: user input data. Should be a dictionary
tiernob24258a2018-10-04 18:39:49 +0200799 :param schema_to_use: jsonschema to test
800 :return: None if ok, raises ValidationError exception on error
tierno0f98af52018-03-19 10:28:22 +0100801 """
802 try:
tierno0f98af52018-03-19 10:28:22 +0100803 if schema_to_use:
804 js_v(indata, schema_to_use)
805 return None
806 except js_e.ValidationError as e:
807 if e.path:
tierno0da52252018-06-27 15:47:22 +0200808 error_pos = "at '" + ":".join(map(str, e.path)) + "'"
tierno0f98af52018-03-19 10:28:22 +0100809 else:
810 error_pos = ""
tierno441dbbf2018-07-10 12:52:48 +0200811 raise ValidationError("Format error {} '{}' ".format(error_pos, e.message))
tierno36ec8602018-11-02 17:27:11 +0100812 except js_e.SchemaError:
813 raise ValidationError("Bad json schema {}".format(schema_to_use), http_code=HTTPStatus.INTERNAL_SERVER_ERROR)
delacruzramoc061f562019-04-05 11:00:02 +0200814
815
816def is_valid_uuid(x):
817 """
818 Test for a valid UUID
819 :param x: string to test
820 :return: True if x is a valid uuid, False otherwise
821 """
822 try:
823 if UUID(x):
824 return True
tiernobdebce92019-07-01 15:36:49 +0000825 except (TypeError, ValueError, AttributeError):
delacruzramoc061f562019-04-05 11:00:02 +0200826 return False