blob: c6821c5240a0f91dd9819fe666b63b02756e6bdf [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,
224 },
225 "required": ["member-vnf-index", "additionalParams"],
226 "additionalProperties": False
227 }
228
229}
230
tierno65acb4d2018-04-06 16:42:40 +0200231ns_instantiate = {
232 "title": "ns action instantiate input schema",
233 "$schema": "http://json-schema.org/draft-04/schema#",
234 "type": "object",
tierno0da52252018-06-27 15:47:22 +0200235 "properties": {
tiernob24258a2018-10-04 18:39:49 +0200236 "lcmOperationType": string_schema,
237 "nsInstanceId": id_schema,
Felipe Vicens07f31722018-10-29 15:16:44 +0100238 "netsliceInstanceId": id_schema,
tierno0da52252018-06-27 15:47:22 +0200239 "nsName": name_schema,
tierno4f9d4ae2019-03-20 17:24:11 +0000240 "nsDescription": {"oneOf": [description_schema, null_schema]},
tierno0da52252018-06-27 15:47:22 +0200241 "nsdId": id_schema,
242 "vimAccountId": id_schema,
tierno4f9d4ae2019-03-20 17:24:11 +0000243 "wimAccountId": {"OneOf": [id_schema, bool_schema, null_schema]},
tiernobee085c2018-12-12 17:03:04 +0000244 "additionalParamsForNs": object_schema,
tiernofd160572019-01-21 10:41:37 +0000245 "additionalParamsForVnf": additional_params_for_vnf,
tiernofc5089c2018-10-31 09:28:11 +0100246 "ssh_keys": {"type": "array", "items": {"type": "string"}},
tierno441dbbf2018-07-10 12:52:48 +0200247 "nsr_id": id_schema,
tiernocc103432018-10-19 14:10:35 +0200248 "vduImage": name_schema,
tierno0da52252018-06-27 15:47:22 +0200249 "vnf": {
250 "type": "array",
251 "minItems": 1,
252 "items": {
253 "type": "object",
254 "properties": {
255 "member-vnf-index": name_schema,
256 "vimAccountId": id_schema,
tierno441dbbf2018-07-10 12:52:48 +0200257 "vdu": {
258 "type": "array",
259 "minItems": 1,
260 "items": ns_instantiate_vdu,
261 },
262 "internal-vld": {
263 "type": "array",
264 "minItems": 1,
265 "items": ns_instantiate_internal_vld
266 }
tierno0da52252018-06-27 15:47:22 +0200267 },
tierno441dbbf2018-07-10 12:52:48 +0200268 "required": ["member-vnf-index"],
269 "minProperties": 2,
270 "additionalProperties": False
tierno0da52252018-06-27 15:47:22 +0200271 }
272 },
273 "vld": {
274 "type": "array",
275 "minItems": 1,
276 "items": {
277 "type": "object",
278 "properties": {
279 "name": string_schema,
280 "vim-network-name": {"OneOf": [string_schema, object_schema]},
gcalvino17d5b732018-12-17 16:26:21 +0100281 "vim-network-id": {"OneOf": [string_schema, object_schema]},
Felipe Vicens09e65422019-01-22 15:06:46 +0100282 "ns-net": object_schema,
tierno4f9d4ae2019-03-20 17:24:11 +0000283 "wimAccountId": {"OneOf": [id_schema, bool_schema, null_schema]},
tierno0da52252018-06-27 15:47:22 +0200284 "ip-profile": object_schema,
kbsub21f03f52019-10-17 16:26:56 +0000285 "provider-network": provider_network_schema,
tiernob7c6f2a2018-09-03 14:32:10 +0200286 "vnfd-connection-point-ref": {
287 "type": "array",
288 "minItems": 1,
289 "items": {
290 "type": "object",
291 "properties": {
292 "member-vnf-index-ref": name_schema,
293 "vnfd-connection-point-ref": name_schema,
294 "ip-address": ip_schema,
295 # "mac-address": mac_schema,
296 },
297 "required": ["member-vnf-index-ref", "vnfd-connection-point-ref"],
298 "minProperties": 3,
299 "additionalProperties": False
300 },
301 }
tierno0da52252018-06-27 15:47:22 +0200302 },
tierno441dbbf2018-07-10 12:52:48 +0200303 "required": ["name"],
304 "additionalProperties": False
tierno0da52252018-06-27 15:47:22 +0200305 }
306 },
307 },
tierno441dbbf2018-07-10 12:52:48 +0200308 "required": ["nsName", "nsdId", "vimAccountId"],
309 "additionalProperties": False
tierno65acb4d2018-04-06 16:42:40 +0200310}
tierno0da52252018-06-27 15:47:22 +0200311
tierno65acb4d2018-04-06 16:42:40 +0200312ns_action = { # TODO for the moment it is only contemplated the vnfd primitive execution
tiernof759d822018-06-11 18:54:54 +0200313 "title": "ns action input schema",
tierno65acb4d2018-04-06 16:42:40 +0200314 "$schema": "http://json-schema.org/draft-04/schema#",
315 "type": "object",
316 "properties": {
tiernob24258a2018-10-04 18:39:49 +0200317 "lcmOperationType": string_schema,
318 "nsInstanceId": id_schema,
tiernof5298be2018-05-16 14:43:57 +0200319 "member_vnf_index": name_schema,
320 "vnf_member_index": name_schema, # TODO for backward compatibility. To remove in future
tierno7ce1db92018-07-25 12:50:52 +0200321 "vdu_id": name_schema,
tiernof0637052019-03-07 16:26:47 +0000322 "vdu_count_index": integer0_schema,
tierno9cb7d672019-10-30 12:13:48 +0000323 "kdu_name": name_schema,
tierno65acb4d2018-04-06 16:42:40 +0200324 "primitive": name_schema,
325 "primitive_params": {"type": "object"},
326 },
tiernof5298be2018-05-16 14:43:57 +0200327 "required": ["primitive", "primitive_params"], # TODO add member_vnf_index
tierno65acb4d2018-04-06 16:42:40 +0200328 "additionalProperties": False
329}
tiernof759d822018-06-11 18:54:54 +0200330ns_scale = { # TODO for the moment it is only VDU-scaling
331 "title": "ns scale input schema",
332 "$schema": "http://json-schema.org/draft-04/schema#",
333 "type": "object",
334 "properties": {
tiernob24258a2018-10-04 18:39:49 +0200335 "lcmOperationType": string_schema,
336 "nsInstanceId": id_schema,
tiernof759d822018-06-11 18:54:54 +0200337 "scaleType": {"enum": ["SCALE_VNF"]},
338 "scaleVnfData": {
339 "type": "object",
340 "properties": {
341 "vnfInstanceId": name_schema,
342 "scaleVnfType": {"enum": ["SCALE_OUT", 'SCALE_IN']},
343 "scaleByStepData": {
344 "type": "object",
345 "properties": {
346 "scaling-group-descriptor": name_schema,
347 "member-vnf-index": name_schema,
348 "scaling-policy": name_schema,
349 },
350 "required": ["scaling-group-descriptor", "member-vnf-index"],
351 "additionalProperties": False
352 },
353 },
354 "required": ["scaleVnfType", "scaleByStepData"], # vnfInstanceId
355 "additionalProperties": False
356 },
357 "scaleTime": time_schema,
358 },
359 "required": ["scaleType", "scaleVnfData"],
360 "additionalProperties": False
361}
tierno65acb4d2018-04-06 16:42:40 +0200362
363
tierno0f98af52018-03-19 10:28:22 +0100364schema_version = {"type": "string", "enum": ["1.0"]}
tierno55ba2e62018-12-11 17:22:22 +0000365schema_type = {"type": "string"}
delacruzramo3a144c92019-10-25 09:46:33 +0200366vim_type = {"enum": ["openstack", "openvim", "vmware", "opennebula", "aws", "azure", "fos"]}
367
tierno09c073e2018-04-26 13:36:48 +0200368vim_account_edit_schema = {
369 "title": "vim_account edit input schema",
370 "$schema": "http://json-schema.org/draft-04/schema#",
371 "type": "object",
372 "properties": {
373 "name": name_schema,
374 "description": description_schema,
tierno09c073e2018-04-26 13:36:48 +0200375 "vim": name_schema,
376 "datacenter": name_schema,
delacruzramo3a144c92019-10-25 09:46:33 +0200377 "vim_type": vim_type,
tierno09c073e2018-04-26 13:36:48 +0200378 "vim_url": description_schema,
delacruzramo3a144c92019-10-25 09:46:33 +0200379 # "vim_url_admin": description_schema,
380 # "vim_tenant": name_schema,
tierno09c073e2018-04-26 13:36:48 +0200381 "vim_tenant_name": name_schema,
delacruzramo3a144c92019-10-25 09:46:33 +0200382 "vim_user": shortname_schema,
tiernocd54a4a2018-09-12 16:40:35 +0200383 "vim_password": passwd_schema,
tierno09c073e2018-04-26 13:36:48 +0200384 "config": {"type": "object"}
385 },
386 "additionalProperties": False
387}
tierno0f98af52018-03-19 10:28:22 +0100388
tierno09c073e2018-04-26 13:36:48 +0200389vim_account_new_schema = {
390 "title": "vim_account creation input schema",
tierno0f98af52018-03-19 10:28:22 +0100391 "$schema": "http://json-schema.org/draft-04/schema#",
392 "type": "object",
393 "properties": {
394 "schema_version": schema_version,
395 "schema_type": schema_type,
396 "name": name_schema,
397 "description": description_schema,
tierno09c073e2018-04-26 13:36:48 +0200398 "vim": name_schema,
399 "datacenter": name_schema,
delacruzramo3a144c92019-10-25 09:46:33 +0200400 "vim_type": vim_type,
tierno0f98af52018-03-19 10:28:22 +0100401 "vim_url": description_schema,
402 # "vim_url_admin": description_schema,
403 # "vim_tenant": name_schema,
404 "vim_tenant_name": name_schema,
tiernofd160572019-01-21 10:41:37 +0000405 "vim_user": shortname_schema,
tiernocd54a4a2018-09-12 16:40:35 +0200406 "vim_password": passwd_schema,
tierno0f98af52018-03-19 10:28:22 +0100407 "config": {"type": "object"}
408 },
409 "required": ["name", "vim_url", "vim_type", "vim_user", "vim_password", "vim_tenant_name"],
410 "additionalProperties": False
411}
tierno0f98af52018-03-19 10:28:22 +0100412
delacruzramo3a144c92019-10-25 09:46:33 +0200413wim_type = {"enum": ["tapi", "onos", "odl", "dynpac", "fake"]}
414
tierno55ba2e62018-12-11 17:22:22 +0000415wim_account_edit_schema = {
416 "title": "wim_account edit input schema",
417 "$schema": "http://json-schema.org/draft-04/schema#",
418 "type": "object",
419 "properties": {
420 "name": name_schema,
421 "description": description_schema,
tierno55ba2e62018-12-11 17:22:22 +0000422 "wim": name_schema,
delacruzramo3a144c92019-10-25 09:46:33 +0200423 "wim_type": wim_type,
tierno55ba2e62018-12-11 17:22:22 +0000424 "wim_url": description_schema,
tiernofd160572019-01-21 10:41:37 +0000425 "user": shortname_schema,
tierno55ba2e62018-12-11 17:22:22 +0000426 "password": passwd_schema,
427 "config": {"type": "object"}
428 },
429 "additionalProperties": False
430}
431
432wim_account_new_schema = {
433 "title": "wim_account creation input schema",
434 "$schema": "http://json-schema.org/draft-04/schema#",
435 "type": "object",
436 "properties": {
437 "schema_version": schema_version,
438 "schema_type": schema_type,
439 "name": name_schema,
440 "description": description_schema,
441 "wim": name_schema,
delacruzramo3a144c92019-10-25 09:46:33 +0200442 "wim_type": wim_type,
tierno55ba2e62018-12-11 17:22:22 +0000443 "wim_url": description_schema,
tiernofd160572019-01-21 10:41:37 +0000444 "user": shortname_schema,
tierno55ba2e62018-12-11 17:22:22 +0000445 "password": passwd_schema,
tiernof0637052019-03-07 16:26:47 +0000446 "config": {
447 "type": "object",
448 "patternProperties": {
449 ".": {"not": {"type": "null"}}
450 }
451 }
tierno55ba2e62018-12-11 17:22:22 +0000452 },
453 "required": ["name", "wim_url", "wim_type"],
454 "additionalProperties": False
455}
tierno0f98af52018-03-19 10:28:22 +0100456
457sdn_properties = {
458 "name": name_schema,
tiernocfb07c62018-05-10 18:30:51 +0200459 "description": description_schema,
tiernocb83c942018-09-24 17:28:13 +0200460 "dpid": dpid_Schema,
tierno0f98af52018-03-19 10:28:22 +0100461 "ip": ip_schema,
462 "port": port_schema,
463 "type": {"type": "string", "enum": ["opendaylight", "floodlight", "onos"]},
464 "version": {"type": "string", "minLength": 1, "maxLength": 12},
tiernofd160572019-01-21 10:41:37 +0000465 "user": shortname_schema,
tierno0f98af52018-03-19 10:28:22 +0100466 "password": passwd_schema
467}
468sdn_new_schema = {
469 "title": "sdn controller information schema",
470 "$schema": "http://json-schema.org/draft-04/schema#",
471 "type": "object",
472 "properties": sdn_properties,
473 "required": ["name", "port", 'ip', 'dpid', 'type'],
474 "additionalProperties": False
475}
476sdn_edit_schema = {
477 "title": "sdn controller update information schema",
478 "$schema": "http://json-schema.org/draft-04/schema#",
479 "type": "object",
480 "properties": sdn_properties,
tiernocfb07c62018-05-10 18:30:51 +0200481 # "required": ["name", "port", 'ip', 'dpid', 'type'],
tierno0f98af52018-03-19 10:28:22 +0100482 "additionalProperties": False
483}
484sdn_port_mapping_schema = {
485 "$schema": "http://json-schema.org/draft-04/schema#",
486 "title": "sdn port mapping information schema",
487 "type": "array",
488 "items": {
489 "type": "object",
490 "properties": {
tiernofd160572019-01-21 10:41:37 +0000491 "compute_node": shortname_schema,
tierno0f98af52018-03-19 10:28:22 +0100492 "ports": {
493 "type": "array",
494 "items": {
495 "type": "object",
496 "properties": {
tierno42fce592018-11-02 09:23:43 +0100497 "pci": pci_extended_schema,
tiernofd160572019-01-21 10:41:37 +0000498 "switch_port": shortname_schema,
tierno0f98af52018-03-19 10:28:22 +0100499 "switch_mac": mac_schema
500 },
501 "required": ["pci"]
502 }
503 }
504 },
505 "required": ["compute_node", "ports"]
506 }
507}
508sdn_external_port_schema = {
509 "$schema": "http://json-schema.org/draft-04/schema#",
tiernocd54a4a2018-09-12 16:40:35 +0200510 "title": "External port information",
tierno0f98af52018-03-19 10:28:22 +0100511 "type": "object",
512 "properties": {
513 "port": {"type": "string", "minLength": 1, "maxLength": 60},
514 "vlan": vlan_schema,
515 "mac": mac_schema
516 },
517 "required": ["port"]
518}
519
delacruzramofe598fe2019-10-23 18:25:11 +0200520# K8s Clusters
521k8scluster_nets_schema = {
522 "title": "k8scluster nets input schema",
523 "$schema": "http://json-schema.org/draft-04/schema#",
524 "type": "object",
525 "patternProperties": {".": string_schema},
526 "minProperties": 1,
527 "additionalProperties": False
528}
529k8scluster_new_schema = {
530 "title": "k8scluster creation input schema",
531 "$schema": "http://json-schema.org/draft-04/schema#",
532 "type": "object",
533 "properties": {
534 "schema_version": schema_version,
535 "schema_type": schema_type,
536 "name": name_schema,
537 "description": description_schema,
538 "credentials": object_schema,
539 "vim_account": id_schema,
540 "k8s_version": string_schema,
541 "nets": k8scluster_nets_schema,
542 "namespace": name_schema,
543 "cni": nameshort_list_schema,
544 },
545 "required": ["name", "credentials", "vim_account", "k8s_version", "nets"],
546 "additionalProperties": False
547}
548k8scluster_edit_schema = {
549 "title": "vim_account edit input schema",
550 "$schema": "http://json-schema.org/draft-04/schema#",
551 "type": "object",
552 "properties": {
553 "name": name_schema,
554 "description": description_schema,
555 "credentials": object_schema,
556 "vim_account": id_schema,
557 "k8s_version": string_schema,
558 "nets": k8scluster_nets_schema,
559 "namespace": name_schema,
560 "cni": nameshort_list_schema,
561 },
562 "additionalProperties": False
563}
564
565# K8s Repos
566k8srepo_types = {"enum": ["chart", "bundle"]}
567k8srepo_properties = {
568 "name": name_schema,
569 "description": description_schema,
570 "type": k8srepo_types,
571 "url": description_schema,
572}
573k8srepo_new_schema = {
574 "title": "k8scluster creation input schema",
575 "$schema": "http://json-schema.org/draft-04/schema#",
576 "type": "object",
577 "properties": k8srepo_properties,
578 "required": ["name", "type", "url"],
579 "additionalProperties": False
580}
581k8srepo_edit_schema = {
582 "title": "vim_account edit input schema",
583 "$schema": "http://json-schema.org/draft-04/schema#",
584 "type": "object",
585 "properties": k8srepo_properties,
586 "additionalProperties": False
587}
588
tiernocb83c942018-09-24 17:28:13 +0200589# PDUs
590pdu_interface = {
591 "type": "object",
592 "properties": {
tiernofd160572019-01-21 10:41:37 +0000593 "name": shortname_schema,
tiernocb83c942018-09-24 17:28:13 +0200594 "mgmt": bool_schema,
595 "type": {"enum": ["overlay", 'underlay']},
tierno36ec8602018-11-02 17:27:11 +0100596 "ip-address": ip_schema,
tiernocb83c942018-09-24 17:28:13 +0200597 # TODO, add user, password, ssh-key
tierno36ec8602018-11-02 17:27:11 +0100598 "mac-address": mac_schema,
tiernofd160572019-01-21 10:41:37 +0000599 "vim-network-name": shortname_schema, # interface is connected to one vim network, or switch port
600 "vim-network-id": shortname_schema,
tierno36ec8602018-11-02 17:27:11 +0100601 # # provide this in case SDN assist must deal with this interface
602 # "switch-dpid": dpid_Schema,
tiernofd160572019-01-21 10:41:37 +0000603 # "switch-port": shortname_schema,
604 # "switch-mac": shortname_schema,
tierno36ec8602018-11-02 17:27:11 +0100605 # "switch-vlan": vlan_schema,
tiernocb83c942018-09-24 17:28:13 +0200606 },
tierno36ec8602018-11-02 17:27:11 +0100607 "required": ["name", "mgmt", "ip-address"],
tiernocb83c942018-09-24 17:28:13 +0200608 "additionalProperties": False
tiernocd54a4a2018-09-12 16:40:35 +0200609}
tiernocb83c942018-09-24 17:28:13 +0200610pdu_new_schema = {
611 "title": "pdu creation input schema",
612 "$schema": "http://json-schema.org/draft-04/schema#",
613 "type": "object",
614 "properties": {
tiernofd160572019-01-21 10:41:37 +0000615 "name": shortname_schema,
616 "type": shortname_schema,
tiernocb83c942018-09-24 17:28:13 +0200617 "description": description_schema,
618 "shared": bool_schema,
619 "vims": nameshort_list_schema,
620 "vim_accounts": nameshort_list_schema,
621 "interfaces": {
622 "type": "array",
tierno36ec8602018-11-02 17:27:11 +0100623 "items": pdu_interface,
tiernocb83c942018-09-24 17:28:13 +0200624 "minItems": 1
625 }
626 },
627 "required": ["name", "type", "interfaces"],
628 "additionalProperties": False
629}
630
631pdu_edit_schema = {
632 "title": "pdu edit input schema",
633 "$schema": "http://json-schema.org/draft-04/schema#",
634 "type": "object",
635 "properties": {
tiernofd160572019-01-21 10:41:37 +0000636 "name": shortname_schema,
637 "type": shortname_schema,
tiernocb83c942018-09-24 17:28:13 +0200638 "description": description_schema,
639 "shared": bool_schema,
garciadeblas84bdd552018-11-30 22:59:45 +0100640 "vims": {"oneOf": [array_edition_schema, nameshort_list_schema]},
641 "vim_accounts": {"oneOf": [array_edition_schema, nameshort_list_schema]},
642 "interfaces": {"oneOf": [
tiernocb83c942018-09-24 17:28:13 +0200643 array_edition_schema,
644 {
645 "type": "array",
tierno36ec8602018-11-02 17:27:11 +0100646 "items": pdu_interface,
tiernocb83c942018-09-24 17:28:13 +0200647 "minItems": 1
648 }
649 ]}
650 },
651 "additionalProperties": False,
652 "minProperties": 1
653}
654
655# USERS
tiernocf042d32019-06-13 09:06:40 +0000656project_role_mappings = {
657 "title": "list pf projects/roles",
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100658 "$schema": "http://json-schema.org/draft-04/schema#",
tiernocf042d32019-06-13 09:06:40 +0000659 "type": "array",
660 "items": {
661 "type": "object",
662 "properties": {
663 "project": shortname_schema,
664 "role": shortname_schema
665 },
666 "required": ["project", "role"],
667 "additionalProperties": False
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100668 },
tiernocf042d32019-06-13 09:06:40 +0000669 "minItems": 1
670}
671project_role_mappings_optional = {
672 "title": "list of projects/roles or projects only",
673 "$schema": "http://json-schema.org/draft-04/schema#",
674 "type": "array",
675 "items": {
676 "type": "object",
677 "properties": {
678 "project": shortname_schema,
679 "role": shortname_schema
680 },
681 "required": ["project"],
682 "additionalProperties": False
683 },
684 "minItems": 1
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100685}
tiernocd54a4a2018-09-12 16:40:35 +0200686user_new_schema = {
687 "$schema": "http://json-schema.org/draft-04/schema#",
688 "title": "New user schema",
689 "type": "object",
690 "properties": {
tiernofd160572019-01-21 10:41:37 +0000691 "username": shortname_schema,
tiernocd54a4a2018-09-12 16:40:35 +0200692 "password": passwd_schema,
tiernocb83c942018-09-24 17:28:13 +0200693 "projects": nameshort_list_schema,
tiernocf042d32019-06-13 09:06:40 +0000694 "project_role_mappings": project_role_mappings,
tiernocd54a4a2018-09-12 16:40:35 +0200695 },
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100696 "required": ["username", "password"],
tiernocd54a4a2018-09-12 16:40:35 +0200697 "additionalProperties": False
698}
699user_edit_schema = {
700 "$schema": "http://json-schema.org/draft-04/schema#",
701 "title": "User edit schema for administrators",
702 "type": "object",
703 "properties": {
704 "password": passwd_schema,
delacruzramoc061f562019-04-05 11:00:02 +0200705 "username": shortname_schema, # To allow User Name modification
tiernocd54a4a2018-09-12 16:40:35 +0200706 "projects": {
garciadeblas84bdd552018-11-30 22:59:45 +0100707 "oneOf": [
tiernocb83c942018-09-24 17:28:13 +0200708 nameshort_list_schema,
tiernocd54a4a2018-09-12 16:40:35 +0200709 array_edition_schema
710 ]
711 },
tiernocf042d32019-06-13 09:06:40 +0000712 "project_role_mappings": project_role_mappings,
713 "add_project_role_mappings": project_role_mappings,
714 "remove_project_role_mappings": project_role_mappings_optional,
tiernocb83c942018-09-24 17:28:13 +0200715 },
716 "minProperties": 1,
717 "additionalProperties": False
tiernocd54a4a2018-09-12 16:40:35 +0200718}
719
720# PROJECTS
delacruzramofe598fe2019-10-23 18:25:11 +0200721topics_with_quota = ["vnfds", "nsds", "nsts", "pdus", "nsrs", "nsis", "vim_accounts", "wim_accounts", "sdns",
722 "k8sclusters", "k8srepos"]
tiernocd54a4a2018-09-12 16:40:35 +0200723project_new_schema = {
724 "$schema": "http://json-schema.org/draft-04/schema#",
725 "title": "New project schema for administrators",
726 "type": "object",
727 "properties": {
tiernofd160572019-01-21 10:41:37 +0000728 "name": shortname_schema,
tiernocd54a4a2018-09-12 16:40:35 +0200729 "admin": bool_schema,
delacruzramo32bab472019-09-13 12:24:22 +0200730 "quotas": {
731 "type": "object",
732 "properties": {topic: integer0_schema for topic in topics_with_quota},
733 "additionalProperties": False
734 },
tiernocd54a4a2018-09-12 16:40:35 +0200735 },
736 "required": ["name"],
737 "additionalProperties": False
738}
739project_edit_schema = {
740 "$schema": "http://json-schema.org/draft-04/schema#",
741 "title": "Project edit schema for administrators",
742 "type": "object",
743 "properties": {
744 "admin": bool_schema,
delacruzramoc061f562019-04-05 11:00:02 +0200745 "name": shortname_schema, # To allow Project Name modification
delacruzramo32bab472019-09-13 12:24:22 +0200746 "quotas": {
747 "type": "object",
748 "properties": {topic: {"oneOf": [integer0_schema, null_schema]} for topic in topics_with_quota},
749 "additionalProperties": False
750 },
tiernocd54a4a2018-09-12 16:40:35 +0200751 },
752 "additionalProperties": False,
753 "minProperties": 1
754}
755
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100756# ROLES
757roles_new_schema = {
758 "$schema": "http://json-schema.org/draft-04/schema#",
759 "title": "New role schema for administrators",
760 "type": "object",
761 "properties": {
762 "name": shortname_schema,
tierno1f029d82019-06-13 22:37:04 +0000763 "permissions": {
764 "type": "object",
765 "patternProperties": {
766 ".": bool_schema,
767 },
768 # "minProperties": 1,
769 }
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100770 },
tierno1f029d82019-06-13 22:37:04 +0000771 "required": ["name"],
772 "additionalProperties": False
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100773}
774roles_edit_schema = {
775 "$schema": "http://json-schema.org/draft-04/schema#",
776 "title": "Roles edit schema for administrators",
777 "type": "object",
778 "properties": {
tierno1f029d82019-06-13 22:37:04 +0000779 "name": shortname_schema,
780 "permissions": {
781 "type": "object",
782 "patternProperties": {
783 ".": {
784 "oneOf": [bool_schema, null_schema]
785 }
786 },
787 # "minProperties": 1,
788 }
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100789 },
tierno1f029d82019-06-13 22:37:04 +0000790 "additionalProperties": False,
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100791 "minProperties": 1
792}
793
tiernocd54a4a2018-09-12 16:40:35 +0200794# GLOBAL SCHEMAS
tierno0f98af52018-03-19 10:28:22 +0100795
796nbi_new_input_schemas = {
tiernocd54a4a2018-09-12 16:40:35 +0200797 "users": user_new_schema,
798 "projects": project_new_schema,
tierno09c073e2018-04-26 13:36:48 +0200799 "vim_accounts": vim_account_new_schema,
tierno65acb4d2018-04-06 16:42:40 +0200800 "sdns": sdn_new_schema,
801 "ns_instantiate": ns_instantiate,
802 "ns_action": ns_action,
tiernocb83c942018-09-24 17:28:13 +0200803 "ns_scale": ns_scale,
804 "pdus": pdu_new_schema,
tierno0f98af52018-03-19 10:28:22 +0100805}
806
807nbi_edit_input_schemas = {
tiernocd54a4a2018-09-12 16:40:35 +0200808 "users": user_edit_schema,
809 "projects": project_edit_schema,
tierno09c073e2018-04-26 13:36:48 +0200810 "vim_accounts": vim_account_edit_schema,
tiernocb83c942018-09-24 17:28:13 +0200811 "sdns": sdn_edit_schema,
812 "pdus": pdu_edit_schema,
tierno0f98af52018-03-19 10:28:22 +0100813}
814
Felipe Vicens07f31722018-10-29 15:16:44 +0100815# NETSLICE SCHEMAS
tierno032916c2019-03-22 13:27:12 +0000816nsi_subnet_instantiate = deepcopy(ns_instantiate)
817nsi_subnet_instantiate["title"] = "netslice subnet instantiation params input schema"
818nsi_subnet_instantiate["properties"]["id"] = name_schema
819del nsi_subnet_instantiate["required"]
garciadeblasdaf8cc52018-11-30 14:17:20 +0100820
821nsi_vld_instantiate = {
822 "title": "netslice vld instantiation params input schema",
823 "$schema": "http://json-schema.org/draft-04/schema#",
824 "type": "object",
825 "properties": {
826 "name": string_schema,
827 "vim-network-name": {"OneOf": [string_schema, object_schema]},
gcalvino17d5b732018-12-17 16:26:21 +0100828 "vim-network-id": {"OneOf": [string_schema, object_schema]},
garciadeblasdaf8cc52018-11-30 14:17:20 +0100829 "ip-profile": object_schema,
830 },
delacruzramoc061f562019-04-05 11:00:02 +0200831 "required": ["name"],
garciadeblasdaf8cc52018-11-30 14:17:20 +0100832 "additionalProperties": False
833}
834
Felipe Vicens07f31722018-10-29 15:16:44 +0100835nsi_instantiate = {
836 "title": "netslice action instantiate input schema",
837 "$schema": "http://json-schema.org/draft-04/schema#",
838 "type": "object",
839 "properties": {
840 "lcmOperationType": string_schema,
Felipe Vicens126af572019-06-05 19:13:04 +0200841 "netsliceInstanceId": id_schema,
Felipe Vicens07f31722018-10-29 15:16:44 +0100842 "nsiName": name_schema,
tierno4f9d4ae2019-03-20 17:24:11 +0000843 "nsiDescription": {"oneOf": [description_schema, null_schema]},
tierno9e5eea32018-11-29 09:42:09 +0000844 "nstId": string_schema,
Felipe Vicens07f31722018-10-29 15:16:44 +0100845 "vimAccountId": id_schema,
846 "ssh_keys": {"type": "string"},
847 "nsi_id": id_schema,
tierno032916c2019-03-22 13:27:12 +0000848 "additionalParamsForNsi": object_schema,
garciadeblasdaf8cc52018-11-30 14:17:20 +0100849 "netslice-subnet": {
Felipe Vicens07f31722018-10-29 15:16:44 +0100850 "type": "array",
851 "minItems": 1,
tierno032916c2019-03-22 13:27:12 +0000852 "items": nsi_subnet_instantiate
garciadeblasdaf8cc52018-11-30 14:17:20 +0100853 },
854 "netslice-vld": {
855 "type": "array",
856 "minItems": 1,
857 "items": nsi_vld_instantiate
Felipe Vicens07f31722018-10-29 15:16:44 +0100858 },
859 },
Felipe Vicensc8bbaaa2018-12-01 04:42:40 +0100860 "required": ["nsiName", "nstId", "vimAccountId"],
Felipe Vicens07f31722018-10-29 15:16:44 +0100861 "additionalProperties": False
862}
863
864nsi_action = {
865
866}
867
868nsi_terminate = {
delacruzramoc061f562019-04-05 11:00:02 +0200869
Felipe Vicens07f31722018-10-29 15:16:44 +0100870}
871
tierno0f98af52018-03-19 10:28:22 +0100872
873class ValidationError(Exception):
tierno36ec8602018-11-02 17:27:11 +0100874 def __init__(self, message, http_code=HTTPStatus.UNPROCESSABLE_ENTITY):
875 self.http_code = http_code
876 Exception.__init__(self, message)
tierno0f98af52018-03-19 10:28:22 +0100877
878
tiernob24258a2018-10-04 18:39:49 +0200879def validate_input(indata, schema_to_use):
tierno0f98af52018-03-19 10:28:22 +0100880 """
tiernocd54a4a2018-09-12 16:40:35 +0200881 Validates input data against json schema
tierno0f98af52018-03-19 10:28:22 +0100882 :param indata: user input data. Should be a dictionary
tiernob24258a2018-10-04 18:39:49 +0200883 :param schema_to_use: jsonschema to test
884 :return: None if ok, raises ValidationError exception on error
tierno0f98af52018-03-19 10:28:22 +0100885 """
886 try:
tierno0f98af52018-03-19 10:28:22 +0100887 if schema_to_use:
888 js_v(indata, schema_to_use)
889 return None
890 except js_e.ValidationError as e:
891 if e.path:
tierno0da52252018-06-27 15:47:22 +0200892 error_pos = "at '" + ":".join(map(str, e.path)) + "'"
tierno0f98af52018-03-19 10:28:22 +0100893 else:
894 error_pos = ""
tierno441dbbf2018-07-10 12:52:48 +0200895 raise ValidationError("Format error {} '{}' ".format(error_pos, e.message))
tierno36ec8602018-11-02 17:27:11 +0100896 except js_e.SchemaError:
897 raise ValidationError("Bad json schema {}".format(schema_to_use), http_code=HTTPStatus.INTERNAL_SERVER_ERROR)
delacruzramoc061f562019-04-05 11:00:02 +0200898
899
900def is_valid_uuid(x):
901 """
902 Test for a valid UUID
903 :param x: string to test
904 :return: True if x is a valid uuid, False otherwise
905 """
906 try:
907 if UUID(x):
908 return True
tiernobdebce92019-07-01 15:36:49 +0000909 except (TypeError, ValueError, AttributeError):
delacruzramoc061f562019-04-05 11:00:02 +0200910 return False