zscams 2.0.4__py3-none-any.whl

zscams/agent/src/support/logger.py

@@ -0,0 +1,88 @@
+"""
+Logger module for TLS Tunnel Client
+"""
+
+"""Singleton logger handlers for local logging only"""
+import sys
+import logging
+import os
+import platform
+from typing import Dict
+from logging import Logger
+
+from zscams.agent.src.support.configuration import get_config
+
+loggers: Dict[str, Logger] = {}
+
+# -------------------- COLOR FORMATTER --------------------
+
+
+class ColorFormatter(logging.Formatter):
+    """Formatter adding ANSI colors to console logs only."""
+
+    COLORS = {
+        "DEBUG": "\033[93m",  # Yellow
+        "INFO": "\033[92m",  # Green
+        "WARNING": "\033[95m",  # Magenta
+        "ERROR": "\033[91m",  # Red
+        "CRITICAL": "\033[41m",  # Red background
+    }
+
+    RESET = "\033[0m"
+
+    def format(self, record):
+        color = self.COLORS.get(record.levelname, self.RESET)
+        msg = super().format(record)
+        return f"{color}{msg}{self.RESET}"
+
+
+# -------------------- SYSTEM LOG PATH --------------------
+
+
+def get_default_system_log_path():
+    """Returns the system default logging path"""
+    system = platform.system()
+
+    if system == "Windows":
+        return os.path.join(
+            os.environ.get("WINDIR", "C:\\Windows"), "System32", "winevt", "Logs"
+        )
+
+    elif system == "Linux":
+        return "/var/log"
+
+    else:
+        return None  # unsupported
+
+
+# -------------------- LOGGER FACTORY --------------------
+
+
+def get_logger(name: str) -> Logger:
+    """Create a singleton instance for that logger name"""
+    if name in loggers:
+        return loggers[name]
+
+    logger = logging.getLogger(
+        f"ZSCAMs - {name}" if name.lower().find("zscams") == -1 else name
+    )
+    logger.setLevel(get_config().get("logging", {}).get("level", 10))
+    logger.propagate = False  # Prevent duplicate logs
+
+    # Cleanup handlers if any
+    if logger.hasHandlers():
+        logger.handlers.clear()
+
+    # -------- Console Handler -------- #
+    console_handler = logging.StreamHandler(sys.stdout)
+    console_handler.setLevel(get_config().get("logging", {}).get("level", 10))
+
+    console_formatter = ColorFormatter(
+        fmt="[%(asctime)s] [%(levelname)s] [%(name)s] %(message)s",
+        datefmt="%Y-%m-%d %H:%M:%S",
+    )
+    console_handler.setFormatter(console_formatter)
+    logger.addHandler(console_handler)
+    # Cache singleton
+    loggers[name] = logger
+    return logger

zscams/agent/src/support/mac.py

@@ -0,0 +1,18 @@
+"""Module to retrieve the MAC address of the primary network interface."""
+
+from getmac import get_mac_address as gma
+
+
+class MacAddressError(Exception):
+    """Exception raised when MAC address cannot be retrieved."""
+
+    pass
+
+
+def get_mac_address() -> str:
+    """Get the MAC address of the primary network interface."""
+
+    mac_addr = gma()
+    if not mac_addr:
+        raise MacAddressError("Could not retrieve MAC address.")
+    return mac_addr

zscams/agent/src/support/network.py

@@ -0,0 +1,49 @@
+"""
+Network utilities for TLS Tunnel Client
+"""
+
+import socket
+
+
+def is_port_open(host, port, logger):
+    """Check if TCP port is open."""
+    with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock:
+        sock.settimeout(1)
+        try:
+            sock.connect((host, port))
+            logger.debug(f"Port {port} on {host} is open.")
+            return True
+        except (ConnectionRefusedError, OSError):
+            logger.error(f"Port {port} on {host} is not open.")
+            return False
+        except Exception as err:
+            logger.error("Port check failed for %s:%s. Error: %s", host, port, err)
+            return False
+
+
+def is_service_running(service_name, running_services, logger):
+    """Wait for another service to be marked as running."""
+    if service_name in running_services:
+        logger.debug(f"Service {service_name} is running.")
+        return True
+
+    logger.error(f"Service {service_name} is not running.")
+    return False
+
+
+def get_local_ip_address():
+    """Get the local IP address of the machine."""
+    with socket.socket(socket.AF_INET, socket.SOCK_DGRAM) as s:
+        try:
+            # The IP used here doesn't need to be reachable
+            s.connect(("8.8.8.8", 80))
+            ip = s.getsockname()[0]
+        except Exception:
+            ip = "127.0.0.1"
+        return ip
+
+
+def get_local_hostname():
+    """Get the local hostname of the machine."""
+
+    return socket.gethostname()

zscams/agent/src/support/openssl.py

@@ -0,0 +1,114 @@
+"""
+This module provides a simple interface for generating RSA key pairs
+"""
+
+import os
+
+from cryptography import x509
+from cryptography.hazmat.primitives.asymmetric import rsa
+from cryptography.x509.oid import NameOID
+from cryptography.hazmat.primitives import hashes, serialization
+from cryptography.hazmat.backends import default_backend
+
+
+def generate_private_key(key_path: str):
+    """Generate a new RSA private key and save it to a file."""
+
+    private_key = rsa.generate_private_key(
+        public_exponent=65537,
+        key_size=4096,
+    )
+
+    pem_private_key = private_key.private_bytes(
+        encoding=serialization.Encoding.PEM,
+        format=serialization.PrivateFormat.PKCS8,
+        encryption_algorithm=serialization.NoEncryption(),
+    )
+
+    with open(key_path, "wb") as f:
+        f.write(pem_private_key)
+
+    os.chmod(key_path, 0o700)
+
+    return pem_private_key
+
+
+# pylint: disable=too-many-arguments,too-many-positional-arguments
+def generate_csr_from_private_key(
+    private_key_content: bytes,
+    country: str,
+    state: str,
+    locality: str,
+    organization: str,
+    common_name: str,
+) -> str:
+    """
+    Generate a CSR (Certificate Signing Request) from an existing private key.
+    Returns:
+        str: The generated CSR in PEM format.
+    """
+
+    private_key = serialization.load_pem_private_key(
+        private_key_content,
+        password=None,
+        backend=default_backend(),
+    )
+
+    csr_builder = x509.CertificateSigningRequestBuilder()
+    csr_builder = (
+        csr_builder.subject_name(
+            x509.Name(
+                [
+                    x509.NameAttribute(NameOID.COUNTRY_NAME, country),
+                    x509.NameAttribute(NameOID.STATE_OR_PROVINCE_NAME, state),
+                    x509.NameAttribute(NameOID.LOCALITY_NAME, locality),
+                    x509.NameAttribute(NameOID.ORGANIZATION_NAME, organization),
+                    x509.NameAttribute(NameOID.COMMON_NAME, common_name),
+                ]
+            )
+        )
+        .add_extension(
+            x509.BasicConstraints(ca=False, path_length=None),
+            critical=False,
+        )
+        .add_extension(
+            x509.UnrecognizedExtension(
+                x509.ObjectIdentifier("2.16.840.1.113730.1.1"),
+                b"SSL Client, S/MIME",
+            ),
+            critical=False,
+        )
+        .add_extension(
+            x509.UnrecognizedExtension(
+                x509.ObjectIdentifier("2.16.840.1.113730.1.13"),
+                b"Generated by OBS/OCD",
+            ),
+            critical=False,
+        )
+        .add_extension(
+            x509.KeyUsage(
+                digital_signature=True,
+                crl_sign=False,
+                key_encipherment=True,
+                content_commitment=True,
+                data_encipherment=False,
+                key_agreement=False,
+                key_cert_sign=False,
+                encipher_only=False,
+                decipher_only=False,
+            ),
+            critical=True,
+        )
+        .add_extension(
+            x509.ExtendedKeyUsage(
+                [
+                    x509.ExtendedKeyUsageOID.CLIENT_AUTH,
+                    x509.ExtendedKeyUsageOID.EMAIL_PROTECTION,
+                ]
+            ),
+            critical=False,
+        )
+    )
+
+    csr = csr_builder.sign(private_key, hashes.SHA256())
+    return csr.public_bytes(serialization.Encoding.PEM).decode("utf-8")

zscams/agent/src/support/os.py

@@ -0,0 +1,138 @@
+import sys
+import subprocess
+import platform
+import subprocess
+from zscams.agent.src.support.logger import get_logger
+
+from .filesystem import write_to_file
+
+logger = get_logger("os_support")
+
+
+def is_linux():
+    if sys.platform.lower().startswith("linux"):
+        return True
+    return False
+
+
+def system_user_exists(username: str):
+    try:
+        subprocess.run(
+            ["id", username],
+            check=True,
+            stdout=subprocess.DEVNULL,
+            stderr=subprocess.DEVNULL,
+        )
+        logger.debug("found the system user %s", username)
+        return True
+    except subprocess.CalledProcessError:
+        return False
+
+
+def is_freebsd():
+    return (
+        platform.system().lower() == "freebsd"
+        or platform.system().lower() == "zscaleros"
+    )
+
+
+def create_system_user(username: str):
+    # Support both Linux and FreeBSD
+    if not (platform.system() == "Linux" or is_freebsd()):
+        logger.error(
+            "Error creating system user: This script is intended to run on Linux or FreeBSD systems."
+        )
+        return
+
+    if not username:
+        logger.error("Error creating system user: Username must be provided.")
+        return
+
+    # Assuming system_user_exists is already updated to handle both
+    if system_user_exists(username):
+        logger.warning("User '%s' already exists.", username)
+        return
+
+    try:
+        if is_freebsd():
+            cmd = ["sudo", "pw", "useradd", "-n", username, "-m", "-s", "/bin/sh"]
+        else:
+            # Standard Linux useradd
+            cmd = ["sudo", "useradd", "-m", "-s", "/bin/bash", username]
+
+        subprocess.run(cmd, check=True)
+        logger.info("System user '%s' created successfully.", username)
+
+    except subprocess.CalledProcessError as e:
+        logger.error("Failed to create user '%s': %s", username, e)
+
+
+def install_service(service_name: str, content: str):
+    """
+    Main entry point to install services.
+    Redirects to systemd for Linux and rc.d for FreeBSD.
+    """
+    if is_linux():
+        install_systemd_service(service_name, content)
+    elif is_freebsd():
+        install_rc_service(service_name, content)
+    else:
+        logger.error("Unsupported OS for service installation.")
+
+
+def install_rc_service(service_name: str, content: str):
+    """
+    Installs a FreeBSD rc.d script.
+    Note: 'content' for FreeBSD should be a valid rc.subr shell script.
+    """
+    service_path = f"/usr/local/etc/rc.d/{service_name}"
+
+    try:
+        # 1. Write the rc script
+        logger.debug("Installing FreeBSD rc script: %s", service_path)
+        # Using sudo tee to ensure write permissions on restricted paths
+        echo_cmd = f"printf '%s' '{content}' | sudo tee {service_path}"
+        subprocess.run(echo_cmd, shell=True, check=True, stdout=subprocess.DEVNULL)
+
+        # 2. Make it executable (Crucial for FreeBSD)
+        subprocess.run(["sudo", "chmod", "+x", service_path], check=True)
+
+        # 3. Enable and Start
+        # In FreeBSD, enabling adds 'service_name_enable="YES"' to /etc/rc.conf
+        logger.debug("Enabling and starting FreeBSD service %s...", service_name)
+        subprocess.run(["sudo", "sysrc", f"{service_name}_enable=YES"], check=True)
+        subprocess.run(["sudo", "service", service_name, "start"], check=True)
+
+        logger.info("Service %s installed and started successfully.", service_name)
+
+    except Exception as e:
+        logger.error("Failed to install FreeBSD service %s: %s", service_name, e)
+
+
+def install_systemd_service(service_name: str, content: str):
+    service_path = f"/etc/systemd/system/{service_name}"
+
+    try:
+        logger.debug("Installing service '%s' content", service_name)
+        write_to_file(service_path, content)
+        logger.debug(f"Installed {service_name}")
+    except PermissionError:
+        logger.warning("Permission denied: trying to write with sudo...")
+        echo_cmd = f"echo '{content}' | sudo tee {service_path}"
+        subprocess.run(echo_cmd, shell=True, check=True, stdout=subprocess.DEVNULL)
+        logger.debug("Wrote the service")
+    except Exception as e:
+        logger.error("Failed to install service %s. %s", service_name, e)
+        return
+
+    try:
+        logger.debug("Enabling %s...", service_name)
+        subprocess.run(["sudo", "systemctl", "enable", service_name], check=True)
+        logger.debug("Starting %s...", service_name)
+        subprocess.run(["sudo", "systemctl", "start", service_name], check=True)
+    except subprocess.CalledProcessError:
+        logger.error(
+            "Failed to enable/restart zscams service, You might need to do that manually by running\nsudo systemctl enable %s && sudo systemctl start %s",
+            service_name,
+            service_name,
+        )

zscams/agent/src/support/ssh.py

@@ -0,0 +1,24 @@
+from zscams.agent.src.support.configuration import get_config
+from zscams.agent.src.support.filesystem import append_to_file
+from zscams.agent.src.support.logger import get_logger
+
+
+logger = get_logger("ssh_support")
+
+
+def add_to_known_hosts(hostname: str, pub_key: str):
+    logger.debug("Appending '%s' to known hosts...", pub_key)
+    append_to_file(
+        get_config().get("ssh", {}).get("known_hosts_file_path"),
+        f"{hostname} {pub_key}\n",
+    )
+    logger.debug("Appended key to known hosts")
+
+
+def add_to_authorized_keys(user, pub_key):
+    logger.debug(f"Appending to public key to {user}")
+    key = pub_key.split(' ')[1] if len(pub_key.split(' ')) >= 2 else pub_key
+    append_to_file(
+        f"/home/{user}/.ssh/authorized_keys",
+        f"ssh-rsa {key} zscams@orangecyberdefense\n",
+    )

zscams/agent/src/support/yaml.py

@@ -0,0 +1,37 @@
+import yaml
+
+
+class YamlIndentedListsDumper(yaml.Dumper):
+    def increase_indent(self, flow=False, indentless=False):
+        return super(YamlIndentedListsDumper, self).increase_indent(flow, False)
+
+def resolve_placeholders( obj, values: dict[str, int]):
+    """
+    Recursively replace '{key}' strings with values[key]
+    in dicts, lists, and strings.
+    """
+    if isinstance(obj, dict):
+        for k, v in obj.items():
+            obj[k] = resolve_placeholders(v, values)
+
+    elif isinstance(obj, list):
+        for i, v in enumerate(obj):
+            obj[i] = resolve_placeholders(v, values)
+
+    elif isinstance(obj, str):
+        for key, value in values.items():
+            placeholder = f"{{{key}}}"
+            if obj == placeholder:
+                return value
+        return obj
+
+    return obj
+def assert_no_placeholders_left(obj):
+    if isinstance(obj, dict):
+        for v in obj.values():
+            assert_no_placeholders_left(v)
+    elif isinstance(obj, list):
+        for v in obj:
+            assert_no_placeholders_left(v)
+    elif isinstance(obj, str) and obj.startswith("{") and obj.endswith("}"):
+        raise ValueError(f"Unresolved placeholder: {obj}")

zscams/deps.py

@@ -0,0 +1,86 @@
+import subprocess
+import sys
+import platform
+import os
+import importlib.util
+
+
+def is_installed(name):
+    return importlib.util.find_spec(name) is not None
+
+
+def ensure_native_deps():
+    # Only run this logic on FreeBSD
+    if (
+        platform.system().lower() != "freebsd"
+        and platform.system().lower() != "zscaleros"
+    ):
+        return
+
+    # 1. Define what we need and how FreeBSD names them
+    py_ver = f"py{sys.version_info.major}{sys.version_info.minor}"
+    deps_map = {
+        "cryptography": f"{py_ver}-cryptography",
+        "yaml": f"{py_ver}-pyyaml",
+        "psutil": f"{py_ver}-psutil",
+    }
+
+    # Identify which modules are actually missing
+    missing_mods = [mod for mod in deps_map if not is_installed(mod)]
+
+    if not missing_mods:
+        return  # Everything is already installed
+
+    print(
+        f"--> ZscalerOS/FreeBSD detected. Missing requirements: {', '.join(missing_mods)}"
+    )
+
+    # 2. Ensure the FreeBSD Mirror is configured
+    # We use a custom local file so we don't overwrite Zscaler's system configs
+    repo_conf_dir = "/usr/local/etc/pkg/repos"
+    repo_conf_file = f"{repo_conf_dir}/FreeBSD.conf"
+
+    if not os.path.exists(repo_conf_file):
+        print("--> Mirror not found. Configuring official FreeBSD repository...")
+        # Hardcoding the ABI to 13 because ZscalerOS identifies as 42-RELEASE
+        mirror_config = (
+            "FreeBSD: { "
+            'url: "pkg+http://pkg.FreeBSD.org/FreeBSD:13:amd64/latest", '
+            'mirror_type: "srv", '
+            'signature_type: "fingerprints", '
+            'fingerprints: "/usr/share/keys/pkg", '
+            "enabled: yes "
+            "}"
+        )
+
+        try:
+            subprocess.run(["sudo", "mkdir", "-p", repo_conf_dir], check=True)
+            # Use printf/tee to handle the sudo write to a restricted path
+            subprocess.run(
+                f"printf '{mirror_config}' | sudo tee {repo_conf_file}",
+                shell=True,
+                check=True,
+                capture_output=True,
+            )
+            print(
+                "--> Mirror configured. Updating package database (this may take a moment)..."
+            )
+            subprocess.run(["sudo", "pkg", "update", "-f"], check=True)
+        except subprocess.CalledProcessError as e:
+            print(f"--> Failed to configure mirror. Error: {e}")
+            sys.exit(1)
+
+    # 3. Install the missing packages
+    targets = [deps_map[m] for m in missing_mods]
+    print(f"--> Attempting auto-install of: {', '.join(targets)}")
+
+    try:
+        # Install via pkg
+        subprocess.run(["sudo", "pkg", "install", "-y"] + targets, check=True)
+        print("--> Dependencies installed successfully!")
+        print("--> Please restart your command to apply changes.")
+        sys.exit(0)
+    except subprocess.CalledProcessError:
+        print("--> Error: Failed to install packages. Check your internet connection.")
+        print(f"--> Manual command: sudo pkg install {' '.join(targets)}")
+        sys.exit(1)

zscams-2.0.4.dist-info/METADATA

@@ -0,0 +1,114 @@
+Metadata-Version: 2.1
+Name: zscams
+Version: 2.0.4
+Summary: Async TLS tunnel client with SNI routing, auto-reconnect, and health checks
+Author: OCD - Cairo Software Team
+Maintainer: OCD - Cairo Software Team
+Requires-Python: >=3.9
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: PyYAML ; sys_platform != "freebsd"
+Requires-Dist: cryptography ; sys_platform != "freebsd"
+Requires-Dist: getmac
+Requires-Dist: psutil ; sys_platform != "freebsd"
+Requires-Dist: requests
+Description-Content-Type: text/markdown
+
+# Agent
+
+
+
+## Getting started
+
+To make it easy for you to get started with GitLab, here's a list of recommended next steps.
+
+Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
+
+## Add your files
+
+- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
+- [ ] [Add files using the command line](https://docs.gitlab.com/topics/git/add_files/#add-files-to-a-git-repository) or push an existing Git repository with the following command:
+
+```
+cd existing_repo
+git remote add origin https://gitlab.tech.orange/cairo-engineering-software-team/zscams/agent.git
+git branch -M main
+git push -uf origin main
+```
+
+## Integrate with your tools
+
+- [ ] [Set up project integrations](https://gitlab.tech.orange/cairo-engineering-software-team/zscams/agent/-/settings/integrations)
+
+## Collaborate with your team
+
+- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
+- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
+- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
+- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
+- [ ] [Set auto-merge](https://docs.gitlab.com/user/project/merge_requests/auto_merge/)
+
+## Test and Deploy
+
+Use the built-in continuous integration in GitLab.
+
+- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/)
+- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
+- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
+- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
+- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
+
+***
+
+# Editing this README
+
+When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
+
+## Suggestions for a good README
+
+Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
+
+## Name
+Choose a self-explaining name for your project.
+
+## Description
+Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
+
+## Badges
+On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
+
+## Visuals
+Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
+
+## Installation
+Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
+
+## Usage
+Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
+
+## Support
+Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
+
+## Roadmap
+If you have ideas for releases in the future, it is a good idea to list them in the README.
+
+## Contributing
+State if you are open to contributions and what your requirements are for accepting them.
+
+For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+
+You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
+
+## Authors and acknowledgment
+Show your appreciation to those who have contributed to the project.
+
+## License
+For open source projects, say how it is licensed.
+
+## Project status
+If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
+