osm_nbi/validation.py

   1 # -*- coding: utf-8 -*-
   2
   3 from jsonschema import validate as js_v, exceptions as js_e
   4
   5 __author__ = "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
   6 __version__ = "0.1"
   7 version_date = "Mar 2018"
   8
   9 """
  10 Validator of input data using JSON schemas for those items that not contains an  OSM yang information model
  11 """
  12
  13 # Basis schemas
  14 patern_name = "^[ -~]+$"
  15 passwd_schema = {"type": "string", "minLength": 1, "maxLength": 60}
  16 nameshort_schema = {"type": "string", "minLength": 1, "maxLength": 60, "pattern": "^[^,;()'\"]+$"}
  17 name_schema = {"type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[^,;()'\"]+$"}
  18 string_schema = {"type": "string", "minLength": 1, "maxLength": 255}
  19 xml_text_schema = {"type": "string", "minLength": 1, "maxLength": 1000, "pattern": "^[^']+$"}
  20 description_schema = {"type": ["string", "null"], "maxLength": 255, "pattern": "^[^'\"]+$"}
  21 id_schema_fake = {"type": "string", "minLength": 2,
  22                   "maxLength": 36}
  23 # "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}$"
  24 id_schema = {"type": "string", "pattern": "^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$"}
  25 pci_schema = {"type": "string", "pattern": "^[0-9a-fA-F]{4}(:[0-9a-fA-F]{2}){2}\.[0-9a-fA-F]$"}
  26 http_schema = {"type": "string", "pattern": "^https?://[^'\"=]+$"}
  27 bandwidth_schema = {"type": "string", "pattern": "^[0-9]+ *([MG]bps)?$"}
  28 memory_schema = {"type": "string", "pattern": "^[0-9]+ *([MG]i?[Bb])?$"}
  29 integer0_schema = {"type": "integer", "minimum": 0}
  30 integer1_schema = {"type": "integer", "minimum": 1}
  31 path_schema = {"type": "string", "pattern": "^(\.){0,2}(/[^/\"':{}\(\)]+)+$"}
  32 vlan_schema = {"type": "integer", "minimum": 1, "maximum": 4095}
  33 vlan1000_schema = {"type": "integer", "minimum": 1000, "maximum": 4095}
  34 mac_schema = {"type": "string",
  35               "pattern": "^[0-9a-fA-F][02468aceACE](:[0-9a-fA-F]{2}){5}$"}  # must be unicast: LSB bit of MSB byte ==0
  36 # mac_schema={"type":"string", "pattern":"^([0-9a-fA-F]{2}:){5}[0-9a-fA-F]{2}$"}
  37 ip_schema = {"type": "string",
  38              "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]?)$"}
  39 ip_prefix_schema = {"type": "string",
  40                     "pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}"
  41                                "(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/(30|[12]?[0-9])$"}
  42 port_schema = {"type": "integer", "minimum": 1, "maximum": 65534}
  43 object_schema = {"type": "object"}
  44 schema_version_2 = {"type": "integer", "minimum": 2, "maximum": 2}
  45 # schema_version_string={"type":"string","enum": ["0.1", "2", "0.2", "3", "0.3"]}
  46 log_level_schema = {"type": "string", "enum": ["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"]}
  47 checksum_schema = {"type": "string", "pattern": "^[0-9a-fA-F]{32}$"}
  48 size_schema = {"type": "integer", "minimum": 1, "maximum": 100}
  49
  50
  51 ns_instantiate = {
  52     "title": "ns action instantiate input schema",
  53     "$schema": "http://json-schema.org/draft-04/schema#",
  54     "type": "object",
  55     "properties": {
  56         "nsName": name_schema,
  57         "nsDescription": description_schema,
  58         "nsdId": id_schema,
  59         "vimAccountId": id_schema,
  60         "ssh_keys": {"type": "string"},
  61         "vnf": {
  62             "type": "array",
  63             "minItems": 1,
  64             "items": {
  65                 "type": "object",
  66                 "properties": {
  67                     "member-vnf-index": name_schema,
  68                     "vimAccountId": id_schema,
  69                 },
  70                 "required": ["member-vnf-index"]
  71             }
  72         },
  73         "vld": {
  74             "type": "array",
  75             "minItems": 1,
  76             "items": {
  77                 "type": "object",
  78                 "properties": {
  79                     "name": string_schema,
  80                     "vim-network-name": {"OneOf": [string_schema, object_schema]},
  81                     "ip-profile": object_schema,
  82                 },
  83                 "required": ["name"]
  84             }
  85         },
  86     },
  87     "required": ["nsName", "nsdId", "vimAccountId"]
  88 }
  89
  90 ns_action = {   # TODO for the moment it is only contemplated the vnfd primitive execution
  91     "title": "ns action update input schema",
  92     "$schema": "http://json-schema.org/draft-04/schema#",
  93     "type": "object",
  94     "properties": {
  95         "member_vnf_index": name_schema,
  96         "vnf_member_index": name_schema,  # TODO for backward compatibility. To remove in future
  97         "primitive": name_schema,
  98         "primitive_params": {"type": "object"},
  99     },
 100     "required": ["primitive", "primitive_params"],   # TODO add member_vnf_index
 101     "additionalProperties": False
 102 }
 103
 104
 105 schema_version = {"type": "string", "enum": ["1.0"]}
 106 vim_account_edit_schema = {
 107     "title": "vim_account edit input schema",
 108     "$schema": "http://json-schema.org/draft-04/schema#",
 109     "type": "object",
 110     "properties": {
 111         "name": name_schema,
 112         "description": description_schema,
 113         "type": nameshort_schema,  # currently "openvim" or "openstack", can be enlarged with plugins
 114         "vim": name_schema,
 115         "datacenter": name_schema,
 116         "vim_url": description_schema,
 117         "vim_url_admin": description_schema,
 118         "vim_tenant": name_schema,
 119         "vim_tenant_name": name_schema,
 120         "vim_username": nameshort_schema,
 121         "vim_password": nameshort_schema,
 122         "config": {"type": "object"}
 123     },
 124     "additionalProperties": False
 125 }
 126 schema_type = {"type": "string"}
 127
 128 vim_account_new_schema = {
 129     "title": "vim_account creation input schema",
 130     "$schema": "http://json-schema.org/draft-04/schema#",
 131     "type": "object",
 132     "properties": {
 133         "schema_version": schema_version,
 134         "schema_type": schema_type,
 135         "name": name_schema,
 136         "description": description_schema,
 137         "vim": name_schema,
 138         "datacenter": name_schema,
 139         "vim_type": {"enum": ["openstack", "openvim", "vmware", "opennebula", "aws"]},
 140         "vim_url": description_schema,
 141         # "vim_url_admin": description_schema,
 142         # "vim_tenant": name_schema,
 143         "vim_tenant_name": name_schema,
 144         "vim_user": nameshort_schema,
 145         "vim_password": nameshort_schema,
 146         "config": {"type": "object"}
 147     },
 148     "required": ["name", "vim_url", "vim_type", "vim_user", "vim_password", "vim_tenant_name"],
 149     "additionalProperties": False
 150 }
 151
 152
 153 sdn_properties = {
 154     "name": name_schema,
 155     "description": description_schema,
 156     "dpid": {"type": "string", "pattern": "^[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){7}$"},
 157     "ip": ip_schema,
 158     "port": port_schema,
 159     "type": {"type": "string", "enum": ["opendaylight", "floodlight", "onos"]},
 160     "version": {"type": "string", "minLength": 1, "maxLength": 12},
 161     "user": nameshort_schema,
 162     "password": passwd_schema
 163 }
 164 sdn_new_schema = {
 165     "title": "sdn controller information schema",
 166     "$schema": "http://json-schema.org/draft-04/schema#",
 167     "type": "object",
 168     "properties": sdn_properties,
 169     "required": ["name", "port", 'ip', 'dpid', 'type'],
 170     "additionalProperties": False
 171 }
 172 sdn_edit_schema = {
 173     "title": "sdn controller update information schema",
 174     "$schema": "http://json-schema.org/draft-04/schema#",
 175     "type": "object",
 176     "properties": sdn_properties,
 177     # "required": ["name", "port", 'ip', 'dpid', 'type'],
 178     "additionalProperties": False
 179 }
 180 sdn_port_mapping_schema = {
 181     "$schema": "http://json-schema.org/draft-04/schema#",
 182     "title": "sdn port mapping information schema",
 183     "type": "array",
 184     "items": {
 185         "type": "object",
 186         "properties": {
 187             "compute_node": nameshort_schema,
 188             "ports": {
 189                 "type": "array",
 190                 "items": {
 191                     "type": "object",
 192                     "properties": {
 193                         "pci": pci_schema,
 194                         "switch_port": nameshort_schema,
 195                         "switch_mac": mac_schema
 196                     },
 197                     "required": ["pci"]
 198                 }
 199             }
 200         },
 201         "required": ["compute_node", "ports"]
 202     }
 203 }
 204 sdn_external_port_schema = {
 205     "$schema": "http://json-schema.org/draft-04/schema#",
 206     "title": "External port ingformation",
 207     "type": "object",
 208     "properties": {
 209         "port": {"type": "string", "minLength": 1, "maxLength": 60},
 210         "vlan": vlan_schema,
 211         "mac": mac_schema
 212     },
 213     "required": ["port"]
 214 }
 215
 216
 217 nbi_new_input_schemas = {
 218     "vim_accounts": vim_account_new_schema,
 219     "sdns": sdn_new_schema,
 220     "ns_instantiate": ns_instantiate,
 221     "ns_action": ns_action,
 222 }
 223
 224 nbi_edit_input_schemas = {
 225     "vim_accounts": vim_account_edit_schema,
 226     "sdns": sdn_edit_schema
 227 }
 228
 229
 230 class ValidationError(Exception):
 231     pass
 232
 233
 234 def validate_input(indata, item, new=True):
 235     """
 236     Validates input data agains json schema
 237     :param indata: user input data. Should be a dictionary
 238     :param item: can be users, projects, vims, sdns, ns_xxxxx
 239     :param new: True if the validation is for creating or False if it is for editing
 240     :return: None if ok, raises ValidationError exception otherwise
 241     """
 242     try:
 243         if new:
 244             schema_to_use = nbi_new_input_schemas.get(item)
 245         else:
 246             schema_to_use = nbi_edit_input_schemas.get(item)
 247         if schema_to_use:
 248             js_v(indata, schema_to_use)
 249         return None
 250     except js_e.ValidationError as e:
 251         if e.path:
 252             error_pos = "at '" + ":".join(map(str, e.path)) + "'"
 253         else:
 254             error_pos = ""
 255         raise ValidationError("Format error {} '{}' ".format(error_pos, e))