blob: c4f6fb7e605e5f64db0a5133aaf7c112c716e6cb [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
kbsub21f03f52019-10-17 16:26:56 +0000175provider_network_schema = {
176 "title": "provider network validation schame",
177 "$schema": "http://json-schema.org/draft-04/schema#",
178 "type": "object",
179 "properties": {
180 "physical-network": name_schema,
181 "segmentation-id": name_schema,
182 },
183 "additionalProperties": False
184}
185
tierno441dbbf2018-07-10 12:52:48 +0200186ns_instantiate_internal_vld = {
187 "title": "ns action instantiate input schema for vdu",
188 "$schema": "http://json-schema.org/draft-04/schema#",
189 "type": "object",
190 "properties": {
191 "name": name_schema,
192 "vim-network-name": name_schema,
gcalvino17d5b732018-12-17 16:26:21 +0100193 "vim-network-id": name_schema,
tierno441dbbf2018-07-10 12:52:48 +0200194 "ip-profile": ip_profile_update_schema,
kbsub21f03f52019-10-17 16:26:56 +0000195 "provider-network": provider_network_schema,
tierno441dbbf2018-07-10 12:52:48 +0200196 "internal-connection-point": {
197 "type": "array",
198 "minItems": 1,
199 "items": {
200 "type": "object",
201 "properties": {
202 "id-ref": name_schema,
203 "ip-address": ip_schema,
tiernob7c6f2a2018-09-03 14:32:10 +0200204 # "mac-address": mac_schema,
tierno441dbbf2018-07-10 12:52:48 +0200205 },
tiernob7c6f2a2018-09-03 14:32:10 +0200206 "required": ["id-ref"],
207 "minProperties": 2,
tierno441dbbf2018-07-10 12:52:48 +0200208 "additionalProperties": False
209 },
210 }
211 },
212 "required": ["name"],
213 "minProperties": 2,
214 "additionalProperties": False
215}
tierno65acb4d2018-04-06 16:42:40 +0200216
tiernofd160572019-01-21 10:41:37 +0000217additional_params_for_vnf = {
218 "type": "array",
219 "items": {
220 "type": "object",
221 "properties": {
222 "member-vnf-index": name_schema,
223 "additionalParams": object_schema,
tierno714954e2019-11-29 13:43:26 +0000224 "additionalParamsForVdu": {
225 "type": "array",
226 "items": {
227 "type": "object",
228 "properties": {
229 "vdu_id": name_schema,
230 "additionalParams": object_schema,
231 },
232 "required": ["vdu_id", "additionalParams"],
233 "additionalProperties": False,
234 },
235 },
236 "additionalParamsForKdu": {
237 "type": "array",
238 "items": {
239 "type": "object",
240 "properties": {
241 "kdu_name": name_schema,
242 "additionalParams": object_schema,
243 },
244 "required": ["kdu_name", "additionalParams"],
245 "additionalProperties": False,
246 },
247 },
tiernofd160572019-01-21 10:41:37 +0000248 },
tierno714954e2019-11-29 13:43:26 +0000249 "required": ["member-vnf-index"],
250 "minProperties": 2,
tiernofd160572019-01-21 10:41:37 +0000251 "additionalProperties": False
252 }
tiernofd160572019-01-21 10:41:37 +0000253}
254
tierno65acb4d2018-04-06 16:42:40 +0200255ns_instantiate = {
256 "title": "ns action instantiate input schema",
257 "$schema": "http://json-schema.org/draft-04/schema#",
258 "type": "object",
tierno0da52252018-06-27 15:47:22 +0200259 "properties": {
tiernob24258a2018-10-04 18:39:49 +0200260 "lcmOperationType": string_schema,
261 "nsInstanceId": id_schema,
Felipe Vicens07f31722018-10-29 15:16:44 +0100262 "netsliceInstanceId": id_schema,
tierno0da52252018-06-27 15:47:22 +0200263 "nsName": name_schema,
tierno4f9d4ae2019-03-20 17:24:11 +0000264 "nsDescription": {"oneOf": [description_schema, null_schema]},
tierno0da52252018-06-27 15:47:22 +0200265 "nsdId": id_schema,
266 "vimAccountId": id_schema,
tierno4f9d4ae2019-03-20 17:24:11 +0000267 "wimAccountId": {"OneOf": [id_schema, bool_schema, null_schema]},
tiernobee085c2018-12-12 17:03:04 +0000268 "additionalParamsForNs": object_schema,
tiernofd160572019-01-21 10:41:37 +0000269 "additionalParamsForVnf": additional_params_for_vnf,
tiernofc5089c2018-10-31 09:28:11 +0100270 "ssh_keys": {"type": "array", "items": {"type": "string"}},
tierno441dbbf2018-07-10 12:52:48 +0200271 "nsr_id": id_schema,
tiernocc103432018-10-19 14:10:35 +0200272 "vduImage": name_schema,
tierno0da52252018-06-27 15:47:22 +0200273 "vnf": {
274 "type": "array",
275 "minItems": 1,
276 "items": {
277 "type": "object",
278 "properties": {
279 "member-vnf-index": name_schema,
280 "vimAccountId": id_schema,
tierno441dbbf2018-07-10 12:52:48 +0200281 "vdu": {
282 "type": "array",
283 "minItems": 1,
284 "items": ns_instantiate_vdu,
285 },
286 "internal-vld": {
287 "type": "array",
288 "minItems": 1,
289 "items": ns_instantiate_internal_vld
290 }
tierno0da52252018-06-27 15:47:22 +0200291 },
tierno441dbbf2018-07-10 12:52:48 +0200292 "required": ["member-vnf-index"],
293 "minProperties": 2,
294 "additionalProperties": False
tierno0da52252018-06-27 15:47:22 +0200295 }
296 },
297 "vld": {
298 "type": "array",
299 "minItems": 1,
300 "items": {
301 "type": "object",
302 "properties": {
303 "name": string_schema,
304 "vim-network-name": {"OneOf": [string_schema, object_schema]},
gcalvino17d5b732018-12-17 16:26:21 +0100305 "vim-network-id": {"OneOf": [string_schema, object_schema]},
Felipe Vicens09e65422019-01-22 15:06:46 +0100306 "ns-net": object_schema,
tierno4f9d4ae2019-03-20 17:24:11 +0000307 "wimAccountId": {"OneOf": [id_schema, bool_schema, null_schema]},
tierno0da52252018-06-27 15:47:22 +0200308 "ip-profile": object_schema,
kbsub21f03f52019-10-17 16:26:56 +0000309 "provider-network": provider_network_schema,
tiernob7c6f2a2018-09-03 14:32:10 +0200310 "vnfd-connection-point-ref": {
311 "type": "array",
312 "minItems": 1,
313 "items": {
314 "type": "object",
315 "properties": {
316 "member-vnf-index-ref": name_schema,
317 "vnfd-connection-point-ref": name_schema,
318 "ip-address": ip_schema,
319 # "mac-address": mac_schema,
320 },
321 "required": ["member-vnf-index-ref", "vnfd-connection-point-ref"],
322 "minProperties": 3,
323 "additionalProperties": False
324 },
325 }
tierno0da52252018-06-27 15:47:22 +0200326 },
tierno441dbbf2018-07-10 12:52:48 +0200327 "required": ["name"],
328 "additionalProperties": False
tierno0da52252018-06-27 15:47:22 +0200329 }
330 },
331 },
tierno441dbbf2018-07-10 12:52:48 +0200332 "required": ["nsName", "nsdId", "vimAccountId"],
333 "additionalProperties": False
tierno65acb4d2018-04-06 16:42:40 +0200334}
tierno0da52252018-06-27 15:47:22 +0200335
tierno65acb4d2018-04-06 16:42:40 +0200336ns_action = { # TODO for the moment it is only contemplated the vnfd primitive execution
tiernof759d822018-06-11 18:54:54 +0200337 "title": "ns action input schema",
tierno65acb4d2018-04-06 16:42:40 +0200338 "$schema": "http://json-schema.org/draft-04/schema#",
339 "type": "object",
340 "properties": {
tiernob24258a2018-10-04 18:39:49 +0200341 "lcmOperationType": string_schema,
342 "nsInstanceId": id_schema,
tiernof5298be2018-05-16 14:43:57 +0200343 "member_vnf_index": name_schema,
344 "vnf_member_index": name_schema, # TODO for backward compatibility. To remove in future
tierno7ce1db92018-07-25 12:50:52 +0200345 "vdu_id": name_schema,
tiernof0637052019-03-07 16:26:47 +0000346 "vdu_count_index": integer0_schema,
tierno9cb7d672019-10-30 12:13:48 +0000347 "kdu_name": name_schema,
tierno65acb4d2018-04-06 16:42:40 +0200348 "primitive": name_schema,
349 "primitive_params": {"type": "object"},
350 },
tiernof5298be2018-05-16 14:43:57 +0200351 "required": ["primitive", "primitive_params"], # TODO add member_vnf_index
tierno65acb4d2018-04-06 16:42:40 +0200352 "additionalProperties": False
353}
tiernof759d822018-06-11 18:54:54 +0200354ns_scale = { # TODO for the moment it is only VDU-scaling
355 "title": "ns scale input schema",
356 "$schema": "http://json-schema.org/draft-04/schema#",
357 "type": "object",
358 "properties": {
tiernob24258a2018-10-04 18:39:49 +0200359 "lcmOperationType": string_schema,
360 "nsInstanceId": id_schema,
tiernof759d822018-06-11 18:54:54 +0200361 "scaleType": {"enum": ["SCALE_VNF"]},
362 "scaleVnfData": {
363 "type": "object",
364 "properties": {
365 "vnfInstanceId": name_schema,
366 "scaleVnfType": {"enum": ["SCALE_OUT", 'SCALE_IN']},
367 "scaleByStepData": {
368 "type": "object",
369 "properties": {
370 "scaling-group-descriptor": name_schema,
371 "member-vnf-index": name_schema,
372 "scaling-policy": name_schema,
373 },
374 "required": ["scaling-group-descriptor", "member-vnf-index"],
375 "additionalProperties": False
376 },
377 },
378 "required": ["scaleVnfType", "scaleByStepData"], # vnfInstanceId
379 "additionalProperties": False
380 },
381 "scaleTime": time_schema,
382 },
383 "required": ["scaleType", "scaleVnfData"],
384 "additionalProperties": False
385}
tierno65acb4d2018-04-06 16:42:40 +0200386
387
tierno0f98af52018-03-19 10:28:22 +0100388schema_version = {"type": "string", "enum": ["1.0"]}
tierno55ba2e62018-12-11 17:22:22 +0000389schema_type = {"type": "string"}
tiernob3d0a0e2019-11-13 15:57:51 +0000390vim_type = shortname_schema # {"enum": ["openstack", "openvim", "vmware", "opennebula", "aws", "azure", "fos"]}
delacruzramo3a144c92019-10-25 09:46:33 +0200391
tierno09c073e2018-04-26 13:36:48 +0200392vim_account_edit_schema = {
393 "title": "vim_account edit input schema",
394 "$schema": "http://json-schema.org/draft-04/schema#",
395 "type": "object",
396 "properties": {
397 "name": name_schema,
398 "description": description_schema,
tierno09c073e2018-04-26 13:36:48 +0200399 "vim": name_schema,
400 "datacenter": name_schema,
delacruzramo3a144c92019-10-25 09:46:33 +0200401 "vim_type": vim_type,
tierno09c073e2018-04-26 13:36:48 +0200402 "vim_url": description_schema,
delacruzramo3a144c92019-10-25 09:46:33 +0200403 # "vim_url_admin": description_schema,
404 # "vim_tenant": name_schema,
tierno09c073e2018-04-26 13:36:48 +0200405 "vim_tenant_name": name_schema,
delacruzramo3a144c92019-10-25 09:46:33 +0200406 "vim_user": shortname_schema,
tiernocd54a4a2018-09-12 16:40:35 +0200407 "vim_password": passwd_schema,
tierno09c073e2018-04-26 13:36:48 +0200408 "config": {"type": "object"}
409 },
410 "additionalProperties": False
411}
tierno0f98af52018-03-19 10:28:22 +0100412
tierno09c073e2018-04-26 13:36:48 +0200413vim_account_new_schema = {
414 "title": "vim_account creation input schema",
tierno0f98af52018-03-19 10:28:22 +0100415 "$schema": "http://json-schema.org/draft-04/schema#",
416 "type": "object",
417 "properties": {
418 "schema_version": schema_version,
419 "schema_type": schema_type,
420 "name": name_schema,
421 "description": description_schema,
tierno09c073e2018-04-26 13:36:48 +0200422 "vim": name_schema,
423 "datacenter": name_schema,
delacruzramo3a144c92019-10-25 09:46:33 +0200424 "vim_type": vim_type,
tierno0f98af52018-03-19 10:28:22 +0100425 "vim_url": description_schema,
426 # "vim_url_admin": description_schema,
427 # "vim_tenant": name_schema,
428 "vim_tenant_name": name_schema,
tiernofd160572019-01-21 10:41:37 +0000429 "vim_user": shortname_schema,
tiernocd54a4a2018-09-12 16:40:35 +0200430 "vim_password": passwd_schema,
tierno0f98af52018-03-19 10:28:22 +0100431 "config": {"type": "object"}
432 },
433 "required": ["name", "vim_url", "vim_type", "vim_user", "vim_password", "vim_tenant_name"],
434 "additionalProperties": False
435}
tierno0f98af52018-03-19 10:28:22 +0100436
tiernob3d0a0e2019-11-13 15:57:51 +0000437wim_type = shortname_schema # {"enum": ["tapi", "onos", "odl", "dynpac", "fake"]}
delacruzramo3a144c92019-10-25 09:46:33 +0200438
tierno55ba2e62018-12-11 17:22:22 +0000439wim_account_edit_schema = {
440 "title": "wim_account edit input schema",
441 "$schema": "http://json-schema.org/draft-04/schema#",
442 "type": "object",
443 "properties": {
444 "name": name_schema,
445 "description": description_schema,
tierno55ba2e62018-12-11 17:22:22 +0000446 "wim": name_schema,
delacruzramo3a144c92019-10-25 09:46:33 +0200447 "wim_type": wim_type,
tierno55ba2e62018-12-11 17:22:22 +0000448 "wim_url": description_schema,
tiernofd160572019-01-21 10:41:37 +0000449 "user": shortname_schema,
tierno55ba2e62018-12-11 17:22:22 +0000450 "password": passwd_schema,
451 "config": {"type": "object"}
452 },
453 "additionalProperties": False
454}
455
456wim_account_new_schema = {
457 "title": "wim_account creation input schema",
458 "$schema": "http://json-schema.org/draft-04/schema#",
459 "type": "object",
460 "properties": {
461 "schema_version": schema_version,
462 "schema_type": schema_type,
463 "name": name_schema,
464 "description": description_schema,
465 "wim": name_schema,
delacruzramo3a144c92019-10-25 09:46:33 +0200466 "wim_type": wim_type,
tierno55ba2e62018-12-11 17:22:22 +0000467 "wim_url": description_schema,
tiernofd160572019-01-21 10:41:37 +0000468 "user": shortname_schema,
tierno55ba2e62018-12-11 17:22:22 +0000469 "password": passwd_schema,
tiernof0637052019-03-07 16:26:47 +0000470 "config": {
471 "type": "object",
472 "patternProperties": {
473 ".": {"not": {"type": "null"}}
474 }
475 }
tierno55ba2e62018-12-11 17:22:22 +0000476 },
477 "required": ["name", "wim_url", "wim_type"],
478 "additionalProperties": False
479}
tierno0f98af52018-03-19 10:28:22 +0100480
481sdn_properties = {
482 "name": name_schema,
tierno7adaeb02019-12-17 16:46:12 +0000483 "type": {"type": "string"},
484 "url": {"type": "string"},
485 "user": shortname_schema,
486 "password": passwd_schema,
487 "config": {"type": "object"},
tiernocfb07c62018-05-10 18:30:51 +0200488 "description": description_schema,
tierno7adaeb02019-12-17 16:46:12 +0000489 # The folowing are deprecated. Maintanied for backward compatibility
tiernocb83c942018-09-24 17:28:13 +0200490 "dpid": dpid_Schema,
tierno0f98af52018-03-19 10:28:22 +0100491 "ip": ip_schema,
492 "port": port_schema,
tierno0f98af52018-03-19 10:28:22 +0100493 "version": {"type": "string", "minLength": 1, "maxLength": 12},
tierno0f98af52018-03-19 10:28:22 +0100494}
495sdn_new_schema = {
496 "title": "sdn controller information schema",
497 "$schema": "http://json-schema.org/draft-04/schema#",
498 "type": "object",
499 "properties": sdn_properties,
tierno7adaeb02019-12-17 16:46:12 +0000500 "required": ["name", 'type'],
tierno0f98af52018-03-19 10:28:22 +0100501 "additionalProperties": False
502}
503sdn_edit_schema = {
504 "title": "sdn controller update information schema",
505 "$schema": "http://json-schema.org/draft-04/schema#",
506 "type": "object",
507 "properties": sdn_properties,
tiernocfb07c62018-05-10 18:30:51 +0200508 # "required": ["name", "port", 'ip', 'dpid', 'type'],
tierno0f98af52018-03-19 10:28:22 +0100509 "additionalProperties": False
510}
511sdn_port_mapping_schema = {
512 "$schema": "http://json-schema.org/draft-04/schema#",
513 "title": "sdn port mapping information schema",
514 "type": "array",
515 "items": {
516 "type": "object",
517 "properties": {
tiernofd160572019-01-21 10:41:37 +0000518 "compute_node": shortname_schema,
tierno0f98af52018-03-19 10:28:22 +0100519 "ports": {
520 "type": "array",
521 "items": {
522 "type": "object",
523 "properties": {
tierno42fce592018-11-02 09:23:43 +0100524 "pci": pci_extended_schema,
tiernofd160572019-01-21 10:41:37 +0000525 "switch_port": shortname_schema,
tierno0f98af52018-03-19 10:28:22 +0100526 "switch_mac": mac_schema
527 },
528 "required": ["pci"]
529 }
530 }
531 },
532 "required": ["compute_node", "ports"]
533 }
534}
535sdn_external_port_schema = {
536 "$schema": "http://json-schema.org/draft-04/schema#",
tiernocd54a4a2018-09-12 16:40:35 +0200537 "title": "External port information",
tierno0f98af52018-03-19 10:28:22 +0100538 "type": "object",
539 "properties": {
540 "port": {"type": "string", "minLength": 1, "maxLength": 60},
541 "vlan": vlan_schema,
542 "mac": mac_schema
543 },
544 "required": ["port"]
545}
546
delacruzramofe598fe2019-10-23 18:25:11 +0200547# K8s Clusters
548k8scluster_nets_schema = {
549 "title": "k8scluster nets input schema",
550 "$schema": "http://json-schema.org/draft-04/schema#",
551 "type": "object",
tiernoc67b0e92019-11-05 12:45:29 +0000552 "patternProperties": {".": {"oneOf": [description_schema, null_schema]}},
delacruzramofe598fe2019-10-23 18:25:11 +0200553 "minProperties": 1,
554 "additionalProperties": False
555}
556k8scluster_new_schema = {
557 "title": "k8scluster creation input schema",
558 "$schema": "http://json-schema.org/draft-04/schema#",
559 "type": "object",
560 "properties": {
561 "schema_version": schema_version,
562 "schema_type": schema_type,
563 "name": name_schema,
564 "description": description_schema,
565 "credentials": object_schema,
566 "vim_account": id_schema,
567 "k8s_version": string_schema,
568 "nets": k8scluster_nets_schema,
569 "namespace": name_schema,
570 "cni": nameshort_list_schema,
571 },
572 "required": ["name", "credentials", "vim_account", "k8s_version", "nets"],
573 "additionalProperties": False
574}
575k8scluster_edit_schema = {
576 "title": "vim_account edit input schema",
577 "$schema": "http://json-schema.org/draft-04/schema#",
578 "type": "object",
579 "properties": {
580 "name": name_schema,
581 "description": description_schema,
582 "credentials": object_schema,
583 "vim_account": id_schema,
584 "k8s_version": string_schema,
585 "nets": k8scluster_nets_schema,
586 "namespace": name_schema,
587 "cni": nameshort_list_schema,
588 },
589 "additionalProperties": False
590}
591
592# K8s Repos
tierno332e0802019-12-03 23:50:49 +0000593k8srepo_types = {"enum": ["helm-chart", "juju-bundle"]}
delacruzramofe598fe2019-10-23 18:25:11 +0200594k8srepo_properties = {
595 "name": name_schema,
596 "description": description_schema,
597 "type": k8srepo_types,
598 "url": description_schema,
599}
600k8srepo_new_schema = {
601 "title": "k8scluster creation input schema",
602 "$schema": "http://json-schema.org/draft-04/schema#",
603 "type": "object",
604 "properties": k8srepo_properties,
605 "required": ["name", "type", "url"],
606 "additionalProperties": False
607}
608k8srepo_edit_schema = {
609 "title": "vim_account edit input schema",
610 "$schema": "http://json-schema.org/draft-04/schema#",
611 "type": "object",
612 "properties": k8srepo_properties,
613 "additionalProperties": False
614}
615
tiernocb83c942018-09-24 17:28:13 +0200616# PDUs
617pdu_interface = {
618 "type": "object",
619 "properties": {
tiernofd160572019-01-21 10:41:37 +0000620 "name": shortname_schema,
tiernocb83c942018-09-24 17:28:13 +0200621 "mgmt": bool_schema,
622 "type": {"enum": ["overlay", 'underlay']},
tierno36ec8602018-11-02 17:27:11 +0100623 "ip-address": ip_schema,
tiernocb83c942018-09-24 17:28:13 +0200624 # TODO, add user, password, ssh-key
tierno36ec8602018-11-02 17:27:11 +0100625 "mac-address": mac_schema,
tiernofd160572019-01-21 10:41:37 +0000626 "vim-network-name": shortname_schema, # interface is connected to one vim network, or switch port
627 "vim-network-id": shortname_schema,
tierno36ec8602018-11-02 17:27:11 +0100628 # # provide this in case SDN assist must deal with this interface
629 # "switch-dpid": dpid_Schema,
tiernofd160572019-01-21 10:41:37 +0000630 # "switch-port": shortname_schema,
631 # "switch-mac": shortname_schema,
tierno36ec8602018-11-02 17:27:11 +0100632 # "switch-vlan": vlan_schema,
tiernocb83c942018-09-24 17:28:13 +0200633 },
tierno36ec8602018-11-02 17:27:11 +0100634 "required": ["name", "mgmt", "ip-address"],
tiernocb83c942018-09-24 17:28:13 +0200635 "additionalProperties": False
tiernocd54a4a2018-09-12 16:40:35 +0200636}
tiernocb83c942018-09-24 17:28:13 +0200637pdu_new_schema = {
638 "title": "pdu creation input schema",
639 "$schema": "http://json-schema.org/draft-04/schema#",
640 "type": "object",
641 "properties": {
tiernofd160572019-01-21 10:41:37 +0000642 "name": shortname_schema,
643 "type": shortname_schema,
tiernocb83c942018-09-24 17:28:13 +0200644 "description": description_schema,
645 "shared": bool_schema,
646 "vims": nameshort_list_schema,
647 "vim_accounts": nameshort_list_schema,
648 "interfaces": {
649 "type": "array",
tierno36ec8602018-11-02 17:27:11 +0100650 "items": pdu_interface,
tiernocb83c942018-09-24 17:28:13 +0200651 "minItems": 1
652 }
653 },
654 "required": ["name", "type", "interfaces"],
655 "additionalProperties": False
656}
657
658pdu_edit_schema = {
659 "title": "pdu edit input schema",
660 "$schema": "http://json-schema.org/draft-04/schema#",
661 "type": "object",
662 "properties": {
tiernofd160572019-01-21 10:41:37 +0000663 "name": shortname_schema,
664 "type": shortname_schema,
tiernocb83c942018-09-24 17:28:13 +0200665 "description": description_schema,
666 "shared": bool_schema,
garciadeblas84bdd552018-11-30 22:59:45 +0100667 "vims": {"oneOf": [array_edition_schema, nameshort_list_schema]},
668 "vim_accounts": {"oneOf": [array_edition_schema, nameshort_list_schema]},
669 "interfaces": {"oneOf": [
tiernocb83c942018-09-24 17:28:13 +0200670 array_edition_schema,
671 {
672 "type": "array",
tierno36ec8602018-11-02 17:27:11 +0100673 "items": pdu_interface,
tiernocb83c942018-09-24 17:28:13 +0200674 "minItems": 1
675 }
676 ]}
677 },
678 "additionalProperties": False,
679 "minProperties": 1
680}
681
682# USERS
tiernocf042d32019-06-13 09:06:40 +0000683project_role_mappings = {
684 "title": "list pf projects/roles",
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100685 "$schema": "http://json-schema.org/draft-04/schema#",
tiernocf042d32019-06-13 09:06:40 +0000686 "type": "array",
687 "items": {
688 "type": "object",
689 "properties": {
690 "project": shortname_schema,
691 "role": shortname_schema
692 },
693 "required": ["project", "role"],
694 "additionalProperties": False
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100695 },
tiernocf042d32019-06-13 09:06:40 +0000696 "minItems": 1
697}
698project_role_mappings_optional = {
699 "title": "list of projects/roles or projects only",
700 "$schema": "http://json-schema.org/draft-04/schema#",
701 "type": "array",
702 "items": {
703 "type": "object",
704 "properties": {
705 "project": shortname_schema,
706 "role": shortname_schema
707 },
708 "required": ["project"],
709 "additionalProperties": False
710 },
711 "minItems": 1
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100712}
tiernocd54a4a2018-09-12 16:40:35 +0200713user_new_schema = {
714 "$schema": "http://json-schema.org/draft-04/schema#",
715 "title": "New user schema",
716 "type": "object",
717 "properties": {
tiernofd160572019-01-21 10:41:37 +0000718 "username": shortname_schema,
tiernocd54a4a2018-09-12 16:40:35 +0200719 "password": passwd_schema,
tiernocb83c942018-09-24 17:28:13 +0200720 "projects": nameshort_list_schema,
tiernocf042d32019-06-13 09:06:40 +0000721 "project_role_mappings": project_role_mappings,
tiernocd54a4a2018-09-12 16:40:35 +0200722 },
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100723 "required": ["username", "password"],
tiernocd54a4a2018-09-12 16:40:35 +0200724 "additionalProperties": False
725}
726user_edit_schema = {
727 "$schema": "http://json-schema.org/draft-04/schema#",
728 "title": "User edit schema for administrators",
729 "type": "object",
730 "properties": {
731 "password": passwd_schema,
delacruzramoc061f562019-04-05 11:00:02 +0200732 "username": shortname_schema, # To allow User Name modification
tiernocd54a4a2018-09-12 16:40:35 +0200733 "projects": {
garciadeblas84bdd552018-11-30 22:59:45 +0100734 "oneOf": [
tiernocb83c942018-09-24 17:28:13 +0200735 nameshort_list_schema,
tiernocd54a4a2018-09-12 16:40:35 +0200736 array_edition_schema
737 ]
738 },
tiernocf042d32019-06-13 09:06:40 +0000739 "project_role_mappings": project_role_mappings,
740 "add_project_role_mappings": project_role_mappings,
741 "remove_project_role_mappings": project_role_mappings_optional,
tiernocb83c942018-09-24 17:28:13 +0200742 },
743 "minProperties": 1,
744 "additionalProperties": False
tiernocd54a4a2018-09-12 16:40:35 +0200745}
746
747# PROJECTS
delacruzramofe598fe2019-10-23 18:25:11 +0200748topics_with_quota = ["vnfds", "nsds", "nsts", "pdus", "nsrs", "nsis", "vim_accounts", "wim_accounts", "sdns",
749 "k8sclusters", "k8srepos"]
tiernocd54a4a2018-09-12 16:40:35 +0200750project_new_schema = {
751 "$schema": "http://json-schema.org/draft-04/schema#",
752 "title": "New project schema for administrators",
753 "type": "object",
754 "properties": {
tiernofd160572019-01-21 10:41:37 +0000755 "name": shortname_schema,
tiernocd54a4a2018-09-12 16:40:35 +0200756 "admin": bool_schema,
delacruzramo32bab472019-09-13 12:24:22 +0200757 "quotas": {
758 "type": "object",
759 "properties": {topic: integer0_schema for topic in topics_with_quota},
760 "additionalProperties": False
761 },
tiernocd54a4a2018-09-12 16:40:35 +0200762 },
763 "required": ["name"],
764 "additionalProperties": False
765}
766project_edit_schema = {
767 "$schema": "http://json-schema.org/draft-04/schema#",
768 "title": "Project edit schema for administrators",
769 "type": "object",
770 "properties": {
771 "admin": bool_schema,
delacruzramoc061f562019-04-05 11:00:02 +0200772 "name": shortname_schema, # To allow Project Name modification
delacruzramo32bab472019-09-13 12:24:22 +0200773 "quotas": {
774 "type": "object",
775 "properties": {topic: {"oneOf": [integer0_schema, null_schema]} for topic in topics_with_quota},
776 "additionalProperties": False
777 },
tiernocd54a4a2018-09-12 16:40:35 +0200778 },
779 "additionalProperties": False,
780 "minProperties": 1
781}
782
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100783# ROLES
784roles_new_schema = {
785 "$schema": "http://json-schema.org/draft-04/schema#",
786 "title": "New role schema for administrators",
787 "type": "object",
788 "properties": {
789 "name": shortname_schema,
tierno1f029d82019-06-13 22:37:04 +0000790 "permissions": {
791 "type": "object",
792 "patternProperties": {
793 ".": bool_schema,
794 },
795 # "minProperties": 1,
796 }
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100797 },
tierno1f029d82019-06-13 22:37:04 +0000798 "required": ["name"],
799 "additionalProperties": False
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100800}
801roles_edit_schema = {
802 "$schema": "http://json-schema.org/draft-04/schema#",
803 "title": "Roles edit schema for administrators",
804 "type": "object",
805 "properties": {
tierno1f029d82019-06-13 22:37:04 +0000806 "name": shortname_schema,
807 "permissions": {
808 "type": "object",
809 "patternProperties": {
810 ".": {
811 "oneOf": [bool_schema, null_schema]
812 }
813 },
814 # "minProperties": 1,
815 }
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100816 },
tierno1f029d82019-06-13 22:37:04 +0000817 "additionalProperties": False,
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100818 "minProperties": 1
819}
820
tiernocd54a4a2018-09-12 16:40:35 +0200821# GLOBAL SCHEMAS
tierno0f98af52018-03-19 10:28:22 +0100822
823nbi_new_input_schemas = {
tiernocd54a4a2018-09-12 16:40:35 +0200824 "users": user_new_schema,
825 "projects": project_new_schema,
tierno09c073e2018-04-26 13:36:48 +0200826 "vim_accounts": vim_account_new_schema,
tierno65acb4d2018-04-06 16:42:40 +0200827 "sdns": sdn_new_schema,
828 "ns_instantiate": ns_instantiate,
829 "ns_action": ns_action,
tiernocb83c942018-09-24 17:28:13 +0200830 "ns_scale": ns_scale,
831 "pdus": pdu_new_schema,
tierno0f98af52018-03-19 10:28:22 +0100832}
833
834nbi_edit_input_schemas = {
tiernocd54a4a2018-09-12 16:40:35 +0200835 "users": user_edit_schema,
836 "projects": project_edit_schema,
tierno09c073e2018-04-26 13:36:48 +0200837 "vim_accounts": vim_account_edit_schema,
tiernocb83c942018-09-24 17:28:13 +0200838 "sdns": sdn_edit_schema,
839 "pdus": pdu_edit_schema,
tierno0f98af52018-03-19 10:28:22 +0100840}
841
Felipe Vicens07f31722018-10-29 15:16:44 +0100842# NETSLICE SCHEMAS
tierno032916c2019-03-22 13:27:12 +0000843nsi_subnet_instantiate = deepcopy(ns_instantiate)
844nsi_subnet_instantiate["title"] = "netslice subnet instantiation params input schema"
845nsi_subnet_instantiate["properties"]["id"] = name_schema
846del nsi_subnet_instantiate["required"]
garciadeblasdaf8cc52018-11-30 14:17:20 +0100847
848nsi_vld_instantiate = {
849 "title": "netslice vld instantiation params input schema",
850 "$schema": "http://json-schema.org/draft-04/schema#",
851 "type": "object",
852 "properties": {
853 "name": string_schema,
854 "vim-network-name": {"OneOf": [string_schema, object_schema]},
gcalvino17d5b732018-12-17 16:26:21 +0100855 "vim-network-id": {"OneOf": [string_schema, object_schema]},
garciadeblasdaf8cc52018-11-30 14:17:20 +0100856 "ip-profile": object_schema,
857 },
delacruzramoc061f562019-04-05 11:00:02 +0200858 "required": ["name"],
garciadeblasdaf8cc52018-11-30 14:17:20 +0100859 "additionalProperties": False
860}
861
Felipe Vicens07f31722018-10-29 15:16:44 +0100862nsi_instantiate = {
863 "title": "netslice action instantiate input schema",
864 "$schema": "http://json-schema.org/draft-04/schema#",
865 "type": "object",
866 "properties": {
867 "lcmOperationType": string_schema,
Felipe Vicens126af572019-06-05 19:13:04 +0200868 "netsliceInstanceId": id_schema,
Felipe Vicens07f31722018-10-29 15:16:44 +0100869 "nsiName": name_schema,
tierno4f9d4ae2019-03-20 17:24:11 +0000870 "nsiDescription": {"oneOf": [description_schema, null_schema]},
tierno9e5eea32018-11-29 09:42:09 +0000871 "nstId": string_schema,
Felipe Vicens07f31722018-10-29 15:16:44 +0100872 "vimAccountId": id_schema,
873 "ssh_keys": {"type": "string"},
874 "nsi_id": id_schema,
tierno032916c2019-03-22 13:27:12 +0000875 "additionalParamsForNsi": object_schema,
garciadeblasdaf8cc52018-11-30 14:17:20 +0100876 "netslice-subnet": {
Felipe Vicens07f31722018-10-29 15:16:44 +0100877 "type": "array",
878 "minItems": 1,
tierno032916c2019-03-22 13:27:12 +0000879 "items": nsi_subnet_instantiate
garciadeblasdaf8cc52018-11-30 14:17:20 +0100880 },
881 "netslice-vld": {
882 "type": "array",
883 "minItems": 1,
884 "items": nsi_vld_instantiate
Felipe Vicens07f31722018-10-29 15:16:44 +0100885 },
886 },
Felipe Vicensc8bbaaa2018-12-01 04:42:40 +0100887 "required": ["nsiName", "nstId", "vimAccountId"],
Felipe Vicens07f31722018-10-29 15:16:44 +0100888 "additionalProperties": False
889}
890
891nsi_action = {
892
893}
894
895nsi_terminate = {
delacruzramoc061f562019-04-05 11:00:02 +0200896
Felipe Vicens07f31722018-10-29 15:16:44 +0100897}
898
tierno0f98af52018-03-19 10:28:22 +0100899
900class ValidationError(Exception):
tierno36ec8602018-11-02 17:27:11 +0100901 def __init__(self, message, http_code=HTTPStatus.UNPROCESSABLE_ENTITY):
902 self.http_code = http_code
903 Exception.__init__(self, message)
tierno0f98af52018-03-19 10:28:22 +0100904
905
tiernob24258a2018-10-04 18:39:49 +0200906def validate_input(indata, schema_to_use):
tierno0f98af52018-03-19 10:28:22 +0100907 """
tiernocd54a4a2018-09-12 16:40:35 +0200908 Validates input data against json schema
tierno0f98af52018-03-19 10:28:22 +0100909 :param indata: user input data. Should be a dictionary
tiernob24258a2018-10-04 18:39:49 +0200910 :param schema_to_use: jsonschema to test
911 :return: None if ok, raises ValidationError exception on error
tierno0f98af52018-03-19 10:28:22 +0100912 """
913 try:
tierno0f98af52018-03-19 10:28:22 +0100914 if schema_to_use:
915 js_v(indata, schema_to_use)
916 return None
917 except js_e.ValidationError as e:
918 if e.path:
tierno0da52252018-06-27 15:47:22 +0200919 error_pos = "at '" + ":".join(map(str, e.path)) + "'"
tierno0f98af52018-03-19 10:28:22 +0100920 else:
921 error_pos = ""
tierno441dbbf2018-07-10 12:52:48 +0200922 raise ValidationError("Format error {} '{}' ".format(error_pos, e.message))
tierno36ec8602018-11-02 17:27:11 +0100923 except js_e.SchemaError:
924 raise ValidationError("Bad json schema {}".format(schema_to_use), http_code=HTTPStatus.INTERNAL_SERVER_ERROR)
delacruzramoc061f562019-04-05 11:00:02 +0200925
926
927def is_valid_uuid(x):
928 """
929 Test for a valid UUID
930 :param x: string to test
931 :return: True if x is a valid uuid, False otherwise
932 """
933 try:
934 if UUID(x):
935 return True
tiernobdebce92019-07-01 15:36:49 +0000936 except (TypeError, ValueError, AttributeError):
delacruzramoc061f562019-04-05 11:00:02 +0200937 return False