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