fp-NGFW-SMC-python 1.0.34__tar.gz → 1.0.35__tar.gz

{fp_ngfw_smc_python-1.0.34 → fp_ngfw_smc_python-1.0.35}/.gitignore

@@ -26,3 +26,4 @@ qa/smc-test-module/terraform/**/*input
 qa/smc-test-module/docker/**/smc-python
 **/**/progress_report_*_result
 *.lock
+LAST_SKILL_UPDATE

{fp_ngfw_smc_python-1.0.34 → fp_ngfw_smc_python-1.0.35}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fp-NGFW-SMC-python
-Version: 1.0.34
+Version: 1.0.35
 Summary: Python based API to Forcepoint NGFW Management Center
 Author-email: Forcepoint <PSIRT@forcepoint.com>
 License: Apache License (2.0)

{fp_ngfw_smc_python-1.0.34 → fp_ngfw_smc_python-1.0.35}/fp_NGFW_SMC_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fp-NGFW-SMC-python
-Version: 1.0.34
+Version: 1.0.35
 Summary: Python based API to Forcepoint NGFW Management Center
 Author-email: Forcepoint <PSIRT@forcepoint.com>
 License: Apache License (2.0)

{fp_ngfw_smc_python-1.0.34 → fp_ngfw_smc_python-1.0.35}/fp_NGFW_SMC_python.egg-info/SOURCES.txt

@@ -25,10 +25,10 @@ smc-monitoring/MANIFEST.in
 smc-monitoring/README.rst
 smc-monitoring/pyproject.toml
 smc-monitoring/requirements.txt
-smc-monitoring/test.py
 smc-monitoring/tox.ini
 smc-monitoring/smc_monitoring/__init__.py
 smc-monitoring/smc_monitoring/__version__.py
+smc-monitoring/smc_monitoring/py.typed
 smc-monitoring/smc_monitoring/wsocket.py
 smc-monitoring/smc_monitoring/models/__init__.py
 smc-monitoring/smc_monitoring/models/calendar.py
@@ -52,7 +52,6 @@ smc-monitoring/smc_monitoring/monitors/vpns.py
 smc-monitoring/smc_monitoring/pubsub/__init__.py
 smc-monitoring/smc_monitoring/pubsub/subscribers.py
 smc-monitoring/tests/__init__.py
-smc-monitoring/tests/docker_smc_bootstrap.py
 smc-monitoring/tests/test_filters.py
 smc-monitoring/tests/test_queries.py
 smc/actions/__init__.py
@@ -248,7 +247,17 @@ smc/routing/prefix_list.py
 smc/routing/route_map.py
 smc/tests/.gitignore
 smc/tests/__init__.py
-smc/tests/docker_smc_bootstrap.py
+smc/tests/api_base_administration_bugs_test.py
+smc/tests/api_web_debug_test.py
+smc/tests/core_bugs_test.py
+smc/tests/elements_bugs_test.py
+smc/tests/engine_bugs_test.py
+smc/tests/internal_gateway_test.py
+smc/tests/monitoring_status_test.py
+smc/tests/policy_vpn_bugs_test.py
+smc/tests/smc_monitoring_entries_test.py
+smc/tests/smc_request_headers_test.py
+smc/tests/system_import_interactive_test.py
 smc/vpn/__init__.py
 smc/vpn/application_access_portal.py
 smc/vpn/elements.py

fp_ngfw_smc_python-1.0.35/pyproject.toml

@@ -0,0 +1,62 @@
+[build-system]
+requires = [
+    "setuptools",
+    "wheel",
+    "setuptools-scm[toml]",
+    "requests",
+    "pytz",
+    "urllib3"
+]
+build-backend = "setuptools.build_meta"
+
+
+[project]
+name = 'fp-NGFW-SMC-python'
+authors = [
+    {name = "Forcepoint", email = "PSIRT@forcepoint.com"},
+]
+description = "Python based API to Forcepoint NGFW Management Center"
+requires-python = ">=3.9"
+license = {text = "Apache License (2.0)"}
+dynamic = ["version", "readme"]
+dependencies = [
+        "requests>=2.31.0",
+        "pytz>=2022.6",
+        "urllib3>=1.26.18"
+]
+classifiers = [
+        "Development Status :: 5 - Production/Stable",
+        "Programming Language :: Python",
+        "Programming Language :: Python :: 3"
+]
+
+
+[tool.setuptools.dynamic]
+version = {attr = "smc.__version__"}  # any module attribute compatible with ast.literal_eval
+readme = {file = ["README.rst", "HISTORY.rst"]}
+
+
+[tool.setuptools.packages.find]
+# All the following settings are optional:
+where = ["."]  # ["."] by default
+include = ["smc", "smc.*"]  # ["*"] by default
+exclude = ["smc.tests", "smc.docs"]  # empty by default
+namespaces = true  # true by default
+
+
+[tool.setuptools]
+include-package-data = true
+license-files = ["LICENSE"]
+
+[tool.setuptools.package-data]
+smc = ["py.typed"]
+
+[tool.mypy]
+# Run from this directory: `mypy` (no argument). Enforced by `make check-tests`.
+python_version = "3.9"
+ignore_missing_imports = true
+files = ["smc", "smc-monitoring/smc_monitoring"]
+exclude = '^smc/(tests|examples|docs)/'
+check_untyped_defs = true
+disallow_untyped_defs = true
+disallow_incomplete_defs = true

{fp_ngfw_smc_python-1.0.34 → fp_ngfw_smc_python-1.0.35}/smc/__init__.py

@@ -20,7 +20,7 @@ from smc.base.util import import_submodules
 
 from .__version__ import  __version__
 
-session_name = None
+session_name: Optional[str] = None
 manager = SessionManager.create()
 session = manager.get_default_session()
 
@@ -42,7 +42,7 @@ try:  # Python 2.7+
     from logging import NullHandler
 except ImportError:
 
-    class NullHandler(logging.Handler):
+    class NullHandler(logging.Handler):  # type: ignore[no-redef]  # py2 fallback
         def emit(self, record: Any) -> None:
             pass
 

{fp_ngfw_smc_python-1.0.34 → fp_ngfw_smc_python-1.0.35}/smc/__version__.py

@@ -10,4 +10,4 @@
 #  License for the specific language governing permissions and limitations
 #  under the License.
 
-__version__ = '1.0.34'
+__version__ = '1.0.35'

{fp_ngfw_smc_python-1.0.34 → fp_ngfw_smc_python-1.0.35}/smc/administration/access_rights.py

@@ -15,7 +15,7 @@ access permissions to either Engines, Policies or Domains.
 """
 from __future__ import annotations
 
-from typing import Any, Iterator, Optional, Union
+from typing import Any, Iterator, Optional, Union, cast
 
 from smc.base.model import Element, ElementCreator
 from smc.base.structs import NestedDict
@@ -156,7 +156,7 @@ class Permission(NestedDict):
 
         :rtype: list(Element)
         """
-        return [Element.from_href(element) for element in self.get("granted_elements")]
+        return [Element.from_href(element) for element in cast(list, self.get("granted_elements"))]
 
     @property
     def role(self) -> Any:
@@ -166,7 +166,7 @@ class Permission(NestedDict):
 
         :rtype: Role
         """
-        return Element.from_href(self.get("role_ref"))
+        return Element.from_href(cast(str, self.get("role_ref")))
 
     @property
     def domain(self) -> Any:
@@ -230,7 +230,7 @@ class GrantedElementPermissions(NestedDict):
         """
         Granted Role containers.
         """
-        return [AdminRoleContainer(container) for container in self.data.get("role_containers")]
+        return [AdminRoleContainer(container) for container in cast(list, self.data.get("role_containers"))]
 
 
 class AdminRoleContainer(NestedDict):

{fp_ngfw_smc_python-1.0.34 → fp_ngfw_smc_python-1.0.35}/smc/administration/certificates/certificate_authority.py

@@ -58,20 +58,20 @@ class CertificateAuthority(Element):
 
         if filename is not None:
             save_to_file(filename, result.content)
-            return
+            return  # type: ignore[return-value]  # implicit None
 
         return result.content
 
     def duplicate(self, name: Any) -> Any:
         raise NotImplementedError(f"This method is not supported for {self.__class__.__name__}")
 
-    def export(self, name: Any) -> Any:
+    def export(self, name: Any) -> Any:  # type: ignore[override]  # unsupported, signature differs
         raise NotImplementedError(f"This method is not supported for {self.__class__.__name__}")
 
     def add_category(self, name: Any) -> Any:
         raise NotImplementedError(f"This method is not supported for {self.__class__.__name__}")
 
-    def categories(self, name: Any) -> Any:
+    def categories(self, name: Any) -> Any:  # type: ignore[override]  # unsupported, overrides a property
         raise NotImplementedError(f"This method is not supported for {self.__class__.__name__}")
 
     def rename(self, name: Any) -> Any:

{fp_ngfw_smc_python-1.0.34 → fp_ngfw_smc_python-1.0.35}/smc/administration/certificates/tls.py

@@ -602,6 +602,15 @@ class TLSServerCredential(
         """
         return self.make_request(method="create", resource="self_sign")
 
+    def sign_with_internal_ca(self) -> Any:
+        """
+        Sign the certificate in 'request' state with the SMC's internal CA
+        (the "Stonesoft Root CA" / "SG Root CA" certificate authority).
+
+        :raises ActionCommandFailed: failed to sign with reason
+        """
+        return self.make_request(method="create", resource="sign_with_internal_ca")
+
     @property
     def valid_from(self) -> Any:
         """

{fp_ngfw_smc_python-1.0.34 → fp_ngfw_smc_python-1.0.35}/smc/administration/certificates/tls_common.py

@@ -17,7 +17,7 @@ where the certificates/keys are stored, or providing in string format.
 """
 from __future__ import annotations
 
-from typing import Any, Optional, Union, Iterator
+from typing import Any, Optional, Union, Iterator, TYPE_CHECKING, Callable
 
 import re
 from smc.compat import unicode
@@ -94,6 +94,10 @@ class ImportExportCertificate(object):
     classes.
     """
 
+    if TYPE_CHECKING:
+        typeof: str
+        make_request: Callable[..., Any]
+
     def import_certificate(self, certificate: Any) -> None:
         """
         Import a valid certificate. Certificate can be either a file path
@@ -133,7 +137,7 @@ class ImportExportCertificate(object):
 
         if filename is not None:
             save_to_file(filename, result.content)
-            return
+            return  # type: ignore[return-value]  # implicit None
 
         return result.content
 
@@ -144,6 +148,9 @@ class ImportExportIntermediate(object):
     certificates
     """
 
+    if TYPE_CHECKING:
+        make_request: Callable[..., Any]
+
     def import_intermediate_certificate(self, certificate: Any) -> None:
         """
         Import a valid certificate. Certificate can be either a file path
@@ -181,7 +188,7 @@ class ImportExportIntermediate(object):
 
         if filename is not None:
             save_to_file(filename, result.content)
-            return
+            return  # type: ignore[return-value]  # implicit None
 
         return result.content
 
@@ -192,6 +199,9 @@ class ImportPrivateKey(object):
     require private keys.
     """
 
+    if TYPE_CHECKING:
+        make_request: Callable[..., Any]
+
     def import_private_key(self, private_key: Any) -> None:
         """
         Import a private key. The private key can be a path to a file

{fp_ngfw_smc_python-1.0.34 → fp_ngfw_smc_python-1.0.35}/smc/administration/certificates/vpn.py

@@ -15,7 +15,7 @@ and other VPN related connections. Each gateway certificate is signed by
 a VPN CA and uses the default internal CA by default.
 """
 from __future__ import annotations
-from typing import Any, Optional, Union, Iterator
+from typing import Any, Optional, Union, Iterator, cast
 from smc.base.model import Element, ElementCreator, SubElement, ElementRef
 from smc.administration.certificates.tls_common import ImportExportCertificate
 from smc.api.exceptions import CertificateError, SMCOperationFailure, CertificateImportError
@@ -97,7 +97,7 @@ class GatewayCertificate(SubElement):
             cert_auth = element_resolver(signing_ca)
             json.update(certificate_authority_href=cert_auth)
         return ElementCreator(
-            GatewayCertificate,
+            cast(Any, GatewayCertificate),
             exception=CertificateError,
             href=self.internal_gateway.get_relation("generate_certificate"),
             json=json
@@ -119,7 +119,7 @@ class GatewayCertificate(SubElement):
         cert_auth = element_resolver(signing_ca)
 
         return ElementCreator(
-            GatewayCertificate,
+            cast(Any, GatewayCertificate),
             exception=CertificateError,
             href=self.internal_gateway.get_relation("generate_certificate"),
             json={
@@ -201,7 +201,7 @@ class GatewayCertificate(SubElement):
         return self.expiration_date
 
     def export_certificate(self, filename: Optional[str] = None) -> Any:
-        export_result = ImportExportCertificate.export_certificate(self, filename)
+        export_result = ImportExportCertificate.export_certificate(cast(Any, self), filename)
         return export_result
 
 
@@ -261,7 +261,7 @@ class GatewayCertificateRequest(SubElement):
         return self.data.public_key_algorithm
 
     def export_certificate_request(self, filename: Optional[str] = None) -> Any:
-        export_result = ImportExportCertificate.export_certificate(self, filename)
+        export_result = ImportExportCertificate.export_certificate(cast(Any, self), filename)
         return export_result
 
     def import_certificate_request(self, certificate: str) -> None:

{fp_ngfw_smc_python-1.0.34 → fp_ngfw_smc_python-1.0.35}/smc/administration/eca_client_config.py

@@ -75,7 +75,7 @@ class EcaClientConfig(Element):
 
         if filename is not None:
             save_to_file(filename, result.content)
-            return
+            return  # type: ignore[return-value]  # implicit None
 
         return result.content
 

{fp_ngfw_smc_python-1.0.34 → fp_ngfw_smc_python-1.0.35}/smc/administration/monitoring_status.py

@@ -28,7 +28,7 @@ To get Monitoring Status for VPN and tunnels, do::
 """
 from __future__ import annotations
 
-from typing import Any, Optional, Union, Iterator
+from typing import Any, Optional, Union, Iterator, TYPE_CHECKING
 import logging
 from smc.api.common import fetch_entry_point, SMCRequest
 from smc.api.exceptions import NotMonitored
@@ -38,6 +38,11 @@ from smc.core.resource import History
 
 logger = logging.getLogger(__name__)
 
+# Present on every status payload, on every API version, but not declared
+# as a property on any subclass - so __get_status_type()'s fallback must
+# ignore them, like base-class attributes.
+_ADDITIVE_ENVELOPE_FIELDS = frozenset({"element", "link"})
+
 
 class MonitoringStatus(object):
     """
@@ -75,6 +80,9 @@ class MonitoringStatus(object):
 
     """
 
+    if TYPE_CHECKING:
+        link: list[Any]
+
     def __init__(self, **data: Any) -> None:
         for d, v in data.items():
             # Made the code SMC 7.1 compatible
@@ -152,7 +160,7 @@ class MonitoringStatus(object):
         return self._result
 
     @property
-    def history(self) -> Optional[History]:
+    def history(self) -> Optional[History]:  # type: ignore[return]  # implicit None
         """
         This function returns a history object.
         :return: history object.
@@ -165,24 +173,48 @@ class MonitoringStatus(object):
                     result = SMCRequest(method="create", href=history_link).create()
                     return History(**result.json)
 
-    @result.setter
+    @result.setter  # type: ignore[no-redef,attr-defined]  # setter not adjacent to its getter
     def result(self, value: Any) -> None:
         self._result = value
 
+    @staticmethod
+    def __self_link_type(links: Any) -> Optional[str]:
+        """
+        :param links: the "link" list of the monitoring status payload, if
+            any (absent on older SMC versions)
+        :return: the "self" link's "type" token, or None if there is no
+            such link or its "type" is missing/null (some API versions)
+        :rtype: str
+        """
+        for link_dict in links or []:
+            if link_dict.get("rel") == "self":
+                return link_dict.get("type")
+        return None
+
     @staticmethod
     def __get_status_type(data: Any) -> Any:
         """
         :return: status class related to data
         :rtype: MonitoringStatus
         """
-        # status by default
+        # Explicit discriminator: the "self" link's "type" token identifies
+        # the concrete type regardless of any additive field. No match ->
+        # fall through to the attribute-matching fallback below unchanged.
+        # A match returns immediately, so every entry in
+        # status_type_by_link_type must be trustworthy, not a guess.
+        link_type = MonitoringStatus.__self_link_type(data.get("link"))
+        if link_type in status_type_by_link_type:
+            return status_type_by_link_type[link_type]
+        # Fallback: infer the type from which attributes are present.
+        # status by default.
         result = MonitoringStatus
         for st in status_type:
             find = True
             nb_found = 0
             for attr in data:
-                # don't check attributes from superclass
-                if hasattr(MonitoringStatus, attr):
+                # don't check attributes from superclass, nor the additive
+                # envelope fields (not diagnostic of the subclass either)
+                if hasattr(MonitoringStatus, attr) or attr in _ADDITIVE_ENVELOPE_FIELDS:
                     continue
                 # if attribute from data not in status type, we continue to next type
                 if not hasattr(st, attr):
@@ -214,10 +246,10 @@ class MonitoringStatus(object):
         return status(**result.json)
 
     def __str__(self) -> str:
-        result = "{}=>".format(self.__class__.__name__)
-        for attr in vars(self):
-            result += "{} = {}, ".format(attr, getattr(self, attr))
-        return result
+        attrs = ", ".join(
+            "{} = {!r}".format(attr, getattr(self, attr)) for attr in vars(self)
+        )
+        return "{}=>{}".format(self.__class__.__name__, attrs)
 
 
 class ServerStatus(MonitoringStatus):
@@ -270,16 +302,8 @@ class EngineNodeStatus(MonitoringStatus):
     state, version, current policy, ... of the specified Node.
     """
 
-    @property
-    def installed_policy(self) -> Optional[str]:
-        """
-        :return: The Last Uploaded Policy.
-        :rtype: str
-        """
-        return self._installed_policy
-
-    def installed_policy(self, value: Any) -> None:
-        self._installed_policy = value
+    #: The Last Uploaded Policy, None when the server does not send it.
+    installed_policy: Optional[str] = None
 
     @property
     def installed_policy_ref(self) -> Any:
@@ -739,3 +763,28 @@ class VPNEndpointTunnelStatus(VPNGatewayTunnelStatus):
 status_type = [ServerStatus, EngineNodeStatus, SDWANBranchStatus, SDWANBranchToBranchStatus,
                SDWANNetlinkElementStatus, VPNStatus, VPNGatewayTunnelStatus,
                VPNEndpointTunnelStatus]
+
+# Maps a monitoring status's "self" link "type" token (the server DTO's
+# @XmlRootElement name, not a snake_case class name) to its
+# MonitoringStatus subclass. Missing key -> safe, falls through to
+# status_type above. Wrong key -> not safe, __get_status_type() returns on
+# a hit and skips that fallback, so a wrong class misclassifies. Every
+# entry must be confirmed, not guessed.
+#
+# "application_health_status" is real but deliberately absent: no
+# ApplicationHealthStatus class exists, and callers read these payloads via
+# dict(vars(status)), which depends on the base class's plain attributes.
+#
+# "sdwan_branch_tunnel_status" -> SDWANBranchToBranchStatus is withheld:
+# real token, but the class was only inferred by elimination, not confirmed
+# live. Falls through to status_type until confirmed.
+status_type_by_link_type = {
+    "smc_server_status": ServerStatus,
+    "engine_node_status": EngineNodeStatus,
+    "sdwan_branch_status": SDWANBranchStatus,
+    # "sdwan_branch_tunnel_status": SDWANBranchToBranchStatus,  # unconfirmed, see note above
+    "netlink_element_status": SDWANNetlinkElementStatus,
+    "vpn_status": VPNStatus,
+    "gateway_tunnel_status": VPNGatewayTunnelStatus,
+    "endpoint_tunnel_status": VPNEndpointTunnelStatus,
+}

{fp_ngfw_smc_python-1.0.34 → fp_ngfw_smc_python-1.0.35}/smc/administration/reports.py

@@ -237,7 +237,7 @@ class Report(Element):
             headers={"accept": "application/pdf"},
         )
 
-    def export_text(self, filename: Optional[str] = None) -> Optional[Any]:
+    def export_text(self, filename: Optional[str] = None) -> Optional[Any]:  # type: ignore[return]  # implicit None
         """
         Export in text format. Optionally provide a filename to
         save to.

{fp_ngfw_smc_python-1.0.34 → fp_ngfw_smc_python-1.0.35}/smc/administration/scheduled_tasks.py

@@ -99,9 +99,12 @@ date::
     for obtaining millisecond times for scheduled tasks.
 """
 from __future__ import annotations
-from typing import Any, Optional, Union, Iterator
+from typing import Any, Optional, Union, Iterator, TYPE_CHECKING, cast, Callable
 
 from smc.base.model import Element, SubElement, ElementCreator, ElementRef
+
+if TYPE_CHECKING:
+    from smc.base.model import ElementCache
 from smc.api.exceptions import ActionCommandFailed, UnsupportedEngineFeature, InvalidEngineNode
 from smc.administration.tasks import Task
 from smc.base.structs import NestedDict
@@ -338,6 +341,10 @@ class ScheduledTaskMixin(object):
     Actions common to all scheduled tasks.
     """
 
+    if TYPE_CHECKING:
+        data: ElementCache
+        make_request: Callable[..., Any]
+
     def start(self) -> Task:
         """
         Start the scheduled task now. Task can then be tracked by
@@ -430,7 +437,7 @@ class ScheduledTaskMixin(object):
         :return: list of Elements
         :rtype: list
         """
-        return [Element.from_href(href) for href in self.data.get("resources")]
+        return [Element.from_href(href) for href in cast(list, self.data.get("resources"))]
 
 
 class RefreshPolicyTask(ScheduledTaskMixin, Element):