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

fp_ngfw_smc_python-1.0.35/.gitignore

@@ -0,0 +1,29 @@
+# remove all intellij conf giles
+.DS_store
+.idea*/*
+*.pyc
+build/*
+dist/*
+/.env
+fp_NGFW_SMC_python.egg-info/*
+smc-monitoring/build/*
+smc-monitoring/dist/*
+smc-monitoring/fp_NGFW_SMC_python_monitoring.egg-info/*
+venv*
+**/**/smc_info.py
+.terraform*
+*.tfstate*
+*tf.log
+terraform/**/*.pem
+*.tfvars*
+qa/results/*
+qa/smc-test-module/terraform/**/**/*.backup
+qa/smc-test-module/terraform/**/**/*.tfstate*
+qa/smc-test-module/terraform/**/**/*.hcl
+qa/smc-test-module/terraform/**/*.output
+qa/smc-test-module/terraform/**/smc_build
+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.33 → fp_ngfw_smc_python-1.0.35}/MANIFEST.in

@@ -1 +1,2 @@
 include README.rst HISTORY.rst
+include smc/py.typed

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

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: fp-NGFW-SMC-python
-Version: 1.0.33
+Version: 1.0.35
 Summary: Python based API to Forcepoint NGFW Management Center
 Author-email: Forcepoint <PSIRT@forcepoint.com>
 License: Apache License (2.0)
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Requires-Python: >=3.5
+Requires-Python: >=3.9
 Description-Content-Type: text/x-rst
 License-File: LICENSE
 Requires-Dist: requests>=2.31.0
@@ -52,7 +52,7 @@ Some of the functionality you get with the SMC Python API:
 Requirements
 ------------
 
-Python >= 3.5
+Python >= 3.9
 
 Requests >= 2.32.0
 websocket-client >= 1.8.0
@@ -134,7 +134,7 @@ Documentation
 
 `View Documentation on Read The Docs <http://fp-ngfw-smc-python.readthedocs.io/en/latest/?badge=latest>`__
 
-.. |Python version| image:: https://img.shields.io/badge/python-2.7%20%7C%203.5%20%7C%203.6-blue
+.. |Python version| image:: https://img.shields.io/badge/python-3.9%2B-blue
     :target: https://pypi.python.org/pypi/fp-NGFW-SMC-python/
 
 Release History

{fp_ngfw_smc_python-1.0.33 → fp_ngfw_smc_python-1.0.35}/README.rst

@@ -35,7 +35,7 @@ Some of the functionality you get with the SMC Python API:
 Requirements
 ------------
 
-Python >= 3.5
+Python >= 3.9
 
 Requests >= 2.32.0
 websocket-client >= 1.8.0
@@ -117,5 +117,5 @@ Documentation
 
 `View Documentation on Read The Docs <http://fp-ngfw-smc-python.readthedocs.io/en/latest/?badge=latest>`__
 
-.. |Python version| image:: https://img.shields.io/badge/python-2.7%20%7C%203.5%20%7C%203.6-blue
+.. |Python version| image:: https://img.shields.io/badge/python-3.9%2B-blue
     :target: https://pypi.python.org/pypi/fp-NGFW-SMC-python/

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

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: fp-NGFW-SMC-python
-Version: 1.0.33
+Version: 1.0.35
 Summary: Python based API to Forcepoint NGFW Management Center
 Author-email: Forcepoint <PSIRT@forcepoint.com>
 License: Apache License (2.0)
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Requires-Python: >=3.5
+Requires-Python: >=3.9
 Description-Content-Type: text/x-rst
 License-File: LICENSE
 Requires-Dist: requests>=2.31.0
@@ -52,7 +52,7 @@ Some of the functionality you get with the SMC Python API:
 Requirements
 ------------
 
-Python >= 3.5
+Python >= 3.9
 
 Requests >= 2.32.0
 websocket-client >= 1.8.0
@@ -134,7 +134,7 @@ Documentation
 
 `View Documentation on Read The Docs <http://fp-ngfw-smc-python.readthedocs.io/en/latest/?badge=latest>`__
 
-.. |Python version| image:: https://img.shields.io/badge/python-2.7%20%7C%203.5%20%7C%203.6-blue
+.. |Python version| image:: https://img.shields.io/badge/python-3.9%2B-blue
     :target: https://pypi.python.org/pypi/fp-NGFW-SMC-python/
 
 Release History

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

@@ -17,6 +17,7 @@ smc/__init__.py
 smc/__version__.py
 smc/compat.py
 smc/known_issues
+smc/py.typed
 smc-monitoring/.coveragerc
 smc-monitoring/HISTORY.rst
 smc-monitoring/LICENSE
@@ -24,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
@@ -51,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
@@ -184,6 +184,7 @@ smc/examples/lldp.py
 smc/examples/login_domain_username_password.py
 smc/examples/match_expression.py
 smc/examples/mini_reports.py
+smc/examples/modem_interface.py
 smc/examples/monitoring_status.py
 smc/examples/netlink.py
 smc/examples/network.py
@@ -246,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.33 → fp_ngfw_smc_python-1.0.35}/pyproject.toml

@@ -16,7 +16,7 @@ authors = [
     {name = "Forcepoint", email = "PSIRT@forcepoint.com"},
 ]
 description = "Python based API to Forcepoint NGFW Management Center"
-requires-python = ">=3.5"
+requires-python = ">=3.9"
 license = {text = "Apache License (2.0)"}
 dynamic = ["version", "readme"]
 dependencies = [
@@ -47,3 +47,16 @@ 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.33 → fp_ngfw_smc_python-1.0.35}/smc/__init__.py

@@ -9,6 +9,9 @@
 #  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 #  License for the specific language governing permissions and limitations
 #  under the License.
+from __future__ import annotations
+
+from typing import Any, Optional, Union, Iterator
 
 import logging
 
@@ -17,11 +20,11 @@ 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()
 
-def get_session_by_user(user):
+def get_session_by_user(user: Optional[str]) -> Any:
     """
     Get a session specifically by it's name
     or new Session if not found in manager
@@ -39,8 +42,8 @@ try:  # Python 2.7+
     from logging import NullHandler
 except ImportError:
 
-    class NullHandler(logging.Handler):
-        def emit(self, record):
+    class NullHandler(logging.Handler):  # type: ignore[no-redef]  # py2 fallback
+        def emit(self, record: Any) -> None:
             pass
 
 
@@ -50,7 +53,7 @@ logging.getLogger(__name__).addHandler(NullHandler())
 LOG_FORMAT = "%(asctime)s - %(name)s - [%(levelname)s] - %(message)s"
 
 
-def set_stream_logger(log_level=logging.DEBUG, format_string=None, logger_name="smc"):
+def set_stream_logger(log_level: int = logging.DEBUG, format_string: Optional[str] = None, logger_name: str = "smc") -> None:
     """
     Stream logger convenience function to log to console
 
@@ -75,7 +78,7 @@ def set_stream_logger(log_level=logging.DEBUG, format_string=None, logger_name="
     logger.addHandler(ch)
 
 
-def set_file_logger(path, log_level=logging.DEBUG, format_string=None, logger_name="smc"):
+def set_file_logger(path: str, log_level: int = logging.DEBUG, format_string: Optional[str] = None, logger_name: str = "smc") -> None:
     """
     Convenience function to quickly configure any level of logging
     to a file.
@@ -103,7 +106,7 @@ def set_file_logger(path, log_level=logging.DEBUG, format_string=None, logger_na
     log.addHandler(ch)
 
 
-def _import_registry():
+def _import_registry() -> None:
     # Load the modules to register needed classes
     # This should be extracted and made dynamic
     for pkg in (

{fp_ngfw_smc_python-1.0.33 → 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.33'
+__version__ = '1.0.35'

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

@@ -13,6 +13,9 @@
 Access Control Lists are assigned to SMC admin accounts to grant limited
 access permissions to either Engines, Policies or Domains.
 """
+from __future__ import annotations
+
+from typing import Any, Iterator, Optional, Union, cast
 
 from smc.base.model import Element, ElementCreator
 from smc.base.structs import NestedDict
@@ -36,7 +39,7 @@ class AccessControlList(Element):
     typeof = "access_control_list"
 
     @classmethod
-    def create(cls, name, granted_element=None):
+    def create(cls, name: str, granted_element: Optional[Any] = None) -> "AccessControlList":
         """
         Create a new ACL
 
@@ -54,7 +57,7 @@ class AccessControlList(Element):
         return ElementCreator(cls, json)
 
     @property
-    def permissions(self):
+    def permissions(self) -> list[Any]:
         """
         Elements associated to this permission. Granted elements can be
         Engines, Policies or other Access Control Lists.
@@ -63,7 +66,7 @@ class AccessControlList(Element):
         """
         return [Element.from_href(e) for e in self.granted_element]
 
-    def add_permission(self, elements):
+    def add_permission(self, elements: Any) -> None:
         """
         Add permission/s to this ACL. By default this change is committed
         after the method is called.
@@ -78,7 +81,7 @@ class AccessControlList(Element):
         self.data["granted_element"].extend(elements)
         self.update()
 
-    def remove_permission(self, elements):
+    def remove_permission(self, elements: Any) -> None:
         """
         Remove permission/s to this ACL. Change is committed at end of
         method call.
@@ -112,7 +115,12 @@ class Permission(NestedDict):
     .. seealso:: :py:mod:`smc.elements.user`
     """
 
-    def __init__(self, granted_elements=None, role_ref=None, granted_domain_ref=None):
+    def __init__(
+        self,
+        granted_elements: Optional[Any] = None,
+        role_ref: Optional[Any] = None,
+        granted_domain_ref: Optional[Any] = None,
+    ) -> None:
         if granted_elements is None:
             granted_elements = []
         data = dict(
@@ -124,7 +132,7 @@ class Permission(NestedDict):
         super(Permission, self).__init__(data=data)
 
     @classmethod
-    def create(cls, elements, role, domain=None):
+    def create(cls, elements: Any, role: Any, domain: Optional[Any] = None) -> "Permission":
         """
         Create a permission.
 
@@ -141,27 +149,27 @@ class Permission(NestedDict):
         return Permission(granted_elements=elements, role_ref=role, granted_domain_ref=domain)
 
     @property
-    def granted_elements(self):
+    def granted_elements(self) -> list[Any]:
         """
         List of elements this permission has rights to. Elements will be of type
         Engine, Policy or ACLs
 
         :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):
+    def role(self) -> Any:
         """
         Specific Role assigned to this permission. A role is what allows read/write
         access to specific operations on the granted elements
 
         :rtype: Role
         """
-        return Element.from_href(self.get("role_ref"))
+        return Element.from_href(cast(str, self.get("role_ref")))
 
     @property
-    def domain(self):
+    def domain(self) -> Any:
         """
         Domain this permission applies to. Shared Domain if unspecified.
 
@@ -169,7 +177,7 @@ class Permission(NestedDict):
         """
         return Element.from_href(self.get("granted_domain_ref", "Shared Domain"))
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         return "Permission(elements={}, role={}, domain={})".format(
             self.granted_elements, self.role, self.domain
         )
@@ -180,11 +188,16 @@ class GrantedElementPermissions(NestedDict):
     The Granted Element permissions container.
     """
 
-    def __init__(self, data):
+    def __init__(self, data: Any) -> None:
         super(GrantedElementPermissions, self).__init__(data=data)
 
     @classmethod
-    def create(cls, cluster_ref=None, granted_access_control_list=[], role_containers=[]):
+    def create(
+        cls,
+        cluster_ref: Optional[Any] = None,
+        granted_access_control_list: list[Any] = [],
+        role_containers: list[Any] = [],
+    ) -> "GrantedElementPermissions":
         """
         :param str cluster_ref: The associated cluster with granted permission.
         :param list(str) granted_access_control_list: Granted Access Control Lists.
@@ -200,24 +213,24 @@ class GrantedElementPermissions(NestedDict):
         return cls(json)
 
     @property
-    def cluster_ref(self):
+    def cluster_ref(self) -> Optional[str]:
         """
         The associated cluster with granted permission.
         """
         return self.data.get("cluster_ref")
 
-    def granted_access_control_list(self):
+    def granted_access_control_list(self) -> Any:
         """
         Granted Access Control Lists.
         """
         return self.data.get("granted_access_control_list")
 
     @property
-    def role_containers(self):
+    def role_containers(self) -> list[Any]:
         """
         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):
@@ -225,11 +238,16 @@ class AdminRoleContainer(NestedDict):
     Represents a permission for a Granted Element: Role <-> Administrator <-> Granted Domain
     """
 
-    def __init__(self, data):
+    def __init__(self, data: Any) -> None:
         super(AdminRoleContainer, self).__init__(data=data)
 
     @classmethod
-    def create(cls, roles=[], admin=None, granted_domain=None):
+    def create(
+        cls,
+        roles: list[Any] = [],
+        admin: Optional[Any] = None,
+        granted_domain: Optional[Any] = None,
+    ) -> "AdminRoleContainer":
         """
         Represents a permission for a Granted Element: Role <-> Administrator <-> Granted Domain.
         :param Role roles: The dedicated Administrative Roles for access rights.
@@ -243,21 +261,21 @@ class AdminRoleContainer(NestedDict):
         return cls(json)
 
     @property
-    def roles(self):
+    def roles(self) -> Any:
         """
         The dedicated Administrative Roles for access rights.
         """
         return self.data.get("roles")
 
     @property
-    def admin_ref(self):
+    def admin_ref(self) -> Optional[str]:
         """
         The dedicated Administrator.
         """
         return self.data.get("admin_ref")
 
     @property
-    def granted_domain_ref(self):
+    def granted_domain_ref(self) -> Optional[str]:
         """
         The dedicated Administrative Domain.
         """

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

@@ -12,6 +12,9 @@
 """
 Module representing certificate authority in SMC
 """
+from __future__ import annotations
+
+from typing import Any, Optional, Union, Iterator
 
 from smc.administration.tasks import TaskOperationPoller
 from smc.api.exceptions import TaskRunFailed
@@ -28,14 +31,14 @@ class CertificateAuthority(Element):
     typeof = 'certificate_authority'
 
     @property
-    def certificate_state(self):
+    def certificate_state(self) -> Optional[str]:
         """
         represents the state of the certificate authority.
         :rtype: str
         """
         return self.data.get("certificate_state")
 
-    def un_trust(self):
+    def un_trust(self) -> Any:
         task = self.make_request(
             TaskRunFailed, method="update", resource="untrust"
         )
@@ -43,7 +46,7 @@ class CertificateAuthority(Element):
             task=task, wait_for_finish=True
         )
 
-    def export_certificate(self, filename=None):
+    def export_certificate(self, filename: Optional[str] = None) -> Optional[str]:
         """
         Export the certificate for the given Certificate Authority.
         :raises CertificateExportError: error exporting certificate
@@ -55,21 +58,21 @@ 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):
+    def duplicate(self, name: Any) -> Any:
         raise NotImplementedError(f"This method is not supported for {self.__class__.__name__}")
 
-    def export(self, name):
+    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):
+    def add_category(self, name: Any) -> Any:
         raise NotImplementedError(f"This method is not supported for {self.__class__.__name__}")
 
-    def categories(self, name):
+    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):
+    def rename(self, name: Any) -> Any:
         raise NotImplementedError(f"This method is not supported for {self.__class__.__name__}")