blob: c398a00cedabd9a2d88f78811dbfe7e71b6a73e0 [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"}},
tiernoa8186a52020-01-14 15:54:48 +0000271 "timeout_ns_deploy": integer1_schema,
tierno441dbbf2018-07-10 12:52:48 +0200272 "nsr_id": id_schema,
tiernocc103432018-10-19 14:10:35 +0200273 "vduImage": name_schema,
tierno0da52252018-06-27 15:47:22 +0200274 "vnf": {
275 "type": "array",
276 "minItems": 1,
277 "items": {
278 "type": "object",
279 "properties": {
280 "member-vnf-index": name_schema,
281 "vimAccountId": id_schema,
tierno441dbbf2018-07-10 12:52:48 +0200282 "vdu": {
283 "type": "array",
284 "minItems": 1,
285 "items": ns_instantiate_vdu,
286 },
287 "internal-vld": {
288 "type": "array",
289 "minItems": 1,
290 "items": ns_instantiate_internal_vld
291 }
tierno0da52252018-06-27 15:47:22 +0200292 },
tierno441dbbf2018-07-10 12:52:48 +0200293 "required": ["member-vnf-index"],
294 "minProperties": 2,
295 "additionalProperties": False
tierno0da52252018-06-27 15:47:22 +0200296 }
297 },
298 "vld": {
299 "type": "array",
300 "minItems": 1,
301 "items": {
302 "type": "object",
303 "properties": {
304 "name": string_schema,
305 "vim-network-name": {"OneOf": [string_schema, object_schema]},
gcalvino17d5b732018-12-17 16:26:21 +0100306 "vim-network-id": {"OneOf": [string_schema, object_schema]},
Felipe Vicens09e65422019-01-22 15:06:46 +0100307 "ns-net": object_schema,
tierno4f9d4ae2019-03-20 17:24:11 +0000308 "wimAccountId": {"OneOf": [id_schema, bool_schema, null_schema]},
tierno0da52252018-06-27 15:47:22 +0200309 "ip-profile": object_schema,
kbsub21f03f52019-10-17 16:26:56 +0000310 "provider-network": provider_network_schema,
tiernob7c6f2a2018-09-03 14:32:10 +0200311 "vnfd-connection-point-ref": {
312 "type": "array",
313 "minItems": 1,
314 "items": {
315 "type": "object",
316 "properties": {
317 "member-vnf-index-ref": name_schema,
318 "vnfd-connection-point-ref": name_schema,
319 "ip-address": ip_schema,
320 # "mac-address": mac_schema,
321 },
322 "required": ["member-vnf-index-ref", "vnfd-connection-point-ref"],
323 "minProperties": 3,
324 "additionalProperties": False
325 },
326 }
tierno0da52252018-06-27 15:47:22 +0200327 },
tierno441dbbf2018-07-10 12:52:48 +0200328 "required": ["name"],
329 "additionalProperties": False
tierno0da52252018-06-27 15:47:22 +0200330 }
331 },
332 },
tierno441dbbf2018-07-10 12:52:48 +0200333 "required": ["nsName", "nsdId", "vimAccountId"],
334 "additionalProperties": False
tierno65acb4d2018-04-06 16:42:40 +0200335}
tierno0da52252018-06-27 15:47:22 +0200336
tierno65acb4d2018-04-06 16:42:40 +0200337ns_action = { # TODO for the moment it is only contemplated the vnfd primitive execution
tiernof759d822018-06-11 18:54:54 +0200338 "title": "ns action input schema",
tierno65acb4d2018-04-06 16:42:40 +0200339 "$schema": "http://json-schema.org/draft-04/schema#",
340 "type": "object",
341 "properties": {
tiernob24258a2018-10-04 18:39:49 +0200342 "lcmOperationType": string_schema,
343 "nsInstanceId": id_schema,
tiernof5298be2018-05-16 14:43:57 +0200344 "member_vnf_index": name_schema,
345 "vnf_member_index": name_schema, # TODO for backward compatibility. To remove in future
tierno7ce1db92018-07-25 12:50:52 +0200346 "vdu_id": name_schema,
tiernof0637052019-03-07 16:26:47 +0000347 "vdu_count_index": integer0_schema,
tierno9cb7d672019-10-30 12:13:48 +0000348 "kdu_name": name_schema,
tierno65acb4d2018-04-06 16:42:40 +0200349 "primitive": name_schema,
350 "primitive_params": {"type": "object"},
351 },
tiernof5298be2018-05-16 14:43:57 +0200352 "required": ["primitive", "primitive_params"], # TODO add member_vnf_index
tierno65acb4d2018-04-06 16:42:40 +0200353 "additionalProperties": False
354}
tiernof759d822018-06-11 18:54:54 +0200355ns_scale = { # TODO for the moment it is only VDU-scaling
356 "title": "ns scale input schema",
357 "$schema": "http://json-schema.org/draft-04/schema#",
358 "type": "object",
359 "properties": {
tiernob24258a2018-10-04 18:39:49 +0200360 "lcmOperationType": string_schema,
361 "nsInstanceId": id_schema,
tiernof759d822018-06-11 18:54:54 +0200362 "scaleType": {"enum": ["SCALE_VNF"]},
363 "scaleVnfData": {
364 "type": "object",
365 "properties": {
366 "vnfInstanceId": name_schema,
367 "scaleVnfType": {"enum": ["SCALE_OUT", 'SCALE_IN']},
368 "scaleByStepData": {
369 "type": "object",
370 "properties": {
371 "scaling-group-descriptor": name_schema,
372 "member-vnf-index": name_schema,
373 "scaling-policy": name_schema,
374 },
375 "required": ["scaling-group-descriptor", "member-vnf-index"],
376 "additionalProperties": False
377 },
378 },
379 "required": ["scaleVnfType", "scaleByStepData"], # vnfInstanceId
380 "additionalProperties": False
381 },
382 "scaleTime": time_schema,
383 },
384 "required": ["scaleType", "scaleVnfData"],
385 "additionalProperties": False
386}
tierno65acb4d2018-04-06 16:42:40 +0200387
388
tierno0f98af52018-03-19 10:28:22 +0100389schema_version = {"type": "string", "enum": ["1.0"]}
tierno55ba2e62018-12-11 17:22:22 +0000390schema_type = {"type": "string"}
tiernob3d0a0e2019-11-13 15:57:51 +0000391vim_type = shortname_schema # {"enum": ["openstack", "openvim", "vmware", "opennebula", "aws", "azure", "fos"]}
delacruzramo3a144c92019-10-25 09:46:33 +0200392
tierno09c073e2018-04-26 13:36:48 +0200393vim_account_edit_schema = {
394 "title": "vim_account edit input schema",
395 "$schema": "http://json-schema.org/draft-04/schema#",
396 "type": "object",
397 "properties": {
398 "name": name_schema,
399 "description": description_schema,
tierno09c073e2018-04-26 13:36:48 +0200400 "vim": name_schema,
401 "datacenter": name_schema,
delacruzramo3a144c92019-10-25 09:46:33 +0200402 "vim_type": vim_type,
tierno09c073e2018-04-26 13:36:48 +0200403 "vim_url": description_schema,
delacruzramo3a144c92019-10-25 09:46:33 +0200404 # "vim_url_admin": description_schema,
405 # "vim_tenant": name_schema,
tierno09c073e2018-04-26 13:36:48 +0200406 "vim_tenant_name": name_schema,
delacruzramo3a144c92019-10-25 09:46:33 +0200407 "vim_user": shortname_schema,
tiernocd54a4a2018-09-12 16:40:35 +0200408 "vim_password": passwd_schema,
tierno09c073e2018-04-26 13:36:48 +0200409 "config": {"type": "object"}
410 },
411 "additionalProperties": False
412}
tierno0f98af52018-03-19 10:28:22 +0100413
tierno09c073e2018-04-26 13:36:48 +0200414vim_account_new_schema = {
415 "title": "vim_account creation input schema",
tierno0f98af52018-03-19 10:28:22 +0100416 "$schema": "http://json-schema.org/draft-04/schema#",
417 "type": "object",
418 "properties": {
419 "schema_version": schema_version,
420 "schema_type": schema_type,
421 "name": name_schema,
422 "description": description_schema,
tierno09c073e2018-04-26 13:36:48 +0200423 "vim": name_schema,
424 "datacenter": name_schema,
delacruzramo3a144c92019-10-25 09:46:33 +0200425 "vim_type": vim_type,
tierno0f98af52018-03-19 10:28:22 +0100426 "vim_url": description_schema,
427 # "vim_url_admin": description_schema,
428 # "vim_tenant": name_schema,
429 "vim_tenant_name": name_schema,
tiernofd160572019-01-21 10:41:37 +0000430 "vim_user": shortname_schema,
tiernocd54a4a2018-09-12 16:40:35 +0200431 "vim_password": passwd_schema,
tierno0f98af52018-03-19 10:28:22 +0100432 "config": {"type": "object"}
433 },
434 "required": ["name", "vim_url", "vim_type", "vim_user", "vim_password", "vim_tenant_name"],
435 "additionalProperties": False
436}
tierno0f98af52018-03-19 10:28:22 +0100437
tierno85807722019-12-20 14:11:35 +0000438wim_type = shortname_schema # {"enum": ["ietfl2vpn", "onos", "odl", "dynpac", "fake"]}
delacruzramo3a144c92019-10-25 09:46:33 +0200439
tierno55ba2e62018-12-11 17:22:22 +0000440wim_account_edit_schema = {
441 "title": "wim_account edit input schema",
442 "$schema": "http://json-schema.org/draft-04/schema#",
443 "type": "object",
444 "properties": {
445 "name": name_schema,
446 "description": description_schema,
tierno55ba2e62018-12-11 17:22:22 +0000447 "wim": name_schema,
delacruzramo3a144c92019-10-25 09:46:33 +0200448 "wim_type": wim_type,
tierno55ba2e62018-12-11 17:22:22 +0000449 "wim_url": description_schema,
tiernofd160572019-01-21 10:41:37 +0000450 "user": shortname_schema,
tierno55ba2e62018-12-11 17:22:22 +0000451 "password": passwd_schema,
452 "config": {"type": "object"}
453 },
454 "additionalProperties": False
455}
456
457wim_account_new_schema = {
458 "title": "wim_account creation input schema",
459 "$schema": "http://json-schema.org/draft-04/schema#",
460 "type": "object",
461 "properties": {
462 "schema_version": schema_version,
463 "schema_type": schema_type,
464 "name": name_schema,
465 "description": description_schema,
466 "wim": name_schema,
delacruzramo3a144c92019-10-25 09:46:33 +0200467 "wim_type": wim_type,
tierno55ba2e62018-12-11 17:22:22 +0000468 "wim_url": description_schema,
tiernofd160572019-01-21 10:41:37 +0000469 "user": shortname_schema,
tierno55ba2e62018-12-11 17:22:22 +0000470 "password": passwd_schema,
tiernof0637052019-03-07 16:26:47 +0000471 "config": {
472 "type": "object",
473 "patternProperties": {
474 ".": {"not": {"type": "null"}}
475 }
476 }
tierno55ba2e62018-12-11 17:22:22 +0000477 },
478 "required": ["name", "wim_url", "wim_type"],
479 "additionalProperties": False
480}
tierno0f98af52018-03-19 10:28:22 +0100481
482sdn_properties = {
483 "name": name_schema,
tierno7adaeb02019-12-17 16:46:12 +0000484 "type": {"type": "string"},
485 "url": {"type": "string"},
486 "user": shortname_schema,
487 "password": passwd_schema,
488 "config": {"type": "object"},
tiernocfb07c62018-05-10 18:30:51 +0200489 "description": description_schema,
tierno7adaeb02019-12-17 16:46:12 +0000490 # The folowing are deprecated. Maintanied for backward compatibility
tiernocb83c942018-09-24 17:28:13 +0200491 "dpid": dpid_Schema,
tierno0f98af52018-03-19 10:28:22 +0100492 "ip": ip_schema,
493 "port": port_schema,
tierno0f98af52018-03-19 10:28:22 +0100494 "version": {"type": "string", "minLength": 1, "maxLength": 12},
tierno0f98af52018-03-19 10:28:22 +0100495}
496sdn_new_schema = {
497 "title": "sdn controller information schema",
498 "$schema": "http://json-schema.org/draft-04/schema#",
499 "type": "object",
500 "properties": sdn_properties,
tierno7adaeb02019-12-17 16:46:12 +0000501 "required": ["name", 'type'],
tierno0f98af52018-03-19 10:28:22 +0100502 "additionalProperties": False
503}
504sdn_edit_schema = {
505 "title": "sdn controller update information schema",
506 "$schema": "http://json-schema.org/draft-04/schema#",
507 "type": "object",
508 "properties": sdn_properties,
tiernocfb07c62018-05-10 18:30:51 +0200509 # "required": ["name", "port", 'ip', 'dpid', 'type'],
tierno0f98af52018-03-19 10:28:22 +0100510 "additionalProperties": False
511}
512sdn_port_mapping_schema = {
513 "$schema": "http://json-schema.org/draft-04/schema#",
514 "title": "sdn port mapping information schema",
515 "type": "array",
516 "items": {
517 "type": "object",
518 "properties": {
tiernofd160572019-01-21 10:41:37 +0000519 "compute_node": shortname_schema,
tierno0f98af52018-03-19 10:28:22 +0100520 "ports": {
521 "type": "array",
522 "items": {
523 "type": "object",
524 "properties": {
tierno42fce592018-11-02 09:23:43 +0100525 "pci": pci_extended_schema,
tiernofd160572019-01-21 10:41:37 +0000526 "switch_port": shortname_schema,
tierno0f98af52018-03-19 10:28:22 +0100527 "switch_mac": mac_schema
528 },
529 "required": ["pci"]
530 }
531 }
532 },
533 "required": ["compute_node", "ports"]
534 }
535}
536sdn_external_port_schema = {
537 "$schema": "http://json-schema.org/draft-04/schema#",
tiernocd54a4a2018-09-12 16:40:35 +0200538 "title": "External port information",
tierno0f98af52018-03-19 10:28:22 +0100539 "type": "object",
540 "properties": {
541 "port": {"type": "string", "minLength": 1, "maxLength": 60},
542 "vlan": vlan_schema,
543 "mac": mac_schema
544 },
545 "required": ["port"]
546}
547
delacruzramofe598fe2019-10-23 18:25:11 +0200548# K8s Clusters
549k8scluster_nets_schema = {
550 "title": "k8scluster nets input schema",
551 "$schema": "http://json-schema.org/draft-04/schema#",
552 "type": "object",
tiernoc67b0e92019-11-05 12:45:29 +0000553 "patternProperties": {".": {"oneOf": [description_schema, null_schema]}},
delacruzramofe598fe2019-10-23 18:25:11 +0200554 "minProperties": 1,
555 "additionalProperties": False
556}
557k8scluster_new_schema = {
558 "title": "k8scluster creation input schema",
559 "$schema": "http://json-schema.org/draft-04/schema#",
560 "type": "object",
561 "properties": {
562 "schema_version": schema_version,
563 "schema_type": schema_type,
564 "name": name_schema,
565 "description": description_schema,
566 "credentials": object_schema,
567 "vim_account": id_schema,
568 "k8s_version": string_schema,
569 "nets": k8scluster_nets_schema,
570 "namespace": name_schema,
571 "cni": nameshort_list_schema,
572 },
573 "required": ["name", "credentials", "vim_account", "k8s_version", "nets"],
574 "additionalProperties": False
575}
576k8scluster_edit_schema = {
577 "title": "vim_account edit input schema",
578 "$schema": "http://json-schema.org/draft-04/schema#",
579 "type": "object",
580 "properties": {
581 "name": name_schema,
582 "description": description_schema,
583 "credentials": object_schema,
584 "vim_account": id_schema,
585 "k8s_version": string_schema,
586 "nets": k8scluster_nets_schema,
587 "namespace": name_schema,
588 "cni": nameshort_list_schema,
589 },
590 "additionalProperties": False
591}
592
593# K8s Repos
tierno332e0802019-12-03 23:50:49 +0000594k8srepo_types = {"enum": ["helm-chart", "juju-bundle"]}
delacruzramofe598fe2019-10-23 18:25:11 +0200595k8srepo_properties = {
596 "name": name_schema,
597 "description": description_schema,
598 "type": k8srepo_types,
599 "url": description_schema,
600}
601k8srepo_new_schema = {
602 "title": "k8scluster creation input schema",
603 "$schema": "http://json-schema.org/draft-04/schema#",
604 "type": "object",
605 "properties": k8srepo_properties,
606 "required": ["name", "type", "url"],
607 "additionalProperties": False
608}
609k8srepo_edit_schema = {
610 "title": "vim_account edit input schema",
611 "$schema": "http://json-schema.org/draft-04/schema#",
612 "type": "object",
613 "properties": k8srepo_properties,
614 "additionalProperties": False
615}
616
tiernocb83c942018-09-24 17:28:13 +0200617# PDUs
618pdu_interface = {
619 "type": "object",
620 "properties": {
tiernofd160572019-01-21 10:41:37 +0000621 "name": shortname_schema,
tiernocb83c942018-09-24 17:28:13 +0200622 "mgmt": bool_schema,
623 "type": {"enum": ["overlay", 'underlay']},
tierno36ec8602018-11-02 17:27:11 +0100624 "ip-address": ip_schema,
tiernocb83c942018-09-24 17:28:13 +0200625 # TODO, add user, password, ssh-key
tierno36ec8602018-11-02 17:27:11 +0100626 "mac-address": mac_schema,
tiernofd160572019-01-21 10:41:37 +0000627 "vim-network-name": shortname_schema, # interface is connected to one vim network, or switch port
628 "vim-network-id": shortname_schema,
tierno36ec8602018-11-02 17:27:11 +0100629 # # provide this in case SDN assist must deal with this interface
630 # "switch-dpid": dpid_Schema,
tiernofd160572019-01-21 10:41:37 +0000631 # "switch-port": shortname_schema,
632 # "switch-mac": shortname_schema,
tierno36ec8602018-11-02 17:27:11 +0100633 # "switch-vlan": vlan_schema,
tiernocb83c942018-09-24 17:28:13 +0200634 },
tierno36ec8602018-11-02 17:27:11 +0100635 "required": ["name", "mgmt", "ip-address"],
tiernocb83c942018-09-24 17:28:13 +0200636 "additionalProperties": False
tiernocd54a4a2018-09-12 16:40:35 +0200637}
tiernocb83c942018-09-24 17:28:13 +0200638pdu_new_schema = {
639 "title": "pdu creation input schema",
640 "$schema": "http://json-schema.org/draft-04/schema#",
641 "type": "object",
642 "properties": {
tiernofd160572019-01-21 10:41:37 +0000643 "name": shortname_schema,
644 "type": shortname_schema,
tiernocb83c942018-09-24 17:28:13 +0200645 "description": description_schema,
646 "shared": bool_schema,
647 "vims": nameshort_list_schema,
648 "vim_accounts": nameshort_list_schema,
649 "interfaces": {
650 "type": "array",
tierno36ec8602018-11-02 17:27:11 +0100651 "items": pdu_interface,
tiernocb83c942018-09-24 17:28:13 +0200652 "minItems": 1
653 }
654 },
655 "required": ["name", "type", "interfaces"],
656 "additionalProperties": False
657}
658
659pdu_edit_schema = {
660 "title": "pdu edit input schema",
661 "$schema": "http://json-schema.org/draft-04/schema#",
662 "type": "object",
663 "properties": {
tiernofd160572019-01-21 10:41:37 +0000664 "name": shortname_schema,
665 "type": shortname_schema,
tiernocb83c942018-09-24 17:28:13 +0200666 "description": description_schema,
667 "shared": bool_schema,
garciadeblas84bdd552018-11-30 22:59:45 +0100668 "vims": {"oneOf": [array_edition_schema, nameshort_list_schema]},
669 "vim_accounts": {"oneOf": [array_edition_schema, nameshort_list_schema]},
670 "interfaces": {"oneOf": [
tiernocb83c942018-09-24 17:28:13 +0200671 array_edition_schema,
672 {
673 "type": "array",
tierno36ec8602018-11-02 17:27:11 +0100674 "items": pdu_interface,
tiernocb83c942018-09-24 17:28:13 +0200675 "minItems": 1
676 }
677 ]}
678 },
679 "additionalProperties": False,
680 "minProperties": 1
681}
682
683# USERS
tiernocf042d32019-06-13 09:06:40 +0000684project_role_mappings = {
685 "title": "list pf projects/roles",
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100686 "$schema": "http://json-schema.org/draft-04/schema#",
tiernocf042d32019-06-13 09:06:40 +0000687 "type": "array",
688 "items": {
689 "type": "object",
690 "properties": {
691 "project": shortname_schema,
692 "role": shortname_schema
693 },
694 "required": ["project", "role"],
695 "additionalProperties": False
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100696 },
tiernocf042d32019-06-13 09:06:40 +0000697 "minItems": 1
698}
699project_role_mappings_optional = {
700 "title": "list of projects/roles or projects only",
701 "$schema": "http://json-schema.org/draft-04/schema#",
702 "type": "array",
703 "items": {
704 "type": "object",
705 "properties": {
706 "project": shortname_schema,
707 "role": shortname_schema
708 },
709 "required": ["project"],
710 "additionalProperties": False
711 },
712 "minItems": 1
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100713}
tiernocd54a4a2018-09-12 16:40:35 +0200714user_new_schema = {
715 "$schema": "http://json-schema.org/draft-04/schema#",
716 "title": "New user schema",
717 "type": "object",
718 "properties": {
tiernofd160572019-01-21 10:41:37 +0000719 "username": shortname_schema,
tiernocd54a4a2018-09-12 16:40:35 +0200720 "password": passwd_schema,
tiernocb83c942018-09-24 17:28:13 +0200721 "projects": nameshort_list_schema,
tiernocf042d32019-06-13 09:06:40 +0000722 "project_role_mappings": project_role_mappings,
tiernocd54a4a2018-09-12 16:40:35 +0200723 },
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100724 "required": ["username", "password"],
tiernocd54a4a2018-09-12 16:40:35 +0200725 "additionalProperties": False
726}
727user_edit_schema = {
728 "$schema": "http://json-schema.org/draft-04/schema#",
729 "title": "User edit schema for administrators",
730 "type": "object",
731 "properties": {
732 "password": passwd_schema,
delacruzramoc061f562019-04-05 11:00:02 +0200733 "username": shortname_schema, # To allow User Name modification
tiernocd54a4a2018-09-12 16:40:35 +0200734 "projects": {
garciadeblas84bdd552018-11-30 22:59:45 +0100735 "oneOf": [
tiernocb83c942018-09-24 17:28:13 +0200736 nameshort_list_schema,
tiernocd54a4a2018-09-12 16:40:35 +0200737 array_edition_schema
738 ]
739 },
tiernocf042d32019-06-13 09:06:40 +0000740 "project_role_mappings": project_role_mappings,
741 "add_project_role_mappings": project_role_mappings,
742 "remove_project_role_mappings": project_role_mappings_optional,
tiernocb83c942018-09-24 17:28:13 +0200743 },
744 "minProperties": 1,
745 "additionalProperties": False
tiernocd54a4a2018-09-12 16:40:35 +0200746}
747
748# PROJECTS
delacruzramofe598fe2019-10-23 18:25:11 +0200749topics_with_quota = ["vnfds", "nsds", "nsts", "pdus", "nsrs", "nsis", "vim_accounts", "wim_accounts", "sdns",
750 "k8sclusters", "k8srepos"]
tiernocd54a4a2018-09-12 16:40:35 +0200751project_new_schema = {
752 "$schema": "http://json-schema.org/draft-04/schema#",
753 "title": "New project schema for administrators",
754 "type": "object",
755 "properties": {
tiernofd160572019-01-21 10:41:37 +0000756 "name": shortname_schema,
tiernocd54a4a2018-09-12 16:40:35 +0200757 "admin": bool_schema,
delacruzramo32bab472019-09-13 12:24:22 +0200758 "quotas": {
759 "type": "object",
760 "properties": {topic: integer0_schema for topic in topics_with_quota},
761 "additionalProperties": False
762 },
tiernocd54a4a2018-09-12 16:40:35 +0200763 },
764 "required": ["name"],
765 "additionalProperties": False
766}
767project_edit_schema = {
768 "$schema": "http://json-schema.org/draft-04/schema#",
769 "title": "Project edit schema for administrators",
770 "type": "object",
771 "properties": {
772 "admin": bool_schema,
delacruzramoc061f562019-04-05 11:00:02 +0200773 "name": shortname_schema, # To allow Project Name modification
delacruzramo32bab472019-09-13 12:24:22 +0200774 "quotas": {
775 "type": "object",
776 "properties": {topic: {"oneOf": [integer0_schema, null_schema]} for topic in topics_with_quota},
777 "additionalProperties": False
778 },
tiernocd54a4a2018-09-12 16:40:35 +0200779 },
780 "additionalProperties": False,
781 "minProperties": 1
782}
783
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100784# ROLES
785roles_new_schema = {
786 "$schema": "http://json-schema.org/draft-04/schema#",
787 "title": "New role schema for administrators",
788 "type": "object",
789 "properties": {
790 "name": shortname_schema,
tierno1f029d82019-06-13 22:37:04 +0000791 "permissions": {
792 "type": "object",
793 "patternProperties": {
794 ".": bool_schema,
795 },
796 # "minProperties": 1,
797 }
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100798 },
tierno1f029d82019-06-13 22:37:04 +0000799 "required": ["name"],
800 "additionalProperties": False
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100801}
802roles_edit_schema = {
803 "$schema": "http://json-schema.org/draft-04/schema#",
804 "title": "Roles edit schema for administrators",
805 "type": "object",
806 "properties": {
tierno1f029d82019-06-13 22:37:04 +0000807 "name": shortname_schema,
808 "permissions": {
809 "type": "object",
810 "patternProperties": {
811 ".": {
812 "oneOf": [bool_schema, null_schema]
813 }
814 },
815 # "minProperties": 1,
816 }
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100817 },
tierno1f029d82019-06-13 22:37:04 +0000818 "additionalProperties": False,
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100819 "minProperties": 1
820}
821
tiernocd54a4a2018-09-12 16:40:35 +0200822# GLOBAL SCHEMAS
tierno0f98af52018-03-19 10:28:22 +0100823
824nbi_new_input_schemas = {
tiernocd54a4a2018-09-12 16:40:35 +0200825 "users": user_new_schema,
826 "projects": project_new_schema,
tierno09c073e2018-04-26 13:36:48 +0200827 "vim_accounts": vim_account_new_schema,
tierno65acb4d2018-04-06 16:42:40 +0200828 "sdns": sdn_new_schema,
829 "ns_instantiate": ns_instantiate,
830 "ns_action": ns_action,
tiernocb83c942018-09-24 17:28:13 +0200831 "ns_scale": ns_scale,
832 "pdus": pdu_new_schema,
tierno0f98af52018-03-19 10:28:22 +0100833}
834
835nbi_edit_input_schemas = {
tiernocd54a4a2018-09-12 16:40:35 +0200836 "users": user_edit_schema,
837 "projects": project_edit_schema,
tierno09c073e2018-04-26 13:36:48 +0200838 "vim_accounts": vim_account_edit_schema,
tiernocb83c942018-09-24 17:28:13 +0200839 "sdns": sdn_edit_schema,
840 "pdus": pdu_edit_schema,
tierno0f98af52018-03-19 10:28:22 +0100841}
842
Felipe Vicens07f31722018-10-29 15:16:44 +0100843# NETSLICE SCHEMAS
tierno032916c2019-03-22 13:27:12 +0000844nsi_subnet_instantiate = deepcopy(ns_instantiate)
845nsi_subnet_instantiate["title"] = "netslice subnet instantiation params input schema"
846nsi_subnet_instantiate["properties"]["id"] = name_schema
847del nsi_subnet_instantiate["required"]
garciadeblasdaf8cc52018-11-30 14:17:20 +0100848
849nsi_vld_instantiate = {
850 "title": "netslice vld instantiation params input schema",
851 "$schema": "http://json-schema.org/draft-04/schema#",
852 "type": "object",
853 "properties": {
854 "name": string_schema,
855 "vim-network-name": {"OneOf": [string_schema, object_schema]},
gcalvino17d5b732018-12-17 16:26:21 +0100856 "vim-network-id": {"OneOf": [string_schema, object_schema]},
garciadeblasdaf8cc52018-11-30 14:17:20 +0100857 "ip-profile": object_schema,
858 },
delacruzramoc061f562019-04-05 11:00:02 +0200859 "required": ["name"],
garciadeblasdaf8cc52018-11-30 14:17:20 +0100860 "additionalProperties": False
861}
862
Felipe Vicens07f31722018-10-29 15:16:44 +0100863nsi_instantiate = {
864 "title": "netslice action instantiate input schema",
865 "$schema": "http://json-schema.org/draft-04/schema#",
866 "type": "object",
867 "properties": {
868 "lcmOperationType": string_schema,
Felipe Vicens126af572019-06-05 19:13:04 +0200869 "netsliceInstanceId": id_schema,
Felipe Vicens07f31722018-10-29 15:16:44 +0100870 "nsiName": name_schema,
tierno4f9d4ae2019-03-20 17:24:11 +0000871 "nsiDescription": {"oneOf": [description_schema, null_schema]},
tierno9e5eea32018-11-29 09:42:09 +0000872 "nstId": string_schema,
Felipe Vicens07f31722018-10-29 15:16:44 +0100873 "vimAccountId": id_schema,
tiernoa8186a52020-01-14 15:54:48 +0000874 "timeout_nsi_deploy": integer1_schema,
Felipe Vicens07f31722018-10-29 15:16:44 +0100875 "ssh_keys": {"type": "string"},
876 "nsi_id": id_schema,
tierno032916c2019-03-22 13:27:12 +0000877 "additionalParamsForNsi": object_schema,
garciadeblasdaf8cc52018-11-30 14:17:20 +0100878 "netslice-subnet": {
Felipe Vicens07f31722018-10-29 15:16:44 +0100879 "type": "array",
880 "minItems": 1,
tierno032916c2019-03-22 13:27:12 +0000881 "items": nsi_subnet_instantiate
garciadeblasdaf8cc52018-11-30 14:17:20 +0100882 },
883 "netslice-vld": {
884 "type": "array",
885 "minItems": 1,
886 "items": nsi_vld_instantiate
Felipe Vicens07f31722018-10-29 15:16:44 +0100887 },
888 },
Felipe Vicensc8bbaaa2018-12-01 04:42:40 +0100889 "required": ["nsiName", "nstId", "vimAccountId"],
Felipe Vicens07f31722018-10-29 15:16:44 +0100890 "additionalProperties": False
891}
892
893nsi_action = {
894
895}
896
897nsi_terminate = {
delacruzramoc061f562019-04-05 11:00:02 +0200898
Felipe Vicens07f31722018-10-29 15:16:44 +0100899}
900
tierno0f98af52018-03-19 10:28:22 +0100901
902class ValidationError(Exception):
tierno36ec8602018-11-02 17:27:11 +0100903 def __init__(self, message, http_code=HTTPStatus.UNPROCESSABLE_ENTITY):
904 self.http_code = http_code
905 Exception.__init__(self, message)
tierno0f98af52018-03-19 10:28:22 +0100906
907
tiernob24258a2018-10-04 18:39:49 +0200908def validate_input(indata, schema_to_use):
tierno0f98af52018-03-19 10:28:22 +0100909 """
tiernocd54a4a2018-09-12 16:40:35 +0200910 Validates input data against json schema
tierno0f98af52018-03-19 10:28:22 +0100911 :param indata: user input data. Should be a dictionary
tiernob24258a2018-10-04 18:39:49 +0200912 :param schema_to_use: jsonschema to test
913 :return: None if ok, raises ValidationError exception on error
tierno0f98af52018-03-19 10:28:22 +0100914 """
915 try:
tierno0f98af52018-03-19 10:28:22 +0100916 if schema_to_use:
917 js_v(indata, schema_to_use)
918 return None
919 except js_e.ValidationError as e:
920 if e.path:
tierno0da52252018-06-27 15:47:22 +0200921 error_pos = "at '" + ":".join(map(str, e.path)) + "'"
tierno0f98af52018-03-19 10:28:22 +0100922 else:
923 error_pos = ""
tierno441dbbf2018-07-10 12:52:48 +0200924 raise ValidationError("Format error {} '{}' ".format(error_pos, e.message))
tierno36ec8602018-11-02 17:27:11 +0100925 except js_e.SchemaError:
926 raise ValidationError("Bad json schema {}".format(schema_to_use), http_code=HTTPStatus.INTERNAL_SERVER_ERROR)
delacruzramoc061f562019-04-05 11:00:02 +0200927
928
929def is_valid_uuid(x):
930 """
931 Test for a valid UUID
932 :param x: string to test
933 :return: True if x is a valid uuid, False otherwise
934 """
935 try:
936 if UUID(x):
937 return True
tiernobdebce92019-07-01 15:36:49 +0000938 except (TypeError, ValueError, AttributeError):
delacruzramoc061f562019-04-05 11:00:02 +0200939 return False