scm-python 0.1.0__py3-none-any.whl

scm/security_services/rest.py

@@ -0,0 +1,264 @@
+# coding: utf-8
+
+"""
+    Security Services
+
+    These APIs are used for defining and managing security services configurations within Strata Cloud Manager.
+
+    The version of the OpenAPI document: 2.0.0
+    Contact: support@paloaltonetworks.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import io
+import json
+import re
+import ssl
+
+import urllib3
+
+from scm.security_services.exceptions import ApiException, ApiValueError
+
+SUPPORTED_SOCKS_PROXIES = {"socks5", "socks5h", "socks4", "socks4a"}
+RESTResponseType = urllib3.HTTPResponse
+
+
+def is_socks_proxy_url(url):
+    if url is None:
+        return False
+    split_section = url.split("://")
+    if len(split_section) < 2:
+        return False
+    else:
+        return split_section[0].lower() in SUPPORTED_SOCKS_PROXIES
+
+
+class RESTResponse(io.IOBase):
+
+    def __init__(self, resp) -> None:
+        self.response = resp
+        self.status = resp.status
+        self.reason = resp.reason
+        self.data = None
+
+    def read(self):
+        if self.data is None:
+            self.data = self.response.data
+        return self.data
+
+    def getheaders(self):
+        """Returns a dictionary of the response headers."""
+        return self.response.headers
+
+    def getheader(self, name, default=None):
+        """Returns a given response header."""
+        return self.response.headers.get(name, default)
+
+
+class RESTClientObject:
+
+    def __init__(self, configuration) -> None:
+        # urllib3.PoolManager will pass all kw parameters to connectionpool
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/poolmanager.py#L75  # noqa: E501
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/connectionpool.py#L680  # noqa: E501
+        # Custom SSL certificates and client certificates: http://urllib3.readthedocs.io/en/latest/advanced-usage.html  # noqa: E501
+
+        # cert_reqs
+        if configuration.verify_ssl:
+            cert_reqs = ssl.CERT_REQUIRED
+        else:
+            cert_reqs = ssl.CERT_NONE
+
+        pool_args = {
+            "cert_reqs": cert_reqs,
+            "ca_certs": configuration.ssl_ca_cert,
+            "cert_file": configuration.cert_file,
+            "key_file": configuration.key_file,
+        }
+        if configuration.assert_hostname is not None:
+            pool_args['assert_hostname'] = (
+                configuration.assert_hostname
+            )
+
+        if configuration.retries is not None:
+            pool_args['retries'] = configuration.retries
+
+        if configuration.tls_server_name:
+            pool_args['server_hostname'] = configuration.tls_server_name
+
+
+        if configuration.socket_options is not None:
+            pool_args['socket_options'] = configuration.socket_options
+
+        if configuration.connection_pool_maxsize is not None:
+            pool_args['maxsize'] = configuration.connection_pool_maxsize
+
+        # https pool manager
+        self.pool_manager: urllib3.PoolManager
+
+        if configuration.proxy:
+            if is_socks_proxy_url(configuration.proxy):
+                from urllib3.contrib.socks import SOCKSProxyManager
+                pool_args["proxy_url"] = configuration.proxy
+                pool_args["headers"] = configuration.proxy_headers
+                self.pool_manager = SOCKSProxyManager(**pool_args)
+            else:
+                pool_args["proxy_url"] = configuration.proxy
+                pool_args["proxy_headers"] = configuration.proxy_headers
+                self.pool_manager = urllib3.ProxyManager(**pool_args)
+        else:
+            self.pool_manager = urllib3.PoolManager(**pool_args)
+
+    def request(
+        self,
+        method,
+        url,
+        headers=None,
+        body=None,
+        post_params=None,
+        _request_timeout=None
+    ):
+        """Perform requests.
+
+        :param method: http request method
+        :param url: http request url
+        :param headers: http request headers
+        :param body: request json body, for `application/json`
+        :param post_params: request post parameters,
+                            `application/x-www-form-urlencoded`
+                            and `multipart/form-data`
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        """
+        method = method.upper()
+        assert method in [
+            'GET',
+            'HEAD',
+            'DELETE',
+            'POST',
+            'PUT',
+            'PATCH',
+            'OPTIONS'
+        ]
+
+        if post_params and body:
+            raise ApiValueError(
+                "body parameter cannot be used with post_params parameter."
+            )
+
+        post_params = post_params or {}
+        headers = headers or {}
+
+        # Fix: urllib3 sets Accept-Encoding: identity when preload_content=False,
+        # but some endpoints return 500 error with this header.
+        # Set to gzip, deflate which servers typically accept.
+        if 'Accept-Encoding' not in headers:
+            headers['Accept-Encoding'] = 'gzip, deflate'
+
+        timeout = None
+        if _request_timeout:
+            if isinstance(_request_timeout, (int, float)):
+                timeout = urllib3.Timeout(total=_request_timeout)
+            elif (
+                    isinstance(_request_timeout, tuple)
+                    and len(_request_timeout) == 2
+                ):
+                timeout = urllib3.Timeout(
+                    connect=_request_timeout[0],
+                    read=_request_timeout[1]
+                )
+
+        try:
+            # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE`
+            if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']:
+
+                # no content type provided or payload is json
+                content_type = headers.get('Content-Type')
+                if (
+                    not content_type
+                    or re.search('json', content_type, re.IGNORECASE)
+                ):
+                    request_body = None
+                    if body is not None:
+                        request_body = json.dumps(body)
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=request_body,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif content_type == 'application/x-www-form-urlencoded':
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        fields=post_params,
+                        encode_multipart=False,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif content_type == 'multipart/form-data':
+                    # must del headers['Content-Type'], or the correct
+                    # Content-Type which generated by urllib3 will be
+                    # overwritten.
+                    del headers['Content-Type']
+                    # Ensures that dict objects are serialized
+                    post_params = [(a, json.dumps(b)) if isinstance(b, dict) else (a,b) for a, b in post_params]
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        fields=post_params,
+                        encode_multipart=True,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                # Pass a `string` parameter directly in the body to support
+                # other content types than JSON when `body` argument is
+                # provided in serialized form.
+                elif isinstance(body, str) or isinstance(body, bytes):
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=body,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif headers['Content-Type'].startswith('text/') and isinstance(body, bool):
+                    request_body = "true" if body else "false"
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=request_body,
+                        preload_content=False,
+                        timeout=timeout,
+                        headers=headers)
+                else:
+                    # Cannot generate the request from given parameters
+                    msg = """Cannot prepare a request message for provided
+                             arguments. Please check that your arguments match
+                             declared content type."""
+                    raise ApiException(status=0, reason=msg)
+            # For `GET`, `HEAD`
+            else:
+                r = self.pool_manager.request(
+                    method,
+                    url,
+                    fields={},
+                    timeout=timeout,
+                    headers=headers,
+                    preload_content=False
+                )
+        except urllib3.exceptions.SSLError as e:
+            msg = "\n".join([type(e).__name__, str(e)])
+            raise ApiException(status=0, reason=msg)
+
+        return RESTResponse(r)

scm/security_services/tests/api_anti_spyware_profiles_test.py

@@ -0,0 +1,201 @@
+import logging
+import uuid
+import pytest
+from scm import Scm
+from scm.security_services.models.anti_spyware_profiles import AntiSpywareProfiles
+from scm.test_helpers import perform
+
+# Configure logging
+logging.basicConfig(level=logging.DEBUG)
+logger = logging.getLogger(__name__)
+
+# -----------------------------------------------------------------------------
+# CONFIGURATION
+# -----------------------------------------------------------------------------
+TARGET_FOLDER = "Prisma Access"
+# -----------------------------------------------------------------------------
+
+
+@pytest.fixture(scope="module")
+def client():
+    try:
+        return Scm(log_level="DEBUG")
+    except Exception as e:
+        pytest.skip(f"Skipping tests due to client initialization failure: {e}")
+
+
+@pytest.fixture(scope="module")
+def anti_spyware_profiles_api(client):
+    return client.security_services.AntiSpywareProfilesApi(client.security_services.api_client)
+
+
+@pytest.fixture
+def clean_anti_spyware_profile(anti_spyware_profiles_api):
+    """
+    Setup/Teardown for a simple Anti-Spyware profile.
+    """
+    profile_name = f"scm-antispyware-{uuid.uuid4().hex[:6]}"
+
+    payload = AntiSpywareProfiles(
+        id="",
+        folder=TARGET_FOLDER,
+        name=profile_name
+    )
+
+    logger.info(f"\n[SETUP] Creating Anti-Spyware Profile: {profile_name}")
+    created_profile = perform(
+        anti_spyware_profiles_api.create_anti_spyware_profiles_with_http_info,
+        response_type=AntiSpywareProfiles,
+        anti_spyware_profiles=payload
+    )
+
+    yield created_profile
+
+    logger.info(f"\n[TEARDOWN] Deleting Anti-Spyware Profile: {created_profile.id}")
+    try:
+        perform(
+            anti_spyware_profiles_api.delete_anti_spyware_profiles_by_id_with_http_info,
+            id=created_profile.id
+        )
+    except Exception as e:
+        logger.error(f"Failed to cleanup Anti-Spyware profile: {e}")
+
+
+def test_create_anti_spyware_profile(anti_spyware_profiles_api):
+    """Test creation of an Anti-Spyware Profile."""
+    profile_name = f"scm-antispyware-create-{uuid.uuid4().hex[:6]}"
+
+    payload = AntiSpywareProfiles(
+        id="",
+        folder=TARGET_FOLDER,
+        name=profile_name
+    )
+
+    created_obj = perform(
+        anti_spyware_profiles_api.create_anti_spyware_profiles_with_http_info,
+        response_type=AntiSpywareProfiles,
+        anti_spyware_profiles=payload
+    )
+
+    assert created_obj is not None
+    assert created_obj.id is not None
+    assert created_obj.name == profile_name
+
+    perform(
+        anti_spyware_profiles_api.delete_anti_spyware_profiles_by_id_with_http_info,
+        id=created_obj.id
+    )
+
+
+def test_get_anti_spyware_profile_by_id(anti_spyware_profiles_api, clean_anti_spyware_profile):
+    """Test retrieving an Anti-Spyware Profile by ID."""
+    fetched_obj = perform(
+        anti_spyware_profiles_api.get_anti_spyware_profiles_by_id_with_http_info,
+        id=clean_anti_spyware_profile.id
+    )
+
+    assert fetched_obj.id == clean_anti_spyware_profile.id
+    assert fetched_obj.name == clean_anti_spyware_profile.name
+
+
+def test_update_anti_spyware_profile(anti_spyware_profiles_api, clean_anti_spyware_profile):
+    """Test updating an Anti-Spyware Profile."""
+    # Create fresh payload with all required fields to avoid Pydantic serialization issues
+    # Note: Name cannot be changed for anti-spyware profiles (same as decryption profiles)
+    update_payload = AntiSpywareProfiles(
+        id=clean_anti_spyware_profile.id,
+        name=clean_anti_spyware_profile.name,  # Name cannot be changed for anti-spyware profiles
+        folder=clean_anti_spyware_profile.folder,
+        description="Updated test anti-spyware profile description"
+    )
+
+    updated_obj = perform(
+        anti_spyware_profiles_api.update_anti_spyware_profiles_by_id_with_http_info,
+        id=clean_anti_spyware_profile.id,
+        anti_spyware_profiles=update_payload
+    )
+
+    assert updated_obj.id == clean_anti_spyware_profile.id
+    assert updated_obj.name == clean_anti_spyware_profile.name
+    assert updated_obj.description == "Updated test anti-spyware profile description"
+
+
+def test_list_anti_spyware_profiles(anti_spyware_profiles_api, clean_anti_spyware_profile):
+    """Test listing Anti-Spyware Profiles."""
+    response = perform(
+        anti_spyware_profiles_api.list_anti_spyware_profiles_with_http_info,
+        folder=TARGET_FOLDER
+    )
+
+    assert response is not None
+    assert len(response.data) > 0
+
+    found = False
+    for item in response.data:
+        if item.name == clean_anti_spyware_profile.name:
+            found = True
+            break
+    assert found is True, f"Created profile {clean_anti_spyware_profile.name} not found in list response"
+
+
+
+
+def test_fetch_anti_spyware_profiles(anti_spyware_profiles_api, clean_anti_spyware_profile):
+    """
+    Test fetching a single anti_spyware_profiles by name using the fetch convenience method.
+    Equivalent to pan-scm-sdk's fetch() method.
+    """
+    # Fetch by exact name
+    fetched_obj = anti_spyware_profiles_api.fetch_anti_spyware_profiles(
+        name=clean_anti_spyware_profile.name,
+        folder=clean_anti_spyware_profile.folder
+    )
+
+    # Verify
+    assert fetched_obj is not None, f"Should have found anti_spyware_profiles '{clean_anti_spyware_profile.name}'"
+    assert fetched_obj.id == clean_anti_spyware_profile.id
+    assert fetched_obj.name == clean_anti_spyware_profile.name
+    assert fetched_obj.folder == clean_anti_spyware_profile.folder
+    logger.info(f"\n[SUCCESS] fetch_anti_spyware_profiles found object: {fetched_obj.name}")
+
+    # Test fetching non-existent anti_spyware_profiles (should return None)
+    not_found = anti_spyware_profiles_api.fetch_anti_spyware_profiles(
+        name="non-existent-anti_spyware_profiles-xyz-12345",
+        folder=clean_anti_spyware_profile.folder
+    )
+    assert not_found is None, "Should return None for non-existent anti_spyware_profiles"
+    logger.info(f"\n[SUCCESS] fetch_anti_spyware_profiles correctly returned None for non-existent anti_spyware_profiles")
+
+
+def test_delete_anti_spyware_profile_by_id(anti_spyware_profiles_api):
+    """Test deleting an Anti-Spyware Profile."""
+    profile_name = f"scm-antispyware-delete-{uuid.uuid4().hex[:6]}"
+
+    payload = AntiSpywareProfiles(
+        id="",
+        folder=TARGET_FOLDER,
+        name=profile_name
+    )
+
+    created_obj = perform(
+        anti_spyware_profiles_api.create_anti_spyware_profiles_with_http_info,
+        response_type=AntiSpywareProfiles,
+        anti_spyware_profiles=payload
+    )
+
+    perform(
+        anti_spyware_profiles_api.delete_anti_spyware_profiles_by_id_with_http_info,
+        id=created_obj.id
+    )
+
+    from scm.security_services.exceptions import NotFoundException
+    from scm.error_parser import parse_scm_error
+    from scm.exceptions import ObjectNotPresentError
+
+    try:
+        anti_spyware_profiles_api.get_anti_spyware_profiles_by_id_with_http_info(id=created_obj.id)
+        pytest.fail("Profile should have been deleted but was found.")
+    except ObjectNotPresentError as e:
+        # Exception is already parsed by decorator
+        logger.info(f"✅ Correctly raised ObjectNotPresentError for deleted object")
+        logger.info(f"   Object ID: {created_obj.id}")

scm/security_services/tests/api_anti_spyware_signatures_test.py

@@ -0,0 +1,189 @@
+import logging
+import uuid
+import pytest
+from scm import Scm
+from scm.security_services.models.anti_spyware_signatures import AntiSpywareSignatures
+from scm.security_services.models.anti_spyware_signatures_signature import AntiSpywareSignaturesSignature
+from scm.security_services.models.anti_spyware_signatures_signature_standard_inner import AntiSpywareSignaturesSignatureStandardInner
+from scm.test_helpers import perform
+
+# Configure logging
+logging.basicConfig(level=logging.DEBUG)
+logger = logging.getLogger(__name__)
+
+# -----------------------------------------------------------------------------
+# CONFIGURATION
+# -----------------------------------------------------------------------------
+TARGET_FOLDER = "All"
+# Threat ID range for anti-spyware signatures: 6900001-7000000
+# -----------------------------------------------------------------------------
+
+
+def create_signature_block():
+    """Create a basic signature block for testing."""
+    standard_signature = AntiSpywareSignaturesSignatureStandardInner(
+        name="std-sig-1",
+        scope="protocol-data-unit"
+    )
+    return AntiSpywareSignaturesSignature(
+        standard=[standard_signature]
+    )
+
+
+@pytest.fixture(scope="module")
+def client():
+    try:
+        return Scm(log_level="DEBUG")
+    except Exception as e:
+        pytest.skip(f"Skipping tests due to client initialization failure: {e}")
+
+
+@pytest.fixture(scope="module")
+def anti_spyware_signatures_api(client):
+    return client.security_services.AntiSpywareSignaturesApi(client.security_services.api_client)
+
+
+@pytest.fixture
+def clean_anti_spyware_signature(anti_spyware_signatures_api):
+    """
+    Setup/Teardown for a simple Anti-Spyware Signature.
+    """
+    sig_name = f"test-aspysig-{uuid.uuid4().hex[:6]}"
+    signature_block = create_signature_block()
+
+    payload = AntiSpywareSignatures(
+        id="",
+        folder=TARGET_FOLDER,
+        threatname=sig_name,
+        threat_id="6900001",
+        severity="medium",
+        direction="client2server",
+        comment="Test anti-spyware signature",
+        signature=signature_block
+    )
+
+    logger.info(f"\n[SETUP] Creating Anti-Spyware Signature: {sig_name}")
+    created_sig = perform(
+        anti_spyware_signatures_api.create_anti_spyware_signatures_with_http_info,
+        response_type=AntiSpywareSignatures,
+        anti_spyware_signatures=payload
+    )
+
+    yield created_sig
+
+    logger.info(f"\n[TEARDOWN] Deleting Anti-Spyware Signature: {created_sig.id}")
+    try:
+        perform(
+            anti_spyware_signatures_api.delete_anti_spyware_signatures_by_id_with_http_info,
+            id=created_sig.id
+        )
+    except Exception as e:
+        logger.error(f"Failed to cleanup Anti-Spyware Signature: {e}")
+
+
+def test_create_anti_spyware_signature(anti_spyware_signatures_api):
+    """Test creation of an Anti-Spyware Signature."""
+    sig_name = f"test-aspysig-create-{uuid.uuid4().hex[:6]}"
+    signature_block = create_signature_block()
+
+    payload = AntiSpywareSignatures(
+        id="",
+        folder=TARGET_FOLDER,
+        threatname=sig_name,
+        threat_id="6900001",
+        severity="medium",
+        direction="client2server",
+        comment="Test anti-spyware signature for create API testing",
+        signature=signature_block
+    )
+
+    created_obj = perform(
+        anti_spyware_signatures_api.create_anti_spyware_signatures_with_http_info,
+        response_type=AntiSpywareSignatures,
+        anti_spyware_signatures=payload
+    )
+
+    assert created_obj is not None
+    assert created_obj.id is not None
+    assert created_obj.threatname == sig_name
+
+    perform(
+        anti_spyware_signatures_api.delete_anti_spyware_signatures_by_id_with_http_info,
+        id=created_obj.id
+    )
+
+
+def test_get_anti_spyware_signature_by_id(anti_spyware_signatures_api, clean_anti_spyware_signature):
+    """Test retrieving an Anti-Spyware Signature by ID."""
+    fetched_obj = perform(
+        anti_spyware_signatures_api.get_anti_spyware_signatures_by_id_with_http_info,
+        id=clean_anti_spyware_signature.id
+    )
+
+    assert fetched_obj.id == clean_anti_spyware_signature.id
+    assert fetched_obj.threatname == clean_anti_spyware_signature.threatname
+
+
+def test_update_anti_spyware_signature(anti_spyware_signatures_api, clean_anti_spyware_signature):
+    """Test updating an Anti-Spyware Signature."""
+    update_payload = clean_anti_spyware_signature
+    update_payload.comment = "Updated test anti-spyware signature comment"
+
+    updated_obj = perform(
+        anti_spyware_signatures_api.update_anti_spyware_signatures_by_id_with_http_info,
+        id=clean_anti_spyware_signature.id,
+        anti_spyware_signatures=update_payload
+    )
+
+    assert updated_obj.id == clean_anti_spyware_signature.id
+    assert updated_obj.comment == "Updated test anti-spyware signature comment"
+
+
+def test_list_anti_spyware_signatures(anti_spyware_signatures_api):
+    """Test listing Anti-Spyware Signatures (read-only)."""
+    response = perform(
+        anti_spyware_signatures_api.list_anti_spyware_signatures_with_http_info,
+        folder=TARGET_FOLDER
+    )
+
+    assert response is not None
+    logger.info(f"Successfully listed anti-spyware signatures, total: {len(response.data)}")
+
+
+def test_delete_anti_spyware_signature_by_id(anti_spyware_signatures_api):
+    """Test deleting an Anti-Spyware Signature."""
+    sig_name = f"test-aspysig-delete-{uuid.uuid4().hex[:6]}"
+    signature_block = create_signature_block()
+
+    payload = AntiSpywareSignatures(
+        id="",
+        folder=TARGET_FOLDER,
+        threatname=sig_name,
+        threat_id="6900005",
+        severity="medium",
+        direction="client2server",
+        comment="Test anti-spyware signature for delete API testing",
+        signature=signature_block
+    )
+
+    created_obj = perform(
+        anti_spyware_signatures_api.create_anti_spyware_signatures_with_http_info,
+        response_type=AntiSpywareSignatures,
+        anti_spyware_signatures=payload
+    )
+
+    perform(
+        anti_spyware_signatures_api.delete_anti_spyware_signatures_by_id_with_http_info,
+        id=created_obj.id
+    )
+
+    from scm.security_services.exceptions import NotFoundException
+    from scm.error_parser import parse_scm_error
+    from scm.exceptions import ObjectNotPresentError
+
+    try:
+        anti_spyware_signatures_api.get_anti_spyware_signatures_by_id_with_http_info(id=created_obj.id)
+        pytest.fail("Signature should have been deleted but was found.")
+    except ObjectNotPresentError as e:
+        logger.info(f"Correctly raised ObjectNotPresentError for deleted object")
+        logger.info(f"   Object ID: {created_obj.id}")