1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
|
import re
from ..constants import BOOL_TO_STR, xsi_namespace, OVAL_NAMESPACES, OVALREFATTR_TO_TAG
from ..xml import ElementTree
from .. import utils
# ----- General functions
def required_attribute(_xml_el, _key):
if _key in _xml_el.attrib:
return _xml_el.get(_key)
raise ValueError(
"%s attribute is required but was not found in %s element:\n%s" % (
_key, _xml_el.tag, repr(_xml_el.attrib))
)
def get_product_name(product, product_version=None):
# Current SSG checks aren't unified which element of '<platform>'
# and '<product>' to use as OVAL AffectedType metadata element,
# e.g. Chromium content uses both of them across the various checks
# Thus for now check both of them when checking concrete platform / product
# Get official name for product (prefixed with content of afftype)
product_name = utils.map_name(product)
# Append the product version to the official name
if product_version is not None:
product_name += " " + utils.get_fixed_product_version(product, product_version)
return product_name
def is_product_name_in(list_, product_name):
for item in list_ if list_ is not None else []:
if product_name in item:
return True
return False
# ----- General Objects
class OVALBaseObject(object):
__namespace = ""
tag = ""
def __init__(self, tag):
match_ns = re.match(r"\{.*\}", tag)
self.namespace = match_ns.group(0) if match_ns else ""
self.tag = tag.replace(self.namespace, "")
@property
def namespace(self):
return self.__namespace
@namespace.setter
def namespace(self, __value):
if isinstance(__value, str):
if not __value.startswith("{"):
__value = "{" + __value
if not __value.endswith("}"):
__value = __value + "}"
self.__namespace = __value
@property
def tag_name(self):
return "{}{}".format(self.namespace, self.tag)
def __ne__(self, __value):
return self.__dict__ != __value.__dict__
def __eq__(self, __value):
return self.__dict__ == __value.__dict__
def __repr__(self):
return str(self.__dict__)
def __str__(self):
return str(self.__dict__)
def get_xml_element(self):
raise NotImplementedError
def translate_id(self, translator, store_defname=False):
raise NotImplementedError
class OVALComponent(OVALBaseObject):
deprecated = False
notes = None
version = "0"
def __init__(self, tag, id_):
super(OVALComponent, self).__init__(tag)
self.id_ = id_
def get_xml_element(self):
el = ElementTree.Element(self.tag_name)
el.set("id", self.id_)
el.set("version", self.version)
if self.deprecated:
el.set("deprecated", BOOL_TO_STR[self.deprecated])
if self.notes:
el.append(self.notes.get_xml_element())
return el
def translate_id(self, translator, store_defname=False):
self.id_ = translator.generate_id(self.tag_name, self.id_)
@property
def name(self):
return re.search(r"(?<=-)[^:]+(?=:)", self.id_).group()
class OVALEntity(OVALComponent):
comment = ""
def __init__(self, tag, id_, properties):
super(OVALEntity, self).__init__(tag, id_)
self.properties = properties
def _get_references(self, key):
out = []
for property_ in self.properties:
out.extend(property_.get_values_by_key(key))
return out
def get_xml_element(self, **attributes):
el = super(OVALEntity, self).get_xml_element()
for key, value in attributes.items():
if "xsi" in key:
key = ElementTree.QName(xsi_namespace, key.split(":")[-1])
el.set(key, value)
if self.comment:
el.set("comment", self.comment)
for property_ in self.properties:
el.append(property_.get_xml_element())
return el
def translate_id(self, translator, store_defname=False):
super(OVALEntity, self).translate_id(translator)
for property_ in self.properties:
property_.translate_id(translator)
# ----- OVAL Objects
def load_notes(oval_notes_xml_el):
if oval_notes_xml_el is None:
return None
notes = []
for note_el in oval_notes_xml_el:
notes.append(note_el.text)
return Notes(oval_notes_xml_el.tag, note_el.tag, notes)
class ExceptionEmptyNote(Exception):
pass
class Notes(OVALBaseObject):
def __init__(self, tag, note_tag, notes):
super(Notes, self).__init__(tag)
self.note_tag = note_tag
if len(notes) == 0:
raise ExceptionEmptyNote(
"Element notes should contain at least one element note."
)
self.notes = notes
def get_xml_element(self):
notes_el = ElementTree.Element(self.tag_name)
for note in self.notes:
note_el = ElementTree.Element(self.note_tag)
note_el.text = note
notes_el.append(note_el)
return notes_el
# -----
def load_property_and_notes_of_oval_entity(oval_entity_el):
notes = None
object_property = []
for child_node_el in oval_entity_el:
if "notes" in child_node_el.tag:
notes = load_notes(child_node_el)
else:
object_property.append(load_oval_entity_property(child_node_el))
return object_property, notes
def load_oval_entity_property(end_point_property_el):
data = OVALEntityProperty(end_point_property_el.tag)
data.attributes = (
end_point_property_el.attrib if end_point_property_el.attrib else None
)
data.text = end_point_property_el.text
for child_end_point_property_el in end_point_property_el:
data.add_child_property(load_oval_entity_property(child_end_point_property_el))
return data
class OVALEntityProperty(OVALBaseObject):
attributes = None
text = None
def __init__(self, tag):
super(OVALEntityProperty, self).__init__(tag)
self.properties = []
def add_child_property(self, property_):
self.properties.append(property_)
def get_xml_element(self):
property_el = ElementTree.Element(self.tag_name)
for key, val in self.attributes.items() if self.attributes is not None else {}:
property_el.set(key, val)
if self.text is not None:
property_el.text = self.text
for child in self.properties:
property_el.append(child.get_xml_element())
return property_el
def get_values_by_key(self, key):
out = []
if self.attributes and key in self.attributes:
out.append(self.attributes.get(key))
if key in self.tag:
out.append(self.text)
for property_ in self.properties:
out.extend(property_.get_values_by_key(key))
return out
def _translate_attributes(self, translator):
for attr in self.attributes.keys() if self.attributes is not None else {}:
if attr in OVALREFATTR_TO_TAG.keys():
self.attributes[attr] = translator.generate_id(
"{%s}%s" % (OVAL_NAMESPACES.definition, OVALREFATTR_TO_TAG[attr]),
self.attributes[attr],
)
def translate_id(self, translator, store_defname=False):
if self.tag == "var_ref":
self.text = translator.generate_id(
"{%s}variable" % OVAL_NAMESPACES.definition, self.text
)
elif self.tag == "filter":
self.text = translator.generate_id(
"{%s}state" % OVAL_NAMESPACES.definition, self.text
)
elif self.tag == "object_reference":
self.text = translator.generate_id(
"{%s}object" % OVAL_NAMESPACES.definition, self.text
)
for property_ in self.properties:
property_.translate_id(translator)
self._translate_attributes(translator)
|