blob: 69c42ae2ee3fdce0dab6e1248356687d446e01da [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]},
magnussonlf318b302020-01-20 18:38:18 +0100268 "placement-engine": string_schema,
269 "placement-constraints": object_schema,
tiernobee085c2018-12-12 17:03:04 +0000270 "additionalParamsForNs": object_schema,
tiernofd160572019-01-21 10:41:37 +0000271 "additionalParamsForVnf": additional_params_for_vnf,
tiernofc5089c2018-10-31 09:28:11 +0100272 "ssh_keys": {"type": "array", "items": {"type": "string"}},
tiernoa8186a52020-01-14 15:54:48 +0000273 "timeout_ns_deploy": integer1_schema,
tierno441dbbf2018-07-10 12:52:48 +0200274 "nsr_id": id_schema,
tiernocc103432018-10-19 14:10:35 +0200275 "vduImage": name_schema,
tierno0da52252018-06-27 15:47:22 +0200276 "vnf": {
277 "type": "array",
278 "minItems": 1,
279 "items": {
280 "type": "object",
281 "properties": {
282 "member-vnf-index": name_schema,
283 "vimAccountId": id_schema,
tierno441dbbf2018-07-10 12:52:48 +0200284 "vdu": {
285 "type": "array",
286 "minItems": 1,
287 "items": ns_instantiate_vdu,
288 },
289 "internal-vld": {
290 "type": "array",
291 "minItems": 1,
292 "items": ns_instantiate_internal_vld
293 }
tierno0da52252018-06-27 15:47:22 +0200294 },
tierno441dbbf2018-07-10 12:52:48 +0200295 "required": ["member-vnf-index"],
296 "minProperties": 2,
297 "additionalProperties": False
tierno0da52252018-06-27 15:47:22 +0200298 }
299 },
300 "vld": {
301 "type": "array",
302 "minItems": 1,
303 "items": {
304 "type": "object",
305 "properties": {
306 "name": string_schema,
307 "vim-network-name": {"OneOf": [string_schema, object_schema]},
gcalvino17d5b732018-12-17 16:26:21 +0100308 "vim-network-id": {"OneOf": [string_schema, object_schema]},
Felipe Vicens09e65422019-01-22 15:06:46 +0100309 "ns-net": object_schema,
tierno4f9d4ae2019-03-20 17:24:11 +0000310 "wimAccountId": {"OneOf": [id_schema, bool_schema, null_schema]},
tierno0da52252018-06-27 15:47:22 +0200311 "ip-profile": object_schema,
kbsub21f03f52019-10-17 16:26:56 +0000312 "provider-network": provider_network_schema,
tiernob7c6f2a2018-09-03 14:32:10 +0200313 "vnfd-connection-point-ref": {
314 "type": "array",
315 "minItems": 1,
316 "items": {
317 "type": "object",
318 "properties": {
319 "member-vnf-index-ref": name_schema,
320 "vnfd-connection-point-ref": name_schema,
321 "ip-address": ip_schema,
322 # "mac-address": mac_schema,
323 },
324 "required": ["member-vnf-index-ref", "vnfd-connection-point-ref"],
325 "minProperties": 3,
326 "additionalProperties": False
327 },
328 }
tierno0da52252018-06-27 15:47:22 +0200329 },
tierno441dbbf2018-07-10 12:52:48 +0200330 "required": ["name"],
331 "additionalProperties": False
tierno0da52252018-06-27 15:47:22 +0200332 }
333 },
334 },
tierno441dbbf2018-07-10 12:52:48 +0200335 "required": ["nsName", "nsdId", "vimAccountId"],
336 "additionalProperties": False
tierno65acb4d2018-04-06 16:42:40 +0200337}
tierno0da52252018-06-27 15:47:22 +0200338
tierno65acb4d2018-04-06 16:42:40 +0200339ns_action = { # TODO for the moment it is only contemplated the vnfd primitive execution
tiernof759d822018-06-11 18:54:54 +0200340 "title": "ns action input schema",
tierno65acb4d2018-04-06 16:42:40 +0200341 "$schema": "http://json-schema.org/draft-04/schema#",
342 "type": "object",
343 "properties": {
tiernob24258a2018-10-04 18:39:49 +0200344 "lcmOperationType": string_schema,
345 "nsInstanceId": id_schema,
tiernof5298be2018-05-16 14:43:57 +0200346 "member_vnf_index": name_schema,
347 "vnf_member_index": name_schema, # TODO for backward compatibility. To remove in future
tierno7ce1db92018-07-25 12:50:52 +0200348 "vdu_id": name_schema,
tiernof0637052019-03-07 16:26:47 +0000349 "vdu_count_index": integer0_schema,
tierno9cb7d672019-10-30 12:13:48 +0000350 "kdu_name": name_schema,
tierno65acb4d2018-04-06 16:42:40 +0200351 "primitive": name_schema,
352 "primitive_params": {"type": "object"},
353 },
tiernof5298be2018-05-16 14:43:57 +0200354 "required": ["primitive", "primitive_params"], # TODO add member_vnf_index
tierno65acb4d2018-04-06 16:42:40 +0200355 "additionalProperties": False
356}
tiernof759d822018-06-11 18:54:54 +0200357ns_scale = { # TODO for the moment it is only VDU-scaling
358 "title": "ns scale input schema",
359 "$schema": "http://json-schema.org/draft-04/schema#",
360 "type": "object",
361 "properties": {
tiernob24258a2018-10-04 18:39:49 +0200362 "lcmOperationType": string_schema,
363 "nsInstanceId": id_schema,
tiernof759d822018-06-11 18:54:54 +0200364 "scaleType": {"enum": ["SCALE_VNF"]},
365 "scaleVnfData": {
366 "type": "object",
367 "properties": {
368 "vnfInstanceId": name_schema,
369 "scaleVnfType": {"enum": ["SCALE_OUT", 'SCALE_IN']},
370 "scaleByStepData": {
371 "type": "object",
372 "properties": {
373 "scaling-group-descriptor": name_schema,
374 "member-vnf-index": name_schema,
375 "scaling-policy": name_schema,
376 },
377 "required": ["scaling-group-descriptor", "member-vnf-index"],
378 "additionalProperties": False
379 },
380 },
381 "required": ["scaleVnfType", "scaleByStepData"], # vnfInstanceId
382 "additionalProperties": False
383 },
384 "scaleTime": time_schema,
385 },
386 "required": ["scaleType", "scaleVnfData"],
387 "additionalProperties": False
388}
tierno65acb4d2018-04-06 16:42:40 +0200389
390
tierno0f98af52018-03-19 10:28:22 +0100391schema_version = {"type": "string", "enum": ["1.0"]}
tierno55ba2e62018-12-11 17:22:22 +0000392schema_type = {"type": "string"}
tiernob3d0a0e2019-11-13 15:57:51 +0000393vim_type = shortname_schema # {"enum": ["openstack", "openvim", "vmware", "opennebula", "aws", "azure", "fos"]}
delacruzramo3a144c92019-10-25 09:46:33 +0200394
tierno09c073e2018-04-26 13:36:48 +0200395vim_account_edit_schema = {
396 "title": "vim_account edit input schema",
397 "$schema": "http://json-schema.org/draft-04/schema#",
398 "type": "object",
399 "properties": {
400 "name": name_schema,
401 "description": description_schema,
tierno09c073e2018-04-26 13:36:48 +0200402 "vim": name_schema,
403 "datacenter": name_schema,
delacruzramo3a144c92019-10-25 09:46:33 +0200404 "vim_type": vim_type,
tierno09c073e2018-04-26 13:36:48 +0200405 "vim_url": description_schema,
delacruzramo3a144c92019-10-25 09:46:33 +0200406 # "vim_url_admin": description_schema,
407 # "vim_tenant": name_schema,
tierno09c073e2018-04-26 13:36:48 +0200408 "vim_tenant_name": name_schema,
delacruzramo3a144c92019-10-25 09:46:33 +0200409 "vim_user": shortname_schema,
tiernocd54a4a2018-09-12 16:40:35 +0200410 "vim_password": passwd_schema,
tierno09c073e2018-04-26 13:36:48 +0200411 "config": {"type": "object"}
412 },
413 "additionalProperties": False
414}
tierno0f98af52018-03-19 10:28:22 +0100415
tierno09c073e2018-04-26 13:36:48 +0200416vim_account_new_schema = {
417 "title": "vim_account creation input schema",
tierno0f98af52018-03-19 10:28:22 +0100418 "$schema": "http://json-schema.org/draft-04/schema#",
419 "type": "object",
420 "properties": {
421 "schema_version": schema_version,
422 "schema_type": schema_type,
423 "name": name_schema,
424 "description": description_schema,
tierno09c073e2018-04-26 13:36:48 +0200425 "vim": name_schema,
426 "datacenter": name_schema,
delacruzramo3a144c92019-10-25 09:46:33 +0200427 "vim_type": vim_type,
tierno0f98af52018-03-19 10:28:22 +0100428 "vim_url": description_schema,
429 # "vim_url_admin": description_schema,
430 # "vim_tenant": name_schema,
431 "vim_tenant_name": name_schema,
tiernofd160572019-01-21 10:41:37 +0000432 "vim_user": shortname_schema,
tiernocd54a4a2018-09-12 16:40:35 +0200433 "vim_password": passwd_schema,
tierno0f98af52018-03-19 10:28:22 +0100434 "config": {"type": "object"}
435 },
436 "required": ["name", "vim_url", "vim_type", "vim_user", "vim_password", "vim_tenant_name"],
437 "additionalProperties": False
438}
tierno0f98af52018-03-19 10:28:22 +0100439
tierno85807722019-12-20 14:11:35 +0000440wim_type = shortname_schema # {"enum": ["ietfl2vpn", "onos", "odl", "dynpac", "fake"]}
delacruzramo3a144c92019-10-25 09:46:33 +0200441
tierno55ba2e62018-12-11 17:22:22 +0000442wim_account_edit_schema = {
443 "title": "wim_account edit input schema",
444 "$schema": "http://json-schema.org/draft-04/schema#",
445 "type": "object",
446 "properties": {
447 "name": name_schema,
448 "description": description_schema,
tierno55ba2e62018-12-11 17:22:22 +0000449 "wim": name_schema,
delacruzramo3a144c92019-10-25 09:46:33 +0200450 "wim_type": wim_type,
tierno55ba2e62018-12-11 17:22:22 +0000451 "wim_url": description_schema,
tiernofd160572019-01-21 10:41:37 +0000452 "user": shortname_schema,
tierno55ba2e62018-12-11 17:22:22 +0000453 "password": passwd_schema,
454 "config": {"type": "object"}
455 },
456 "additionalProperties": False
457}
458
459wim_account_new_schema = {
460 "title": "wim_account creation input schema",
461 "$schema": "http://json-schema.org/draft-04/schema#",
462 "type": "object",
463 "properties": {
464 "schema_version": schema_version,
465 "schema_type": schema_type,
466 "name": name_schema,
467 "description": description_schema,
468 "wim": name_schema,
delacruzramo3a144c92019-10-25 09:46:33 +0200469 "wim_type": wim_type,
tierno55ba2e62018-12-11 17:22:22 +0000470 "wim_url": description_schema,
tiernofd160572019-01-21 10:41:37 +0000471 "user": shortname_schema,
tierno55ba2e62018-12-11 17:22:22 +0000472 "password": passwd_schema,
tiernof0637052019-03-07 16:26:47 +0000473 "config": {
474 "type": "object",
475 "patternProperties": {
476 ".": {"not": {"type": "null"}}
477 }
478 }
tierno55ba2e62018-12-11 17:22:22 +0000479 },
480 "required": ["name", "wim_url", "wim_type"],
481 "additionalProperties": False
482}
tierno0f98af52018-03-19 10:28:22 +0100483
484sdn_properties = {
485 "name": name_schema,
tierno7adaeb02019-12-17 16:46:12 +0000486 "type": {"type": "string"},
487 "url": {"type": "string"},
488 "user": shortname_schema,
489 "password": passwd_schema,
490 "config": {"type": "object"},
tiernocfb07c62018-05-10 18:30:51 +0200491 "description": description_schema,
tierno7adaeb02019-12-17 16:46:12 +0000492 # The folowing are deprecated. Maintanied for backward compatibility
tiernocb83c942018-09-24 17:28:13 +0200493 "dpid": dpid_Schema,
tierno0f98af52018-03-19 10:28:22 +0100494 "ip": ip_schema,
495 "port": port_schema,
tierno0f98af52018-03-19 10:28:22 +0100496 "version": {"type": "string", "minLength": 1, "maxLength": 12},
tierno0f98af52018-03-19 10:28:22 +0100497}
498sdn_new_schema = {
499 "title": "sdn controller information schema",
500 "$schema": "http://json-schema.org/draft-04/schema#",
501 "type": "object",
502 "properties": sdn_properties,
tierno7adaeb02019-12-17 16:46:12 +0000503 "required": ["name", 'type'],
tierno0f98af52018-03-19 10:28:22 +0100504 "additionalProperties": False
505}
506sdn_edit_schema = {
507 "title": "sdn controller update information schema",
508 "$schema": "http://json-schema.org/draft-04/schema#",
509 "type": "object",
510 "properties": sdn_properties,
tiernocfb07c62018-05-10 18:30:51 +0200511 # "required": ["name", "port", 'ip', 'dpid', 'type'],
tierno0f98af52018-03-19 10:28:22 +0100512 "additionalProperties": False
513}
514sdn_port_mapping_schema = {
515 "$schema": "http://json-schema.org/draft-04/schema#",
516 "title": "sdn port mapping information schema",
517 "type": "array",
518 "items": {
519 "type": "object",
520 "properties": {
tiernofd160572019-01-21 10:41:37 +0000521 "compute_node": shortname_schema,
tierno0f98af52018-03-19 10:28:22 +0100522 "ports": {
523 "type": "array",
524 "items": {
525 "type": "object",
526 "properties": {
tierno42fce592018-11-02 09:23:43 +0100527 "pci": pci_extended_schema,
tiernofd160572019-01-21 10:41:37 +0000528 "switch_port": shortname_schema,
tierno0f98af52018-03-19 10:28:22 +0100529 "switch_mac": mac_schema
530 },
531 "required": ["pci"]
532 }
533 }
534 },
535 "required": ["compute_node", "ports"]
536 }
537}
538sdn_external_port_schema = {
539 "$schema": "http://json-schema.org/draft-04/schema#",
tiernocd54a4a2018-09-12 16:40:35 +0200540 "title": "External port information",
tierno0f98af52018-03-19 10:28:22 +0100541 "type": "object",
542 "properties": {
543 "port": {"type": "string", "minLength": 1, "maxLength": 60},
544 "vlan": vlan_schema,
545 "mac": mac_schema
546 },
547 "required": ["port"]
548}
549
delacruzramofe598fe2019-10-23 18:25:11 +0200550# K8s Clusters
551k8scluster_nets_schema = {
552 "title": "k8scluster nets input schema",
553 "$schema": "http://json-schema.org/draft-04/schema#",
554 "type": "object",
tiernoc67b0e92019-11-05 12:45:29 +0000555 "patternProperties": {".": {"oneOf": [description_schema, null_schema]}},
delacruzramofe598fe2019-10-23 18:25:11 +0200556 "minProperties": 1,
557 "additionalProperties": False
558}
559k8scluster_new_schema = {
560 "title": "k8scluster creation input schema",
561 "$schema": "http://json-schema.org/draft-04/schema#",
562 "type": "object",
563 "properties": {
564 "schema_version": schema_version,
565 "schema_type": schema_type,
566 "name": name_schema,
567 "description": description_schema,
568 "credentials": object_schema,
569 "vim_account": id_schema,
570 "k8s_version": string_schema,
571 "nets": k8scluster_nets_schema,
572 "namespace": name_schema,
573 "cni": nameshort_list_schema,
574 },
575 "required": ["name", "credentials", "vim_account", "k8s_version", "nets"],
576 "additionalProperties": False
577}
578k8scluster_edit_schema = {
579 "title": "vim_account edit input schema",
580 "$schema": "http://json-schema.org/draft-04/schema#",
581 "type": "object",
582 "properties": {
583 "name": name_schema,
584 "description": description_schema,
585 "credentials": object_schema,
586 "vim_account": id_schema,
587 "k8s_version": string_schema,
588 "nets": k8scluster_nets_schema,
589 "namespace": name_schema,
590 "cni": nameshort_list_schema,
591 },
592 "additionalProperties": False
593}
594
595# K8s Repos
tierno332e0802019-12-03 23:50:49 +0000596k8srepo_types = {"enum": ["helm-chart", "juju-bundle"]}
delacruzramofe598fe2019-10-23 18:25:11 +0200597k8srepo_properties = {
598 "name": name_schema,
599 "description": description_schema,
600 "type": k8srepo_types,
601 "url": description_schema,
602}
603k8srepo_new_schema = {
604 "title": "k8scluster creation input schema",
605 "$schema": "http://json-schema.org/draft-04/schema#",
606 "type": "object",
607 "properties": k8srepo_properties,
608 "required": ["name", "type", "url"],
609 "additionalProperties": False
610}
611k8srepo_edit_schema = {
612 "title": "vim_account edit input schema",
613 "$schema": "http://json-schema.org/draft-04/schema#",
614 "type": "object",
615 "properties": k8srepo_properties,
616 "additionalProperties": False
617}
618
tiernocb83c942018-09-24 17:28:13 +0200619# PDUs
620pdu_interface = {
621 "type": "object",
622 "properties": {
tiernofd160572019-01-21 10:41:37 +0000623 "name": shortname_schema,
tiernocb83c942018-09-24 17:28:13 +0200624 "mgmt": bool_schema,
625 "type": {"enum": ["overlay", 'underlay']},
tierno36ec8602018-11-02 17:27:11 +0100626 "ip-address": ip_schema,
tiernocb83c942018-09-24 17:28:13 +0200627 # TODO, add user, password, ssh-key
tierno36ec8602018-11-02 17:27:11 +0100628 "mac-address": mac_schema,
tiernofd160572019-01-21 10:41:37 +0000629 "vim-network-name": shortname_schema, # interface is connected to one vim network, or switch port
630 "vim-network-id": shortname_schema,
tierno36ec8602018-11-02 17:27:11 +0100631 # # provide this in case SDN assist must deal with this interface
632 # "switch-dpid": dpid_Schema,
tiernofd160572019-01-21 10:41:37 +0000633 # "switch-port": shortname_schema,
634 # "switch-mac": shortname_schema,
tierno36ec8602018-11-02 17:27:11 +0100635 # "switch-vlan": vlan_schema,
tiernocb83c942018-09-24 17:28:13 +0200636 },
tierno36ec8602018-11-02 17:27:11 +0100637 "required": ["name", "mgmt", "ip-address"],
tiernocb83c942018-09-24 17:28:13 +0200638 "additionalProperties": False
tiernocd54a4a2018-09-12 16:40:35 +0200639}
tiernocb83c942018-09-24 17:28:13 +0200640pdu_new_schema = {
641 "title": "pdu creation input schema",
642 "$schema": "http://json-schema.org/draft-04/schema#",
643 "type": "object",
644 "properties": {
tiernofd160572019-01-21 10:41:37 +0000645 "name": shortname_schema,
646 "type": shortname_schema,
tiernocb83c942018-09-24 17:28:13 +0200647 "description": description_schema,
648 "shared": bool_schema,
649 "vims": nameshort_list_schema,
650 "vim_accounts": nameshort_list_schema,
651 "interfaces": {
652 "type": "array",
tierno36ec8602018-11-02 17:27:11 +0100653 "items": pdu_interface,
tiernocb83c942018-09-24 17:28:13 +0200654 "minItems": 1
655 }
656 },
657 "required": ["name", "type", "interfaces"],
658 "additionalProperties": False
659}
660
661pdu_edit_schema = {
662 "title": "pdu edit input schema",
663 "$schema": "http://json-schema.org/draft-04/schema#",
664 "type": "object",
665 "properties": {
tiernofd160572019-01-21 10:41:37 +0000666 "name": shortname_schema,
667 "type": shortname_schema,
tiernocb83c942018-09-24 17:28:13 +0200668 "description": description_schema,
669 "shared": bool_schema,
garciadeblas84bdd552018-11-30 22:59:45 +0100670 "vims": {"oneOf": [array_edition_schema, nameshort_list_schema]},
671 "vim_accounts": {"oneOf": [array_edition_schema, nameshort_list_schema]},
672 "interfaces": {"oneOf": [
tiernocb83c942018-09-24 17:28:13 +0200673 array_edition_schema,
674 {
675 "type": "array",
tierno36ec8602018-11-02 17:27:11 +0100676 "items": pdu_interface,
tiernocb83c942018-09-24 17:28:13 +0200677 "minItems": 1
678 }
679 ]}
680 },
681 "additionalProperties": False,
682 "minProperties": 1
683}
684
685# USERS
tiernocf042d32019-06-13 09:06:40 +0000686project_role_mappings = {
687 "title": "list pf projects/roles",
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100688 "$schema": "http://json-schema.org/draft-04/schema#",
tiernocf042d32019-06-13 09:06:40 +0000689 "type": "array",
690 "items": {
691 "type": "object",
692 "properties": {
693 "project": shortname_schema,
694 "role": shortname_schema
695 },
696 "required": ["project", "role"],
697 "additionalProperties": False
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100698 },
tiernocf042d32019-06-13 09:06:40 +0000699 "minItems": 1
700}
701project_role_mappings_optional = {
702 "title": "list of projects/roles or projects only",
703 "$schema": "http://json-schema.org/draft-04/schema#",
704 "type": "array",
705 "items": {
706 "type": "object",
707 "properties": {
708 "project": shortname_schema,
709 "role": shortname_schema
710 },
711 "required": ["project"],
712 "additionalProperties": False
713 },
714 "minItems": 1
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100715}
tiernocd54a4a2018-09-12 16:40:35 +0200716user_new_schema = {
717 "$schema": "http://json-schema.org/draft-04/schema#",
718 "title": "New user schema",
719 "type": "object",
720 "properties": {
tiernofd160572019-01-21 10:41:37 +0000721 "username": shortname_schema,
tiernocd54a4a2018-09-12 16:40:35 +0200722 "password": passwd_schema,
tiernocb83c942018-09-24 17:28:13 +0200723 "projects": nameshort_list_schema,
tiernocf042d32019-06-13 09:06:40 +0000724 "project_role_mappings": project_role_mappings,
tiernocd54a4a2018-09-12 16:40:35 +0200725 },
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100726 "required": ["username", "password"],
tiernocd54a4a2018-09-12 16:40:35 +0200727 "additionalProperties": False
728}
729user_edit_schema = {
730 "$schema": "http://json-schema.org/draft-04/schema#",
731 "title": "User edit schema for administrators",
732 "type": "object",
733 "properties": {
734 "password": passwd_schema,
delacruzramoc061f562019-04-05 11:00:02 +0200735 "username": shortname_schema, # To allow User Name modification
tiernocd54a4a2018-09-12 16:40:35 +0200736 "projects": {
garciadeblas84bdd552018-11-30 22:59:45 +0100737 "oneOf": [
tiernocb83c942018-09-24 17:28:13 +0200738 nameshort_list_schema,
tiernocd54a4a2018-09-12 16:40:35 +0200739 array_edition_schema
740 ]
741 },
tiernocf042d32019-06-13 09:06:40 +0000742 "project_role_mappings": project_role_mappings,
743 "add_project_role_mappings": project_role_mappings,
744 "remove_project_role_mappings": project_role_mappings_optional,
tiernocb83c942018-09-24 17:28:13 +0200745 },
746 "minProperties": 1,
747 "additionalProperties": False
tiernocd54a4a2018-09-12 16:40:35 +0200748}
749
750# PROJECTS
delacruzramofe598fe2019-10-23 18:25:11 +0200751topics_with_quota = ["vnfds", "nsds", "nsts", "pdus", "nsrs", "nsis", "vim_accounts", "wim_accounts", "sdns",
752 "k8sclusters", "k8srepos"]
tiernocd54a4a2018-09-12 16:40:35 +0200753project_new_schema = {
754 "$schema": "http://json-schema.org/draft-04/schema#",
755 "title": "New project schema for administrators",
756 "type": "object",
757 "properties": {
tiernofd160572019-01-21 10:41:37 +0000758 "name": shortname_schema,
tiernocd54a4a2018-09-12 16:40:35 +0200759 "admin": bool_schema,
delacruzramo32bab472019-09-13 12:24:22 +0200760 "quotas": {
761 "type": "object",
762 "properties": {topic: integer0_schema for topic in topics_with_quota},
763 "additionalProperties": False
764 },
tiernocd54a4a2018-09-12 16:40:35 +0200765 },
766 "required": ["name"],
767 "additionalProperties": False
768}
769project_edit_schema = {
770 "$schema": "http://json-schema.org/draft-04/schema#",
771 "title": "Project edit schema for administrators",
772 "type": "object",
773 "properties": {
774 "admin": bool_schema,
delacruzramoc061f562019-04-05 11:00:02 +0200775 "name": shortname_schema, # To allow Project Name modification
delacruzramo32bab472019-09-13 12:24:22 +0200776 "quotas": {
777 "type": "object",
778 "properties": {topic: {"oneOf": [integer0_schema, null_schema]} for topic in topics_with_quota},
779 "additionalProperties": False
780 },
tiernocd54a4a2018-09-12 16:40:35 +0200781 },
782 "additionalProperties": False,
783 "minProperties": 1
784}
785
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100786# ROLES
787roles_new_schema = {
788 "$schema": "http://json-schema.org/draft-04/schema#",
789 "title": "New role schema for administrators",
790 "type": "object",
791 "properties": {
792 "name": shortname_schema,
tierno1f029d82019-06-13 22:37:04 +0000793 "permissions": {
794 "type": "object",
795 "patternProperties": {
796 ".": bool_schema,
797 },
798 # "minProperties": 1,
799 }
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100800 },
tierno1f029d82019-06-13 22:37:04 +0000801 "required": ["name"],
802 "additionalProperties": False
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100803}
804roles_edit_schema = {
805 "$schema": "http://json-schema.org/draft-04/schema#",
806 "title": "Roles edit schema for administrators",
807 "type": "object",
808 "properties": {
tierno1f029d82019-06-13 22:37:04 +0000809 "name": shortname_schema,
810 "permissions": {
811 "type": "object",
812 "patternProperties": {
813 ".": {
814 "oneOf": [bool_schema, null_schema]
815 }
816 },
817 # "minProperties": 1,
818 }
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100819 },
tierno1f029d82019-06-13 22:37:04 +0000820 "additionalProperties": False,
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100821 "minProperties": 1
822}
823
tiernocd54a4a2018-09-12 16:40:35 +0200824# GLOBAL SCHEMAS
tierno0f98af52018-03-19 10:28:22 +0100825
826nbi_new_input_schemas = {
tiernocd54a4a2018-09-12 16:40:35 +0200827 "users": user_new_schema,
828 "projects": project_new_schema,
tierno09c073e2018-04-26 13:36:48 +0200829 "vim_accounts": vim_account_new_schema,
tierno65acb4d2018-04-06 16:42:40 +0200830 "sdns": sdn_new_schema,
831 "ns_instantiate": ns_instantiate,
832 "ns_action": ns_action,
tiernocb83c942018-09-24 17:28:13 +0200833 "ns_scale": ns_scale,
834 "pdus": pdu_new_schema,
tierno0f98af52018-03-19 10:28:22 +0100835}
836
837nbi_edit_input_schemas = {
tiernocd54a4a2018-09-12 16:40:35 +0200838 "users": user_edit_schema,
839 "projects": project_edit_schema,
tierno09c073e2018-04-26 13:36:48 +0200840 "vim_accounts": vim_account_edit_schema,
tiernocb83c942018-09-24 17:28:13 +0200841 "sdns": sdn_edit_schema,
842 "pdus": pdu_edit_schema,
tierno0f98af52018-03-19 10:28:22 +0100843}
844
Felipe Vicens07f31722018-10-29 15:16:44 +0100845# NETSLICE SCHEMAS
tierno032916c2019-03-22 13:27:12 +0000846nsi_subnet_instantiate = deepcopy(ns_instantiate)
847nsi_subnet_instantiate["title"] = "netslice subnet instantiation params input schema"
848nsi_subnet_instantiate["properties"]["id"] = name_schema
849del nsi_subnet_instantiate["required"]
garciadeblasdaf8cc52018-11-30 14:17:20 +0100850
851nsi_vld_instantiate = {
852 "title": "netslice vld instantiation params input schema",
853 "$schema": "http://json-schema.org/draft-04/schema#",
854 "type": "object",
855 "properties": {
856 "name": string_schema,
857 "vim-network-name": {"OneOf": [string_schema, object_schema]},
gcalvino17d5b732018-12-17 16:26:21 +0100858 "vim-network-id": {"OneOf": [string_schema, object_schema]},
garciadeblasdaf8cc52018-11-30 14:17:20 +0100859 "ip-profile": object_schema,
860 },
delacruzramoc061f562019-04-05 11:00:02 +0200861 "required": ["name"],
garciadeblasdaf8cc52018-11-30 14:17:20 +0100862 "additionalProperties": False
863}
864
Felipe Vicens07f31722018-10-29 15:16:44 +0100865nsi_instantiate = {
866 "title": "netslice action instantiate input schema",
867 "$schema": "http://json-schema.org/draft-04/schema#",
868 "type": "object",
869 "properties": {
870 "lcmOperationType": string_schema,
Felipe Vicens126af572019-06-05 19:13:04 +0200871 "netsliceInstanceId": id_schema,
Felipe Vicens07f31722018-10-29 15:16:44 +0100872 "nsiName": name_schema,
tierno4f9d4ae2019-03-20 17:24:11 +0000873 "nsiDescription": {"oneOf": [description_schema, null_schema]},
tierno9e5eea32018-11-29 09:42:09 +0000874 "nstId": string_schema,
Felipe Vicens07f31722018-10-29 15:16:44 +0100875 "vimAccountId": id_schema,
tiernoa8186a52020-01-14 15:54:48 +0000876 "timeout_nsi_deploy": integer1_schema,
Felipe Vicens07f31722018-10-29 15:16:44 +0100877 "ssh_keys": {"type": "string"},
878 "nsi_id": id_schema,
tierno032916c2019-03-22 13:27:12 +0000879 "additionalParamsForNsi": object_schema,
garciadeblasdaf8cc52018-11-30 14:17:20 +0100880 "netslice-subnet": {
Felipe Vicens07f31722018-10-29 15:16:44 +0100881 "type": "array",
882 "minItems": 1,
tierno032916c2019-03-22 13:27:12 +0000883 "items": nsi_subnet_instantiate
garciadeblasdaf8cc52018-11-30 14:17:20 +0100884 },
885 "netslice-vld": {
886 "type": "array",
887 "minItems": 1,
888 "items": nsi_vld_instantiate
Felipe Vicens07f31722018-10-29 15:16:44 +0100889 },
890 },
Felipe Vicensc8bbaaa2018-12-01 04:42:40 +0100891 "required": ["nsiName", "nstId", "vimAccountId"],
Felipe Vicens07f31722018-10-29 15:16:44 +0100892 "additionalProperties": False
893}
894
895nsi_action = {
896
897}
898
899nsi_terminate = {
delacruzramoc061f562019-04-05 11:00:02 +0200900
Felipe Vicens07f31722018-10-29 15:16:44 +0100901}
902
tierno0f98af52018-03-19 10:28:22 +0100903
904class ValidationError(Exception):
tierno36ec8602018-11-02 17:27:11 +0100905 def __init__(self, message, http_code=HTTPStatus.UNPROCESSABLE_ENTITY):
906 self.http_code = http_code
907 Exception.__init__(self, message)
tierno0f98af52018-03-19 10:28:22 +0100908
909
tiernob24258a2018-10-04 18:39:49 +0200910def validate_input(indata, schema_to_use):
tierno0f98af52018-03-19 10:28:22 +0100911 """
tiernocd54a4a2018-09-12 16:40:35 +0200912 Validates input data against json schema
tierno0f98af52018-03-19 10:28:22 +0100913 :param indata: user input data. Should be a dictionary
tiernob24258a2018-10-04 18:39:49 +0200914 :param schema_to_use: jsonschema to test
915 :return: None if ok, raises ValidationError exception on error
tierno0f98af52018-03-19 10:28:22 +0100916 """
917 try:
tierno0f98af52018-03-19 10:28:22 +0100918 if schema_to_use:
919 js_v(indata, schema_to_use)
920 return None
921 except js_e.ValidationError as e:
922 if e.path:
tierno0da52252018-06-27 15:47:22 +0200923 error_pos = "at '" + ":".join(map(str, e.path)) + "'"
tierno0f98af52018-03-19 10:28:22 +0100924 else:
925 error_pos = ""
tierno441dbbf2018-07-10 12:52:48 +0200926 raise ValidationError("Format error {} '{}' ".format(error_pos, e.message))
tierno36ec8602018-11-02 17:27:11 +0100927 except js_e.SchemaError:
928 raise ValidationError("Bad json schema {}".format(schema_to_use), http_code=HTTPStatus.INTERNAL_SERVER_ERROR)
delacruzramoc061f562019-04-05 11:00:02 +0200929
930
931def is_valid_uuid(x):
932 """
933 Test for a valid UUID
934 :param x: string to test
935 :return: True if x is a valid uuid, False otherwise
936 """
937 try:
938 if UUID(x):
939 return True
tiernobdebce92019-07-01 15:36:49 +0000940 except (TypeError, ValueError, AttributeError):
delacruzramoc061f562019-04-05 11:00:02 +0200941 return False