updates

Backend/venv/lib/python3.12/site-packages/cyclonedx/validation/xml.py

@@ -0,0 +1,102 @@
+# This file is part of CycloneDX Python Library
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# Copyright (c) OWASP Foundation. All Rights Reserved.
+
+
+__all__ = ['XmlValidator']
+
+from abc import ABC
+from typing import TYPE_CHECKING, Any, Literal, Optional, Tuple
+
+from ..exception import MissingOptionalDependencyException
+from ..schema import OutputFormat
+from ..schema._res import BOM_XML as _S_BOM
+from . import BaseSchemabasedValidator, SchemabasedValidator, ValidationError
+
+if TYPE_CHECKING:  # pragma: no cover
+    from ..schema import SchemaVersion
+
+_missing_deps_error: Optional[Tuple[MissingOptionalDependencyException, ImportError]] = None
+try:
+    from lxml.etree import (  # type:ignore[import-untyped] # nosec B410
+        XMLParser,
+        XMLSchema,
+        fromstring as xml_fromstring,
+    )
+except ImportError as err:
+    _missing_deps_error = MissingOptionalDependencyException(
+        'This functionality requires optional dependencies.\n'
+        'Please install `cyclonedx-python-lib` with the extra "xml-validation".\n'
+    ), err
+
+
+class _BaseXmlValidator(BaseSchemabasedValidator, ABC):
+
+    @property
+    def output_format(self) -> Literal[OutputFormat.XML]:
+        return OutputFormat.XML
+
+    def __init__(self, schema_version: 'SchemaVersion') -> None:
+        # this is the def that is used for generating the documentation
+        super().__init__(schema_version)
+
+    if _missing_deps_error:
+        __MDERROR = _missing_deps_error
+
+        def validate_str(self, data: str) -> Optional[ValidationError]:
+            raise self.__MDERROR[0] from self.__MDERROR[1]
+    else:
+        def validate_str(self, data: str) -> Optional[ValidationError]:
+            return self._validata_data(
+                xml_fromstring(  # nosec B320
+                    bytes(data, encoding='utf8'),
+                    parser=self.__xml_parser))
+
+        def _validata_data(self, data: Any) -> Optional[ValidationError]:
+            validator = self._validator  # may throw on error that MUST NOT be caught
+            if not validator.validate(data):
+                return ValidationError(validator.error_log.last_error)
+            return None
+
+        __validator: Optional['XMLSchema'] = None
+
+        @property
+        def __xml_parser(self) -> XMLParser:
+            return XMLParser(
+                attribute_defaults=False, dtd_validation=False, load_dtd=False,
+                no_network=True,
+                resolve_entities=False,
+                huge_tree=True,
+                compact=True,
+                recover=False
+            )
+
+        @property
+        def _validator(self) -> 'XMLSchema':
+            if not self.__validator:
+                schema_file = self._schema_file
+                if schema_file is None:
+                    raise NotImplementedError('missing schema file')
+                self.__validator = XMLSchema(file=schema_file)
+            return self.__validator
+
+
+class XmlValidator(_BaseXmlValidator, BaseSchemabasedValidator, SchemabasedValidator):
+    """Validator for CycloneDX documents in XML format."""
+
+    @property
+    def _schema_file(self) -> Optional[str]:
+        return _S_BOM.get(self.schema_version)