blob: c3e37f75578a5ff9f42da15d4265312661d506cb [file] [log] [blame]
tierno0f98af52018-03-19 10:28:22 +01001# -*- coding: utf-8 -*-
2
tiernod125caf2018-11-22 16:05:54 +00003# Licensed under the Apache License, Version 2.0 (the "License");
4# you may not use this file except in compliance with the License.
5# You may obtain a copy of the License at
6#
7# http://www.apache.org/licenses/LICENSE-2.0
8#
9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS,
11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
12# implied.
13# See the License for the specific language governing permissions and
14# limitations under the License.
15
tierno0f98af52018-03-19 10:28:22 +010016from jsonschema import validate as js_v, exceptions as js_e
tierno36ec8602018-11-02 17:27:11 +010017from http import HTTPStatus
garciadeblasdaf8cc52018-11-30 14:17:20 +010018from copy import deepcopy
delacruzramoc061f562019-04-05 11:00:02 +020019from uuid import UUID # To test for valid UUID
tierno0f98af52018-03-19 10:28:22 +010020
21__author__ = "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
22__version__ = "0.1"
23version_date = "Mar 2018"
24
25"""
26Validator of input data using JSON schemas for those items that not contains an OSM yang information model
27"""
28
29# Basis schemas
30patern_name = "^[ -~]+$"
tiernofd160572019-01-21 10:41:37 +000031shortname_schema = {"type": "string", "minLength": 1, "maxLength": 60, "pattern": "^[^,;()\\.\\$'\"]+$"}
tierno0f98af52018-03-19 10:28:22 +010032passwd_schema = {"type": "string", "minLength": 1, "maxLength": 60}
tierno0f98af52018-03-19 10:28:22 +010033name_schema = {"type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[^,;()'\"]+$"}
tierno0da52252018-06-27 15:47:22 +020034string_schema = {"type": "string", "minLength": 1, "maxLength": 255}
tierno0f98af52018-03-19 10:28:22 +010035xml_text_schema = {"type": "string", "minLength": 1, "maxLength": 1000, "pattern": "^[^']+$"}
36description_schema = {"type": ["string", "null"], "maxLength": 255, "pattern": "^[^'\"]+$"}
tierno441dbbf2018-07-10 12:52:48 +020037id_schema_fake = {"type": "string", "minLength": 2, "maxLength": 36}
38bool_schema = {"type": "boolean"}
39null_schema = {"type": "null"}
tierno2236d202018-05-16 19:05:16 +020040# "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
tierno0f98af52018-03-19 10:28:22 +010041id_schema = {"type": "string", "pattern": "^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$"}
tiernof759d822018-06-11 18:54:54 +020042time_schema = {"type": "string", "pattern": "^[0-9]{4}-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]([0-5]:){2}"}
tierno87006042018-10-24 12:50:20 +020043pci_schema = {"type": "string", "pattern": "^[0-9a-fA-F]{4}(:[0-9a-fA-F]{2}){2}\\.[0-9a-fA-F]$"}
tierno42fce592018-11-02 09:23:43 +010044# allows [] for wildcards. For that reason huge length limit is set
45pci_extended_schema = {"type": "string", "pattern": "^[0-9a-fA-F.:-\\[\\]]{12,40}$"}
tierno0f98af52018-03-19 10:28:22 +010046http_schema = {"type": "string", "pattern": "^https?://[^'\"=]+$"}
47bandwidth_schema = {"type": "string", "pattern": "^[0-9]+ *([MG]bps)?$"}
48memory_schema = {"type": "string", "pattern": "^[0-9]+ *([MG]i?[Bb])?$"}
49integer0_schema = {"type": "integer", "minimum": 0}
50integer1_schema = {"type": "integer", "minimum": 1}
tierno87006042018-10-24 12:50:20 +020051path_schema = {"type": "string", "pattern": "^(\\.){0,2}(/[^/\"':{}\\(\\)]+)+$"}
tierno0f98af52018-03-19 10:28:22 +010052vlan_schema = {"type": "integer", "minimum": 1, "maximum": 4095}
53vlan1000_schema = {"type": "integer", "minimum": 1000, "maximum": 4095}
54mac_schema = {"type": "string",
55 "pattern": "^[0-9a-fA-F][02468aceACE](:[0-9a-fA-F]{2}){5}$"} # must be unicast: LSB bit of MSB byte ==0
tiernocb83c942018-09-24 17:28:13 +020056dpid_Schema = {"type": "string", "pattern": "^[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){7}$"}
tierno0f98af52018-03-19 10:28:22 +010057# mac_schema={"type":"string", "pattern":"^([0-9a-fA-F]{2}:){5}[0-9a-fA-F]{2}$"}
58ip_schema = {"type": "string",
tierno87006042018-10-24 12:50:20 +020059 "pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$"}
tierno0f98af52018-03-19 10:28:22 +010060ip_prefix_schema = {"type": "string",
tierno87006042018-10-24 12:50:20 +020061 "pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}"
tierno2236d202018-05-16 19:05:16 +020062 "(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/(30|[12]?[0-9])$"}
tierno0f98af52018-03-19 10:28:22 +010063port_schema = {"type": "integer", "minimum": 1, "maximum": 65534}
64object_schema = {"type": "object"}
65schema_version_2 = {"type": "integer", "minimum": 2, "maximum": 2}
66# schema_version_string={"type":"string","enum": ["0.1", "2", "0.2", "3", "0.3"]}
67log_level_schema = {"type": "string", "enum": ["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"]}
68checksum_schema = {"type": "string", "pattern": "^[0-9a-fA-F]{32}$"}
69size_schema = {"type": "integer", "minimum": 1, "maximum": 100}
tiernocd54a4a2018-09-12 16:40:35 +020070array_edition_schema = {
71 "type": "object",
72 "patternProperties": {
tiernofd160572019-01-21 10:41:37 +000073 "^\\$": {}
tiernocd54a4a2018-09-12 16:40:35 +020074 },
75 "additionalProperties": False,
76 "minProperties": 1,
77}
tiernocb83c942018-09-24 17:28:13 +020078nameshort_list_schema = {
79 "type": "array",
80 "minItems": 1,
tiernofd160572019-01-21 10:41:37 +000081 "items": shortname_schema,
tiernocb83c942018-09-24 17:28:13 +020082}
tiernocd54a4a2018-09-12 16:40:35 +020083
tierno0f98af52018-03-19 10:28:22 +010084
tierno441dbbf2018-07-10 12:52:48 +020085ns_instantiate_vdu = {
86 "title": "ns action instantiate input schema for vdu",
87 "$schema": "http://json-schema.org/draft-04/schema#",
88 "type": "object",
89 "properties": {
90 "id": name_schema,
91 "volume": {
92 "type": "array",
93 "minItems": 1,
94 "items": {
95 "type": "object",
96 "properties": {
97 "name": name_schema,
98 "vim-volume-id": name_schema,
99 },
100 "required": ["name", "vim-volume-id"],
101 "additionalProperties": False
102 }
103 },
104 "interface": {
105 "type": "array",
106 "minItems": 1,
107 "items": {
108 "type": "object",
109 "properties": {
110 "name": name_schema,
111 "ip-address": ip_schema,
112 "mac-address": mac_schema,
113 "floating-ip-required": bool_schema,
114 },
115 "required": ["name"],
116 "additionalProperties": False
117 }
118 }
119 },
120 "required": ["id"],
121 "additionalProperties": False
122}
123
124ip_profile_dns_schema = {
125 "type": "array",
126 "minItems": 1,
127 "items": {
128 "type": "object",
129 "properties": {
130 "address": ip_schema,
131 },
132 "required": ["address"],
133 "additionalProperties": False
134 }
135}
136
137ip_profile_dhcp_schema = {
138 "type": "object",
139 "properties": {
140 "enabled": {"type": "boolean"},
141 "count": integer1_schema,
142 "start-address": ip_schema
143 },
144 "additionalProperties": False,
145}
146
147ip_profile_schema = {
148 "title": "ip profile validation schame",
149 "$schema": "http://json-schema.org/draft-04/schema#",
150 "type": "object",
151 "properties": {
152 "ip-version": {"enum": ["ipv4", "ipv6"]},
153 "subnet-address": ip_prefix_schema,
154 "gateway-address": ip_schema,
155 "dns-server": ip_profile_dns_schema,
156 "dhcp-params": ip_profile_dhcp_schema,
157 }
158}
159
160ip_profile_update_schema = {
161 "title": "ip profile validation schame",
162 "$schema": "http://json-schema.org/draft-04/schema#",
163 "type": "object",
164 "properties": {
165 "ip-version": {"enum": ["ipv4", "ipv6"]},
166 "subnet-address": {"oneOf": [null_schema, ip_prefix_schema]},
167 "gateway-address": {"oneOf": [null_schema, ip_schema]},
168 "dns-server": {"oneOf": [null_schema, ip_profile_dns_schema]},
169
170 "dhcp-params": {"oneOf": [null_schema, ip_profile_dhcp_schema]},
171 },
172 "additionalProperties": False
173}
174
175ns_instantiate_internal_vld = {
176 "title": "ns action instantiate input schema for vdu",
177 "$schema": "http://json-schema.org/draft-04/schema#",
178 "type": "object",
179 "properties": {
180 "name": name_schema,
181 "vim-network-name": name_schema,
gcalvino17d5b732018-12-17 16:26:21 +0100182 "vim-network-id": name_schema,
tierno441dbbf2018-07-10 12:52:48 +0200183 "ip-profile": ip_profile_update_schema,
184 "internal-connection-point": {
185 "type": "array",
186 "minItems": 1,
187 "items": {
188 "type": "object",
189 "properties": {
190 "id-ref": name_schema,
191 "ip-address": ip_schema,
tiernob7c6f2a2018-09-03 14:32:10 +0200192 # "mac-address": mac_schema,
tierno441dbbf2018-07-10 12:52:48 +0200193 },
tiernob7c6f2a2018-09-03 14:32:10 +0200194 "required": ["id-ref"],
195 "minProperties": 2,
tierno441dbbf2018-07-10 12:52:48 +0200196 "additionalProperties": False
197 },
198 }
199 },
200 "required": ["name"],
201 "minProperties": 2,
202 "additionalProperties": False
203}
tierno65acb4d2018-04-06 16:42:40 +0200204
tiernofd160572019-01-21 10:41:37 +0000205additional_params_for_vnf = {
206 "type": "array",
207 "items": {
208 "type": "object",
209 "properties": {
210 "member-vnf-index": name_schema,
211 "additionalParams": object_schema,
212 },
213 "required": ["member-vnf-index", "additionalParams"],
214 "additionalProperties": False
215 }
216
217}
218
tierno65acb4d2018-04-06 16:42:40 +0200219ns_instantiate = {
220 "title": "ns action instantiate input schema",
221 "$schema": "http://json-schema.org/draft-04/schema#",
222 "type": "object",
tierno0da52252018-06-27 15:47:22 +0200223 "properties": {
tiernob24258a2018-10-04 18:39:49 +0200224 "lcmOperationType": string_schema,
225 "nsInstanceId": id_schema,
Felipe Vicens07f31722018-10-29 15:16:44 +0100226 "netsliceInstanceId": id_schema,
tierno0da52252018-06-27 15:47:22 +0200227 "nsName": name_schema,
tierno4f9d4ae2019-03-20 17:24:11 +0000228 "nsDescription": {"oneOf": [description_schema, null_schema]},
tierno0da52252018-06-27 15:47:22 +0200229 "nsdId": id_schema,
230 "vimAccountId": id_schema,
tierno4f9d4ae2019-03-20 17:24:11 +0000231 "wimAccountId": {"OneOf": [id_schema, bool_schema, null_schema]},
tiernobee085c2018-12-12 17:03:04 +0000232 "additionalParamsForNs": object_schema,
tiernofd160572019-01-21 10:41:37 +0000233 "additionalParamsForVnf": additional_params_for_vnf,
tiernofc5089c2018-10-31 09:28:11 +0100234 "ssh_keys": {"type": "array", "items": {"type": "string"}},
tierno441dbbf2018-07-10 12:52:48 +0200235 "nsr_id": id_schema,
tiernocc103432018-10-19 14:10:35 +0200236 "vduImage": name_schema,
tierno0da52252018-06-27 15:47:22 +0200237 "vnf": {
238 "type": "array",
239 "minItems": 1,
240 "items": {
241 "type": "object",
242 "properties": {
243 "member-vnf-index": name_schema,
244 "vimAccountId": id_schema,
tierno441dbbf2018-07-10 12:52:48 +0200245 "vdu": {
246 "type": "array",
247 "minItems": 1,
248 "items": ns_instantiate_vdu,
249 },
250 "internal-vld": {
251 "type": "array",
252 "minItems": 1,
253 "items": ns_instantiate_internal_vld
254 }
tierno0da52252018-06-27 15:47:22 +0200255 },
tierno441dbbf2018-07-10 12:52:48 +0200256 "required": ["member-vnf-index"],
257 "minProperties": 2,
258 "additionalProperties": False
tierno0da52252018-06-27 15:47:22 +0200259 }
260 },
261 "vld": {
262 "type": "array",
263 "minItems": 1,
264 "items": {
265 "type": "object",
266 "properties": {
267 "name": string_schema,
268 "vim-network-name": {"OneOf": [string_schema, object_schema]},
gcalvino17d5b732018-12-17 16:26:21 +0100269 "vim-network-id": {"OneOf": [string_schema, object_schema]},
Felipe Vicens09e65422019-01-22 15:06:46 +0100270 "ns-net": object_schema,
tierno4f9d4ae2019-03-20 17:24:11 +0000271 "wimAccountId": {"OneOf": [id_schema, bool_schema, null_schema]},
tierno0da52252018-06-27 15:47:22 +0200272 "ip-profile": object_schema,
tiernob7c6f2a2018-09-03 14:32:10 +0200273 "vnfd-connection-point-ref": {
274 "type": "array",
275 "minItems": 1,
276 "items": {
277 "type": "object",
278 "properties": {
279 "member-vnf-index-ref": name_schema,
280 "vnfd-connection-point-ref": name_schema,
281 "ip-address": ip_schema,
282 # "mac-address": mac_schema,
283 },
284 "required": ["member-vnf-index-ref", "vnfd-connection-point-ref"],
285 "minProperties": 3,
286 "additionalProperties": False
287 },
288 }
tierno0da52252018-06-27 15:47:22 +0200289 },
tierno441dbbf2018-07-10 12:52:48 +0200290 "required": ["name"],
291 "additionalProperties": False
tierno0da52252018-06-27 15:47:22 +0200292 }
293 },
294 },
tierno441dbbf2018-07-10 12:52:48 +0200295 "required": ["nsName", "nsdId", "vimAccountId"],
296 "additionalProperties": False
tierno65acb4d2018-04-06 16:42:40 +0200297}
tierno0da52252018-06-27 15:47:22 +0200298
tierno65acb4d2018-04-06 16:42:40 +0200299ns_action = { # TODO for the moment it is only contemplated the vnfd primitive execution
tiernof759d822018-06-11 18:54:54 +0200300 "title": "ns action input schema",
tierno65acb4d2018-04-06 16:42:40 +0200301 "$schema": "http://json-schema.org/draft-04/schema#",
302 "type": "object",
303 "properties": {
tiernob24258a2018-10-04 18:39:49 +0200304 "lcmOperationType": string_schema,
305 "nsInstanceId": id_schema,
tiernof5298be2018-05-16 14:43:57 +0200306 "member_vnf_index": name_schema,
307 "vnf_member_index": name_schema, # TODO for backward compatibility. To remove in future
tierno7ce1db92018-07-25 12:50:52 +0200308 "vdu_id": name_schema,
tiernof0637052019-03-07 16:26:47 +0000309 "vdu_count_index": integer0_schema,
tierno9cb7d672019-10-30 12:13:48 +0000310 "kdu_name": name_schema,
tierno65acb4d2018-04-06 16:42:40 +0200311 "primitive": name_schema,
312 "primitive_params": {"type": "object"},
313 },
tiernof5298be2018-05-16 14:43:57 +0200314 "required": ["primitive", "primitive_params"], # TODO add member_vnf_index
tierno65acb4d2018-04-06 16:42:40 +0200315 "additionalProperties": False
316}
tiernof759d822018-06-11 18:54:54 +0200317ns_scale = { # TODO for the moment it is only VDU-scaling
318 "title": "ns scale input schema",
319 "$schema": "http://json-schema.org/draft-04/schema#",
320 "type": "object",
321 "properties": {
tiernob24258a2018-10-04 18:39:49 +0200322 "lcmOperationType": string_schema,
323 "nsInstanceId": id_schema,
tiernof759d822018-06-11 18:54:54 +0200324 "scaleType": {"enum": ["SCALE_VNF"]},
325 "scaleVnfData": {
326 "type": "object",
327 "properties": {
328 "vnfInstanceId": name_schema,
329 "scaleVnfType": {"enum": ["SCALE_OUT", 'SCALE_IN']},
330 "scaleByStepData": {
331 "type": "object",
332 "properties": {
333 "scaling-group-descriptor": name_schema,
334 "member-vnf-index": name_schema,
335 "scaling-policy": name_schema,
336 },
337 "required": ["scaling-group-descriptor", "member-vnf-index"],
338 "additionalProperties": False
339 },
340 },
341 "required": ["scaleVnfType", "scaleByStepData"], # vnfInstanceId
342 "additionalProperties": False
343 },
344 "scaleTime": time_schema,
345 },
346 "required": ["scaleType", "scaleVnfData"],
347 "additionalProperties": False
348}
tierno65acb4d2018-04-06 16:42:40 +0200349
350
tierno0f98af52018-03-19 10:28:22 +0100351schema_version = {"type": "string", "enum": ["1.0"]}
tierno55ba2e62018-12-11 17:22:22 +0000352schema_type = {"type": "string"}
delacruzramo3a144c92019-10-25 09:46:33 +0200353vim_type = {"enum": ["openstack", "openvim", "vmware", "opennebula", "aws", "azure", "fos"]}
354
tierno09c073e2018-04-26 13:36:48 +0200355vim_account_edit_schema = {
356 "title": "vim_account edit input schema",
357 "$schema": "http://json-schema.org/draft-04/schema#",
358 "type": "object",
359 "properties": {
360 "name": name_schema,
361 "description": description_schema,
tierno09c073e2018-04-26 13:36:48 +0200362 "vim": name_schema,
363 "datacenter": name_schema,
delacruzramo3a144c92019-10-25 09:46:33 +0200364 "vim_type": vim_type,
tierno09c073e2018-04-26 13:36:48 +0200365 "vim_url": description_schema,
delacruzramo3a144c92019-10-25 09:46:33 +0200366 # "vim_url_admin": description_schema,
367 # "vim_tenant": name_schema,
tierno09c073e2018-04-26 13:36:48 +0200368 "vim_tenant_name": name_schema,
delacruzramo3a144c92019-10-25 09:46:33 +0200369 "vim_user": shortname_schema,
tiernocd54a4a2018-09-12 16:40:35 +0200370 "vim_password": passwd_schema,
tierno09c073e2018-04-26 13:36:48 +0200371 "config": {"type": "object"}
372 },
373 "additionalProperties": False
374}
tierno0f98af52018-03-19 10:28:22 +0100375
tierno09c073e2018-04-26 13:36:48 +0200376vim_account_new_schema = {
377 "title": "vim_account creation input schema",
tierno0f98af52018-03-19 10:28:22 +0100378 "$schema": "http://json-schema.org/draft-04/schema#",
379 "type": "object",
380 "properties": {
381 "schema_version": schema_version,
382 "schema_type": schema_type,
383 "name": name_schema,
384 "description": description_schema,
tierno09c073e2018-04-26 13:36:48 +0200385 "vim": name_schema,
386 "datacenter": name_schema,
delacruzramo3a144c92019-10-25 09:46:33 +0200387 "vim_type": vim_type,
tierno0f98af52018-03-19 10:28:22 +0100388 "vim_url": description_schema,
389 # "vim_url_admin": description_schema,
390 # "vim_tenant": name_schema,
391 "vim_tenant_name": name_schema,
tiernofd160572019-01-21 10:41:37 +0000392 "vim_user": shortname_schema,
tiernocd54a4a2018-09-12 16:40:35 +0200393 "vim_password": passwd_schema,
tierno0f98af52018-03-19 10:28:22 +0100394 "config": {"type": "object"}
395 },
396 "required": ["name", "vim_url", "vim_type", "vim_user", "vim_password", "vim_tenant_name"],
397 "additionalProperties": False
398}
tierno0f98af52018-03-19 10:28:22 +0100399
delacruzramo3a144c92019-10-25 09:46:33 +0200400wim_type = {"enum": ["tapi", "onos", "odl", "dynpac", "fake"]}
401
tierno55ba2e62018-12-11 17:22:22 +0000402wim_account_edit_schema = {
403 "title": "wim_account edit input schema",
404 "$schema": "http://json-schema.org/draft-04/schema#",
405 "type": "object",
406 "properties": {
407 "name": name_schema,
408 "description": description_schema,
tierno55ba2e62018-12-11 17:22:22 +0000409 "wim": name_schema,
delacruzramo3a144c92019-10-25 09:46:33 +0200410 "wim_type": wim_type,
tierno55ba2e62018-12-11 17:22:22 +0000411 "wim_url": description_schema,
tiernofd160572019-01-21 10:41:37 +0000412 "user": shortname_schema,
tierno55ba2e62018-12-11 17:22:22 +0000413 "password": passwd_schema,
414 "config": {"type": "object"}
415 },
416 "additionalProperties": False
417}
418
419wim_account_new_schema = {
420 "title": "wim_account creation input schema",
421 "$schema": "http://json-schema.org/draft-04/schema#",
422 "type": "object",
423 "properties": {
424 "schema_version": schema_version,
425 "schema_type": schema_type,
426 "name": name_schema,
427 "description": description_schema,
428 "wim": name_schema,
delacruzramo3a144c92019-10-25 09:46:33 +0200429 "wim_type": wim_type,
tierno55ba2e62018-12-11 17:22:22 +0000430 "wim_url": description_schema,
tiernofd160572019-01-21 10:41:37 +0000431 "user": shortname_schema,
tierno55ba2e62018-12-11 17:22:22 +0000432 "password": passwd_schema,
tiernof0637052019-03-07 16:26:47 +0000433 "config": {
434 "type": "object",
435 "patternProperties": {
436 ".": {"not": {"type": "null"}}
437 }
438 }
tierno55ba2e62018-12-11 17:22:22 +0000439 },
440 "required": ["name", "wim_url", "wim_type"],
441 "additionalProperties": False
442}
tierno0f98af52018-03-19 10:28:22 +0100443
444sdn_properties = {
445 "name": name_schema,
tiernocfb07c62018-05-10 18:30:51 +0200446 "description": description_schema,
tiernocb83c942018-09-24 17:28:13 +0200447 "dpid": dpid_Schema,
tierno0f98af52018-03-19 10:28:22 +0100448 "ip": ip_schema,
449 "port": port_schema,
450 "type": {"type": "string", "enum": ["opendaylight", "floodlight", "onos"]},
451 "version": {"type": "string", "minLength": 1, "maxLength": 12},
tiernofd160572019-01-21 10:41:37 +0000452 "user": shortname_schema,
tierno0f98af52018-03-19 10:28:22 +0100453 "password": passwd_schema
454}
455sdn_new_schema = {
456 "title": "sdn controller information schema",
457 "$schema": "http://json-schema.org/draft-04/schema#",
458 "type": "object",
459 "properties": sdn_properties,
460 "required": ["name", "port", 'ip', 'dpid', 'type'],
461 "additionalProperties": False
462}
463sdn_edit_schema = {
464 "title": "sdn controller update information schema",
465 "$schema": "http://json-schema.org/draft-04/schema#",
466 "type": "object",
467 "properties": sdn_properties,
tiernocfb07c62018-05-10 18:30:51 +0200468 # "required": ["name", "port", 'ip', 'dpid', 'type'],
tierno0f98af52018-03-19 10:28:22 +0100469 "additionalProperties": False
470}
471sdn_port_mapping_schema = {
472 "$schema": "http://json-schema.org/draft-04/schema#",
473 "title": "sdn port mapping information schema",
474 "type": "array",
475 "items": {
476 "type": "object",
477 "properties": {
tiernofd160572019-01-21 10:41:37 +0000478 "compute_node": shortname_schema,
tierno0f98af52018-03-19 10:28:22 +0100479 "ports": {
480 "type": "array",
481 "items": {
482 "type": "object",
483 "properties": {
tierno42fce592018-11-02 09:23:43 +0100484 "pci": pci_extended_schema,
tiernofd160572019-01-21 10:41:37 +0000485 "switch_port": shortname_schema,
tierno0f98af52018-03-19 10:28:22 +0100486 "switch_mac": mac_schema
487 },
488 "required": ["pci"]
489 }
490 }
491 },
492 "required": ["compute_node", "ports"]
493 }
494}
495sdn_external_port_schema = {
496 "$schema": "http://json-schema.org/draft-04/schema#",
tiernocd54a4a2018-09-12 16:40:35 +0200497 "title": "External port information",
tierno0f98af52018-03-19 10:28:22 +0100498 "type": "object",
499 "properties": {
500 "port": {"type": "string", "minLength": 1, "maxLength": 60},
501 "vlan": vlan_schema,
502 "mac": mac_schema
503 },
504 "required": ["port"]
505}
506
delacruzramofe598fe2019-10-23 18:25:11 +0200507# K8s Clusters
508k8scluster_nets_schema = {
509 "title": "k8scluster nets input schema",
510 "$schema": "http://json-schema.org/draft-04/schema#",
511 "type": "object",
512 "patternProperties": {".": string_schema},
513 "minProperties": 1,
514 "additionalProperties": False
515}
516k8scluster_new_schema = {
517 "title": "k8scluster creation input schema",
518 "$schema": "http://json-schema.org/draft-04/schema#",
519 "type": "object",
520 "properties": {
521 "schema_version": schema_version,
522 "schema_type": schema_type,
523 "name": name_schema,
524 "description": description_schema,
525 "credentials": object_schema,
526 "vim_account": id_schema,
527 "k8s_version": string_schema,
528 "nets": k8scluster_nets_schema,
529 "namespace": name_schema,
530 "cni": nameshort_list_schema,
531 },
532 "required": ["name", "credentials", "vim_account", "k8s_version", "nets"],
533 "additionalProperties": False
534}
535k8scluster_edit_schema = {
536 "title": "vim_account edit input schema",
537 "$schema": "http://json-schema.org/draft-04/schema#",
538 "type": "object",
539 "properties": {
540 "name": name_schema,
541 "description": description_schema,
542 "credentials": object_schema,
543 "vim_account": id_schema,
544 "k8s_version": string_schema,
545 "nets": k8scluster_nets_schema,
546 "namespace": name_schema,
547 "cni": nameshort_list_schema,
548 },
549 "additionalProperties": False
550}
551
552# K8s Repos
553k8srepo_types = {"enum": ["chart", "bundle"]}
554k8srepo_properties = {
555 "name": name_schema,
556 "description": description_schema,
557 "type": k8srepo_types,
558 "url": description_schema,
559}
560k8srepo_new_schema = {
561 "title": "k8scluster creation input schema",
562 "$schema": "http://json-schema.org/draft-04/schema#",
563 "type": "object",
564 "properties": k8srepo_properties,
565 "required": ["name", "type", "url"],
566 "additionalProperties": False
567}
568k8srepo_edit_schema = {
569 "title": "vim_account edit input schema",
570 "$schema": "http://json-schema.org/draft-04/schema#",
571 "type": "object",
572 "properties": k8srepo_properties,
573 "additionalProperties": False
574}
575
tiernocb83c942018-09-24 17:28:13 +0200576# PDUs
577pdu_interface = {
578 "type": "object",
579 "properties": {
tiernofd160572019-01-21 10:41:37 +0000580 "name": shortname_schema,
tiernocb83c942018-09-24 17:28:13 +0200581 "mgmt": bool_schema,
582 "type": {"enum": ["overlay", 'underlay']},
tierno36ec8602018-11-02 17:27:11 +0100583 "ip-address": ip_schema,
tiernocb83c942018-09-24 17:28:13 +0200584 # TODO, add user, password, ssh-key
tierno36ec8602018-11-02 17:27:11 +0100585 "mac-address": mac_schema,
tiernofd160572019-01-21 10:41:37 +0000586 "vim-network-name": shortname_schema, # interface is connected to one vim network, or switch port
587 "vim-network-id": shortname_schema,
tierno36ec8602018-11-02 17:27:11 +0100588 # # provide this in case SDN assist must deal with this interface
589 # "switch-dpid": dpid_Schema,
tiernofd160572019-01-21 10:41:37 +0000590 # "switch-port": shortname_schema,
591 # "switch-mac": shortname_schema,
tierno36ec8602018-11-02 17:27:11 +0100592 # "switch-vlan": vlan_schema,
tiernocb83c942018-09-24 17:28:13 +0200593 },
tierno36ec8602018-11-02 17:27:11 +0100594 "required": ["name", "mgmt", "ip-address"],
tiernocb83c942018-09-24 17:28:13 +0200595 "additionalProperties": False
tiernocd54a4a2018-09-12 16:40:35 +0200596}
tiernocb83c942018-09-24 17:28:13 +0200597pdu_new_schema = {
598 "title": "pdu creation input schema",
599 "$schema": "http://json-schema.org/draft-04/schema#",
600 "type": "object",
601 "properties": {
tiernofd160572019-01-21 10:41:37 +0000602 "name": shortname_schema,
603 "type": shortname_schema,
tiernocb83c942018-09-24 17:28:13 +0200604 "description": description_schema,
605 "shared": bool_schema,
606 "vims": nameshort_list_schema,
607 "vim_accounts": nameshort_list_schema,
608 "interfaces": {
609 "type": "array",
tierno36ec8602018-11-02 17:27:11 +0100610 "items": pdu_interface,
tiernocb83c942018-09-24 17:28:13 +0200611 "minItems": 1
612 }
613 },
614 "required": ["name", "type", "interfaces"],
615 "additionalProperties": False
616}
617
618pdu_edit_schema = {
619 "title": "pdu edit input schema",
620 "$schema": "http://json-schema.org/draft-04/schema#",
621 "type": "object",
622 "properties": {
tiernofd160572019-01-21 10:41:37 +0000623 "name": shortname_schema,
624 "type": shortname_schema,
tiernocb83c942018-09-24 17:28:13 +0200625 "description": description_schema,
626 "shared": bool_schema,
garciadeblas84bdd552018-11-30 22:59:45 +0100627 "vims": {"oneOf": [array_edition_schema, nameshort_list_schema]},
628 "vim_accounts": {"oneOf": [array_edition_schema, nameshort_list_schema]},
629 "interfaces": {"oneOf": [
tiernocb83c942018-09-24 17:28:13 +0200630 array_edition_schema,
631 {
632 "type": "array",
tierno36ec8602018-11-02 17:27:11 +0100633 "items": pdu_interface,
tiernocb83c942018-09-24 17:28:13 +0200634 "minItems": 1
635 }
636 ]}
637 },
638 "additionalProperties": False,
639 "minProperties": 1
640}
641
642# USERS
tiernocf042d32019-06-13 09:06:40 +0000643project_role_mappings = {
644 "title": "list pf projects/roles",
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100645 "$schema": "http://json-schema.org/draft-04/schema#",
tiernocf042d32019-06-13 09:06:40 +0000646 "type": "array",
647 "items": {
648 "type": "object",
649 "properties": {
650 "project": shortname_schema,
651 "role": shortname_schema
652 },
653 "required": ["project", "role"],
654 "additionalProperties": False
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100655 },
tiernocf042d32019-06-13 09:06:40 +0000656 "minItems": 1
657}
658project_role_mappings_optional = {
659 "title": "list of projects/roles or projects only",
660 "$schema": "http://json-schema.org/draft-04/schema#",
661 "type": "array",
662 "items": {
663 "type": "object",
664 "properties": {
665 "project": shortname_schema,
666 "role": shortname_schema
667 },
668 "required": ["project"],
669 "additionalProperties": False
670 },
671 "minItems": 1
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100672}
tiernocd54a4a2018-09-12 16:40:35 +0200673user_new_schema = {
674 "$schema": "http://json-schema.org/draft-04/schema#",
675 "title": "New user schema",
676 "type": "object",
677 "properties": {
tiernofd160572019-01-21 10:41:37 +0000678 "username": shortname_schema,
tiernocd54a4a2018-09-12 16:40:35 +0200679 "password": passwd_schema,
tiernocb83c942018-09-24 17:28:13 +0200680 "projects": nameshort_list_schema,
tiernocf042d32019-06-13 09:06:40 +0000681 "project_role_mappings": project_role_mappings,
tiernocd54a4a2018-09-12 16:40:35 +0200682 },
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100683 "required": ["username", "password"],
tiernocd54a4a2018-09-12 16:40:35 +0200684 "additionalProperties": False
685}
686user_edit_schema = {
687 "$schema": "http://json-schema.org/draft-04/schema#",
688 "title": "User edit schema for administrators",
689 "type": "object",
690 "properties": {
691 "password": passwd_schema,
delacruzramoc061f562019-04-05 11:00:02 +0200692 "username": shortname_schema, # To allow User Name modification
tiernocd54a4a2018-09-12 16:40:35 +0200693 "projects": {
garciadeblas84bdd552018-11-30 22:59:45 +0100694 "oneOf": [
tiernocb83c942018-09-24 17:28:13 +0200695 nameshort_list_schema,
tiernocd54a4a2018-09-12 16:40:35 +0200696 array_edition_schema
697 ]
698 },
tiernocf042d32019-06-13 09:06:40 +0000699 "project_role_mappings": project_role_mappings,
700 "add_project_role_mappings": project_role_mappings,
701 "remove_project_role_mappings": project_role_mappings_optional,
tiernocb83c942018-09-24 17:28:13 +0200702 },
703 "minProperties": 1,
704 "additionalProperties": False
tiernocd54a4a2018-09-12 16:40:35 +0200705}
706
707# PROJECTS
delacruzramofe598fe2019-10-23 18:25:11 +0200708topics_with_quota = ["vnfds", "nsds", "nsts", "pdus", "nsrs", "nsis", "vim_accounts", "wim_accounts", "sdns",
709 "k8sclusters", "k8srepos"]
tiernocd54a4a2018-09-12 16:40:35 +0200710project_new_schema = {
711 "$schema": "http://json-schema.org/draft-04/schema#",
712 "title": "New project schema for administrators",
713 "type": "object",
714 "properties": {
tiernofd160572019-01-21 10:41:37 +0000715 "name": shortname_schema,
tiernocd54a4a2018-09-12 16:40:35 +0200716 "admin": bool_schema,
delacruzramo32bab472019-09-13 12:24:22 +0200717 "quotas": {
718 "type": "object",
719 "properties": {topic: integer0_schema for topic in topics_with_quota},
720 "additionalProperties": False
721 },
tiernocd54a4a2018-09-12 16:40:35 +0200722 },
723 "required": ["name"],
724 "additionalProperties": False
725}
726project_edit_schema = {
727 "$schema": "http://json-schema.org/draft-04/schema#",
728 "title": "Project edit schema for administrators",
729 "type": "object",
730 "properties": {
731 "admin": bool_schema,
delacruzramoc061f562019-04-05 11:00:02 +0200732 "name": shortname_schema, # To allow Project Name modification
delacruzramo32bab472019-09-13 12:24:22 +0200733 "quotas": {
734 "type": "object",
735 "properties": {topic: {"oneOf": [integer0_schema, null_schema]} for topic in topics_with_quota},
736 "additionalProperties": False
737 },
tiernocd54a4a2018-09-12 16:40:35 +0200738 },
739 "additionalProperties": False,
740 "minProperties": 1
741}
742
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100743# ROLES
744roles_new_schema = {
745 "$schema": "http://json-schema.org/draft-04/schema#",
746 "title": "New role schema for administrators",
747 "type": "object",
748 "properties": {
749 "name": shortname_schema,
tierno1f029d82019-06-13 22:37:04 +0000750 "permissions": {
751 "type": "object",
752 "patternProperties": {
753 ".": bool_schema,
754 },
755 # "minProperties": 1,
756 }
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100757 },
tierno1f029d82019-06-13 22:37:04 +0000758 "required": ["name"],
759 "additionalProperties": False
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100760}
761roles_edit_schema = {
762 "$schema": "http://json-schema.org/draft-04/schema#",
763 "title": "Roles edit schema for administrators",
764 "type": "object",
765 "properties": {
tierno1f029d82019-06-13 22:37:04 +0000766 "name": shortname_schema,
767 "permissions": {
768 "type": "object",
769 "patternProperties": {
770 ".": {
771 "oneOf": [bool_schema, null_schema]
772 }
773 },
774 # "minProperties": 1,
775 }
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100776 },
tierno1f029d82019-06-13 22:37:04 +0000777 "additionalProperties": False,
Eduardo Sousa5c01e192019-05-08 02:35:47 +0100778 "minProperties": 1
779}
780
tiernocd54a4a2018-09-12 16:40:35 +0200781# GLOBAL SCHEMAS
tierno0f98af52018-03-19 10:28:22 +0100782
783nbi_new_input_schemas = {
tiernocd54a4a2018-09-12 16:40:35 +0200784 "users": user_new_schema,
785 "projects": project_new_schema,
tierno09c073e2018-04-26 13:36:48 +0200786 "vim_accounts": vim_account_new_schema,
tierno65acb4d2018-04-06 16:42:40 +0200787 "sdns": sdn_new_schema,
788 "ns_instantiate": ns_instantiate,
789 "ns_action": ns_action,
tiernocb83c942018-09-24 17:28:13 +0200790 "ns_scale": ns_scale,
791 "pdus": pdu_new_schema,
tierno0f98af52018-03-19 10:28:22 +0100792}
793
794nbi_edit_input_schemas = {
tiernocd54a4a2018-09-12 16:40:35 +0200795 "users": user_edit_schema,
796 "projects": project_edit_schema,
tierno09c073e2018-04-26 13:36:48 +0200797 "vim_accounts": vim_account_edit_schema,
tiernocb83c942018-09-24 17:28:13 +0200798 "sdns": sdn_edit_schema,
799 "pdus": pdu_edit_schema,
tierno0f98af52018-03-19 10:28:22 +0100800}
801
Felipe Vicens07f31722018-10-29 15:16:44 +0100802# NETSLICE SCHEMAS
tierno032916c2019-03-22 13:27:12 +0000803nsi_subnet_instantiate = deepcopy(ns_instantiate)
804nsi_subnet_instantiate["title"] = "netslice subnet instantiation params input schema"
805nsi_subnet_instantiate["properties"]["id"] = name_schema
806del nsi_subnet_instantiate["required"]
garciadeblasdaf8cc52018-11-30 14:17:20 +0100807
808nsi_vld_instantiate = {
809 "title": "netslice vld instantiation params input schema",
810 "$schema": "http://json-schema.org/draft-04/schema#",
811 "type": "object",
812 "properties": {
813 "name": string_schema,
814 "vim-network-name": {"OneOf": [string_schema, object_schema]},
gcalvino17d5b732018-12-17 16:26:21 +0100815 "vim-network-id": {"OneOf": [string_schema, object_schema]},
garciadeblasdaf8cc52018-11-30 14:17:20 +0100816 "ip-profile": object_schema,
817 },
delacruzramoc061f562019-04-05 11:00:02 +0200818 "required": ["name"],
garciadeblasdaf8cc52018-11-30 14:17:20 +0100819 "additionalProperties": False
820}
821
Felipe Vicens07f31722018-10-29 15:16:44 +0100822nsi_instantiate = {
823 "title": "netslice action instantiate input schema",
824 "$schema": "http://json-schema.org/draft-04/schema#",
825 "type": "object",
826 "properties": {
827 "lcmOperationType": string_schema,
Felipe Vicens126af572019-06-05 19:13:04 +0200828 "netsliceInstanceId": id_schema,
Felipe Vicens07f31722018-10-29 15:16:44 +0100829 "nsiName": name_schema,
tierno4f9d4ae2019-03-20 17:24:11 +0000830 "nsiDescription": {"oneOf": [description_schema, null_schema]},
tierno9e5eea32018-11-29 09:42:09 +0000831 "nstId": string_schema,
Felipe Vicens07f31722018-10-29 15:16:44 +0100832 "vimAccountId": id_schema,
833 "ssh_keys": {"type": "string"},
834 "nsi_id": id_schema,
tierno032916c2019-03-22 13:27:12 +0000835 "additionalParamsForNsi": object_schema,
garciadeblasdaf8cc52018-11-30 14:17:20 +0100836 "netslice-subnet": {
Felipe Vicens07f31722018-10-29 15:16:44 +0100837 "type": "array",
838 "minItems": 1,
tierno032916c2019-03-22 13:27:12 +0000839 "items": nsi_subnet_instantiate
garciadeblasdaf8cc52018-11-30 14:17:20 +0100840 },
841 "netslice-vld": {
842 "type": "array",
843 "minItems": 1,
844 "items": nsi_vld_instantiate
Felipe Vicens07f31722018-10-29 15:16:44 +0100845 },
846 },
Felipe Vicensc8bbaaa2018-12-01 04:42:40 +0100847 "required": ["nsiName", "nstId", "vimAccountId"],
Felipe Vicens07f31722018-10-29 15:16:44 +0100848 "additionalProperties": False
849}
850
851nsi_action = {
852
853}
854
855nsi_terminate = {
delacruzramoc061f562019-04-05 11:00:02 +0200856
Felipe Vicens07f31722018-10-29 15:16:44 +0100857}
858
tierno0f98af52018-03-19 10:28:22 +0100859
860class ValidationError(Exception):
tierno36ec8602018-11-02 17:27:11 +0100861 def __init__(self, message, http_code=HTTPStatus.UNPROCESSABLE_ENTITY):
862 self.http_code = http_code
863 Exception.__init__(self, message)
tierno0f98af52018-03-19 10:28:22 +0100864
865
tiernob24258a2018-10-04 18:39:49 +0200866def validate_input(indata, schema_to_use):
tierno0f98af52018-03-19 10:28:22 +0100867 """
tiernocd54a4a2018-09-12 16:40:35 +0200868 Validates input data against json schema
tierno0f98af52018-03-19 10:28:22 +0100869 :param indata: user input data. Should be a dictionary
tiernob24258a2018-10-04 18:39:49 +0200870 :param schema_to_use: jsonschema to test
871 :return: None if ok, raises ValidationError exception on error
tierno0f98af52018-03-19 10:28:22 +0100872 """
873 try:
tierno0f98af52018-03-19 10:28:22 +0100874 if schema_to_use:
875 js_v(indata, schema_to_use)
876 return None
877 except js_e.ValidationError as e:
878 if e.path:
tierno0da52252018-06-27 15:47:22 +0200879 error_pos = "at '" + ":".join(map(str, e.path)) + "'"
tierno0f98af52018-03-19 10:28:22 +0100880 else:
881 error_pos = ""
tierno441dbbf2018-07-10 12:52:48 +0200882 raise ValidationError("Format error {} '{}' ".format(error_pos, e.message))
tierno36ec8602018-11-02 17:27:11 +0100883 except js_e.SchemaError:
884 raise ValidationError("Bad json schema {}".format(schema_to_use), http_code=HTTPStatus.INTERNAL_SERVER_ERROR)
delacruzramoc061f562019-04-05 11:00:02 +0200885
886
887def is_valid_uuid(x):
888 """
889 Test for a valid UUID
890 :param x: string to test
891 :return: True if x is a valid uuid, False otherwise
892 """
893 try:
894 if UUID(x):
895 return True
tiernobdebce92019-07-01 15:36:49 +0000896 except (TypeError, ValueError, AttributeError):
delacruzramoc061f562019-04-05 11:00:02 +0200897 return False